@toktokhan-dev/cli-plugin-gen-api-react-query 0.0.16 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toktokhan-dev/cli-plugin-gen-api-react-query",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "A CLI plugin for generating API hooks with React Query built by TOKTOKHAN.DEV",
   "author": "TOKTOKHAN.DEV <fe-system@toktokhan.dev>",
   "license": "ISC",
@@ -38,8 +38,8 @@
     "lodash": "^4.17.21",
     "prettier-plugin-organize-imports": "^3.2.4",
     "swagger-typescript-api": "^13.0.3",
-    "@toktokhan-dev/cli": "0.0.10",
-    "@toktokhan-dev/node": "0.0.9"
+    "@toktokhan-dev/cli": "0.0.11",
+    "@toktokhan-dev/node": "0.0.10"
   },
   "devDependencies": {
     "@types/lodash": "^4.17.0",

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

@@ -1,70 +1,173 @@
 <%
-const { myConfig } = it;
-const errorType = myConfig.httpClientType === 'axios' ? 'AxiosError<any>' : 'any';
-%>
-import { AxiosError } from 'axios';
-
-import {
-  UseInfiniteQueryOptions,
-  UseMutationOptions,
-  UseQueryOptions,
-} from '@tanstack/react-query';
-
-
-/**
- * !DO NOT EDIT THIS FILE
- *
- * 스크립트가 실행될때, 파일을 항상 새로 쓰기 때문에 파일 수정시 작성내용이 제거 될 수 있습니다.
+  const { utils, route, config, myConfig, dataFromApiTemplate } = it;
+  const { query } = route.request;
+  const { errorType } = route.response;
+  const { getConfigByRoute,paginationTargetKeywords } = dataFromApiTemplate;
+
+
+  const { 
+    conditions:{
+      hasPagination,
+      isQuery,
+      isMutation,
+      isOptionalVariables,
+    },
+    data: {
+      rawWrapperArgs,
+      wrapperArgs,
+      queryKeyName,
+      functionName,
+      apiInstanceName,
+      apiClassName,
+      hookVariant,
+      key,
+      methodKey,
+      pagination
+    },
+    utils: {
+      upperSnakeCase,
+      removeModuleName,
+      argToTmpl,
+    }
+  } = getConfigByRoute(route);
+
+  const { _, classNameCase } = utils;
+
+  const conditionalParamsText = isOptionalVariables ? "params?" : "params"
+  const conditionCallWithVariabels = isQuery ? `(${conditionalParamsText}.variables)` : "";
+  const conditionParamQueryKey = isQuery ? `,${conditionalParamsText}.variables` : "";
+  const conditionWrapFunc =  isQuery ? "() =>" : "";
+  const conditionalQueryKeyParams =  isQuery ? `${conditionalParamsText}.variables` : "";
+  const conditionalFn =  isQuery ? "queryFn" : "mutationFn";
+
+  const routeDocs = includeFile("@base/route-docs", { config, route, utils });
+  const lowerhookVariant =  _.lowerCase(hookVariant)
+  const hookKeyName = `${lowerhookVariant}Key`;
+
+  const isAxiosInstance = myConfig.httpClientType === 'axios'
+  const fetchErrorType = `{ error: ${errorType} }`
+
+
+
+  const initialPageParam = () => {
+    if(typeof pagination.initialPageParam === "string") return pagination.initialPageParam;
+    if(typeof pagination.initialPageParam === "function") return pagination.initialPageParam({ apiInstanceName, functionName, pagination})
+  }
+
+  const getNextPage = () => {
+    if(typeof pagination.getNextPage === "string") return pagination.getNextPage;
+    if(typeof pagination.getNextPage === "function") return pagination.getNextPage({ apiInstanceName, functionName, pagination})
+  }
+
+  const getNextPageParam = () => {
+    if(typeof pagination.getNextPageParam === "string") return pagination.getNextPageParam;
+    if(typeof pagination.getNextPageParam === "function") return pagination.getNextPageParam({ apiInstanceName, functionName, pagination})
+  }
+
+
+ %>
+
+ /**
+ <%~ routeDocs.description %>
+
+ * <% /* Here you can add some other JSDoc tags */ %>
+
+<%~ routeDocs.lines %>
  */
 
- 
-
-export type QueryHookParams<
-  T extends CustomRequestFn,
-  Error = <%~ errorType %>,
-  TData = RequestFnReturn<T>,
-  OriginData = RequestFnReturn<T>,
-  Variables = Parameter<T>,
-> = {
-  options?: Omit<
-    UseQueryOptions<OriginData, Error, TData>,
-    'queryKey' | 'queryFn'
-  >;
-} & OptionalVariables<Variables>;
-
-export type InfiniteQueryHookParams<
-  T extends CustomRequestFn,
-  Error = <%~ errorType %>,
-  TData = RequestFnReturn<T>,
-  OriginData = RequestFnReturn<T>,
-  Variables = Parameter<T>,
-> = {
-  options?: Partial<
-    Omit<
-      UseInfiniteQueryOptions<OriginData, Error, TData, OriginData, any, any>,
-      'queryKey' | 'queryFn'
-    >
-  >;
-} & OptionalVariables<Variables>;
-
-export type MutationHookParams<
-  T extends CustomRequestFn,
-  Error = <%~ errorType %>,
-  Data = RequestFnReturn<T>,
-  Variables = Parameter<T>,
-> = {
-  options?: Omit<
-    UseMutationOptions<Data, Error, Variables>,
-    'mutationFn' | 'mutationKey'
-  >;
+<% if (isQuery) { %>
+  export const use<%~ classNameCase(functionName) %>Query = <
+   TData = RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
+  >(
+  <%~ conditionalParamsText %>: QueryHookParams<typeof <%= apiInstanceName %>.<%~ functionName %>,
+    <% if (isAxiosInstance) { %>
+    AxiosError<<%~ errorType %>>
+    <% } else { %>
+    <%~ fetchErrorType %>
+    <% } %>
+  , TData>,
+) => {
+  const <%~ hookKeyName %> = <%~ queryKeyName %>.<%~ methodKey %>(<%~ `${conditionalParamsText}.variables` %>);
+  return useQuery({
+    <%~ hookKeyName %>,
+    queryFn: () => <%= apiInstanceName %>.<%~ functionName %>(<%~ `${conditionalParamsText}.variables` %>),
+    ...params?.options,
+  });
+};
+<% } else { %>
+  export const use<%~ classNameCase(functionName) %>Mutation = (
+  <%~ conditionalParamsText %>: MutationHookParams<typeof <%= apiInstanceName %>.<%~ functionName %>,
+    <% if (isAxiosInstance) { %>
+    AxiosError<<%~ errorType %>>
+    <% } else { %>
+    <%~ fetchErrorType %>
+    <% } %>
+  >,
+) => {
+  const <%~ hookKeyName %> = <%~ queryKeyName %>.<%~ methodKey %>();
+  return useMutation({
+    <%~ hookKeyName %>,
+    mutationFn: <%= apiInstanceName %>.<%~ functionName %>,
+    ...params?.options,
+  });
 };
+<% } %>
+
 
-export type OptionalVariables<T> = undefined extends T
-  ? { variables?: T }
-  : { variables: T };
+<% if (isQuery && hasPagination) { %>
 
-export type Parameter<T> = T extends (param: infer U) => any ? U : never;
+ /**
+ <%~ routeDocs.description %>
 
-export type CustomRequestFn = (variables?: any) => Promise<any>;
+ * <% /* Here you can add some other JSDoc tags */ %>
+
+<%~ routeDocs.lines %>
+
+ */
+export const use<%~ classNameCase(functionName) %>InfiniteQuery = <
+   TData = InfiniteData<
+       RequestFnReturn<typeof <%= apiInstanceName %>.<%~ functionName %>>,
+       Parameter<typeof <%= apiInstanceName %>.<%~ functionName %>>
+  >,
+>(
+  <%~ conditionalParamsText %>: InfiniteQueryHookParams<typeof <%= apiInstanceName %>.<%~ functionName %>,
+  <% if (isAxiosInstance) { %>
+  AxiosError<<%~ errorType %>>
+    <% } else { %>
+  <%~ errorType %>
+  <% } %>
+, TData>,
+) => {
+  const <%~ hookKeyName %> =  <%~ queryKeyName %>.<%~ methodKey %>_INFINITE(<%~ conditionalQueryKeyParams %>);
+
+  return useInfiniteQuery({
+    <%~ hookKeyName %>,
+    initialPageParam:  <% if (initialPageParam()) { %>
+      <%~ initialPageParam() %> 
+      <% } else { %>
+         null
+      <% } %>,
+    queryFn: <% if (getNextPage()) { %>
+      <%~ getNextPage() %> 
+      <% } else { %>
+        ({ pageParam }) => {
+          return <%= apiInstanceName %>.<%~ functionName %>({
+            ...params?.variables,
+            query: { ...params?.variables?.query, <%~ pagination.nextKey %>: pageParam, }
+          });
+        }
+      <% } %>,
+      getNextPageParam: 
+      <% if (getNextPageParam()) { %>
+        <%~ getNextPageParam() %> 
+        <% } else { %>
+          (lastPage) => {
+            const <%~ pagination.nextKey %> = lastPage.cursor ?? null;
+            return <%~ pagination.nextKey %>;
+          }
+        <% } %>,
+      ...params?.options,
+  });
+};
 
-export type RequestFnReturn<T extends CustomRequestFn> = Awaited<ReturnType<T>>;
+<% } %>