@unchainedshop/roles 5.0.0-alpha.5 → 5.0.0-alpha.7

package/README.md

@@ -20,6 +20,8 @@ import { Roles, Role } from '@unchainedshop/roles';
 
 // Create a new role
 const editorRole = new Role('editor');
+Roles.addRole(editorRole);
+Roles.registerAction('updateProduct');
 
 // Allow actions for the role
 editorRole.allow('updateProduct', async (product, params, context) => {
@@ -42,6 +44,7 @@ const allowed = await Roles.userHasPermission(
 | Method | Description |
 |--------|-------------|
 | `Roles.registerAction` | Register a new action name |
+| `Roles.addRole` | Register a role instance |
 | `Roles.registerHelper` | Register a new helper name |
 | `Roles.getUserRoles` | Get user roles including special roles |
 | `Roles.allow` | Check if any role allows an action |
@@ -51,12 +54,14 @@ const allowed = await Roles.userHasPermission(
 
 | Method | Description |
 |--------|-------------|
-| `new Role(name)` | Create and register a new role |
+| `new Role(name)` | Create a role; register it with `roles.addRole()` |
 | `role.allow(action, fn)` | Add allow rule for an action |
 | `role.helper(name, fn)` | Add helper function to role |
 
 ### Built-in Roles
 
+`createRoles()` returns an empty role registry. Call `initDefaultRoles(registry)` to add the following roles, or use the API layer's `roles.configureRoles()` to configure the platform's permission rules.
+
 | Role | Description |
 |------|-------------|
 | `Roles.adminRole` | Admin role with elevated privileges |
@@ -70,7 +75,7 @@ const allowed = await Roles.userHasPermission(
 | `__all__` | Automatically assigned to everyone |
 | `__loggedIn__` | Automatically assigned to authenticated users |
 | `__notLoggedIn__` | Automatically assigned to anonymous users |
-| `__notAdmin__` | Automatically assigned to non-admin users |
+| `__notAdmin__` | Automatically assigned to authenticated non-admin users |
 
 ### Utility Functions
 
@@ -93,13 +98,13 @@ const allowed = await Roles.userHasPermission(
 ## Configuration
 
 ```typescript
-import type { IRoleOptionConfig } from '@unchainedshop/roles';
+import { Role, type IRoleOptionConfig } from '@unchainedshop/roles';
 
 const config: IRoleOptionConfig = {
   additionalRoles: {
     customRole: (roles, actions) => {
-      const role = new Role('customRole');
-      role.allow(actions.READ, () => true);
+      const role = roles.addRole(new Role('customRole'));
+      role.allow(actions.CUSTOM_ACTION, async () => true);
     },
   },
   additionalActions: ['CUSTOM_ACTION'],

package/lib/utils/permissions.d.ts

@@ -1 +1 @@
-export declare const permissions: (userRoles: any, allRoles: any) => Promise<(string | null)[]>;
+export declare const permissions: (userRoles: any, allRoles: any) => Promise<string[]>;

package/lib/utils/permissions.js

@@ -1,29 +1,30 @@
 export const permissions = async (userRoles, allRoles) => {
-    const roleMap = new Map();
+    const rolesByName = new Map();
     for (const r of Object.values(allRoles)) {
-        roleMap.set(r.name, r);
+        if (r?.name)
+            rolesByName.set(r.name, r);
     }
-    const actions = [];
+    const result = [];
+    const seen = new Set();
     for (const role of userRoles || []) {
-        const foundRole = roleMap.get(role);
+        const foundRole = rolesByName.get(role);
         if (!foundRole)
             continue;
-        for (const [roleName, funcs] of Object.entries(foundRole.allowRules || {})) {
+        for (const [actionName, funcs] of Object.entries(foundRole.allowRules || {})) {
+            if (seen.has(actionName))
+                continue;
             for (const f of funcs) {
-                actions.push((async () => {
-                    try {
-                        const r = await f(null, null, null);
-                        if (r)
-                            return roleName;
-                        return null;
+                try {
+                    if (await f(null, null, null)) {
+                        seen.add(actionName);
+                        result.push(actionName);
+                        break;
                     }
-                    catch {
-                        return null;
-                    }
-                })());
+                }
+                catch {
+                }
             }
         }
     }
-    const resolvedActions = await Promise.all(actions);
-    return [...new Set(resolvedActions)].filter(Boolean).toSorted((a, b) => a.localeCompare(b));
+    return result.sort((a, b) => a.localeCompare(b));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/roles",
-  "version": "5.0.0-alpha.5",
+  "version": "5.0.0-alpha.7",
   "description": "Role-based access control system for the Unchained Engine",
   "main": "lib/roles-index.js",
   "types": "lib/roles-index.d.ts",