fix: make @CASL peerDependencies optional (#48)

* fix: make @CASL peerDependencies optional

* chore: update lock file

* chore: bump version

* chore: update readme

* chore: update package version

Author: tadejrebernjak

README.md

@@ -4,7 +4,7 @@
 
 **NOTE:** Version 1+ requires zod v4 and is not compatible with zod v3.
 
-**NOTE:** Version 2+ includes supporting classes/types/components for the generated code as well as auth, therefore it has peerDependencies for @casl/ability, @casl/react, @tanstack/react-query, axios, react and zod.
+**NOTE:** Version 2+ includes supporting classes/types/components for the generated code as well as auth, therefore it has peerDependencies for @tanstack/react-query, axios, react and zod. @casl/ability and @casl/react are also required if you are generating ACL checks and/or using imports from "@povio/openapi-codegen-cli/acl"!
 
 Use this tool to generate code (Zod schemas, TypeScript types, API definitions, and React queries) from an OpenAPI v3 specification. API definitions are generated to use a REST client wrapper that utilizes Axios. React queries are generated in alignment with our code standards, without the need for explicit types.
 

esbuild.mjs

@@ -45,3 +45,4 @@ const clientBuildOptions = {
 await build({ ...nodeBuildOptions, entryPoints: ["./src/sh.ts"], outfile: "./dist/sh.js" });
 await build({ ...nodeBuildOptions, entryPoints: ["./src/generator.ts"], outfile: "./dist/generator.js" });
 await build({ ...clientBuildOptions, entryPoints: ["./src/index.ts"], outfile: "./dist/index.js" });
+await build({ ...clientBuildOptions, entryPoints: ["./src/acl.ts"], outfile: "./dist/acl.js" });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -13,6 +13,11 @@
       "types": "./dist/generator.d.ts",
       "import": "./dist/generator.js",
       "require": "./dist/generator.js"
+    },
+    "./acl": {
+      "types": "./dist/acl.d.ts",
+      "import": "./dist/acl.js",
+      "require": "./dist/acl.js"
     }
   },
   "bin": {
@@ -64,6 +69,14 @@
     "react": "^19.1.0",
     "zod": "^4.1.12"
   },
+  "peerDependenciesMeta": {
+    "@casl/ability": {
+      "optional": true
+    },
+    "@casl/react": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@casl/ability": "^6.7.3",

src/acl.ts

@@ -0,0 +1,5 @@
+// ACL exports - requires @casl/ability and @casl/react peer dependencies
+export { AbilityContext } from "./lib/acl/ability.context";
+export { createAclGuard } from "./lib/acl/AclGuard";
+export { Can } from "./lib/acl/Can";
+export type { AppAbilities, AppAbility } from "./lib/acl/appAbility.types";

src/generators/const/deps.const.ts

@@ -1,5 +1,5 @@
 import { GenerateFile, Import } from "src/generators/types/generate";
-import { PACKAGE_IMPORT_PATH } from "./package.const";
+import { ACL_PACKAGE_IMPORT_PATH, PACKAGE_IMPORT_PATH } from "./package.const";
 
 export const APP_REST_CLIENT_NAME = "AppRestClient";
 export const APP_REST_CLIENT_FILE: GenerateFile = { fileName: "app-rest-client", extension: "ts" };
@@ -23,7 +23,7 @@ export const ERROR_HANDLING_IMPORT: Import = {
 export const ABILITY_CONTEXT = "AbilityContext";
 export const ABILITY_CONTEXT_IMPORT: Import = {
   bindings: [ABILITY_CONTEXT],
-  from: PACKAGE_IMPORT_PATH,
+  from: ACL_PACKAGE_IMPORT_PATH,
 };
 export const BUILDERS_UTILS = {
   dynamicInputs: "dynamicInputs",

src/generators/const/package.const.ts

@@ -1 +1,2 @@
 export const PACKAGE_IMPORT_PATH = "@povio/openapi-codegen-cli";
+export const ACL_PACKAGE_IMPORT_PATH = "@povio/openapi-codegen-cli/acl";

src/index.ts

@@ -24,9 +24,3 @@ export { OpenApiQueryConfig } from "./lib/config/queryConfig.context";
 export { AuthContext } from "./lib/auth/auth.context";
 export { AuthGuard } from "./lib/auth/AuthGuard";
 export type { AuthGuardProps } from "./lib/auth/AuthGuard";
-
-// ACL
-export { AbilityContext } from "./lib/acl/ability.context";
-export { createAclGuard } from "./lib/acl/AclGuard";
-export { Can } from "./lib/acl/Can";
-export type { AppAbilities, AppAbility } from "./lib/acl/appAbility.types";

yarn.lock

@@ -672,6 +672,11 @@ __metadata:
     axios: ^1.13.1
     react: ^19.1.0
     zod: ^4.1.12
+  peerDependenciesMeta:
+    "@casl/ability":
+      optional: true
+    "@casl/react":
+      optional: true
   bin:
     openapi-codegen: ./dist/sh.js
   languageName: unknown