@jperezmart/nest-casl-testing 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Javier Pérez Martín
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,33 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _casl_ability = require("@casl/ability");
+//#region src/index.ts
+/**
+* Build a CASL ability directly from a permissions map and a user, without
+* booting a Nest application. Intended for unit-testing permission definitions
+* in projects that consume `@jperezmart/nest-casl`.
+*
+* @example
+* ```ts
+* const ability = buildAbilityForTest(permissions, { id: "1", roles: ["author"] });
+* expect(ability.can("update", subject("Article", { authorId: "1" }))).toBe(true);
+* ```
+*/
+function buildAbilityForTest(permissions, user, options = {}) {
+	const builder = new _casl_ability.AbilityBuilder(_casl_ability.createMongoAbility);
+	const buildOptions = options.detectSubjectType ? { detectSubjectType: options.detectSubjectType } : void 0;
+	const roles = Array.isArray(user.roles) ? user.roles : [];
+	if (options.superuserRole !== void 0 && roles.includes(options.superuserRole)) {
+		builder.can("manage", "all");
+		return builder.build(buildOptions);
+	}
+	for (const role of roles) {
+		const definition = permissions[role];
+		if (definition === true) builder.can("manage", "all");
+		else if (typeof definition === "function") definition(user, builder);
+	}
+	return builder.build(buildOptions);
+}
+//#endregion
+exports.buildAbilityForTest = buildAbilityForTest;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["AbilityBuilder","createMongoAbility"],"sources":["../src/index.ts"],"sourcesContent":["import type { AnyAbility, MongoAbility } from '@casl/ability';\nimport { AbilityBuilder, createMongoAbility } from '@casl/ability';\nimport type {\n  AuthorizableUser,\n  DefinePermissions,\n  Permissions,\n} from '@jperezmart/nest-casl';\n\n/** Extra options accepted by {@link buildAbilityForTest}. */\nexport interface BuildAbilityForTestOptions<Roles extends string = string> {\n  /** Role that bypasses all checks (mirrors `CaslModule.forRoot`). */\n  superuserRole?: Roles;\n\n  /** Custom subject-type detection (mirrors `CaslModule.forRoot`). */\n  detectSubjectType?: (subject: object) => string;\n}\n\n/**\n * Build a CASL ability directly from a permissions map and a user, without\n * booting a Nest application. Intended for unit-testing permission definitions\n * in projects that consume `@jperezmart/nest-casl`.\n *\n * @example\n * ```ts\n * const ability = buildAbilityForTest(permissions, { id: \"1\", roles: [\"author\"] });\n * expect(ability.can(\"update\", subject(\"Article\", { authorId: \"1\" }))).toBe(true);\n * ```\n */\nexport function buildAbilityForTest<\n  Roles extends string = string,\n  TUser extends AuthorizableUser<Roles> = AuthorizableUser<Roles>,\n  TAbility extends AnyAbility = AnyAbility,\n>(\n  permissions: Permissions<Roles, TUser, TAbility>,\n  user: TUser,\n  options: BuildAbilityForTestOptions<Roles> = {},\n): TAbility {\n  const builder = new AbilityBuilder<MongoAbility>(createMongoAbility);\n  const buildOptions = options.detectSubjectType\n    ? { detectSubjectType: options.detectSubjectType }\n    : undefined;\n\n  // Mirror AbilityFactory: a missing / non-array `roles` means \"no roles\".\n  const roles: string[] = Array.isArray(user.roles) ? user.roles : [];\n\n  if (\n    options.superuserRole !== undefined &&\n    roles.includes(options.superuserRole)\n  ) {\n    builder.can('manage', 'all');\n    return builder.build(buildOptions) as unknown as TAbility;\n  }\n\n  for (const role of roles) {\n    const definition = (permissions as Record<string, unknown>)[role];\n    if (definition === true) {\n      builder.can('manage', 'all');\n    } else if (typeof definition === 'function') {\n      (definition as DefinePermissions<TUser, AnyAbility>)(\n        user,\n        builder as unknown as AbilityBuilder<AnyAbility>,\n      );\n    }\n  }\n\n  return builder.build(buildOptions) as unknown as TAbility;\n}\n"],"mappings":";;;;;;;;;;;;;;AA4BA,SAAgB,oBAKd,aACA,MACA,UAA6C,CAAC,GACpC;CACV,MAAM,UAAU,IAAIA,cAAAA,eAA6BC,cAAAA,kBAAkB;CACnE,MAAM,eAAe,QAAQ,oBACzB,EAAE,mBAAmB,QAAQ,kBAAkB,IAC/C,KAAA;CAGJ,MAAM,QAAkB,MAAM,QAAQ,KAAK,KAAK,IAAI,KAAK,QAAQ,CAAC;CAElE,IACE,QAAQ,kBAAkB,KAAA,KAC1B,MAAM,SAAS,QAAQ,aAAa,GACpC;EACA,QAAQ,IAAI,UAAU,KAAK;EAC3B,OAAO,QAAQ,MAAM,YAAY;CACnC;CAEA,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,aAAc,YAAwC;EAC5D,IAAI,eAAe,MACjB,QAAQ,IAAI,UAAU,KAAK;OACtB,IAAI,OAAO,eAAe,YAC/B,WACE,MACA,OACF;CAEJ;CAEA,OAAO,QAAQ,MAAM,YAAY;AACnC"}

package/dist/index.d.cts

@@ -0,0 +1,26 @@
+import { AnyAbility } from "@casl/ability";
+import { AuthorizableUser, Permissions } from "@jperezmart/nest-casl";
+
+//#region src/index.d.ts
+/** Extra options accepted by {@link buildAbilityForTest}. */
+interface BuildAbilityForTestOptions<Roles extends string = string> {
+  /** Role that bypasses all checks (mirrors `CaslModule.forRoot`). */
+  superuserRole?: Roles;
+  /** Custom subject-type detection (mirrors `CaslModule.forRoot`). */
+  detectSubjectType?: (subject: object) => string;
+}
+/**
+ * Build a CASL ability directly from a permissions map and a user, without
+ * booting a Nest application. Intended for unit-testing permission definitions
+ * in projects that consume `@jperezmart/nest-casl`.
+ *
+ * @example
+ * ```ts
+ * const ability = buildAbilityForTest(permissions, { id: "1", roles: ["author"] });
+ * expect(ability.can("update", subject("Article", { authorId: "1" }))).toBe(true);
+ * ```
+ */
+declare function buildAbilityForTest<Roles extends string = string, TUser extends AuthorizableUser<Roles> = AuthorizableUser<Roles>, TAbility extends AnyAbility = AnyAbility>(permissions: Permissions<Roles, TUser, TAbility>, user: TUser, options?: BuildAbilityForTestOptions<Roles>): TAbility;
+//#endregion
+export { BuildAbilityForTestOptions, buildAbilityForTest };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;UASiB,0BAAA;EAAA;EAEf,aAAA,GAAgB,KAAK;EAFoB;EAKzC,iBAAA,IAAqB,OAAA;AAAA;;;;;;AAAe;AActC;;;;;iBAAgB,mBAAA,8CAEA,gBAAA,CAAiB,KAAA,IAAS,gBAAA,CAAiB,KAAA,oBACxC,UAAA,GAAa,UAAA,EAE9B,WAAA,EAAa,WAAA,CAAY,KAAA,EAAO,KAAA,EAAO,QAAA,GACvC,IAAA,EAAM,KAAA,EACN,OAAA,GAAS,0BAAA,CAA2B,KAAA,IACnC,QAAA"}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { AnyAbility } from "@casl/ability";
+import { AuthorizableUser, Permissions } from "@jperezmart/nest-casl";
+
+//#region src/index.d.ts
+/** Extra options accepted by {@link buildAbilityForTest}. */
+interface BuildAbilityForTestOptions<Roles extends string = string> {
+  /** Role that bypasses all checks (mirrors `CaslModule.forRoot`). */
+  superuserRole?: Roles;
+  /** Custom subject-type detection (mirrors `CaslModule.forRoot`). */
+  detectSubjectType?: (subject: object) => string;
+}
+/**
+ * Build a CASL ability directly from a permissions map and a user, without
+ * booting a Nest application. Intended for unit-testing permission definitions
+ * in projects that consume `@jperezmart/nest-casl`.
+ *
+ * @example
+ * ```ts
+ * const ability = buildAbilityForTest(permissions, { id: "1", roles: ["author"] });
+ * expect(ability.can("update", subject("Article", { authorId: "1" }))).toBe(true);
+ * ```
+ */
+declare function buildAbilityForTest<Roles extends string = string, TUser extends AuthorizableUser<Roles> = AuthorizableUser<Roles>, TAbility extends AnyAbility = AnyAbility>(permissions: Permissions<Roles, TUser, TAbility>, user: TUser, options?: BuildAbilityForTestOptions<Roles>): TAbility;
+//#endregion
+export { BuildAbilityForTestOptions, buildAbilityForTest };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;UASiB,0BAAA;EAAA;EAEf,aAAA,GAAgB,KAAK;EAFoB;EAKzC,iBAAA,IAAqB,OAAA;AAAA;;;;;;AAAe;AActC;;;;;iBAAgB,mBAAA,8CAEA,gBAAA,CAAiB,KAAA,IAAS,gBAAA,CAAiB,KAAA,oBACxC,UAAA,GAAa,UAAA,EAE9B,WAAA,EAAa,WAAA,CAAY,KAAA,EAAO,KAAA,EAAO,QAAA,GACvC,IAAA,EAAM,KAAA,EACN,OAAA,GAAS,0BAAA,CAA2B,KAAA,IACnC,QAAA"}

package/dist/index.js

@@ -0,0 +1,32 @@
+import { AbilityBuilder, createMongoAbility } from "@casl/ability";
+//#region src/index.ts
+/**
+* Build a CASL ability directly from a permissions map and a user, without
+* booting a Nest application. Intended for unit-testing permission definitions
+* in projects that consume `@jperezmart/nest-casl`.
+*
+* @example
+* ```ts
+* const ability = buildAbilityForTest(permissions, { id: "1", roles: ["author"] });
+* expect(ability.can("update", subject("Article", { authorId: "1" }))).toBe(true);
+* ```
+*/
+function buildAbilityForTest(permissions, user, options = {}) {
+	const builder = new AbilityBuilder(createMongoAbility);
+	const buildOptions = options.detectSubjectType ? { detectSubjectType: options.detectSubjectType } : void 0;
+	const roles = Array.isArray(user.roles) ? user.roles : [];
+	if (options.superuserRole !== void 0 && roles.includes(options.superuserRole)) {
+		builder.can("manage", "all");
+		return builder.build(buildOptions);
+	}
+	for (const role of roles) {
+		const definition = permissions[role];
+		if (definition === true) builder.can("manage", "all");
+		else if (typeof definition === "function") definition(user, builder);
+	}
+	return builder.build(buildOptions);
+}
+//#endregion
+export { buildAbilityForTest };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { AnyAbility, MongoAbility } from '@casl/ability';\nimport { AbilityBuilder, createMongoAbility } from '@casl/ability';\nimport type {\n  AuthorizableUser,\n  DefinePermissions,\n  Permissions,\n} from '@jperezmart/nest-casl';\n\n/** Extra options accepted by {@link buildAbilityForTest}. */\nexport interface BuildAbilityForTestOptions<Roles extends string = string> {\n  /** Role that bypasses all checks (mirrors `CaslModule.forRoot`). */\n  superuserRole?: Roles;\n\n  /** Custom subject-type detection (mirrors `CaslModule.forRoot`). */\n  detectSubjectType?: (subject: object) => string;\n}\n\n/**\n * Build a CASL ability directly from a permissions map and a user, without\n * booting a Nest application. Intended for unit-testing permission definitions\n * in projects that consume `@jperezmart/nest-casl`.\n *\n * @example\n * ```ts\n * const ability = buildAbilityForTest(permissions, { id: \"1\", roles: [\"author\"] });\n * expect(ability.can(\"update\", subject(\"Article\", { authorId: \"1\" }))).toBe(true);\n * ```\n */\nexport function buildAbilityForTest<\n  Roles extends string = string,\n  TUser extends AuthorizableUser<Roles> = AuthorizableUser<Roles>,\n  TAbility extends AnyAbility = AnyAbility,\n>(\n  permissions: Permissions<Roles, TUser, TAbility>,\n  user: TUser,\n  options: BuildAbilityForTestOptions<Roles> = {},\n): TAbility {\n  const builder = new AbilityBuilder<MongoAbility>(createMongoAbility);\n  const buildOptions = options.detectSubjectType\n    ? { detectSubjectType: options.detectSubjectType }\n    : undefined;\n\n  // Mirror AbilityFactory: a missing / non-array `roles` means \"no roles\".\n  const roles: string[] = Array.isArray(user.roles) ? user.roles : [];\n\n  if (\n    options.superuserRole !== undefined &&\n    roles.includes(options.superuserRole)\n  ) {\n    builder.can('manage', 'all');\n    return builder.build(buildOptions) as unknown as TAbility;\n  }\n\n  for (const role of roles) {\n    const definition = (permissions as Record<string, unknown>)[role];\n    if (definition === true) {\n      builder.can('manage', 'all');\n    } else if (typeof definition === 'function') {\n      (definition as DefinePermissions<TUser, AnyAbility>)(\n        user,\n        builder as unknown as AbilityBuilder<AnyAbility>,\n      );\n    }\n  }\n\n  return builder.build(buildOptions) as unknown as TAbility;\n}\n"],"mappings":";;;;;;;;;;;;;AA4BA,SAAgB,oBAKd,aACA,MACA,UAA6C,CAAC,GACpC;CACV,MAAM,UAAU,IAAI,eAA6B,kBAAkB;CACnE,MAAM,eAAe,QAAQ,oBACzB,EAAE,mBAAmB,QAAQ,kBAAkB,IAC/C,KAAA;CAGJ,MAAM,QAAkB,MAAM,QAAQ,KAAK,KAAK,IAAI,KAAK,QAAQ,CAAC;CAElE,IACE,QAAQ,kBAAkB,KAAA,KAC1B,MAAM,SAAS,QAAQ,aAAa,GACpC;EACA,QAAQ,IAAI,UAAU,KAAK;EAC3B,OAAO,QAAQ,MAAM,YAAY;CACnC;CAEA,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,aAAc,YAAwC;EAC5D,IAAI,eAAe,MACjB,QAAQ,IAAI,UAAU,KAAK;OACtB,IAAI,OAAO,eAAe,YAC/B,WACE,MACA,OACF;CAEJ;CAEA,OAAO,QAAQ,MAAM,YAAY;AACnC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@jperezmart/nest-casl-testing",
+  "version": "0.1.0",
+  "description": "Testing utilities for @jperezmart/nest-casl — build and assert abilities without booting Nest.",
+  "license": "MIT",
+  "author": "Javier Pérez Martín <javier.perez.martin97@gmail.com>",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "@casl/ability": "^7.0.0",
+    "eslint": "^10.3.0",
+    "tsdown": "^0.22.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9",
+    "@jperezmart/eslint-config": "0.0.0",
+    "@jperezmart/nest-casl": "0.1.0",
+    "@jperezmart/typescript-config": "0.0.0"
+  },
+  "peerDependencies": {
+    "@casl/ability": "^7.0.0",
+    "@jperezmart/nest-casl": "^0.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rm -rf dist .turbo *.tsbuildinfo",
+    "dev": "tsdown --watch",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}