reuse function to generate keys

7nohe · May 3, 2024 · 3588856 · 3588856
1 parent c5460df
commit 3588856
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 33 deletions.
diff --git a/src/createPrefetch.mts b/src/createPrefetch.mts
@@ -4,12 +4,15 @@ import {
   BuildCommonTypeName,
   extractPropertiesFromObjectParam,
   getNameFromMethod,
+  queryKeyConstraint,
+  queryKeyGenericType,
 } from "./common.mjs";
 import { type MethodDescription } from "./common.mjs";
 import {
   createQueryKeyFromMethod,
   getRequestParamFromMethod,
   hookNameFromMethod,
+  getQueryKeyFnName,
 } from "./createUseQuery.mjs";
 import { addJSDocToNode } from "./util.mjs";
 
@@ -42,7 +45,16 @@ function createPrefetchHook({
           undefined,
           ts.factory.createArrowFunction(
             undefined,
-            undefined,
+            ts.factory.createNodeArray([
+              ts.factory.createTypeParameterDeclaration(
+                undefined,
+                "TQueryKey",
+                queryKeyConstraint,
+                ts.factory.createArrayTypeNode(
+                  ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)
+                )
+              ),
+            ]),
             [
               ts.factory.createParameterDeclaration(
                 undefined,
@@ -54,6 +66,13 @@ function createPrefetchHook({
                 )
               ),
               ...requestParams,
+              ts.factory.createParameterDeclaration(
+                undefined,
+                undefined,
+                ts.factory.createIdentifier("queryKey"),
+                ts.factory.createToken(ts.SyntaxKind.QuestionToken),
+                queryKeyGenericType
+              ),
             ],
             undefined,
             ts.factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
@@ -64,28 +83,28 @@ function createPrefetchHook({
                 ts.factory.createObjectLiteralExpression([
                   ts.factory.createPropertyAssignment(
                     ts.factory.createIdentifier("queryKey"),
-                    ts.factory.createArrayLiteralExpression(
-                      [
-                        BuildCommonTypeName(queryKey),
-                        method.getParameters().length
-                          ? ts.factory.createArrayLiteralExpression([
-                              ts.factory.createObjectLiteralExpression(
-                                method
-                                  .getParameters()
-                                  .map((param) =>
-                                    extractPropertiesFromObjectParam(param).map(
-                                      (p) =>
-                                        ts.factory.createShorthandPropertyAssignment(
-                                          ts.factory.createIdentifier(p.name)
-                                        )
-                                    )
+                    ts.factory.createCallExpression(
+                      BuildCommonTypeName(getQueryKeyFnName(queryKey)),
+                      undefined,
+
+                      method.getParameters().length
+                        ? [
+                            ts.factory.createObjectLiteralExpression(
+                              method
+                                .getParameters()
+                                .map((param) =>
+                                  extractPropertiesFromObjectParam(param).map(
+                                    (p) =>
+                                      ts.factory.createShorthandPropertyAssignment(
+                                        ts.factory.createIdentifier(p.name)
+                                      )
                                   )
-                                  .flat()
-                              ),
-                            ])
-                          : ts.factory.createArrayLiteralExpression([]),
-                      ],
-                      false
+                                )
+                                .flat()
+                            ),
+                            ts.factory.createIdentifier("queryKey"),
+                          ]
+                        : []
                     )
                   ),
                   ts.factory.createPropertyAssignment(

diff --git a/src/createUseQuery.mts b/src/createUseQuery.mts
@@ -466,7 +466,7 @@ export const createUseQuery = ({
   };
 };
 
-function getQueryKeyFnName(queryKey: string) {
+export function getQueryKeyFnName(queryKey: string) {
   return `${capitalizeFirstLetter(queryKey)}Fn`;
 }
 

diff --git a/tests/__snapshots__/createSource.test.ts.snap b/tests/__snapshots__/createSource.test.ts.snap
@@ -180,17 +180,17 @@ import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
 * @returns Error unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceFindPets = (queryClient: QueryClient, { limit, tags }: {
+export const prefetchUseDefaultServiceFindPets = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, { limit, tags }: {
     limit?: number;
     tags?: string[];
-} = {}) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceFindPetsKey, [{ limit, tags }]], queryFn: () => DefaultService.findPets({ limit, tags }) });
+} = {}, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPetsKeyFn({ limit, tags }, queryKey), queryFn: () => DefaultService.findPets({ limit, tags }) });
 /**
 * @deprecated
 * This path is not fully defined.
 * @returns unknown unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceGetNotDefined = (queryClient: QueryClient) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceGetNotDefinedKey, []], queryFn: () => DefaultService.getNotDefined() });
+export const prefetchUseDefaultServiceGetNotDefined = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceGetNotDefinedKeyFn(), queryFn: () => DefaultService.getNotDefined() });
 /**
 * Returns a user based on a single ID, if the user does not have access to the pet
 * @param data The data for the request.
@@ -199,8 +199,8 @@ export const prefetchUseDefaultServiceGetNotDefined = (queryClient: QueryClient)
 * @returns Error unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceFindPetById = (queryClient: QueryClient, { id }: {
+export const prefetchUseDefaultServiceFindPetById = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, { id }: {
     id: number;
-}) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceFindPetByIdKey, [{ id }]], queryFn: () => DefaultService.findPetById({ id }) });
+}, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPetByIdKeyFn({ id }, queryKey), queryFn: () => DefaultService.findPetById({ id }) });
 "
 `;
diff --git a/tests/__snapshots__/generate.test.ts.snap b/tests/__snapshots__/generate.test.ts.snap
@@ -54,17 +54,17 @@ import * as Common from "./common";
 * @returns Error unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceFindPets = (queryClient: QueryClient, { limit, tags }: {
+export const prefetchUseDefaultServiceFindPets = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, { limit, tags }: {
   limit?: number;
   tags?: string[];
-} = {}) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceFindPetsKey, [{ limit, tags }]], queryFn: () => DefaultService.findPets({ limit, tags }) });
+} = {}, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPetsKeyFn({ limit, tags }, queryKey), queryFn: () => DefaultService.findPets({ limit, tags }) });
 /**
 * @deprecated
 * This path is not fully defined.
 * @returns unknown unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceGetNotDefined = (queryClient: QueryClient) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceGetNotDefinedKey, []], queryFn: () => DefaultService.getNotDefined() });
+export const prefetchUseDefaultServiceGetNotDefined = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceGetNotDefinedKeyFn(), queryFn: () => DefaultService.getNotDefined() });
 /**
 * Returns a user based on a single ID, if the user does not have access to the pet
 * @param data The data for the request.
@@ -73,9 +73,9 @@ export const prefetchUseDefaultServiceGetNotDefined = (queryClient: QueryClient)
 * @returns Error unexpected error
 * @throws ApiError
 */
-export const prefetchUseDefaultServiceFindPetById = (queryClient: QueryClient, { id }: {
+export const prefetchUseDefaultServiceFindPetById = <TQueryKey extends Array<unknown> = unknown[]>(queryClient: QueryClient, { id }: {
   id: number;
-}) => queryClient.prefetchQuery({ queryKey: [Common.useDefaultServiceFindPetByIdKey, [{ id }]], queryFn: () => DefaultService.findPetById({ id }) });
+}, queryKey?: TQueryKey) => queryClient.prefetchQuery({ queryKey: Common.UseDefaultServiceFindPetByIdKeyFn({ id }, queryKey), queryFn: () => DefaultService.findPetById({ id }) });
 "
 `;
-Original file line number
+Diff line change
@@ Expand Up / @@ -466,7 +466,7 @@ export const createUseQuery = ({ @@
       };
     };
-    function getQueryKeyFnName(queryKey: string) {
+    export function getQueryKeyFnName(queryKey: string) {
       return `${capitalizeFirstLetter(queryKey)}Fn`;
     }
@@ Expand Down @@