@unchainedshop/roles 4.3.4 → 4.5.0

package/README.md

@@ -1,5 +1,111 @@
-# Roles (Unchained Engine)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/roles.svg)](https://npmjs.com/package/@unchainedshop/roles)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
 
-This package delivers inner logic for the ACL layer of all Unchained API's.
+# @unchainedshop/roles
+
+Role-based access control (RBAC) system for the Unchained Engine. Provides fine-grained permission management for API operations.
 
 Thanks to Nicolás López for the initial version of Roles: https://github.com/nicolaslopezj/roles
+
+## Installation
+
+```bash
+npm install @unchainedshop/roles
+```
+
+## Usage
+
+```typescript
+import { Roles, Role } from '@unchainedshop/roles';
+
+// Create a new role
+const editorRole = new Role('editor');
+
+// Allow actions for the role
+editorRole.allow('updateProduct', async (product, params, context) => {
+  // Return true if allowed, false otherwise
+  return context.userId != null;
+});
+
+// Check if a user has permission
+const allowed = await Roles.userHasPermission(
+  { userId: 'user-123', user: { roles: ['editor'] } },
+  'updateProduct',
+  [productObject, {}]
+);
+```
+
+## API Overview
+
+### Roles Singleton
+
+| Method | Description |
+|--------|-------------|
+| `Roles.registerAction` | Register a new action name |
+| `Roles.registerHelper` | Register a new helper name |
+| `Roles.getUserRoles` | Get user roles including special roles |
+| `Roles.allow` | Check if any role allows an action |
+| `Roles.userHasPermission` | Check if user has permission for action |
+
+### Role Class
+
+| Method | Description |
+|--------|-------------|
+| `new Role(name)` | Create and register a new role |
+| `role.allow(action, fn)` | Add allow rule for an action |
+| `role.helper(name, fn)` | Add helper function to role |
+
+### Built-in Roles
+
+| Role | Description |
+|------|-------------|
+| `Roles.adminRole` | Admin role with elevated privileges |
+| `Roles.loggedInRole` | Applied to all logged-in users (`__loggedIn__`) |
+| `Roles.allRole` | Applied to all users (`__all__`) |
+
+### Special Internal Roles
+
+| Role | Description |
+|------|-------------|
+| `__all__` | Automatically assigned to everyone |
+| `__loggedIn__` | Automatically assigned to authenticated users |
+| `__notLoggedIn__` | Automatically assigned to anonymous users |
+| `__notAdmin__` | Automatically assigned to non-admin users |
+
+### Utility Functions
+
+| Export | Description |
+|--------|-------------|
+| `has` | Check if object has property |
+| `isFunction` | Check if value is a function |
+| `permissions` | Permission constants and helpers |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `RolesInterface` | Interface for the Roles singleton |
+| `RoleInterface` | Interface for Role instances |
+| `RoleInterfaceFactory` | Factory type for Role class |
+| `IRoleOptionConfig` | Configuration options for roles |
+| `CheckPermissionArgs` | Arguments tuple for permission checks |
+
+## Configuration
+
+```typescript
+import type { IRoleOptionConfig } from '@unchainedshop/roles';
+
+const config: IRoleOptionConfig = {
+  additionalRoles: {
+    customRole: (roles, actions) => {
+      const role = new Role('customRole');
+      role.allow(actions.READ, () => true);
+    },
+  },
+  additionalActions: ['CUSTOM_ACTION'],
+};
+```
+
+## License
+
+EUPL-1.2

package/lib/roles-index.d.ts

@@ -1,5 +1,4 @@
-export * from './roles.js';
-export { has } from './utils/has.js';
-export { isFunction } from './utils/isFunction.js';
-export { permissions } from './utils/permissions.js';
-//# sourceMappingURL=roles-index.d.ts.map
+export * from './roles.ts';
+export { has } from './utils/has.ts';
+export { isFunction } from './utils/isFunction.ts';
+export { permissions } from './utils/permissions.ts';

package/lib/roles-index.js

@@ -1,5 +1,4 @@
-export * from './roles.js';
-export { has } from './utils/has.js';
-export { isFunction } from './utils/isFunction.js';
-export { permissions } from './utils/permissions.js';
-//# sourceMappingURL=roles-index.js.map
+export * from "./roles.js";
+export { has } from "./utils/has.js";
+export { isFunction } from "./utils/isFunction.js";
+export { permissions } from "./utils/permissions.js";

package/lib/roles.d.ts

@@ -34,22 +34,12 @@ export interface IRoleOptionConfig {
     additionalActions?: string[];
 }
 export declare const Roles: RolesInterface;
-/**
- * Constructs a new role
- */
 export declare class Role implements RoleInterface {
     name: string;
     allowRules: Record<string, any>;
     helpers: Record<string, any>;
     constructor(name: string);
-    /**
-     * Adds a helper to a role
-     */
     helper(helper: string, func: any): void;
-    /**
-     * Adds allow properties to a role
-     */
     allow(action: any, allow: any): void;
 }
 export {};
-//# sourceMappingURL=roles.d.ts.map

package/lib/roles.js

@@ -1,28 +1,19 @@
-import { has } from './utils/has.js';
-import { isFunction } from './utils/isFunction.js';
+import { has } from "./utils/has.js";
+import { isFunction } from "./utils/isFunction.js";
 export const Roles = {
     roles: {},
     actions: [],
     helpers: [],
-    /**
-     * Creates a new action
-     */
     registerAction(name) {
         if (!this.actions.includes(name)) {
             this.actions.push(name);
         }
     },
-    /**
-     * Creates a new helper
-     */
     registerHelper(name) {
         if (!this.helpers.includes(name)) {
             this.helpers.push(name);
         }
     },
-    /**
-     * Get user roles
-     */
     getUserRoles(userId, roles, includeSpecial) {
         const newRoles = [...(roles || [])];
         if (includeSpecial) {
@@ -39,9 +30,6 @@ export const Roles = {
         }
         return newRoles;
     },
-    /**
-     * Returns true if the user passes the allow check
-     */
     async allow(context, roles, action, [obj, params]) {
         const userRoles = Roles.getUserRoles(context.userId, roles, true);
         return userRoles.reduce(async (roleIsAllowedPromise, role) => {
@@ -59,33 +47,24 @@ export const Roles = {
             return roleIsAllowed;
         }, Promise.resolve(false));
     },
-    /**
-     * To check if a user has permisisons to execute an action
-     */
     userHasPermission: async (context, action, args) => {
         const roles = Array.isArray(context.user?.roles) ? context.user.roles : [];
         const allows = await Roles.allow(context, roles, action, args);
         return allows === true;
     },
 };
-/**
- * Constructs a new role
- */
 export class Role {
     name;
     allowRules;
     helpers;
     constructor(name) {
-        this.name = name;
         if (has(Roles.roles, name))
             throw new Error(`"${name}" role is already defined`);
+        this.name = name;
         this.allowRules = {};
         this.helpers = {};
         Roles.roles[name] = this;
     }
-    /**
-     * Adds a helper to a role
-     */
     helper(helper, func) {
         if (!Roles.helpers.includes(helper)) {
             Roles.registerHelper(helper);
@@ -102,9 +81,6 @@ export class Role {
         }
         this.helpers[helper].push(helperFn);
     }
-    /**
-     * Adds allow properties to a role
-     */
     allow(action, allow) {
         if (!action) {
             throw new Error(`Action doesn't exist`);
@@ -123,16 +99,6 @@ export class Role {
         this.allowRules[action].push(allowFn);
     }
 }
-/**
- * The admin role, who recives the default actions.
- */
 Roles.adminRole = new Role('admin');
-/**
- * All the logged in users users
- */
 Roles.loggedInRole = new Role('__loggedIn__');
-/**
- * Always, no exception
- */
 Roles.allRole = new Role('__all__');
-//# sourceMappingURL=roles.js.map

package/lib/utils/has.d.ts

@@ -1,2 +1 @@
 export declare const has: (obj: Record<string, any>, key: string) => boolean;
-//# sourceMappingURL=has.d.ts.map

package/lib/utils/has.js

@@ -5,4 +5,3 @@ export const has = (obj, key) => {
             ? has(obj[key.split('.')[0]], keyParts.slice(1).join('.'))
             : obj.hasOwnProperty.call(obj, key)));
 };
-//# sourceMappingURL=has.js.map

package/lib/utils/isFunction.d.ts

@@ -1,2 +1 @@
 export declare const isFunction: (func: () => any) => boolean;
-//# sourceMappingURL=isFunction.d.ts.map

package/lib/utils/isFunction.js

@@ -1,4 +1,3 @@
 export const isFunction = (func) => {
     return func && typeof func === 'function';
 };
-//# sourceMappingURL=isFunction.js.map

package/lib/utils/permissions.d.ts

@@ -1,2 +1 @@
 export declare const permissions: (userRoles: any, allRoles: any) => Promise<any[]>;
-//# sourceMappingURL=permissions.d.ts.map

package/lib/utils/permissions.js

@@ -6,8 +6,6 @@ export const permissions = async (userRoles, allRoles) => {
         return Object.entries(foundRole.allowRules || {}).flatMap(([roleName, funcs]) => {
             return funcs.map(async (f) => {
                 try {
-                    // return permissions that are by default activated for that role,
-                    // accidentally don't check context
                     const r = await f(null, null, null);
                     if (r)
                         return roleName;
@@ -22,4 +20,3 @@ export const permissions = async (userRoles, allRoles) => {
     const resolvedActions = await Promise.all(actions);
     return [...new Set(resolvedActions)].filter(Boolean).toSorted((a, b) => a.localeCompare(b));
 };
-//# sourceMappingURL=permissions.js.map

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@unchainedshop/roles",
-  "version": "4.3.4",
+  "version": "4.5.0",
   "description": "Roles package for unchained engine",
   "main": "lib/roles-index.js",
   "types": "lib/roles-index.d.ts",
   "type": "module",
+  "sideEffects": false,
   "scripts": {
     "clean": "tsc -b --clean",
     "build": "tsc -b",
     "prepublishOnly": "npm run clean && npm run build",
     "watch": "tsc -w",
-    "test": "tsx --test",
-    "test:watch": "tsx --test --watch"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "repository": {
     "type": "git",
@@ -22,8 +23,10 @@
     "ecommerce"
   ],
   "authors": [
-    "Joël Meiller",
-    "Pascal Kaufmann"
+    "Pascal Kaufmann",
+    "Mikael Araya",
+    "Vedran Rudelj",
+    "Joël Meiller"
   ],
   "license": "EUPL-1.2",
   "bugs": {
@@ -31,7 +34,7 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "devDependencies": {
-    "@types/node": "^24.0.13",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

package/lib/roles-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"roles-index.d.ts","sourceRoot":"","sources":["../src/roles-index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/roles-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"roles-index.js","sourceRoot":"","sources":["../src/roles-index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/roles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAGA,UAAU,eAAe;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AACD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACvG,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,EAAE,MAAM,KAAK,aAAa,CAAC;AAEtE,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;AAE5D,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC;IACjF,KAAK,CACH,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,MAAM,EAAE,EACf,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,iBAAiB,CACf,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACvG,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;IAClG,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,eAAO,MAAM,KAAK,EAAE,cA6EnB,CAAC;AAEF;;GAEG;AACH,qBAAa,IAAK,YAAW,aAAa;IAKrB,IAAI,EAAE,MAAM;IAJ/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAEV,IAAI,EAAE,MAAM;IAS/B;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAqBhC;;OAEG;IACH,KAAK,CAAC,MAAM,KAAA,EAAE,KAAK,KAAA;CAiBpB"}

package/lib/roles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"roles.js","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAoDnD,MAAM,CAAC,MAAM,KAAK,GAAmB;IACnC,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX;;OAEG;IACH,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,cAAc;QACxC,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QACpC,IAAI,cAAc,EAAE,CAAC;YACnB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAc,EAAE,CAAC,GAAG,EAAE,MAAM,CAAM;QAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAEnE,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,oBAAsC,EAAE,IAAI,EAAE,EAAE;YAC7E,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAAC;YAEjD,IAAI,aAAa;gBAAE,OAAO,IAAI,CAAC;YAE/B,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9F,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAChD,KAAK,EAAE,qBAAuC,EAAE,OAAY,EAAE,EAAE;oBAC9D,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC;oBAClD,IAAI,aAAa;wBAAE,OAAO,IAAI,CAAC;oBAE/B,OAAO,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;gBACvC,CAAC,EACD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CACvB,CAAC;YACJ,CAAC;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC/D,OAAO,MAAM,KAAK,IAAI,CAAC;IACzB,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,IAAI;IAKI;IAJnB,UAAU,CAAsB;IAEhC,OAAO,CAAsB;IAE7B,YAAmB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;QAC7B,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,2BAA2B,CAAC,CAAC;QAEjF,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAA4B,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,IAAS;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC;QAEpB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;YAC9C,QAAQ,GAAG,GAAG,EAAE;gBACd,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,KAAK;QACjB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;YAC7C,OAAO,GAAG,GAAG,EAAE;gBACb,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACxD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACF;AAED;;GAEG;AACH,KAAK,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,OAAO,CAAyB,CAAC;AAC5D;;GAEG;AACH,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,CAAC,cAAc,CAAyB,CAAC;AACtE;;GAEG;AACH,KAAK,CAAC,OAAO,GAAG,IAAI,IAAI,CAAC,SAAS,CAAyB,CAAC"}

package/lib/utils/has.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"has.d.ts","sourceRoot":"","sources":["../../src/utils/has.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,GAAG,GAAI,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,MAAM,KAAG,OAS3D,CAAC"}

package/lib/utils/has.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"has.js","sourceRoot":"","sources":["../../src/utils/has.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,GAAwB,EAAE,GAAW,EAAW,EAAE;IACpE,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEhC,OAAO,CACL,CAAC,CAAC,GAAG;QACL,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAClB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACvC,CAAC;AACJ,CAAC,CAAC"}

package/lib/utils/isFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"isFunction.d.ts","sourceRoot":"","sources":["../../src/utils/isFunction.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,GAAG,KAAG,OAE5C,CAAC"}

package/lib/utils/isFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isFunction.js","sourceRoot":"","sources":["../../src/utils/isFunction.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAe,EAAW,EAAE;IACrD,OAAO,IAAI,IAAI,OAAO,IAAI,KAAK,UAAU,CAAC;AAC5C,CAAC,CAAC"}

package/lib/utils/permissions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/utils/permissions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAU,WAAW,GAAG,EAAE,UAAU,GAAG,mBAoB9D,CAAC"}

package/lib/utils/permissions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../src/utils/permissions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,SAAc,EAAE,QAAa,EAAE,EAAE;IACjE,MAAM,OAAO,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1C,MAAM,SAAS,GAAQ,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS;YAAE,OAAO,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAM,EAAE,EAAE;YACnF,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAC3B,IAAI,CAAC;oBACH,kEAAkE;oBAClE,mCAAmC;oBACnC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpC,IAAI,CAAC;wBAAE,OAAO,QAAQ,CAAC;oBACvB,OAAO,IAAI,CAAC;gBACd,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC,CAAC"}

package/src/roles-index.ts

@@ -1,5 +0,0 @@
-export * from './roles.js';
-
-export { has } from './utils/has.js';
-export { isFunction } from './utils/isFunction.js';
-export { permissions } from './utils/permissions.js';

package/src/roles.test.ts

@@ -1,295 +0,0 @@
-import { describe, it, beforeEach } from 'node:test';
-import assert from 'node:assert';
-import { isFunction, permissions, has } from './roles-index.js';
-import { Role, Roles } from './roles.js';
-
-describe('Role', () => {
-  beforeEach(() => {
-    Roles.roles = {};
-    Roles.actions = [];
-    Roles.helpers = [];
-  });
-
-  describe('constructor', () => {
-    it('should create a new role with the given name', () => {
-      assert.strictEqual(new Role('admin').name, 'admin');
-    });
-
-    it('should throw an error if a role with the same name already exists', () => {
-      new Role('admin');
-      assert.throws(() => new Role('admin'), /"admin" role is already defined/);
-    });
-  });
-
-  describe('helper', () => {
-    it('should add the helper function to the role', () => {
-      const role = new Role('admin');
-      role.helper('checkPermission', () => true);
-      assert.strictEqual(typeof role.helpers.checkPermission[0], 'function');
-    });
-
-    it('should add the helper to the list of helpers if it does not exist', () => {
-      const role = new Role('admin');
-      role.helper('checkPermission', () => true);
-      assert.deepStrictEqual(Roles.helpers, ['checkPermission']);
-    });
-
-    it('should convert a non-function value to a function that returns that value', () => {
-      const role = new Role('admin');
-      role.helper('checkPermission', true);
-      assert.strictEqual(typeof role.helpers.checkPermission[0], 'function');
-      assert.strictEqual(role.helpers.checkPermission[0](), true);
-    });
-  });
-
-  describe('allow', () => {
-    it('should add the allow function to the role', () => {
-      const role = new Role('admin');
-      role.allow('createUser', () => true);
-      assert.strictEqual(typeof role.allowRules.createUser[0], 'function');
-    });
-
-    it('should add the action to the list of actions if it does not exist', () => {
-      const role = new Role('admin');
-      role.allow('createUser', () => true);
-      assert.deepStrictEqual(Roles.actions, ['createUser']);
-    });
-
-    it('should throw an error if the action does not exist', () => {
-      const role = new Role('admin');
-      assert.throws(() => role.allow(null, () => true), /Action doesn't exist/);
-    });
-
-    it('should convert a non-function value to a function that returns that value', () => {
-      const role = new Role('admin');
-      role.allow('createUser', true);
-      assert.strictEqual(typeof role.allowRules.createUser[0], 'function');
-      assert.strictEqual(role.allowRules.createUser[0](), true);
-    });
-  });
-
-  describe('Role utilities', () => {
-    const testRole = new Role('test_role');
-    const actionName = 'view_secret';
-
-    it('should register an action rule', () => {
-      const allowFn = () => true;
-      testRole.allow(actionName, allowFn);
-      assert.strictEqual(typeof testRole.allowRules[actionName][0], 'function');
-    });
-
-    it('should register a helper', () => {
-      const helperFn = () => true;
-      testRole.helper('test_helper', helperFn);
-      assert.strictEqual(typeof testRole.helpers.test_helper[0], 'function');
-    });
-  });
-
-  describe('Role Helper Registration', () => {
-    it('should add a helper', () => {
-      Roles.registerHelper('test_helper');
-      assert.deepStrictEqual(Roles.helpers, ['test_helper']);
-    });
-
-    it('should add a helper attaching it to adminRole', () => {
-      Roles.registerHelper('test_admin_helper');
-      assert(Roles.helpers.includes('test_admin_helper'));
-    });
-
-    it('should skip adding helper if it already exists', () => {
-      Roles.registerHelper('test_helper');
-      Roles.registerHelper('test_admin_helper');
-      assert(Roles.helpers.includes('test_helper'));
-      assert(Roles.helpers.includes('test_admin_helper'));
-    });
-  });
-
-  describe('Action registration', () => {
-    it('should add an action', () => {
-      Roles.registerAction('test_action');
-      assert.deepStrictEqual(Roles.actions, ['test_action']);
-    });
-
-    it('should skip adding action if it already exists', () => {
-      Roles.registerAction('test_action');
-      assert.deepStrictEqual(Roles.actions, ['test_action']);
-    });
-  });
-
-  describe('Role contruction', () => {
-    it('should construct a new role', () => {
-      assert.equal(new Role('test_role') instanceof Role, true);
-    });
-
-    it('should throw an error if given a role with similar name', () => {
-      new Role('test_role');
-      assert.throws(() => new Role('test_role'));
-    });
-  });
-
-  describe('isFunction', () => {
-    it('should return true given a function', () => {
-      assert.strictEqual(
-        isFunction(() => ({})),
-        true,
-      );
-    });
-
-    it('should return false given an improper function', () => {
-      assert.strictEqual(isFunction('false' as any), false);
-    });
-  });
-
-  describe('has', () => {
-    it('should return true for existent key', () => {
-      const obj = {
-        foo: 'bar',
-      };
-      assert.strictEqual(has(obj, 'foo'), true);
-    });
-
-    it('should return true for existent nested key', () => {
-      const obj = {
-        foo: { bar: 'baz' },
-      };
-      assert.strictEqual(has(obj, 'foo.bar'), true);
-    });
-
-    it('should return false for non existent', () => {
-      const obj = {
-        foo: 'bar',
-      };
-      assert.strictEqual(has(obj, 'baz'), false);
-    });
-  });
-});
-
-describe('permissions', () => {
-  it('should return an empty array if no user roles are provided', async () => {
-    const userRoles = [];
-    const allRoles = {
-      admin: {
-        name: 'admin',
-        allowRules: {
-          createUser: [async () => true, async () => false],
-        },
-      },
-    };
-    const result = await permissions(userRoles, allRoles);
-    assert.deepStrictEqual(result, []);
-  });
-
-  it('should return the correct permissions for a single user role', async () => {
-    const userRoles = ['admin'];
-    const allRoles = {
-      admin: {
-        name: 'admin',
-        allowRules: {
-          createUser: [async () => true, async () => false],
-        },
-      },
-    };
-    const result = await permissions(userRoles, allRoles);
-    assert.deepStrictEqual(result, ['createUser']);
-  });
-
-  it('should return the correct permissions for multiple user roles', async () => {
-    const userRoles = ['admin', 'user'];
-    const allRoles = {
-      admin: {
-        name: 'admin',
-        allowRules: {
-          createUser: [async () => true, async () => false],
-        },
-      },
-      user: {
-        name: 'user',
-        allowRules: {
-          viewUser: [async () => true, async () => false],
-        },
-      },
-    };
-    const result = await permissions(userRoles, allRoles);
-    assert.deepStrictEqual(result, ['createUser', 'viewUser']);
-  });
-
-  it('should return unique and sorted permissions', async () => {
-    const userRoles = ['admin', 'user'];
-    const allRoles = {
-      admin: {
-        name: 'admin',
-        allowRules: {
-          createUser: [async () => true, async () => true],
-          viewUser: [async () => true, async () => false],
-        },
-      },
-      user: {
-        name: 'user',
-        allowRules: {
-          viewUser: [async () => true, async () => true],
-        },
-      },
-    };
-    const result = await permissions(userRoles, allRoles);
-    assert.deepStrictEqual(result, ['createUser', 'viewUser']);
-  });
-});
-
-describe('registerAction', () => {
-  it('should add a new action to the list of actions if it does not already exist', () => {
-    const action = 'createUser';
-    Roles.registerAction(action);
-    assert(Roles.actions.includes(action));
-  });
-
-  it('should not add the same action multiple times', () => {
-    const action = 'createUser';
-    Roles.registerAction(action);
-    Roles.registerAction(action);
-    assert.deepStrictEqual(Roles.actions, [action]);
-  });
-});
-
-describe('registerHelper', () => {
-  it('should add a new helper to the list of helpers if it does not already exist', () => {
-    const helper = 'checkAdmin';
-    Roles.registerHelper(helper);
-    assert(Roles.helpers.includes(helper));
-  });
-
-  it('should not add the same helper multiple times', () => {
-    const helper = 'checkAdmin';
-    Roles.registerHelper(helper);
-    Roles.registerHelper(helper);
-    assert.deepStrictEqual(Roles.helpers, [helper]);
-  });
-});
-
-describe('getUserRoles', () => {
-  it('should return the correct roles for a logged-in user', () => {
-    const userId = 'user1';
-    const roles = ['admin'];
-    const includeSpecial = true;
-    const expected = ['admin', '__all__', '__loggedIn__'];
-    const result = Roles.getUserRoles(userId, roles, includeSpecial);
-    assert.deepStrictEqual(result, expected);
-  });
-
-  it('should return the correct roles for a logged-out user', () => {
-    const userId = null;
-    const roles = ['admin'];
-    const includeSpecial = true;
-    const expected = ['admin', '__all__', '__notLoggedIn__'];
-    const result = Roles.getUserRoles(userId as any, roles, includeSpecial);
-    assert.deepStrictEqual(result, expected);
-  });
-
-  it('should return the correct roles when includeSpecial is false', () => {
-    const userId = 'user1';
-    const roles = ['admin'];
-    const includeSpecial = false;
-    const expected = ['admin'];
-    const result = Roles.getUserRoles(userId, roles, includeSpecial);
-    assert.deepStrictEqual(result, expected);
-  });
-});

package/src/roles.ts

@@ -1,207 +0,0 @@
-import { has } from './utils/has.js';
-import { isFunction } from './utils/isFunction.js';
-
-interface RoleUserContext {
-  userId?: string;
-  user?: any;
-}
-export interface RoleInterface {
-  name: string;
-  allowRules: Record<string, any>;
-  allow(action: string, fn: (root: any, props: any, context: RoleUserContext) => Promise<boolean>): void;
-  helpers: Record<string, unknown>;
-}
-
-export type RoleInterfaceFactory = new (key: string) => RoleInterface;
-
-export type CheckPermissionArgs = [obj?: any, params?: any];
-
-export interface RolesInterface {
-  roles: Record<string, RoleInterface>;
-  actions: string[];
-  helpers: string[];
-  registerAction(name: string): void;
-  registerHelper(name: string): void;
-  getUserRoles(userId: string, roles: string[], includeSpecial: boolean): string[];
-  allow(
-    context: RoleUserContext,
-    roles: string[],
-    action?: string,
-    args?: CheckPermissionArgs,
-  ): Promise<boolean>;
-  userHasPermission(
-    context: RoleUserContext,
-    action: string,
-    args: CheckPermissionArgs,
-  ): Promise<boolean>;
-  adminRole?: RoleInterface;
-  loggedInRole?: RoleInterface;
-  allRole?: RoleInterface;
-}
-
-export interface RoleInterface {
-  name: string;
-  allowRules: Record<string, any>;
-  allow(action: string, fn: (root: any, props: any, context: RoleUserContext) => Promise<boolean>): void;
-  helpers: Record<string, unknown>;
-}
-
-export interface IRoleOptionConfig {
-  additionalRoles?: Record<string, (role: RolesInterface, actions: Record<string, string>) => void>;
-  additionalActions?: string[];
-}
-
-export const Roles: RolesInterface = {
-  roles: {},
-  actions: [],
-  helpers: [],
-  /**
-   * Creates a new action
-   */
-  registerAction(name: string): void {
-    if (!this.actions.includes(name)) {
-      this.actions.push(name);
-    }
-  },
-
-  /**
-   * Creates a new helper
-   */
-  registerHelper(name: string): void {
-    if (!this.helpers.includes(name)) {
-      this.helpers.push(name);
-    }
-  },
-
-  /**
-   * Get user roles
-   */
-  getUserRoles(userId, roles, includeSpecial) {
-    const newRoles = [...(roles || [])];
-    if (includeSpecial) {
-      newRoles.push('__all__');
-      if (!userId) {
-        newRoles.push('__notLoggedIn__');
-      } else {
-        newRoles.push('__loggedIn__');
-        if (!newRoles.includes('admin')) {
-          newRoles.push('__notAdmin__');
-        }
-      }
-    }
-
-    return newRoles;
-  },
-
-  /**
-   * Returns true if the user passes the allow check
-   */
-  async allow(context, roles, action: string, [obj, params]: any) {
-    const userRoles = Roles.getUserRoles(context.userId!, roles, true);
-
-    return userRoles.reduce(async (roleIsAllowedPromise: Promise<boolean>, role) => {
-      const roleIsAllowed = await roleIsAllowedPromise;
-
-      if (roleIsAllowed) return true;
-
-      if (Roles.roles[role] && Roles.roles[role].allowRules && Roles.roles[role].allowRules[action]) {
-        return Roles.roles[role].allowRules[action].reduce(
-          async (rulesIsAllowedPromise: Promise<boolean>, allowFn: any) => {
-            const ruleIsAllowed = await rulesIsAllowedPromise;
-            if (ruleIsAllowed) return true;
-
-            return allowFn(obj, params, context);
-          },
-          Promise.resolve(false),
-        );
-      }
-
-      return roleIsAllowed;
-    }, Promise.resolve(false));
-  },
-
-  /**
-   * To check if a user has permisisons to execute an action
-   */
-  userHasPermission: async (context, action, args) => {
-    const roles = Array.isArray(context.user?.roles) ? context.user.roles : [];
-    const allows = await Roles.allow(context, roles, action, args);
-    return allows === true;
-  },
-};
-
-/**
- * Constructs a new role
- */
-export class Role implements RoleInterface {
-  allowRules: Record<string, any>;
-
-  helpers: Record<string, any>;
-
-  constructor(public name: string) {
-    if (has(Roles.roles, name)) throw new Error(`"${name}" role is already defined`);
-
-    this.allowRules = {};
-    this.helpers = {};
-
-    Roles.roles[name] = this as any as RoleInterface;
-  }
-
-  /**
-   * Adds a helper to a role
-   */
-  helper(helper: string, func: any) {
-    if (!Roles.helpers.includes(helper)) {
-      Roles.registerHelper(helper);
-    }
-
-    let helperFn = func;
-
-    if (!isFunction(helperFn)) {
-      const clonedValue = structuredClone(helperFn);
-      helperFn = () => {
-        return clonedValue;
-      };
-    }
-
-    if (!this.helpers[helper]) {
-      this.helpers[helper] = [];
-    }
-
-    this.helpers[helper].push(helperFn);
-  }
-
-  /**
-   * Adds allow properties to a role
-   */
-  allow(action, allow) {
-    if (!action) {
-      throw new Error(`Action doesn't exist`);
-    }
-    if (!Roles.actions.includes(action)) {
-      Roles.registerAction(action);
-    }
-    let allowFn = allow;
-    if (!isFunction(allowFn)) {
-      const clonedValue = structuredClone(allowFn);
-      allowFn = () => {
-        return clonedValue;
-      };
-    }
-    this.allowRules[action] = this.allowRules[action] || [];
-    this.allowRules[action].push(allowFn);
-  }
-}
-
-/**
- * The admin role, who recives the default actions.
- */
-Roles.adminRole = new Role('admin') as any as RoleInterface;
-/**
- * All the logged in users users
- */
-Roles.loggedInRole = new Role('__loggedIn__') as any as RoleInterface;
-/**
- * Always, no exception
- */
-Roles.allRole = new Role('__all__') as any as RoleInterface;

package/src/utils/has.ts

@@ -1,10 +0,0 @@
-export const has = (obj: Record<string, any>, key: string): boolean => {
-  const keyParts = key.split('.');
-
-  return (
-    !!obj &&
-    (keyParts.length > 1
-      ? has(obj[key.split('.')[0]], keyParts.slice(1).join('.'))
-      : obj.hasOwnProperty.call(obj, key))
-  );
-};

package/src/utils/isFunction.ts

@@ -1,3 +0,0 @@
-export const isFunction = (func: () => any): boolean => {
-  return func && typeof func === 'function';
-};

package/src/utils/permissions.ts

@@ -1,21 +0,0 @@
-export const permissions = async (userRoles: any, allRoles: any) => {
-  const actions = userRoles?.flatMap((role) => {
-    const foundRole: any = Object.values(allRoles).find((r: any) => r.name === role);
-    if (!foundRole) return [];
-    return Object.entries(foundRole.allowRules || {}).flatMap(([roleName, funcs]: any) => {
-      return funcs.map(async (f) => {
-        try {
-          // return permissions that are by default activated for that role,
-          // accidentally don't check context
-          const r = await f(null, null, null);
-          if (r) return roleName;
-          return null;
-        } catch {
-          return null;
-        }
-      });
-    });
-  });
-  const resolvedActions = await Promise.all(actions);
-  return [...new Set(resolvedActions)].filter(Boolean).toSorted((a: any, b: any) => a.localeCompare(b));
-};

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../shared/base.tsconfig.json",
-  "compilerOptions": {
-    "declarationDir": "./lib",
-    "rootDir": "./src",
-    "outDir": "./lib",
-    
-  },
-  "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
-}