Merge pull request #1 from 7nohe/feature/export-query-keys

feat: export query keys

Author: 7nohe

README.md

@@ -5,6 +5,7 @@
 ## Features
 
 - 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)
 
 ## Install
@@ -81,8 +82,13 @@ You can also use pure TS clients.
 ```tsx
 import { useQuery } from "@tanstack/react-query";
 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
 
     return PetService.findPetsByStatus(['available']);

src/createUseQuery.ts

@@ -39,13 +39,30 @@ export const createUseQuery = (
       ),
     );
   }
-  return ts.factory.createVariableStatement(
+
+  const customHookName = `use${className}${capitalizeFirstLetter(methodName)}`;
+  const queryKey = `${customHookName}Key`
+
+  return [
+    ts.factory.createVariableStatement(
+      [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+      ts.factory.createVariableDeclarationList(
+        [ts.factory.createVariableDeclaration(
+          ts.factory.createIdentifier(queryKey),
+          undefined,
+          undefined,
+          ts.factory.createStringLiteral(`${className}${capitalizeFirstLetter(methodName)}`)
+        )],
+        ts.NodeFlags.Const
+      )
+    ),
+    ts.factory.createVariableStatement(
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createVariableDeclarationList(
       [
         ts.factory.createVariableDeclaration(
           ts.factory.createIdentifier(
-            `use${className}${capitalizeFirstLetter(methodName)}`
+            customHookName
           ),
           undefined,
           undefined,
@@ -146,9 +163,7 @@ export const createUseQuery = (
               [
                 ts.factory.createArrayLiteralExpression(
                   [
-                    ts.factory.createStringLiteral(
-                      `${className}${capitalizeFirstLetter(methodName)}`
-                    ),
+                    ts.factory.createIdentifier(queryKey),
                     ts.factory.createSpreadElement(ts.factory.createIdentifier("queryKey"))
                   ],
                   false
@@ -178,5 +193,5 @@ export const createUseQuery = (
       ],
       ts.NodeFlags.Const
     )
-  );
+  )];
 };