fix: replace usedatafunctionreturn with serializefrom as per remix 1.7.0

sandulat · Aug 26, 2022 · 03e2f40 · 03e2f40
1 parent b5f2779
commit 03e2f40
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,8 @@ First, you have to install the package itself:
 yarn add -D remix-docs-gen
 ```
 
+> Note that you need @remix-run/server-runtime to be at least ^1.7.0.
+
 ## Usage Example
 
 You can simply run:

diff --git a/packages/remix-docs-gen/CHANGELOG.md b/packages/remix-docs-gen/CHANGELOG.md
@@ -1,5 +1,11 @@
 # remix-docs-gen
 
+## 0.1.3
+
+### Patch Changes
+
+- Replace UseDataFunctionReturn with SerializeFrom as per Remix 1.7.0.
+
 ## 0.1.2
 
 ### Patch Changes

diff --git a/packages/remix-docs-gen/package.json b/packages/remix-docs-gen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "remix-docs-gen",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -33,6 +33,6 @@
     "config": "*"
   },
   "peerDependencies": {
-    "@remix-run/dev": "^1.0.3"
+    "@remix-run/dev": "^1.7.0"
   }
 }
diff --git a/packages/remix-docs-gen/src/docs.ts b/packages/remix-docs-gen/src/docs.ts
@@ -84,14 +84,14 @@ const parseDataFunctionOutput = (
 
   const typeName = `__RESERVED_${dataFunctionName}_RETURN_TYPE_${timestamp}`;
 
-  const dataFunctionReturnTypeName = `__RESERVED_USE_DATA_FUNCTION_RETURN_${timestamp}`;
+  const serializeFromTypeName = `__RESERVED_SERIALIZE_FROM_${timestamp}`;
 
   sourceFile
     .replaceWithText(
-      `import { UseDataFunctionReturn as ${dataFunctionReturnTypeName} } from "@remix-run/react/dist/components";
+      `import type { SerializeFrom as ${serializeFromTypeName} } from "@remix-run/server-runtime";
 ${sourceFile.getFullText()}
 
-type ${typeName} = ${dataFunctionReturnTypeName}<typeof ${dataFunctionName}>;
+type ${typeName} = ${serializeFromTypeName}<typeof ${dataFunctionName}>;
 `
     )
     .getFullText();