@7nohe/openapi-react-query-codegen - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

dist/package.json

 {
     "name": "@7nohe/openapi-react-query-codegen",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "OpenAPI React Query Codegen",
@@ -16,3 +16,3 @@ "bin": {
         "type": "git",
-        "url": "https://github.com/7nohe/openapi-react-query-codegen.git"
+        "url": "git+https://github.com/7nohe/openapi-react-query-codegen.git"
     },
@@ -19,0 +19,0 @@ "homepage": "https://github.com/7nohe/openapi-react-query-codegen",

dist/src/createUseQuery.js

@@ -45,38 +45,43 @@ "use strict";
     }
-    return typescript_1["default"].factory.createVariableStatement([typescript_1["default"].factory.createModifier(typescript_1["default"].SyntaxKind.ExportKeyword)], typescript_1["default"].factory.createVariableDeclarationList([
-        typescript_1["default"].factory.createVariableDeclaration(typescript_1["default"].factory.createIdentifier("use".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName))), undefined, undefined, typescript_1["default"].factory.createArrowFunction(undefined, undefined, __spreadArray(__spreadArray([], __read(requestParam), false), [
-            typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("queryKey"), undefined, typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)), typescript_1["default"].factory.createArrayLiteralExpression([], false)),
-            typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("options"), typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.QuestionToken), typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Omit"), [
-                typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("UseQueryOptions"), [
-                    typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
-                        typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
-                            typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
+    var customHookName = "use".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName));
+    var queryKey = "".concat(customHookName, "Key");
+    return [
+        typescript_1["default"].factory.createVariableStatement([typescript_1["default"].factory.createModifier(typescript_1["default"].SyntaxKind.ExportKeyword)], typescript_1["default"].factory.createVariableDeclarationList([typescript_1["default"].factory.createVariableDeclaration(typescript_1["default"].factory.createIdentifier(queryKey), undefined, undefined, typescript_1["default"].factory.createStringLiteral("".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName))))], typescript_1["default"].NodeFlags.Const)),
+        typescript_1["default"].factory.createVariableStatement([typescript_1["default"].factory.createModifier(typescript_1["default"].SyntaxKind.ExportKeyword)], typescript_1["default"].factory.createVariableDeclarationList([
+            typescript_1["default"].factory.createVariableDeclaration(typescript_1["default"].factory.createIdentifier(customHookName), undefined, undefined, typescript_1["default"].factory.createArrowFunction(undefined, undefined, __spreadArray(__spreadArray([], __read(requestParam), false), [
+                typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("queryKey"), undefined, typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)), typescript_1["default"].factory.createArrayLiteralExpression([], false)),
+                typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("options"), typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.QuestionToken), typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Omit"), [
+                    typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("UseQueryOptions"), [
+                        typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
+                            typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
+                                typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
+                            ]),
                         ]),
-                    ]),
-                    typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.UnknownKeyword),
-                    typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
-                        typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
-                            typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
+                        typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.UnknownKeyword),
+                        typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
+                            typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
+                                typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
+                            ]),
                         ]),
+                        typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)),
                     ]),
-                    typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)),
-                ]),
-                typescript_1["default"].factory.createUnionTypeNode([
-                    typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryKey")),
-                    typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryFn")),
-                    typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("initialData")),
-                ]),
-            ]), undefined),
-        ], false), undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createIdentifier("useQuery"), undefined, [
-            typescript_1["default"].factory.createArrayLiteralExpression([
-                typescript_1["default"].factory.createStringLiteral("".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName))),
-                typescript_1["default"].factory.createSpreadElement(typescript_1["default"].factory.createIdentifier("queryKey"))
-            ], false),
-            typescript_1["default"].factory.createArrowFunction(undefined, undefined, [], undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createPropertyAccessExpression(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined, method.parameters.map(function (param) {
-                return typescript_1["default"].factory.createIdentifier(param.name.getText(node));
-            }))),
-            typescript_1["default"].factory.createIdentifier("options"),
-        ]))),
-    ], typescript_1["default"].NodeFlags.Const));
+                    typescript_1["default"].factory.createUnionTypeNode([
+                        typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryKey")),
+                        typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryFn")),
+                        typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("initialData")),
+                    ]),
+                ]), undefined),
+            ], false), undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createIdentifier("useQuery"), undefined, [
+                typescript_1["default"].factory.createArrayLiteralExpression([
+                    typescript_1["default"].factory.createIdentifier(queryKey),
+                    typescript_1["default"].factory.createSpreadElement(typescript_1["default"].factory.createIdentifier("queryKey"))
+                ], false),
+                typescript_1["default"].factory.createArrowFunction(undefined, undefined, [], undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createPropertyAccessExpression(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined, method.parameters.map(function (param) {
+                    return typescript_1["default"].factory.createIdentifier(param.name.getText(node));
+                }))),
+                typescript_1["default"].factory.createIdentifier("options"),
+            ]))),
+        ], typescript_1["default"].NodeFlags.Const))
+    ];
 };
 exports.createUseQuery = createUseQuery;

package.json

 {
   "name": "@7nohe/openapi-react-query-codegen",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "OpenAPI React Query Codegen",
@@ -10,3 +10,3 @@ "bin": {
     "type": "git",
-    "url": "https://github.com/7nohe/openapi-react-query-codegen.git"
+    "url": "git+https://github.com/7nohe/openapi-react-query-codegen.git"
   },
@@ -13,0 +13,0 @@ "homepage": "https://github.com/7nohe/openapi-react-query-codegen",

README.md

@@ -8,2 +8,3 @@ # OpenAPI React Query Codegen
 - Supports generation of custom react hooks that use React Query's `useQuery` and `useMutation` hooks
+- Supports generation of query keys for query caching
 - Supports the option to use pure TypeScript clients generated by [OpenAPI Typescript Codegen](https://github.com/ferdikoomen/openapi-typescript-codegen)
@@ -85,4 +86,9 @@
 import { PetService } from '../openapi/requests/services/PetService';
+import {
+  usePetServiceFindPetsByStatusKey,
+} from "../openapi/queries";
+
 function App() {
-  const { data } = useQuery(['MyKey'], () => {
+  // You can still use the auto-generated query key
+  const { data } = useQuery([usePetServiceFindPetsByStatusKey], () => {
     // Do something here
@@ -89,0 +95,0 @@

No alert changes

Improved metrics

Lines of code

457

1.56%

Number of lines in readme file

109

5.83%

Worsened metrics

Total package byte prevSize

34146

-3.16%

Number of package files

13

-18.75%

No dependency changes