@povio/openapi-codegen-cli 0.5.8 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.5.8",
+  "version": "0.6.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"

package/src/assets/react-query.types.ts

@@ -1,4 +1,10 @@
-import { UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+import {
+  InfiniteData,
+  QueryKey,
+  UseInfiniteQueryOptions,
+  UseMutationOptions,
+  UseQueryOptions,
+} from "@tanstack/react-query";
 
 type Function = (...args: any) => any;
 type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
@@ -18,7 +24,19 @@ export type AppMutationOptions<
   enableInvalidateAll?: boolean;
 };
 
-export type AppInfiniteQueryOptions<TFunction extends Function, TData = Awaited<ReturnType<TFunction>>> = Omit<
-  UseInfiniteQueryOptions<Awaited<ReturnType<TFunction>>, Error, IsUnknown<TData, Awaited<ReturnType<TFunction>>>>,
+export type AppInfiniteQueryOptions<
+  TFunction extends Function,
+  TData = InfiniteData<Awaited<ReturnType<TFunction>>>,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = number,
+> = Omit<
+  UseInfiniteQueryOptions<
+    Awaited<ReturnType<TFunction>>,
+    Error,
+    IsUnknown<TData, InfiniteData<Awaited<ReturnType<TFunction>>>>,
+    Awaited<ReturnType<TFunction>>,
+    TQueryKey,
+    TPageParam
+  >,
   "queryKey" | "queryFn" | "initialPageParam" | "getNextPageParam"
 >;

package/src/generators/templates/partials/endpoint-params.hbs

@@ -1 +1 @@
-{{#each (endpointParams endpoint) as | endpointParam |}}{{endpointParam.name}}{{#unless endpointParam.required}}?{{/unless}}: {{endpointParam.type}}, {{/each}}
+{{#each (endpointParams endpoint extra) as | endpointParam |}}{{endpointParam.name}}{{#unless endpointParam.required}}?{{/unless}}: {{endpointParam.type}}, {{/each}}

package/src/generators/templates/partials/query-js-docs.hbs

@@ -1,4 +1,16 @@
+{{#if infiniteQuery}}
 /** 
+ * Infinite query `{{infiniteQueryName endpoint}}{{#if endpoint.summary}}
+ * @summary {{addAsteriskAfterNewLine endpoint.summary}}{{/if}}{{#if endpoint.description}} 
+ * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
+ * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
+{{#if (endpointParams endpoint)}}{{#each (endpointParams endpoint infiniteQuery "removePageParam") as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
+{{/each}}{{/if}} * @param { AppInfiniteQueryOptions } options Infinite query options
+ * @returns { UseInfiniteQueryResult<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
+ * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
+ */
+ {{else}}
+ /** 
  * {{#if (isQuery endpoint)}}Query{{else}}Mutation{{/if}} `{{queryName endpoint}}`{{#if endpoint.summary}}
  * @summary {{addAsteriskAfterNewLine endpoint.summary}}{{/if}}{{#if endpoint.description}} 
  * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
@@ -7,4 +19,4 @@
 {{/each}}{{/if}} * @param {{#if (isQuery endpoint)}}{ AppQueryOptions } options Query options{{else}}{ AppMutationOptions } options Mutation options{{/if}}
  * @returns { {{#if (isQuery endpoint)}}UseQueryResult{{else}}UseMutationResult{{/if}}<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
- */
+ */{{/if}}

package/src/generators/templates/partials/query-keys.hbs

@@ -2,5 +2,10 @@ export const keys = {
     all: ["{{namespace}}"] as const,
     {{#each queryEndpoints as | endpoint |}}
     {{endpointName endpoint}}: ({{{genEndpointParams endpoint}}}) => [...keys.all, "{{endpoint.path}}", {{{endpointArgs endpoint}}}] as const,
+    {{#if ../generateInfiniteQueries}}
+    {{#if (isInfiniteQuery endpoint)}}
+    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint "removePageParam"}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint "removePageParam"}}}] as const,
+    {{/if}}
+    {{/if}}
     {{/each}}
 };

package/src/generators/templates/partials/query-use-infinite-query.hbs

@@ -0,0 +1,15 @@
+{{! Js docs }}
+{{{genQueryJsDocs endpoint "infiniteQuery" }}}
+{{! Infinite query definition}}
+export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint "removePageParam"}}} }: { {{{genEndpointParams endpoint "removePageParam"}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>) => {
+  return {{infiniteQueryHook}}({
+    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint "removePageParam"}}}{{/if}}),
+    queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint "replacePageParam"}}}),
+    initialPageParam: 1,
+    getNextPageParam: ({ {{pageParamName}}, {{totalItemsName}}, {{limitParamName}}: limitParam }) => {
+      const pageParam = {{pageParamName}} ?? 1;
+      return pageParam * limitParam < {{totalItemsName}} ? pageParam + 1 : null;
+    },
+    ...options,
+  });
+};

package/src/generators/templates/queries.hbs

@@ -21,6 +21,12 @@ export namespace {{namespace}} {
 {{#each endpoints as | endpoint |}}
 {{{genQuery endpoint ../queryEndpoints}}}
 
+{{#if ../generateInfiniteQueries}}
+{{#if (isInfiniteQuery endpoint)}}
+{{{genInfiniteQuery endpoint ../queryEndpoints}}}
+{{/if}}
+{{/if}}
+
 {{/each}}
 
 {{#if includeNamespace}}