feat: react hooks support customHandler

tsdk-monorepo · Sep 29, 2024 · 198b3f9 · 198b3f9
1 parent 7dbad27
commit 198b3f9
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 37 deletions.
diff --git a/examples/server/package.json b/examples/server/package.json
@@ -28,7 +28,7 @@
     "reflect-metadata": "^0.2.1",
     "socket.io": "^4.8.0",
     "typeorm": "^0.3.20",
-    "kysely": "^0.27.2",
+    "kysely": "^0.27.4",
     "typeorm-cursor-pagination": "^0.10.1",
     "utf-8-validate": "^6.0.3",
     "ws": "^8.13.0",

diff --git a/examples/server/packages/fe-sdk-demo/package.json b/examples/server/packages/fe-sdk-demo/package.json
@@ -12,8 +12,8 @@
     "axios": "^1.7.7",
     "xior": "^0.6.1",
     "change-case": "^4.1.2",
-    "kysely": "^0.26.3",
-    "@tanstack/react-query": "^5.22.2",
+    "kysely": "^0.27.4",
+    "@tanstack/react-query": "^5.56.2",
     "i18next": "^23.10.1",
     "intl-pluralrules": "^2.0.1"
   },

diff --git a/examples/web/pages/xior/page.tsx b/examples/web/pages/xior/page.tsx
@@ -9,6 +9,7 @@ import {
 import { QueryTodoRes } from 'fe-sdk-demo/lib/apiconf-refs';
 import { TodoStatus } from 'fe-sdk-demo/lib/modules/todo/Todo.entity';
 import { AddTodo, QueryTodo } from 'fe-sdk-demo/lib/user-api';
+import { useQueryTodo } from 'fe-sdk-demo/lib/user-api-hooks';
 import Head from 'next/head';
 import { useState, useEffect } from 'react';
 // eslint-disable-next-line import/namespace
@@ -35,6 +36,7 @@ const apiURL = baseURL + `api/${apiType}`;
 export default function Home() {
   const [handlerName, setHanlderName] = useState('');
   const [result, setResult] = useState<QueryTodoRes>();
+  const { data } = useQueryTodo(handlerName ? {} : undefined);
 
   useEffect(() => {
     const io = SocketIO(socketURL, {
@@ -80,6 +82,7 @@ export default function Home() {
     };
   }, []);
 
+  console.log(data);
   return (
     <div className={styles.container}>
       <Head>

diff --git a/packages/tsdk/fe-sdk-template/src/gen-api.ts b/packages/tsdk/fe-sdk-template/src/gen-api.ts
@@ -13,6 +13,8 @@ let handler = (
   return Promise.reject(new NoHandlerError(`Call \`setHandler\` first`));
 };
 
+export type Handler = typeof handler;
+
 /**
  * @example
  * ```ts

diff --git a/packages/tsdk/src/sync-api.ts b/packages/tsdk/src/sync-api.ts
@@ -59,6 +59,7 @@ export async function syncAPI() {
     }
     `
     }
+    import { Handler } from './gen-api';
     `;
     let dataHookImportStr = ``;
     let dataHookBodyStr = isReactQuery
@@ -173,15 +174,16 @@ export async function syncAPI() {
  * @category ${category}
  */
 export function use${name}(
-payload: ${name}Req | undefined,
+payload?: ${name}Req,
 options?: SWRConfiguration<${name}Res | undefined>,
-requestConfig?: AxiosRequestConfig<${name}Req>
+requestConfig?: AxiosRequestConfig<${name}Req>,
+customHandler?: Handler,
 ) {
 return useSWR(
   () => ({ url: ${name}.config.path, arg: payload }),
   ({ arg }) => {
     if (typeof arg === 'undefined') return undefined;
-    return ${name}(arg, requestConfig);
+    return ${name}(arg, requestConfig, customHandler);
   },
   options
 );
@@ -201,11 +203,12 @@ return useSWR(
                 ${name}Req
               >,
               requestConfig?: AxiosRequestConfig<${name}Req>,
+              customHandler?: Handler,
             ) {
               return useSWRMutation(
                 ${name}.config.path,
                 (url, { arg }: { arg: ${name}Req }) => {
-                  return ${name}(arg, requestConfig);
+                  return ${name}(arg, requestConfig, customHandler);
                 },
                 options
               );
@@ -224,10 +227,11 @@ return useSWR(
            * @category ${category}
            */
           export function use${name}(
-            payload: ${name}Req | undefined,
+            payload?: ${name}Req,
             options?: UndefinedInitialDataOptions<${name}Res | undefined, Error>,
             queryClient?: QueryClient,
             requestConfig?: AxiosRequestConfig<${name}Req>,
+            customHandler?: Handler,
           ) {
             return useQuery(
               {
@@ -237,7 +241,7 @@ return useSWR(
                   if (typeof payload === 'undefined') {
                     return undefined;
                   }
-                  return ${name}(payload, requestConfig);
+                  return ${name}(payload, requestConfig, customHandler);
                 },
               },
               queryClient || _queryClient
@@ -258,12 +262,13 @@ return useSWR(
                 >,
                 queryClient?: QueryClient,
                 requestConfig?: AxiosRequestConfig<${name}Req>,
+                customHandler?: Handler,
               ) {
                 return useMutation(
                   {
                     ...(options || {}),
                     mutationFn(payload) {
-                      return ${name}(payload, requestConfig);
+                      return ${name}(payload, requestConfig, customHandler);
                     },
                   },
                   queryClient || _queryClient

diff --git a/packages/tsdk/src/sync-files.ts b/packages/tsdk/src/sync-files.ts
@@ -98,13 +98,13 @@ async function reconfigPkg() {
       : [config.entityLibName || 'typeorm']
     )?.find((item) => item === 'kysely')
   ) {
-    pkgContent.dependencies.kysely = '^0.26.3';
+    pkgContent.dependencies.kysely = '^0.27.4';
   }
   const dataHookLib = config.dataHookLib?.toLowerCase();
   if (dataHookLib === 'swr') {
     pkgContent.dependencies.swr = '^2.2.5';
   } else if (dataHookLib === 'reactquery') {
-    pkgContent.dependencies['@tanstack/react-query'] = '^5.22.2';
+    pkgContent.dependencies['@tanstack/react-query'] = '^5.56.2';
   }
 
   if (config.dependencies) {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/pages/docs/quick-start/react-query.en-US.mdx b/website/pages/docs/quick-start/react-query.en-US.mdx
@@ -26,7 +26,7 @@ Add `@tanstack/react-query` to **next-app/package.json**:
   },
   "dependencies": {
     ...
-    "@tanstack/react-query": "^5.8.4"
+    "@tanstack/react-query": "^5.56.2"
   },
   ...
 }

diff --git a/website/pages/docs/quick-start/react-query.zh-CN.mdx b/website/pages/docs/quick-start/react-query.zh-CN.mdx
@@ -26,7 +26,7 @@ import { Callout } from 'nextra/components';
   },
   "dependencies": {
     ...
-    "@tanstack/react-query": "^5.8.4"
+    "@tanstack/react-query": "^5.56.2"
   },
   ...
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,8 @@ let handler = ( @@
       return Promise.reject(new NoHandlerError(`Call \`setHandler\` first`));
     };
+    export type Handler = typeof handler;
     /**
      * @example
      * ```ts
@@ Expand Down @@