@toktokhan-dev/cli-plugin-gen-api-react-query 0.0.7 → 0.0.9

package/dist/index.js

@@ -1,9 +1,10 @@
 import { defineCommand } from '@toktokhan-dev/cli';
-import { createPackageRoot, prettierString, prettierFile, withLoading, cwd } from '@toktokhan-dev/node';
+import { createPackageRoot, prettierString, withLoading, cwd } from '@toktokhan-dev/node';
 import path from 'path';
 import { generateApi } from 'swagger-typescript-api';
 import fs from 'fs';
 import camelCase from 'lodash/camelCase.js';
+import upperFirst from 'lodash/upperFirst.js';
 
 
 // -- Shims --
@@ -22,7 +23,7 @@ const GENERATE_SWAGGER_DATA = {
     TYPE_FILE: ['react-query-type.ts', 'data-contracts.ts', 'util-types.ts'],
     UTIL_FILE: ['param-serializer-by.ts'],
     QUERY_HOOK_INDICATOR: '@indicator-for-query-hook',
-    AXIOS_DEFAULT_INSTANCE_PATH: '@apis/_axios/instance',
+    AXIOS_DEFAULT_INSTANCE_PATH: '@/configs/axios/instance',
     FETCH_DEFAULT_INSTANCE_PATH: '@/configs/fetch/fetch-extend',
 };
 
@@ -109,11 +110,15 @@ const writeSwaggerApiFile = (params) => {
     });
 };
 async function genreatePretty(path, contents) {
-    generate(path, await prettierString(contents, {
+    const organized = await prettierString(contents, {
         parser: 'babel-ts',
         plugins: ['prettier-plugin-organize-imports'],
-    }));
-    await prettierFile(path, { parser: 'typescript' });
+    });
+    const formatted = await prettierString(organized, {
+        parser: 'typescript',
+        configPath: 'auto',
+    });
+    generate(path, formatted);
 }
 function generate(path, contents) {
     fs.writeFileSync(path, contents);
@@ -123,7 +128,7 @@ function spilitHookContents(filename, content) {
     const lastImport = getLastImportLine(content);
     const lines = content.split('\n');
     const importArea = [
-        `import { ${camelCase(filename)}Api } from './${filename}.api';`,
+        `import { ${upperFirst(camelCase(filename))}Api } from './${filename}.api';`,
         ...lines.slice(0, lastImport),
     ].join('\n');
     return {
@@ -152,7 +157,7 @@ const genApi = defineCommand({
         includeReactQuery: true,
         includeReactInfiniteQuery: true,
         httpClientType: 'axios',
-        instancePath: '@apis/_axios/instance',
+        instancePath: GENERATE_SWAGGER_DATA.AXIOS_DEFAULT_INSTANCE_PATH,
         paginations: [
             {
                 keywords: ['cursor'],
@@ -161,7 +166,6 @@ const genApi = defineCommand({
         ],
     },
     run: async (config) => {
-        console.log(config);
         const isWebUrl = (string) => string.startsWith('http://') || string.startsWith('https://');
         const coverPath = (config) => {
             const { httpClientType, swaggerSchemaUrl, output } = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toktokhan-dev/cli-plugin-gen-api-react-query",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -27,8 +27,8 @@
     "lodash": "^4.17.21",
     "prettier-plugin-organize-imports": "^3.2.4",
     "swagger-typescript-api": "^13.0.3",
-    "@toktokhan-dev/cli": "0.0.5",
-    "@toktokhan-dev/node": "0.0.4"
+    "@toktokhan-dev/cli": "0.0.6",
+    "@toktokhan-dev/node": "0.0.5"
   },
   "scripts": {
     "build": "rollup -c",

package/templates/custom-axios/api.eta

@@ -14,7 +14,7 @@ const reactQuerKeyTemplatePath = `${myTemeplatePath}/react-query-key.eta`
 
 const apiClassName = classNameCase(route.moduleName) + 'Api';
 const paginations = myConfig?.paginations
-const instancePath = myConfig?.instancePath || "@apis/_axios/instance.ts"
+const instancePath = myConfig?.instancePath
 
 const apiInstanceName =route.moduleName + "Api";
 const queryKeyName = "QUERY_KEY_" + _.upperCase(apiClassName).replace(/ /g, '_');
@@ -143,6 +143,14 @@ import { DeepOmitReadOnly } from '../@types/util-types';
   import { <%~ dataContracts.join(", ") %> } from "../@types/<%~ config.fileNames.dataContracts %>"
 <% } %>
 
+/**
+ * !DO NOT EDIT THIS FILE
+ * 
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
+
 export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
 <% if(config.singleHttpClient) { %>
   http: HttpClient<SecurityDataType>;
@@ -158,14 +166,22 @@ export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singl
 }
 
 
-export const <%= apiInstanceName %> = new <%= apiClassName %>({ instance })
 
 <% if(myConfig.includeReactQuery) { %>
   //<%~ myConfig.QUERY_HOOK_INDICATOR %>
 
-  /**
-   * QUERY_KEYS
-   */
+/**
+ * !DO NOT EDIT THIS FILE
+ * 
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
+/**
+ * tok-cli.config.ts 에서 설정된 instance 경로의 axios instace 가 적용된, api 의 instance 입니다.
+ */
+export const <%= apiInstanceName %> = new <%= apiClassName %>({ instance:instance })
+
    <%~ includeFile(reactQuerKeyTemplatePath, { ...it, route , dataFromApiTemplate:dataForReactHookTemplate}) %>
   
    <% routes.forEach((route) => { %>

package/templates/custom-axios/data-contracts.eta

@@ -62,6 +62,13 @@
     ]);
   }
 %>
+
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
 <% modelTypes.forEach((contract) => { %>
 <% const description = createDescription(contract); %>
 <% if (description.length) { %>

package/templates/custom-axios/http-client.eta

@@ -4,6 +4,14 @@ const { apiConfig, generateResponses, config } = it;
 
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType, HeadersDefaults } from "axios";
 
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
+
 export type QueryParamsType = Record<string | number, any>;
 
 export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {

package/templates/custom-fetch/api.eta

@@ -134,6 +134,15 @@ import { DeepOmitReadOnly } from '../@types/util-types';
 import { <%~ dataContracts.join(", ") %> } from "../@types/<%~ config.fileNames.dataContracts %>";
 <% } %>
 
+
+/**
+ * !DO NOT EDIT THIS FILE
+ * 
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
+
 export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
 <% if (config.singleHttpClient) { %>
   http: HttpClient<SecurityDataType>;
@@ -148,14 +157,22 @@ export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singl
   <% }) %>
 }
 
-export const <%= apiInstanceName %> = new <%= apiClassName %>({ customFetch: fetchExtended });
 
 <% if (myConfig.includeReactQuery) { %>
   //<%~ myConfig.QUERY_HOOK_INDICATOR %>
 
-  /**
-   * QUERY_KEYS
-   */
+
+/**
+ * !DO NOT EDIT THIS FILE
+ * 
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
+/**
+ * tok-cli.config.ts 에서 설정된 instance 경로의 fetch instance 가 적용된, api 의 instance 입니다.
+ */
+export const <%= apiInstanceName %> = new <%= apiClassName %>({ customFetch: fetchExtended });
   <%~ includeFile(reactQuerKeyTemplatePath, { ...it, route, dataFromApiTemplate: dataForReactHookTemplate }) %>
 
   <% routes.forEach((route) => { %>

package/templates/custom-fetch/data-contracts.eta

@@ -62,6 +62,15 @@
     ]);
   }
 %>
+
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+ 
+
 <% modelTypes.forEach((contract) => { %>
 <% const description = createDescription(contract); %>
 <% if (description.length) { %>

package/templates/custom-fetch/http-client.eta

@@ -2,6 +2,14 @@
 const { apiConfig, generateResponses, config } = it;
 %>
 
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+ 
+
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
 

package/templates/my/param-serializer-by.eta

@@ -1,3 +1,10 @@
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+
 export const paramsSerializerBy =
   (
     format?: Partial<

package/templates/my/react-query-hook.eta

@@ -75,10 +75,7 @@
 
 <% if (isQuery) { %>
   export const use<%~ classNameCase(functionName) %>Query = <
-      TData = InfiniteData<
-       RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
-       Parameter<typeof <%= apiInstanceName %>.<%~ functionName %>>
-  >,
+   TData = RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
   >(
   <%~ conditionalParamsText %>: QueryHookParams<typeof <%= apiInstanceName %>.<%~ functionName %>,
     <% if (isAxiosInstance) { %>
@@ -126,7 +123,10 @@
 
  */
 export const use<%~ classNameCase(functionName) %>InfiniteQuery = <
-  TData = RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
+   TData = InfiniteData<
+       RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
+       Parameter<typeof <%= apiInstanceName %>.<%~ functionName %>>
+  >,
 >(
   <%~ conditionalParamsText %>: InfiniteQueryHookParams<typeof <%= apiInstanceName %>.<%~ functionName %>,
   <% if (isAxiosInstance) { %>
@@ -160,10 +160,7 @@ export const use<%~ classNameCase(functionName) %>InfiniteQuery = <
         <%~ getNextPageParam() %> 
         <% } else { %>
           (lastPage) => {
-            const params = lastPage.next
-              ? new URL(lastPage.next).searchParams
-              : null;
-            const <%~ pagination.nextKey %> = params ? params.get('<%~ pagination.nextKey %>') : null;
+            const <%~ pagination.nextKey %> = lastPage.cursor ?? null;
             return <%~ pagination.nextKey %>;
           }
         <% } %>,

package/templates/my/react-query-key.eta

@@ -1,8 +1,17 @@
 <%
 const { utils, route, config, modelTypes,dataFromApiTemplate } = it;
 const routes = route.routes;
-const { getConfigByRoute ,queryKeyName } = dataFromApiTemplate;
+const { getConfigByRoute, queryKeyName } = dataFromApiTemplate;
 %>
+
+/**
+ * query key 에 undfined 를 포함시키지 않기 위한 함수입니다.
+ */
+const isDefined = (v: unknown) => typeof v !== "undefined"
+
+/**
+ * query-keys
+ */
 export const <%= queryKeyName %> = {
   <% routes.forEach((route) => { %>
     <% 
@@ -29,12 +38,13 @@ export const <%= queryKeyName %> = {
           argToTmpl,
         }
       } = getConfigByRoute(route);
-      const conditionalParam = isQuery ?  `(variables? : Parameter<typeof ${apiInstanceName}.${functionName}>)`: "()"
-      const conditionalHookKeyVariant = isQuery ? "variables" : ""
+      const queryKey = `(variables? : Parameter<typeof ${apiInstanceName}.${functionName}>) => ["${key}", variables].filter(isDefined)`
+      const mutationKey = `() => ["${key}"]`
+      const infiniteQueryKey = `(variables? : Parameter<typeof ${apiInstanceName}.${functionName}>) => ["${key}_INFINITE", variables].filter(isDefined)`
     %>
-    <%~ methodKey %>: <%~ conditionalParam %> => ["<%~ key %>", <%~ conditionalHookKeyVariant %>].filter(key => typeof key !== 'undefined'),
+    <%~ methodKey %>: <%~ isQuery ? queryKey : mutationKey  %>,
     <% if(hasPagination) { %>
-     <%~ methodKey %>_INFINITE : <%~ conditionalParam %> => ["<%~ key %>_INFINITE", <%~ conditionalHookKeyVariant %>].filter(key => typeof key !== 'undefined'),
+     <%~ methodKey %>_INFINITE : <%~ infiniteQueryKey %>,
     <% }%>
   <% }) %>
 }; 

package/templates/my/react-query-type.eta

@@ -10,6 +10,15 @@ import {
   UseQueryOptions,
 } from '@tanstack/react-query';
 
+
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+ 
+
 export type QueryHookParams<
   T extends CustomRequestFn,
   Error = <%~ errorType %>,

package/templates/my/util-types.eta

@@ -1,3 +1,12 @@
+/**
+ * !DO NOT EDIT THIS FILE
+ *
+ * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+ */
+
+ 
+
+
 export type DeepOmitReadOnly<T extends object | undefined> = Omit<
   {
     [P in keyof T]: NonNullable<T[P]> extends Array<infer I>