Optimize ACL ability types

monikaboz · monikaboz · commit c95dc74c5b54 · 2025-08-29T14:08:47.000+02:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
diff --git a/src/generators/const/acl.const.ts b/src/generators/const/acl.const.ts
@@ -1,7 +1,6 @@
 import { GenerateFile, Import } from "src/generators/types/generate";
 
 export const ACL_APP_ABILITY_FILE: GenerateFile = { fileName: "acl/app.ability", extension: "ts" };
-export const ACL_ALL_ABILITIES = "AllAbilities";
 export const ACL_APP_ABILITIES = "AppAbilities";
 
 export const ACL_CHECK_FILE: GenerateFile = { fileName: "acl/useAclCheck", extension: "ts" };
diff --git a/src/generators/generate/generateAcl.ts b/src/generators/generate/generateAcl.ts
@@ -1,26 +1,17 @@
-import {
-  ACL_ALL_ABILITIES,
-  ACL_APP_ABILITIES,
-  CASL_ABILITY_BINDING,
-  CASL_ABILITY_IMPORT,
-} from "src/generators/const/acl.const";
-import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
+import { ACL_APP_ABILITIES, CASL_ABILITY_BINDING, CASL_ABILITY_IMPORT } from "src/generators/const/acl.const";
 import { GenerateType, GenerateTypeParams, Import } from "src/generators/types/generate";
-import { getUniqueArray } from "src/generators/utils/array.utils";
-import { getTagAllAbilitiesName } from "src/generators/utils/generate/generate.acl.utils";
-import { getEntityImports, getModelsImports } from "src/generators/utils/generate/generate.imports.utils";
+import { getAclData, getAppAbilitiesType } from "src/generators/utils/generate/generate.acl.utils";
 import { getNamespaceName } from "src/generators/utils/generate/generate.utils";
 import { getHbsTemplateDelegate } from "src/generators/utils/hbs/hbs-template.utils";
 
 export function generateAcl({ resolver, data, tag = "" }: GenerateTypeParams) {
-  const endpoints = data.get(tag)?.endpoints.filter(({ acl }) => acl && acl.length > 0);
-  if (!endpoints || endpoints.length === 0) {
+  const aclData = getAclData({ resolver, data, tag });
+  if (!aclData) {
     return;
   }
 
-  const hasAdditionalAbilityImports = endpoints.some(
-    ({ acl }) => acl?.[0].conditions && Object.keys(acl[0].conditions).length > 0,
-  );
+  const { hasAdditionalAbilityImports, modelsImports, endpoints } = aclData;
+
   const caslAbilityTupleImport: Import = {
     bindings: [
       CASL_ABILITY_BINDING.abilityTuple,
@@ -29,20 +20,6 @@ export function generateAcl({ resolver, data, tag = "" }: GenerateTypeParams) {
     from: CASL_ABILITY_IMPORT.from,
   };
 
-  const aclZodSchemas = endpoints.reduce((acc, endpoint) => {
-    const zodSchemas = endpoint.acl?.[0].conditionsTypes?.reduce(
-      (acc, propertyType) => [...acc, ...(propertyType?.zodSchemaName ? [propertyType.zodSchemaName] : [])],
-      [] as string[],
-    );
-    return [...acc, ...(zodSchemas ?? [])];
-  }, [] as string[]);
-
-  const modelsImports = getModelsImports({
-    resolver,
-    tag,
-    zodSchemasAsTypes: getUniqueArray(aclZodSchemas),
-  });
-
   const hbsTemplate = getHbsTemplateDelegate(resolver, "acl");
 
   return hbsTemplate({
@@ -54,35 +31,25 @@ export function generateAcl({ resolver, data, tag = "" }: GenerateTypeParams) {
   });
 }
 
-export function generateAppAcl(resolver: SchemaResolver, tags: string[]) {
+export function generateAppAcl({ resolver, data }: Omit<GenerateTypeParams, "tag">) {
+  const { appAbilitiesType, hasAdditionalAbilityImports, modelsImports } = getAppAbilitiesType({ resolver, data });
+
   const caslAbilityTupleImport: Import = {
     bindings: [
       CASL_ABILITY_BINDING.pureAbility,
-      ...(tags.length === 0 ? [CASL_ABILITY_BINDING.subjectType, CASL_ABILITY_BINDING.abilityTuple] : []),
+      CASL_ABILITY_BINDING.abilityTuple,
+      ...(hasAdditionalAbilityImports ? [CASL_ABILITY_BINDING.forcedSubject] : []),
     ],
     from: CASL_ABILITY_IMPORT.from,
   };
 
-  const imports = getEntityImports({
-    tags,
-    entityName: ACL_ALL_ABILITIES,
-    getAliasEntityName: getTagAllAbilitiesName,
-    type: GenerateType.Acl,
-    options: resolver.options,
-  });
-
-  const namespaces = tags.map((tag) => getNamespaceName({ type: GenerateType.Acl, tag, options: resolver.options }));
-
   const hbsTemplate = getHbsTemplateDelegate(resolver, "app-acl");
 
   return hbsTemplate({
     caslAbilityTupleImport,
-    imports,
-    allAbilities: ACL_ALL_ABILITIES,
+    modelsImports,
+    appAbilitiesType,
     appAbilities: ACL_APP_ABILITIES,
-    includeNamespace: resolver.options.tsNamespaces,
-    tags,
-    namespaces,
     abilityTuple: CASL_ABILITY_BINDING.abilityTuple,
     subjectType: CASL_ABILITY_BINDING.subjectType,
   });
diff --git a/src/generators/generate/generateModels.ts b/src/generators/generate/generateModels.ts
@@ -24,7 +24,6 @@ export function generateModels({ resolver, data, tag = "" }: GenerateTypeParams)
 
   const zodSchemasData: Record<string, GenerateZodSchemaData> = Object.entries(zodSchemas).reduce(
     (acc, [key, code]) => {
-      const ref = resolver.getRefByZodSchemaName(key);
       const schemaObj = resolver.getZodSchemaObj(key);
 
       const value = {
diff --git a/src/generators/generateCodeFromOpenAPIDoc.ts b/src/generators/generateCodeFromOpenAPIDoc.ts
@@ -51,7 +51,7 @@ export function generateCodeFromOpenAPIDoc(openApiDoc: OpenAPIV3.Document, optio
   });
 
   generateFilesData.push(
-    ...getAclFiles(appAclTags, resolver),
+    ...getAclFiles(data, resolver),
     ...getMutationEffectsFiles(data, resolver),
     ...getZodExtendedFiles(data, resolver),
     ...getStandaloneFiles(resolver),
diff --git a/src/generators/templates/acl.hbs b/src/generators/templates/acl.hbs
@@ -8,14 +8,6 @@
 {{#if includeNamespace}}
 export namespace {{namespace}} {
 {{/if}}
-{{! Ability types }}
-{{#each endpoints as | endpoint |}}
-{{{genCaslAbilityType endpoint}}}
-
-{{/each}}
-{{! All abilities type }}
-export type AllAbilities =
-{{#each endpoints as | endpoint |}} | {{abilityTypeName endpoint}} {{/each}};
 
 {{! Ability functions }}
 {{#each endpoints as | endpoint |}}
@@ -24,4 +16,4 @@ export type AllAbilities =
 {{/each}}
 {{#if includeNamespace}}
 }
-{{/if}}
+{{/if}}
diff --git a/src/generators/templates/app-acl.hbs b/src/generators/templates/app-acl.hbs
@@ -1,17 +1,17 @@
 {{! Casl AbilityTuple import}}
 {{{genImport caslAbilityTupleImport}}}
-{{! Acl imports }}
-{{#each imports as | import |}}
-{{{genImport import}}}
+{{! Models import }}
+{{#each modelsImports as | modelsImport |}}
+{{{genImport modelsImport}}}
 {{/each}}
 
 {{! AppAbilities union type }}
-export type {{appAbilities}} = 
-{{#if tags}}
-{{#if includeNamespace}}{{#each namespaces as | namespace |}} | {{namespace}}.{{../allAbilities}}{{/each}}
-{{else}}{{#each tags as | tag |}} | {{tagAllAbilitiesName tag}}{{/each}}{{/if}}
+export type {{appAbilities}} = {{#if appAbilitiesType}} 
+{{#each appAbilitiesType as | appAbilityType |}}
+| {{../abilityTuple}}<"{{@key}}", {{{union appAbilityType}}}>
+{{/each}}
 {{else}}
 {{abilityTuple}}<string, {{subjectType}}>;
 {{/if}}
 
-export type AppAbility = PureAbility<{{appAbilities}}>;
+export type AppAbility = PureAbility<{{appAbilities}}>;
diff --git a/src/generators/templates/partials/casl-ability-function.hbs b/src/generators/templates/partials/casl-ability-function.hbs
@@ -2,11 +2,11 @@
  * Use for {{{genCaslAbilityQuery endpoint}}} 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 {{{genCaslAbilityQuery endpoint}}}
+{{/each}}{{/if}} * @returns { AbilityTuple } An ability tuple indicating the user's ability to use {{{genCaslAbilityQuery endpoint}}}
  */
 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}}
 ) => [
   "{{ablityAction endpoint}}", 
   {{#if (hasAbilityConditions endpoint)}}object ? subject("{{ablitySubject endpoint}}", object) : "{{ablitySubject endpoint}}"{{else}}"{{ablitySubject endpoint}}"{{/if}}
-] as {{abilityTypeName endpoint}};
+] as {{{genCaslAbilityType endpoint}}};
diff --git a/src/generators/templates/partials/casl-ability-type.hbs b/src/generators/templates/partials/casl-ability-type.hbs
@@ -1,5 +1 @@
-type {{abilityTypeName endpoint}} = {{abilityTupleType}}<
-  "{{ablityAction endpoint}}", 
-  "{{ablitySubject endpoint}}" 
-  {{#if (hasAbilityConditions endpoint)}}| (ForcedSubject<"{{ablitySubject endpoint}}"> & { {{#each (abilityConditionsTypes endpoint) as | propertyType |}}{{propertyType.name}}{{#unless propertyType.required}}?{{/unless}}: {{propertyType.type}}{{propertyType.zodSchemaName}}, {{/each}} }){{/if}}
->;
+{{abilityTuple}}<"{{ablityAction endpoint}}", {{{union (abilitySubjectTypes endpoint)}}}>
diff --git a/src/generators/utils/generate-files.utils.ts b/src/generators/utils/generate-files.utils.ts
@@ -17,7 +17,7 @@ import { GenerateData, GenerateFile, GenerateFileData } from "src/generators/typ
 import { getOutputFileName, readAssetSync } from "./file.utils";
 import { getFileNameWithExtension } from "./generate/generate.utils";
 
-export function getAclFiles(appAclTags: string[], resolver: SchemaResolver): GenerateFileData[] {
+export function getAclFiles(data: GenerateData, resolver: SchemaResolver): GenerateFileData[] {
   if (!resolver.options.acl) {
     return [];
   }
@@ -28,7 +28,7 @@ export function getAclFiles(appAclTags: string[], resolver: SchemaResolver): Gen
         output: resolver.options.output,
         fileName: getFileNameWithExtension(ACL_APP_ABILITY_FILE),
       }),
-      content: generateAppAcl(resolver, appAclTags),
+      content: generateAppAcl({ resolver, data }),
     },
     ...(resolver.options.checkAcl
       ? [
diff --git a/src/generators/utils/generate/generate.acl.utils.ts b/src/generators/utils/generate/generate.acl.utils.ts
@@ -1,14 +1,13 @@
-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 "src/generators/types/endpoint";
+import { GenerateType, GenerateTypeParams, Import } from "src/generators/types/generate";
+import { GenerateOptions } from "src/generators/types/options";
 import { capitalize, snakeToCamel } from "src/generators/utils/string.utils";
+
+import { getUniqueArray } from "src/generators/utils/array.utils";
 import { getEndpointTag } from "./generate.endpoints.utils";
+import { getModelsImports, mergeImports } from "./generate.imports.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))}`;
 
@@ -25,8 +24,91 @@ export const getAbilitySubject = (endpoint: Endpoint) => endpoint.acl?.[0].subje
 
 export const hasAbilityConditions = (endpoint: Endpoint) => !!getAbilityConditionsTypes(endpoint)?.length;
 
-export const getAbilityConditionsTypes = (endpoint: Endpoint) => endpoint.acl?.[0].conditionsTypes;
+export const getAbilityConditionsTypes = (endpoint: Endpoint) =>
+  endpoint.acl?.[0].conditionsTypes?.sort((a, b) => a.name.localeCompare(b.name));
 
 export const getAbilityDescription = (endpoint: Endpoint) => endpoint.acl?.[0].description;
 
-export const getTagAllAbilitiesName = (tag: string) => `${capitalize(tag)}${ACL_ALL_ABILITIES}`;
+export const getAbilitySubjectTypes = (endpoint: Endpoint) => {
+  const abilitySubject = getAbilitySubject(endpoint);
+  const types: string[] = [`"${abilitySubject ?? ""}"`];
+
+  if (hasAbilityConditions(endpoint)) {
+    types.push(
+      `ForcedSubject<"${abilitySubject}"> & { ${getAbilityConditionsTypes(endpoint)
+        ?.map(
+          (conditionType) =>
+            `${conditionType.name}${conditionType.required ? "" : "?"}: ${conditionType.type ?? ""}${conditionType.zodSchemaName ?? ""},`,
+        )
+        .join(" ")} }`,
+    );
+  }
+
+  return types;
+};
+
+export function getAclData({ resolver, data, tag = "" }: GenerateTypeParams) {
+  const endpoints = data.get(tag)?.endpoints.filter(({ acl }) => acl && acl.length > 0);
+  if (!endpoints || endpoints.length === 0) {
+    return;
+  }
+
+  const hasAdditionalAbilityImports = endpoints.some(
+    ({ acl }) => acl?.[0].conditions && Object.keys(acl[0].conditions).length > 0,
+  );
+
+  const aclZodSchemas = endpoints.reduce((acc, endpoint) => {
+    const zodSchemas = endpoint.acl?.[0].conditionsTypes?.reduce(
+      (acc, propertyType) => [...acc, ...(propertyType?.zodSchemaName ? [propertyType.zodSchemaName] : [])],
+      [] as string[],
+    );
+    return [...acc, ...(zodSchemas ?? [])];
+  }, [] as string[]);
+
+  const modelsImports = getModelsImports({
+    resolver,
+    tag,
+    zodSchemasAsTypes: getUniqueArray(aclZodSchemas),
+  });
+
+  return { endpoints, hasAdditionalAbilityImports, modelsImports };
+}
+
+export const getAppAbilitiesType = ({ resolver, data }: Omit<GenerateTypeParams, "tag">) => {
+  const appAbilitiesTypeMap: Map<string, Set<string>> = new Map();
+  const modelsImportsArr: Import[][] = [];
+  let hasAdditionalAbilityImports = false;
+
+  data.forEach((_, tag) => {
+    const aclData = getAclData({ resolver, data, tag });
+    if (!aclData) {
+      return;
+    }
+
+    const {
+      modelsImports: tagModelsImports,
+      hasAdditionalAbilityImports: tagHasAdditionalAbilityImports,
+      endpoints,
+    } = aclData;
+
+    modelsImportsArr.push(tagModelsImports);
+    hasAdditionalAbilityImports = hasAdditionalAbilityImports || tagHasAdditionalAbilityImports;
+
+    endpoints.forEach((endpoint) => {
+      const abilityAction = getAbilityAction(endpoint);
+      if (abilityAction) {
+        appAbilitiesTypeMap.set(
+          abilityAction,
+          new Set([...(appAbilitiesTypeMap.get(abilityAction) ?? []), ...getAbilitySubjectTypes(endpoint)]),
+        );
+      }
+    });
+  });
+
+  const modelsImports = mergeImports(resolver.options, ...modelsImportsArr);
+  const appAbilitiesType = Object.fromEntries(
+    Array.from(appAbilitiesTypeMap.entries()).map(([key, valueSet]) => [key, Array.from(valueSet)]),
+  );
+
+  return { appAbilitiesType, modelsImports, hasAdditionalAbilityImports };
+};
diff --git a/src/generators/utils/hbs/hbs.acl.utils.ts b/src/generators/utils/hbs/hbs.acl.utils.ts
@@ -8,38 +8,31 @@ import {
   getAbilityDescription,
   getAbilityFunctionName,
   getAbilitySubject,
-  getAbilityTypeName,
+  getAbilitySubjectTypes,
   getImportedAbilityFunctionName,
-  getTagAllAbilitiesName,
   hasAbilityConditions,
 } from "src/generators/utils/generate/generate.acl.utils";
 
 enum AclHelpers {
-  AbilityTypeName = "abilityTypeName",
   AbilityFunctionName = "abilityFunctionName",
   ImportedAbilityFunctionName = "importedAbilityFunctionName",
   AbilityAction = "ablityAction",
   AbilitySubject = "ablitySubject",
   HasAbilityConditions = "hasAbilityConditions",
   AbilityConditionsTypes = "abilityConditionsTypes",
   AbilityDescription = "abilityDescription",
-  TagAllAbilitiesName = "tagAllAbilitiesName",
+  AbilitySubjectTypes = "abilitySubjectTypes",
 }
 
 export function registerAclHbsHelpers(resolver: SchemaResolver) {
-  registerAbilityTypeNameHelper();
   registerAbilityFunctionNameHelper();
   registerImportedAbilityFunctionNameHelper(resolver.options);
   registerAbilityActionHelper();
   registerAbilitySubjectHelper();
   registerHasAbilityConditionsHelper();
   registerAbilityConditionsTypesHelper();
   registerAbilityDescriptionHelper();
-  registerTagAllAbilitiesNameHelper();
-}
-
-function registerAbilityTypeNameHelper() {
-  Handlebars.registerHelper(AclHelpers.AbilityTypeName, getAbilityTypeName);
+  registerAbilitySubjectTypesHelper();
 }
 
 function registerAbilityFunctionNameHelper() {
@@ -72,6 +65,6 @@ function registerAbilityDescriptionHelper() {
   Handlebars.registerHelper(AclHelpers.AbilityDescription, getAbilityDescription);
 }
 
-function registerTagAllAbilitiesNameHelper() {
-  Handlebars.registerHelper(AclHelpers.TagAllAbilitiesName, getTagAllAbilitiesName);
+function registerAbilitySubjectTypesHelper() {
+  Handlebars.registerHelper(AclHelpers.AbilitySubjectTypes, getAbilitySubjectTypes);
 }
diff --git a/src/generators/utils/hbs/hbs.common.utils.ts b/src/generators/utils/hbs/hbs.common.utils.ts
diff --git a/src/generators/utils/hbs/hbs.partials.utils.ts b/src/generators/utils/hbs/hbs.partials.utils.ts
diff --git a/test/config.ts b/test/config.ts

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": "1.0.3",`
	`3`	`+ "version": "1.1.0",`
`4`	`4`	`"main": "./dist/index.js",`
`5`	`5`	`"bin": {`
`6`	`6`	`"openapi-codegen": "./dist/sh.js"`