@povio/openapi-codegen-cli 0.12.1 → 0.13.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.12.1",
+  "version": "0.13.2",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
@@ -19,7 +19,7 @@
     "format:check": "prettier --check .",
     "format:fix": "prettier --write .",
     "push": "yarn exec ./scripts/publish.sh",
-    "dev:generate": "rm -rf ./output && yarn start generate --input http://localhost:4000/docs-json"
+    "dev:generate": "rm -rf ./output && yarn start generate --input ./test/test.json"
   },
   "files": [
     "dist/*",

package/src/assets/useMutationEffects.ts

@@ -11,11 +11,11 @@ export interface MutationEffectsOptions {
   preferUpdate?: boolean;
 }
 
-export interface UseMutationEffectsOptions {
+export interface UseMutationEffectsProps {
   currentModule: QueryModule;
 }
 
-export function useMutationEffects({ currentModule }: UseMutationEffectsOptions) {
+export function useMutationEffects({ currentModule }: UseMutationEffectsProps) {
   const queryClient = useQueryClient();
   const config = OpenApiQueryConfig.useConfig();
 

package/src/generators/templates/acl-check.hbs

@@ -0,0 +1,23 @@
+import { useCallback } from "react";
+{{! Ability context import }}
+{{{genImport abilityContextImport}}}
+{{! Error handling import }}
+{{{genImport errorHandlingImport}}}
+{{! App abilities import }}
+{{{genImport appAbilitiesImport}}}
+
+interface UseAclCheckProps {
+  errorHandler?: {{errorHandler}}<never>;
+}
+
+export function {{aclCheckHook}}({ errorHandler }: UseAclCheckProps = {}) {
+  const ability = {{abilityContext}}.useAbility();
+
+  const checkAcl = useCallback((appAbility: {{appAbilities}}) => {
+    if (!ability.can(...appAbility)) {
+      (errorHandler ?? {{sharedErrorHandler}}).rethrowError(new Error("ACL check failed"));
+    }
+  }, [ability, errorHandler]);
+
+  return { checkAcl };
+}

package/src/generators/templates/app-acl.hbs

@@ -6,8 +6,12 @@
 {{/each}}
 
 {{! AppAbilities union type }}
-export type AppAbilities = 
+export type {{appAbilities}} = 
+{{#if tags}}
 {{#if includeNamespace}}{{#each namespaces as | namespace |}} | {{namespace}}.{{../allAbilities}}{{/each}}
 {{else}}{{#each tags as | tag |}} | {{tagAllAbilitiesName tag}}{{/each}}{{/if}}
+{{else}}
+{{abilityTuple}}<string, {{subject}}>;
+{{/if}}
 
-export type AppAbility = PureAbility<AppAbilities>;
+export type AppAbility = PureAbility<{{appAbilities}}>;

package/src/generators/templates/partials/acl-check-params.hbs

@@ -0,0 +1 @@
+{{#if generateAclCheckParams}}{ {{#each (abilityConditionsTypes endpoint) as | propertyType |}}{{propertyType.name}}, {{/each}} } {{/if}}

package/src/generators/templates/partials/endpoint-param-parse.hbs

@@ -1 +1 @@
-{{zodExtended}}.{{parse}}({{#if param.parameterSortingEnumSchemaName}}{{zodExtended}}.{{sortingString}}({{importedZodSchemaName param.parameterSortingEnumSchemaName}}){{#if addOptional}}.optional(){{/if}}{{else}}{{importedZodSchemaName param.zodSchema}}{{#if addOptional}}.optional(){{/if}}{{/if}}, {{paramName}})
+{{zodExtended}}.{{parse}}({{#if param.parameterSortingEnumSchemaName}}{{zodExtended}}.{{sortingString}}({{importedZodSchemaName param.parameterSortingEnumSchemaName}}){{#if addOptional}}.optional(){{/if}}{{else}}{{importedZodSchemaName param.zodSchema}}{{#if addOptional}}.optional(){{/if}}{{/if}}, {{paramName}}{{#if isQuery}}, { type: "query", name: "{{paramName}}" }{{/if}})

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

@@ -2,9 +2,15 @@
 {{{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 }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint replacePageParam=true}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}}),
+    queryFn: ({ pageParam }) => {{#if hasQueryFnBody}}{ {{/if}} 
+    {{#if hasAclCheck}}checkAcl({{genAclCheckParams 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;

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

@@ -2,12 +2,15 @@
 {{{genQueryJsDocs endpoint mutation=true}}}
 {{! Mutation definition}}
 export const {{queryName endpoint mutation=true}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}} }>{{#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}}) => {{#if endpoint.mediaUpload}} {
-      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if endpoint.mediaUpload}}; 
+    mutationFn: {{#if endpoint.mediaUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if hasMutationFnBody}} { {{/if}}
+      {{#if hasAclCheck}}checkAcl({{genAclCheckParams endpoint}});{{/if}}
+      {{#if endpoint.mediaUpload}}const uploadInstructions = await {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}); 
       
       if (file && uploadInstructions.url) {
         await axios.put(uploadInstructions.url, file, {
@@ -16,14 +19,17 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
           },
         });
       }
-
+      
       return uploadInstructions;
-    }{{/if}},
+      {{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, context) => {
       {{! Mutation effects }}
       {{#if updateQueryEndpoints}}
-      const { {{endpointArgs endpoint includeOnlyRequiredParams=true excludeBodyParam=true}} } = variables;
+      {{#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, options{{#if updateQueryEndpoints}}, updateKeys{{/if}});

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

@@ -2,9 +2,15 @@
 {{{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}}() => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/if}},
+    queryFn: {{#if hasQueryFn}}() => {{#if hasQueryFnBody}}{ {{/if}} 
+    {{#if hasAclCheck}}checkAcl({{genAclCheckParams 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

@@ -12,6 +12,10 @@
 {{#if hasMutationEffectsImport}}
 {{{genImport mutationEffectsImport}}}
 {{/if}}
+{{! Acl check import }}
+{{#if hasAclCheck}}
+{{{genImport aclCheckImport}}}
+{{/if}}
 {{! React query types import }}
 {{{genImport queryTypesImport}}}
 {{! Models import }}

package/src/generators/templates/zod.hbs

@@ -29,10 +29,19 @@ function isSortingStringValid(enumSchema: z.ZodEnum<[string, ...string[]]>, data
   return new RegExp(`^${commaSeparatedOptions}$`).test(data);
 }
 
-function {{parse}}(schema: z.ZodSchema, data: unknown, errorHandler?: {{errorHandler}}<never>) {
+interface ParseOptions {
+  type: "body" | "query";
+  name?: string;
+  errorHandler?: {{errorHandler}}<never>;
+}
+
+function {{parse}}(schema: z.ZodSchema, data: unknown, { type, name, errorHandler }: ParseOptions = { type: "body" }) {
   try {
     return schema.parse(data);
-  } catch (e: unknown) {
+  } 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;
   }