@povio/openapi-codegen-cli 0.8.1 → 0.8.3

package/package.json

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

package/src/generators/templates/invalidate-queries.hbs

@@ -0,0 +1,34 @@
+import { QueryClient, QueryKey } from "@tanstack/react-query";
+
+export const enum QueryModule {
+   {{#each modules as | module |}}
+   {{module.tag}} = "{{module.namespace}}",
+   {{/each}}
+}
+
+export interface InvalidateQueryOptions {
+  invalidateCurrentModule?: boolean;
+  invalidateModules?: QueryModule[];
+  invalidateKeys?: QueryKey[];
+}
+
+export async function invalidateQueries(
+  queryClient: QueryClient,
+  currentModule: QueryModule,
+  options: InvalidateQueryOptions = {},
+) {
+  const { invalidateCurrentModule, invalidateModules, invalidateKeys } = options;
+
+  if (invalidateCurrentModule) {
+    await queryClient.invalidateQueries({ queryKey: [currentModule] });
+  }
+
+  if (invalidateModules) {
+    await Promise.all([...invalidateModules.map((module) => queryClient.invalidateQueries({ queryKey: [module] }))]);
+  }
+
+  if (invalidateKeys) {
+    await Promise.all([...invalidateKeys.map((queryKey) => queryClient.invalidateQueries({ queryKey }))]);
+  }
+}
+

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

@@ -10,22 +10,22 @@
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{else if query}}
  /** 
- * Query `{{queryName endpoint}}`{{#if endpoint.summary}}{{#if endpoint.fileDownload}} - recommended when file should be cached{{/if}}
+ * Query `{{queryName endpoint}}`{{#if endpoint.summary}}{{#if endpoint.mediaDownload}} - recommended when file should be cached{{/if}}
  * @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 includeFileParam=true)}}{{#each (endpointParams endpoint includeFileParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/each}}{{/if}} * @param { AppQueryOptions } options Query options
- * @returns { UseQueryResult<{{#if endpoint.fileDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.fileDownload}}>{{/if}}> } {{endpoint.responseDescription}}
+ * @returns { UseQueryResult<{{#if endpoint.mediaDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.mediaDownload}}>{{/if}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{else if mutation}}
  /** 
- * Mutation `{{queryName endpoint mutation=true}}`{{#if endpoint.summary}}{{#if endpoint.fileDownload}} - recommended when file should not be cached{{/if}}
+ * Mutation `{{queryName endpoint mutation=true}}`{{#if endpoint.summary}}{{#if endpoint.mediaDownload}} - recommended when file should not be cached{{/if}}
  * @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 includeFileParam=true)}}{{#each (endpointParams endpoint includeFileParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } mutation.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/each}}{{/if}} * @param { AppMutationOptions{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}} } options Mutation options
- * @returns { UseMutationResult<{{#if endpoint.fileDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.fileDownload}}>{{/if}}> } {{endpoint.responseDescription}}
+ * @returns { UseMutationResult<{{#if endpoint.mediaDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.mediaDownload}}>{{/if}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{/if}}

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

@@ -5,8 +5,8 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
   {{#if hasInvalidateQueryOptions}} const queryClient = useQueryClient();{{/if}}
 
   return {{queryHook}}({
-    mutationFn: {{#if endpoint.fileUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if endpoint.fileUpload}} {
-      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if endpoint.fileUpload}}; 
+    mutationFn: {{#if endpoint.mediaUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if endpoint.mediaUpload}} {
+      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if endpoint.mediaUpload}}; 
       
       if (file && uploadInstructions.url) {
         await axios.put(uploadInstructions.url, file, {

package/src/generators/templates/queries.hbs

@@ -5,7 +5,7 @@
 {{! React query import }}
 {{{genImport queryImport}}}
 {{! Invalidate queries import }}
-{{#if hasInvalidateQueriesImport}}
+{{#if hasInvalidateQueryOptions}}
 {{{genImport invalidateQueriesImport}}}
 {{/if}}
 {{! React query types import }}
@@ -23,7 +23,7 @@
 export namespace {{namespace}} {
 {{/if}}
 
-export const {{queriesModuleName}} = "{{namespace}}";
+export const {{queriesModuleName}} = {{#if hasInvalidateQueryOptions}}{{queryModuleEnum}}.{{tag}}{{else}}"{{namespace}}"{{/if}};
 
 {{! Query keys export}}
 {{{genQueryKeys queryEndpoints}}}

package/dist/generators/generate/generateQueryModules.d.ts

@@ -1,2 +0,0 @@
-import { GenerateTypeParams } from "../types/generate";
-export declare function generateQueryModules({ resolver, data }: Omit<GenerateTypeParams, "tag">): string;

package/src/assets/invalidateQueries.ts

@@ -1,31 +0,0 @@
-import { QueryClient } from "@tanstack/react-query";
-
-import { QueriesModuleType, QueriesModuleKeysAll } from "./queryModules";
-
-export interface InvalidateQueryOptions {
-  invalidateCurrentModule?: boolean;
-  invalidateModules?: QueriesModuleType[];
-  invalidateKeys?: readonly unknown[][];
-}
-
-export async function invalidateQueries(
-  queryClient: QueryClient,
-  currentModule: QueriesModuleType,
-  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/generators/templates/query-modules.hbs

@@ -1,18 +0,0 @@
-{{! 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 QueriesModuleType = keyof typeof QueriesModuleKeysAll;
-
-{{! Queries modules record }}
-export const QueriesModule = {
-    {{#if includeNamespace}}{{#each modules as | module |}} {{module.tag}}: {{module.namespace}}.{{../queriesModuleName}}, {{/each}}
-    {{else}}{{#each modules as | module |}} {{module.tag}}:  {{tagModuleName module.tag}}, {{/each}}{{/if}}
-} satisfies Record<string, QueriesModuleType>;