@povio/openapi-codegen-cli 0.5.2 → 0.5.4

package/package.json

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

package/src/generators/templates/models.hbs

@@ -9,9 +9,11 @@
 export namespace {{namespace}} {
 {{/if}}
 {{#each zodSchemasData as | zodSchema |}}
+{{! Js docs }}
+{{{genModelJsDocs @key zodSchema ../tag}}}
 {{! Zod schema export }}
-{{#if zodSchema.isCircular}}// TODO: Fix type inference {{/if}}
-export const {{@key}}{{#if zodSchema.isCircular}}: z.ZodType<unknown>{{/if}} = {{{zodSchema.code}}};
+export const {{@key}}{{#if zodSchema.isCircular}}: z.ZodType<unknown> // TODO: Fix type inference {{/if}}
+    = {{{zodSchema.code}}};
 {{! Zod schema infered type export }}
 export type {{zodInferedType @key}} = z.infer<typeof {{@key}}>;
 {{#if zodSchema.isEnum}}export const {{zodInferedType @key}} = {{@key}}.enum;{{/if}}

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

@@ -0,0 +1,6 @@
+/** 
+ * {{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

@@ -0,0 +1,10 @@
+/** 
+ * {{#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}}
+ * @returns { {{#if (isQuery endpoint)}}UseQueryResult{{else}}UseMutationResult{{/if}}<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
+ * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
+ */

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

@@ -1,12 +1,6 @@
-/** 
- * Mutation `{{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}} } mutation.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param { AppMutationOptions } options Mutation options
- * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
- */
+{{! Js docs }}
+{{{genQueryJsDocs endpoint}}}
+{{! Mutation definition}}
 export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint}}} }>) => {
   {{#if queryEndpoints}} const queryClient = useQueryClient();{{/if}}
 
@@ -14,6 +8,7 @@ export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{imp
     mutationFn: ({{#if (endpointParams endpoint)}} { {{{endpointArgs endpoint}}} } {{/if}}) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}),
     ...options, {{#if queryEndpoints}}
     onSuccess: (...args) => {
+      {{! Invalidation }}
       if (options?.enableInvalidateAll) {
         queryClient.invalidateQueries({ queryKey: keys.all });
       }

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

@@ -1,12 +1,6 @@
-/** 
- * Query `{{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}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param { AppQueryOptions } options Query options
- * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
- */
+{{! 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>) => {
   return {{queryHook}}({
     queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),

package/dist/generators/utils/deps.utils.d.ts

@@ -1,3 +0,0 @@
-import { GenerateOptions } from "src/generators/types/options";
-export declare function getAppRestClientImportPath(options: GenerateOptions): string;
-export declare function getQueryTypesImportPath(options: GenerateOptions): string;