@povio/openapi-codegen-cli 0.6.5 → 0.7.0

package/package.json

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

package/src/assets/invalidateQueries.ts

@@ -0,0 +1,31 @@
+import { QueryClient } from "@tanstack/react-query";
+
+import { QueriesModule, QueriesModuleKeysAll } from "./queryModules";
+
+export interface InvalidateQueryOptions {
+  invalidateCurrentModule?: boolean;
+  invalidateModules?: QueriesModule[];
+  invalidateKeys?: readonly unknown[][];
+}
+
+export async function invalidateQueries(
+  queryClient: QueryClient,
+  currentModule: QueriesModule,
+  options: InvalidateQueryOptions = {},
+) {
+  const { invalidateCurrentModule, invalidateModules, invalidateKeys } = options;
+
+  if (invalidateCurrentModule && QueriesModuleKeysAll[currentModule]) {
+    await queryClient.invalidateQueries({ queryKey: QueriesModuleKeysAll[currentModule] });
+  }
+
+  if (invalidateModules) {
+    await Promise.all([
+      ...invalidateModules.map((module) => queryClient.invalidateQueries({ queryKey: QueriesModuleKeysAll[module] })),
+    ]);
+  }
+
+  if (invalidateKeys) {
+    await Promise.all([...invalidateKeys.map((queryKey) => queryClient.invalidateQueries({ queryKey }))]);
+  }
+}

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

@@ -20,9 +20,7 @@ export type AppMutationOptions<
   TFunction extends Function,
   TVariables = void,
   TData = Awaited<ReturnType<TFunction>>,
-> = Omit<UseMutationOptions<TData, Error, TVariables>, "mutationKey" | "mutationFn"> & {
-  enableInvalidateAll?: boolean;
-};
+> = Omit<UseMutationOptions<TData, Error, TVariables>, "mutationKey" | "mutationFn">;
 
 export type AppInfiniteQueryOptions<
   TFunction extends Function,

package/src/generators/templates/endpoints.hbs

@@ -1,5 +1,9 @@
 {{! App rest client import}}
 {{{genImport appRestClientImport}}}
+{{! Axios import }}
+{{#if hasAxiosImport}}
+{{{genImport axiosImport}}}
+{{/if}}
 {{! Zod import }}
 {{#if hasZodImport}}
 {{{genImport zodImport}}}
@@ -14,7 +18,7 @@ export namespace {{namespace}} {
 {{/if}}
 {{! Endpoints export }}
 {{#each endpoints as | endpoint |}}
-export const {{endpointName endpoint}} = ({{{genEndpointParams endpoint}}}) => { 
+export const {{endpointName endpoint}} = ({{{genEndpointParams endpoint}}}{{#if ../hasAxiosRequestConfig}}{{../axiosRequestConfigName}}?: {{../axiosRequestConfigType}}{{/if}}) => { 
     return {{../restClientName}}.{{endpoint.method}}( 
         {{! Response }}
         { resSchema: {{importedZodSchemaName endpoint.response}} }, 

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

@@ -1,5 +1,8 @@
 {
     {{! Query params}}
+    {{#if hasAxiosRequestConfig}}
+    ...{{axiosRequestConfigName}},
+    {{/if}}
     {{#if endpointConfig.params}}
     params: {
         {{#each endpointConfig.params as | param |}}

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

@@ -8,15 +8,14 @@
 {{/each}}{{/if}} * @param { AppInfiniteQueryOptions } options Infinite query options
  * @returns { UseInfiniteQueryResult<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
- */
- {{else}}
+ */{{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}}
  * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
 {{#if (endpointParams endpoint)}}{{#each (endpointParams endpoint) as | endpointParam |}} * @param { {{endpointParam.type}} } {{#if (isQuery ../endpoint)}}object{{else}}mutation{{/if}}.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param {{#if (isQuery endpoint)}}{ AppQueryOptions } options Query options{{else}}{ AppMutationOptions } options Mutation options{{/if}}
+{{/each}}{{/if}} * @param {{#if (isQuery endpoint)}}{ AppQueryOptions } options Query options{{else}}{ AppMutationOptions{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}} } 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

@@ -1,5 +1,5 @@
 export const keys = {
-    all: ["{{namespace}}"] as const,
+    all: [{{queriesModuleName}}] as const,
     {{#each queryEndpoints as | endpoint |}}
     {{endpointName endpoint}}: ({{{genEndpointParams endpoint}}}) => [...keys.all, "{{endpoint.path}}", {{{endpointArgs endpoint}}}] as const,
     {{#if ../generateInfiniteQueries}}

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

@@ -1,10 +1,10 @@
 {{! 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>) => {
+export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint "removePageParam"}}} }: { {{{genEndpointParams endpoint "removePageParam"}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{infiniteQueryHook}}({
     queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint "removePageParam"}}}{{/if}}),
-    queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint "replacePageParam"}}}),
+    queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint "replacePageParam"}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}}),
     initialPageParam: 1,
     getNextPageParam: ({ {{pageParamName}}, {{totalItemsName}}, {{limitParamName}}: limitParam }) => {
       const pageParam = {{pageParamName}} ?? 1;

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

@@ -1,17 +1,15 @@
 {{! Js docs }}
 {{{genQueryJsDocs endpoint}}}
 {{! Mutation definition}}
-export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint}}} }>) => {
-  {{#if queryEndpoints}} const queryClient = useQueryClient();{{/if}}
+export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint}}} }>{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+  {{#if hasInvalidateQueryOptions}} const queryClient = useQueryClient();{{/if}}
 
   return {{queryHook}}({
-    mutationFn: ({{#if (endpointParams endpoint)}} { {{{endpointArgs endpoint}}} } {{/if}}) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}),
-    ...options, {{#if queryEndpoints}}
+    mutationFn: ({{#if (endpointParams endpoint)}} { {{{endpointArgs endpoint}}} } {{/if}}) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}),
+    ...options, {{#if hasInvalidateQueryOptions}}
     onSuccess: (...args) => {
       {{! Invalidation }}
-      if (options?.enableInvalidateAll) {
-        queryClient.invalidateQueries({ queryKey: keys.all });
-      }
+      invalidateQueries(queryClient, {{queriesModuleName}}, options);
       options?.onSuccess?.(...args);
     },{{/if}}
   });

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

@@ -1,10 +1,10 @@
 {{! Js docs }}
 {{{genQueryJsDocs endpoint}}}
 {{! Query definition}}
-export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint}}} }: { {{{genEndpointParams endpoint}}} }, {{/if}}options?: AppQueryOptions<typeof {{importedEndpointName endpoint}}, TData>) => {
+export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint}}} }: { {{{genEndpointParams endpoint}}} }, {{/if}}options?: AppQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{queryHook}}({
     queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),
-    queryFn: {{#if (endpointParams endpoint)}}() => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}){{else}}{{importedEndpointName endpoint}}{{/if}},
+    queryFn: {{#if hasEndpointArgs}}() => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/if}},
     ...options,
   });
 };

package/src/generators/templates/queries.hbs

@@ -1,5 +1,13 @@
+{{! Axios import }}
+{{#if hasAxiosImport}}
+{{{genImport axiosImport}}}
+{{/if}}
 {{! React query import }}
 {{{genImport queryImport}}}
+{{! Invalidate queries import }}
+{{#if hasInvalidateQueriesImport}}
+{{{genImport invalidateQueriesImport}}}
+{{/if}}
 {{! React query types import }}
 {{{genImport queryTypesImport}}}
 {{! Models import }}
@@ -14,16 +22,19 @@
 {{#if includeNamespace}}
 export namespace {{namespace}} {
 {{/if}}
+
+export const {{queriesModuleName}} = "{{namespace}}";
+
 {{! Query keys export}}
-{{{genQueryKeys queryEndpoints namespace}}}
+{{{genQueryKeys queryEndpoints}}}
 
 {{! Query export }}
 {{#each endpoints as | endpoint |}}
-{{{genQuery endpoint ../queryEndpoints}}}
+{{{genQuery endpoint}}}
 
 {{#if ../generateInfiniteQueries}}
 {{#if (isInfiniteQuery endpoint)}}
-{{{genInfiniteQuery endpoint ../queryEndpoints}}}
+{{{genInfiniteQuery endpoint}}}
 {{/if}}
 {{/if}}
 

package/src/generators/templates/query-modules.hbs

@@ -0,0 +1,14 @@
+{{! Module name and keys imports }}
+{{#each imports as | import |}}
+{{{genImport import}}}
+{{/each}}
+
+{{! Queries module name and keys object }}
+export const QueriesModuleKeysAll = {
+    {{#if includeNamespace}}{{#each modules as | module |}} [{{module.namespace}}.{{../queriesModuleName}}]: {{#if module.hasKeys}}{{module.namespace}}.keys.all{{else}}undefined{{/if}}, {{/each}}
+    {{else}}{{#each modules as | module |}} [{{tagModuleName module.tag}}]:{{#if module.hasKeys}}{{tagKeys module.tag}}.all{{else}}undefined{{/if}}, {{/each}}{{/if}}
+} as const;
+
+export type QueriesModule = keyof typeof QueriesModuleKeysAll;
+
+