@povio/openapi-codegen-cli 0.4.6 → 0.4.7

package/package.json

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

package/src/generators/templates/partials/casl-ability-function.hbs

@@ -1,8 +1,8 @@
 /**
- * Use for `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}} ability. {{#if (hasAbilityConditions endpoint)}}For global ability, omit the object parameter.{{/if}}
- * {{#if (hasAbilityConditions endpoint)}} 
- {{#each (abilityConditionsTypes endpoint) as | propertyType |}}* @param object.{{propertyType.name}} - {{propertyType.name}} from {{propertyType.info}}{{/each}}{{/if}} 
- * @returns An ability tuple indicating the user's ability to use `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}}.
+ * Use for `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}} ability. {{#if (hasAbilityConditions endpoint)}}For global ability, omit the object parameter.{{/if}}{{#if (abilityDescription endpoint)}}
+ * @description {{abilityDescription endpoint}}{{/if}} 
+{{#if (hasAbilityConditions endpoint)}}{{#each (abilityConditionsTypes endpoint) as | propertyType |}} * @param { {{propertyType.type}}{{propertyType.zodSchemaName}} } object.{{propertyType.name}} {{propertyType.name}} from {{propertyType.info}}
+{{/each}}{{/if}} * @returns { {{abilityTypeName endpoint}} } An ability tuple indicating the user's ability to use `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}}
  */
 export const {{abilityFunctionName endpoint}} = (
   {{#if (hasAbilityConditions endpoint)}}object?: { {{#each (abilityConditionsTypes endpoint) as | propertyType |}}{{propertyType.name}}{{#unless propertyType.required}}?{{/unless}}: {{propertyType.type}}{{propertyType.zodSchemaName}}, {{/each}} } {{/if}}

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

@@ -1,3 +1,12 @@
+/** 
+ * 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}}]
+ */
 export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint}}} }>) => {
   return {{queryHook}}({
     mutationFn: ({{#if (endpointParams endpoint)}} { {{{endpointArgs endpoint}}} } {{/if}}) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}),

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

@@ -1,3 +1,12 @@
+/** 
+ * 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}}]
+ */
 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}}),