@povio/openapi-codegen-cli 2.0.8-rc.9 → 3.0.0-rc.2

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

@@ -1,6 +0,0 @@
-/** 
- * {{name}} 
- * @type { {{zodSchemaType zodSchema}} }{{#if (zodSchemaDescription zodSchema)}}
- * @description {{{zodSchemaDescription zodSchema}}}{{/if}}
-{{#if (zodSchemaPropertyDescriptions zodSchema tag)}}{{#each (zodSchemaPropertyDescriptions zodSchema tag) as | property |}} * @property { {{property.type}} } {{@key}} {{{addAsteriskAfterNewLine property.description}}} 
-{{/each}}{{/if}} */

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

@@ -1,31 +0,0 @@
-{{#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 excludePageParam=true) 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 query}}
- /** 
- * 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.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.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 hasMutationEffects}} & {{mutationEffectsType}}{{/if}} } options Mutation options
- * @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-keys.hbs

@@ -1,11 +0,0 @@
-export const keys = {
-    all: [{{queriesModuleName}}] as const,
-    {{#each queryEndpoints as | endpoint |}}
-    {{endpointName endpoint}}: ({{{genEndpointParams endpoint pathParamsRequiredOnly=true}}}) => [...keys.all, "{{endpoint.path}}", {{{endpointArgs endpoint}}}] as const,
-    {{#if ../generateInfiniteQueries}}
-    {{#if (isInfiniteQuery endpoint)}}
-    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint excludePageParam=true pathParamsRequiredOnly=true}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint excludePageParam=true}}}] as const,
-    {{/if}}
-    {{/if}}
-    {{/each}}
-};

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

@@ -1,21 +0,0 @@
-{{! Js docs }}
-{{{genQueryJsDocs endpoint infiniteQuery=true}}}
-{{! Infinite query definition}}
-export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint excludePageParam=true}}} }: { {{{genEndpointParams endpoint excludePageParam=true}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
-  {{! Use acl check }}
-  {{#if hasAclCheck}}const { checkAcl } = {{aclCheckHook}}();{{/if}}
-
-  return {{infiniteQueryHook}}({
-    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint excludePageParam=true}}}{{/if}}),
-    queryFn: ({ pageParam }) => {{#if hasQueryFnBody}}{ {{/if}} 
-    {{#if hasAclCheck}}{{{genAclCheckCall endpoint}}}{{/if}}
-    {{#if hasQueryFnBody}}return {{/if}}{{importedEndpointName endpoint}}({{{endpointArgs endpoint replacePageParam=true}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}})
-    {{#if hasQueryFnBody}} }{{/if}},
-    initialPageParam: 1,
-    getNextPageParam: ({ {{pageParamName}}, {{totalItemsName}}, {{limitParamName}}: limitParam }) => {
-      const pageParam = {{pageParamName}} ?? 1;
-      return pageParam * limitParam < {{totalItemsName}} ? pageParam + 1 : null;
-    },
-    ...options,
-  });
-};

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

@@ -1,54 +0,0 @@
-{{! Js docs }}
-{{{genQueryJsDocs endpoint mutation=true}}}
-{{! Mutation definition}}
-export const {{queryName endpoint mutation=true}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}}{{#if endpoint.mediaUpload}} abortController?: AbortController, onUploadProgress?: (progress: { loaded: number; total: number }) => void{{/if}} }>{{#if hasMutationEffects}} & {{mutationEffectsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
-  {{! Use acl check }}
-  {{#if hasAclCheck}}const { checkAcl } = {{aclCheckHook}}();{{/if}}
-  {{! Use mutation effects }}
-  {{#if hasMutationEffects}}const { runMutationEffects } = useMutationEffects({ currentModule: {{queriesModuleName}} });{{/if}}
-
-  return {{queryHook}}({
-    mutationFn: {{#if endpoint.mediaUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}}{{#if endpoint.mediaUpload}}, abortController, onUploadProgress{{/if}} } {{/if}}) => {{#if hasMutationFnBody}} { {{/if}}
-      {{#if hasAclCheck}}{{{genAclCheckCall endpoint}}}{{/if}}
-      {{#if endpoint.mediaUpload}}const uploadInstructions = await {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}});
-
-      if (file && uploadInstructions.url) {
-        const method = (data?.method?.toLowerCase() ?? "put") as 'put' | 'post';
-        let dataToSend: File | FormData = file;
-        if (method === "post") {
-          dataToSend = new FormData();
-          if (uploadInstructions.fields) {
-            for (const [key, value] of uploadInstructions.fields) {
-              dataToSend.append(key, value);
-            }
-          }
-          dataToSend.append('file', file);
-        }
-        await axios[method](uploadInstructions.url, dataToSend, {
-          headers: {
-            "Content-Type": file.type,
-          },
-          signal: abortController?.signal,
-          onUploadProgress: onUploadProgress
-          ? (progressEvent) => onUploadProgress({ loaded: progressEvent.loaded, total: progressEvent.total ?? 0 })
-          : undefined,
-        });
-      }
-
-      return uploadInstructions;
-      {{else}}
-      {{#if hasMutationFnBody}}return {{/if}}{{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}})
-      {{/if}}
-    {{#if hasMutationFnBody}} }{{/if}},
-    ...options, {{#if hasMutationEffects}}
-    onSuccess: async (resData, variables, onMutateResult, context) => {
-      {{! Mutation effects }}
-      {{#if updateQueryEndpoints}}
-      {{#if destructuredVariables}}const { {{commaSeparated destructuredVariables }} } = variables;{{/if}}
-      const updateKeys = [{{#each updateQueryEndpoints as | endpoint |}}keys.{{endpointName endpoint}}({{{endpointArgs endpoint includeOnlyRequiredParams=true}}}), {{/each}}];
-      {{/if}}
-      await runMutationEffects(resData, variables, options{{#if updateQueryEndpoints}}, updateKeys{{/if}});
-      options?.onSuccess?.(resData, variables, onMutateResult, context);
-    },{{/if}}
-  });
-};

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

@@ -1,16 +0,0 @@
-{{! Js docs }}
-{{{genQueryJsDocs endpoint query=true}}}
-{{! Query definition}}
-export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint}}} }: { {{{genEndpointParams endpoint}}} }, {{/if}}options?: AppQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
-  {{! Use acl check }}
-  {{#if hasAclCheck}}const { checkAcl } = {{aclCheckHook}}();{{/if}}
-  
-  return {{queryHook}}({
-    queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),
-    queryFn: {{#if hasQueryFn}}() => {{#if hasQueryFnBody}}{ {{/if}} 
-    {{#if hasAclCheck}}{{{genAclCheckCall endpoint}}}{{/if}}
-    {{#if hasQueryFnBody}}return {{/if}}{{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/if}}
-    {{#if hasQueryFnBody}} }{{/if}},
-    ...options,
-  });
-};

package/src/generators/templates/queries.hbs

@@ -1,54 +0,0 @@
-{{! Axios import }}
-{{#if hasAxiosImport}}
-{{{genImport axiosImport}}}
-{{/if}}
-{{! React query import }}
-{{{genImport queryImport}}}
-{{! Query modules import }}
-{{#if hasMutationEffects}}
-{{{genImport queryModulesImport}}}
-{{/if}}
-{{! Mutation effects import }}
-{{#if hasMutationEffectsImport}}
-{{{genImport mutationEffectsImport}}}
-{{/if}}
-{{! Acl check import }}
-{{#if hasAclCheck}}
-{{{genImport aclCheckImport}}}
-{{#each aclImports as | aclImport |}}
-{{{genImport aclImport}}}
-{{/each}}
-{{/if}}
-{{! React query types import }}
-{{{genImport queryTypesImport}}}
-{{! Models import }}
-{{#each modelsImports as | modelsImport |}}
-{{{genImport modelsImport}}}
-{{/each}}
-{{! Endpoints import }}
-{{#each endpointsImports as | endpointsImport |}}
-{{{genImport endpointsImport}}}
-{{/each}}
-
-{{#if includeNamespace}}
-export namespace {{namespace}} {
-{{/if}}
-
-export const {{queriesModuleName}} = {{#if hasMutationEffects}}{{queryModuleEnum}}.{{tag}}{{else}}"{{namespace}}"{{/if}};
-
-{{! Query keys export}}
-{{{genQueryKeys queryEndpoints}}}
-
-{{! Query export }}
-{{#each endpoints as | endpoint |}}
-{{{genQuery endpoint}}}
-
-{{{genMutation endpoint ../queryEndpoints}}}
-
-{{{genInfiniteQuery endpoint}}}
-
-{{/each}}
-
-{{#if includeNamespace}}
-}
-{{/if}}

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

@@ -1,5 +0,0 @@
-export const enum QueryModule {
-   {{#each modules as | module |}}
-   {{module.tag}} = "{{module.namespace}}",
-   {{/each}}
-}

package/src/generators/templates/zod-extended.hbs

@@ -1,49 +0,0 @@
-{{! Zod import }}
-{{{genImport zodImport}}}
-{{! Error handling import }}
-{{{genImport errorHandlingImport}}}
-
-export namespace ZodExtended {
-  interface ParseOptions {
-    type: "body" | "query";
-    name?: string;
-    errorHandler?: ErrorHandler<never>;
-  }
-
-  export function {{parse}}<ZOutput, ZInput>(
-    schema: z.ZodType<ZOutput, ZInput>,
-    data: unknown,
-    { type, name, errorHandler }: ParseOptions = { type: "body" },
-  ) {
-    try {
-      return schema.parse(data);
-    } catch (e) {
-      if (e instanceof z.ZodError) {
-        e.name = `FE Request ${type === "body" ? "body" : "query param"}${name ? ` ("${name}")` : ""} schema mismatch - ZodError`;
-      }
-      (errorHandler ?? {{sharedErrorHandler}}).rethrowError(e);
-      throw e;
-    }
-  }
-
-  function is{{capitalize sortExp}}Valid(enumSchema: z.ZodEnum, data?: string) {
-    if (data === undefined || data === "" || enumSchema.options.length === 0) {
-      return true;
-    }
-
-    const prefixedEnumOptions = `([+-]?(${enumSchema.options.join("|")}))`;
-    const commaSeparatedOptions = `(${prefixedEnumOptions})(\s*,\s*${prefixedEnumOptions})*`;
-    return new RegExp(`^${commaSeparatedOptions}$`).test(data);
-  }
-
-  export const {{sortExp}} = (enumSchema: z.ZodEnum) =>
-    z.string().superRefine((arg, ctx) => {
-      if (!is{{capitalize sortExp}}Valid(enumSchema, arg)) {
-        ctx.addIssue({
-          code: "invalid_value",
-          message: "Invalid sorting string.",
-          values: [],
-        });
-      }
-    });
-}