Acl check imported functions fix

monikaboz · monikaboz · commit f80e102875fc · 2025-07-22T12:49:43.000+02:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.13.5",
+  "version": "0.13.6",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
diff --git a/src/generators/generate/generateQueries.ts b/src/generators/generate/generateQueries.ts
@@ -5,7 +5,7 @@ import { QUERIES_MODULE_NAME, QUERY_HOOKS, QUERY_IMPORT } from "../const/queries
 import { EndpointParameter } from "../types/endpoint";
 import { GenerateType, GenerateTypeParams, Import } from "../types/generate";
 import { getUniqueArray } from "../utils/array.utils";
-import { getEndpointsImports, getModelsImports } from "../utils/generate/generate.imports.utils";
+import { getAclImports, getEndpointsImports, getModelsImports } from "../utils/generate/generate.imports.utils";
 import {
   getAclCheckImportPath,
   getMutationEffectsImportPath,
@@ -57,7 +57,8 @@ export function generateQueries({ resolver, data, tag = "" }: GenerateTypeParams
     from: getMutationEffectsImportPath(resolver.options),
   };
 
-  const hasAclCheck = resolver.options.checkAcl && endpoints.some((endpoint) => endpoint.acl);
+  const aclEndpoints = endpoints.filter((endpoint) => endpoint.acl);
+  const hasAclCheck = resolver.options.checkAcl && aclEndpoints.length > 0;
   const aclCheckImport: Import = {
     bindings: [ACL_CHECK_HOOK],
     from: getAclCheckImportPath(resolver.options),
@@ -87,6 +88,12 @@ export function generateQueries({ resolver, data, tag = "" }: GenerateTypeParams
     options: resolver.options,
   });
 
+  const aclImports = getAclImports({
+    tag,
+    endpoints: aclEndpoints,
+    options: resolver.options,
+  });
+
   const hbsTemplate = getHbsTemplateDelegate(resolver, "queries");
 
   return hbsTemplate({
@@ -102,6 +109,7 @@ export function generateQueries({ resolver, data, tag = "" }: GenerateTypeParams
     queryTypesImport,
     modelsImports,
     endpointsImports,
+    aclImports,
     includeNamespace: resolver.options.tsNamespaces,
     tag,
     namespace: getNamespaceName({ type: GenerateType.Queries, tag, options: resolver.options }),
diff --git a/src/generators/templates/partials/acl-check-call.hbs b/src/generators/templates/partials/acl-check-call.hbs
@@ -0,0 +1 @@
+checkAcl({{importedAbilityFunctionName endpoint}}({{#if generateAclCheckParams}}{ {{#each (abilityConditionsTypes endpoint) as | propertyType |}}{{propertyType.name}}, {{/each}} } {{/if}}));
diff --git a/src/generators/templates/partials/acl-check-params.hbs b/src/generators/templates/partials/acl-check-params.hbs
diff --git a/src/generators/templates/partials/query-use-infinite-query.hbs b/src/generators/templates/partials/query-use-infinite-query.hbs
@@ -8,7 +8,7 @@ export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endp
   return {{infiniteQueryHook}}({
     queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint excludePageParam=true}}}{{/if}}),
     queryFn: ({ pageParam }) => {{#if hasQueryFnBody}}{ {{/if}} 
-    {{#if hasAclCheck}}checkAcl({{genAclCheckParams endpoint}});{{/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,
diff --git a/src/generators/templates/partials/query-use-mutation.hbs b/src/generators/templates/partials/query-use-mutation.hbs
@@ -9,7 +9,7 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
 
   return {{queryHook}}({
     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 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) {
diff --git a/src/generators/templates/partials/query-use-query.hbs b/src/generators/templates/partials/query-use-query.hbs
@@ -8,7 +8,7 @@ export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{
   return {{queryHook}}({
     queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),
     queryFn: {{#if hasQueryFn}}() => {{#if hasQueryFnBody}}{ {{/if}} 
-    {{#if hasAclCheck}}checkAcl({{genAclCheckParams endpoint}});{{/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,
diff --git a/src/generators/templates/queries.hbs b/src/generators/templates/queries.hbs
@@ -26,6 +26,10 @@
 {{#each endpointsImports as | endpointsImport |}}
 {{{genImport endpointsImport}}}
 {{/each}}
+{{! Acl import }}
+{{#each aclImports as | aclImport |}}
+{{{genImport aclImport}}}
+{{/each}}
 
 {{#if includeNamespace}}
 export namespace {{namespace}} {
diff --git a/src/generators/utils/generate/generate.acl.utils.ts b/src/generators/utils/generate/generate.acl.utils.ts
@@ -1,13 +1,24 @@
 import { ACL_ALL_ABILITIES } from "src/generators/const/acl.const";
+import { GenerateType } from "src/generators/types/generate";
+import { GenerateOptions } from "src/generators/types/options";
 import { Endpoint } from "../../types/endpoint";
 import { capitalize, snakeToCamel } from "../string.utils";
+import { getEndpointTag } from "./generate.endpoints.utils";
+import { getNamespaceName } from "./generate.utils";
 
 export const getAbilityTypeName = (endpoint: Endpoint) =>
   `Use${capitalize(snakeToCamel(endpoint.operationName))}Ability`;
 
 export const getAbilityFunctionName = (endpoint: Endpoint) =>
   `canUse${capitalize(snakeToCamel(endpoint.operationName))}`;
 
+export const getImportedAbilityFunctionName = (endpoint: Endpoint, options: GenerateOptions) => {
+  const namespacePrefix = options.tsNamespaces
+    ? `${getNamespaceName({ type: GenerateType.Acl, tag: getEndpointTag(endpoint, options), options })}.`
+    : "";
+  return `${namespacePrefix}${getAbilityFunctionName(endpoint)}`;
+};
+
 export const getAbilityAction = (endpoint: Endpoint) => endpoint.acl?.[0].action;
 
 export const getAbilitySubject = (endpoint: Endpoint) => endpoint.acl?.[0].subject;
diff --git a/src/generators/utils/generate/generate.imports.utils.ts b/src/generators/utils/generate/generate.imports.utils.ts
@@ -4,6 +4,7 @@ import { Endpoint } from "../../types/endpoint";
 import { GenerateType, Import } from "../../types/generate";
 import { GenerateOptions } from "../../types/options";
 import { getUniqueArray } from "../array.utils";
+import { getAbilityFunctionName } from "./generate.acl.utils";
 import { getEndpointName, getEndpointTag } from "./generate.endpoints.utils";
 import { getNamespaceName, getTagImportPath } from "./generate.utils";
 import { getZodSchemaInferedTypeName } from "./generate.zod.utils";
@@ -62,6 +63,25 @@ export function getEndpointsImports({
   });
 }
 
+export function getAclImports({
+  tag,
+  endpoints,
+  options,
+}: {
+  tag: string;
+  endpoints: Endpoint[];
+  options: GenerateOptions;
+}) {
+  return getImports({
+    type: GenerateType.Acl,
+    tag,
+    entities: endpoints,
+    getTag: (endpoint) => getEndpointTag(endpoint, options),
+    getEntityName: getAbilityFunctionName,
+    options,
+  });
+}
+
 export function getEntityImports({
   tags,
   entityName,
diff --git a/src/generators/utils/hbs/hbs-template.utils.ts b/src/generators/utils/hbs/hbs-template.utils.ts
@@ -4,10 +4,10 @@ import { readHbsTemplateSync } from "../file.utils";
 import { registerAclHbsHelpers } from "./hbs.acl.utils";
 import { registerCommonHbsHelpers } from "./hbs.common.utils";
 import { registerEndpointsHbsHelpers } from "./hbs.endpoints.utils";
+import { registerImportsHbsHelpers } from "./hbs.imports.utils";
 import { registerPartialsHbsHelpers } from "./hbs.partials.utils";
 import { registerQueryHbsHelpers } from "./hbs.query.utils";
 import { registerZodHbsHelpers } from "./hbs.zod.utils";
-import { registerImportsHbsHelpers } from "./hbs.imports.utils";
 
 export function getHbsTemplateDelegate(resolver: SchemaResolver, templateName: string) {
   const template = readHbsTemplateSync(templateName);
@@ -17,7 +17,7 @@ export function getHbsTemplateDelegate(resolver: SchemaResolver, templateName: s
   registerZodHbsHelpers(resolver);
   registerEndpointsHbsHelpers(resolver);
   registerQueryHbsHelpers();
-  registerAclHbsHelpers();
+  registerAclHbsHelpers(resolver);
   registerPartialsHbsHelpers(resolver);
 
   return Handlebars.compile(template);
diff --git a/src/generators/utils/hbs/hbs.acl.utils.ts b/src/generators/utils/hbs/hbs.acl.utils.ts
@@ -1,18 +1,23 @@
 import Handlebars from "handlebars";
+import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
+import { Endpoint } from "src/generators/types/endpoint";
+import { GenerateOptions } from "src/generators/types/options";
 import {
   getAbilityAction,
   getAbilityConditionsTypes,
   getAbilityDescription,
   getAbilityFunctionName,
   getAbilitySubject,
   getAbilityTypeName,
+  getImportedAbilityFunctionName,
   getTagAllAbilitiesName,
   hasAbilityConditions,
 } from "../generate/generate.acl.utils";
 
 enum AclHelpers {
   AbilityTypeName = "abilityTypeName",
   AbilityFunctionName = "abilityFunctionName",
+  ImportedAbilityFunctionName = "importedAbilityFunctionName",
   AbilityAction = "ablityAction",
   AbilitySubject = "ablitySubject",
   HasAbilityConditions = "hasAbilityConditions",
@@ -21,9 +26,10 @@ enum AclHelpers {
   TagAllAbilitiesName = "tagAllAbilitiesName",
 }
 
-export function registerAclHbsHelpers() {
+export function registerAclHbsHelpers(resolver: SchemaResolver) {
   registerAbilityTypeNameHelper();
   registerAbilityFunctionNameHelper();
+  registerImportedAbilityFunctionNameHelper(resolver.options);
   registerAbilityActionHelper();
   registerAbilitySubjectHelper();
   registerHasAbilityConditionsHelper();
@@ -40,6 +46,12 @@ function registerAbilityFunctionNameHelper() {
   Handlebars.registerHelper(AclHelpers.AbilityFunctionName, getAbilityFunctionName);
 }
 
+function registerImportedAbilityFunctionNameHelper(options: GenerateOptions) {
+  Handlebars.registerHelper(AclHelpers.ImportedAbilityFunctionName, (endpoint: Endpoint) =>
+    getImportedAbilityFunctionName(endpoint, options),
+  );
+}
+
 function registerAbilityActionHelper() {
   Handlebars.registerHelper(AclHelpers.AbilityAction, getAbilityAction);
 }
diff --git a/src/generators/utils/hbs/hbs.partials.utils.ts b/src/generators/utils/hbs/hbs.partials.utils.ts
@@ -31,7 +31,7 @@ enum PartialsHelpers {
   CaslAbilityType = "genCaslAbilityType",
   CaslAbilityFunction = "genCaslAbilityFunction",
   CaslAbilityQuery = "genCaslAbilityQuery",
-  AclCheckParams = "genAclCheckParams",
+  AclCheckCall = "genAclCheckCall",
 }
 
 export function registerPartialsHbsHelpers(resolver: SchemaResolver) {
@@ -48,7 +48,7 @@ export function registerPartialsHbsHelpers(resolver: SchemaResolver) {
   registerGenerateCaslAbilityTypeHelper();
   registerGenerateCaslAbilityFunctionHelper();
   registerGenerateCaslAbilityQueryHelper();
-  registerGenerateAclCheckParamsHelper();
+  registerGenerateAclCheckCallHelper();
 }
 
 function registerGenerateModelJsDocsHelper() {
@@ -234,13 +234,13 @@ function registerGenerateCaslAbilityQueryHelper() {
   );
 }
 
-function registerGenerateAclCheckParamsHelper() {
-  Handlebars.registerHelper(PartialsHelpers.AclCheckParams, (endpoint: Endpoint) => {
+function registerGenerateAclCheckCallHelper() {
+  Handlebars.registerHelper(PartialsHelpers.AclCheckCall, (endpoint: Endpoint) => {
     const checkParams = getAbilityConditionsTypes(endpoint)?.map((condition) => condition.name);
     const params = endpoint.parameters.map((param) => param.name);
     const hasAllCheckParams = checkParams?.every((param) => params.includes(param));
 
-    return getHbsPartialTemplateDelegate("acl-check-params")({
+    return getHbsPartialTemplateDelegate("acl-check-call")({
       endpoint,
       generateAclCheckParams: hasAbilityConditions(endpoint) && hasAllCheckParams,
     });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@povio/openapi-codegen-cli",`
`3`		`- "version": "0.13.5",`
	`3`	`+ "version": "0.13.6",`
`4`	`4`	`"main": "./dist/index.js",`
`5`	`5`	`"bin": {`
`6`	`6`	`"openapi-codegen": "./dist/sh.js"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+checkAcl({{importedAbilityFunctionName endpoint}}({{#if generateAclCheckParams}}{ {{#each (abilityConditionsTypes endpoint) as \| propertyType \|}}{{propertyType.name}}, {{/each}} } {{/if}}));`