@unchainedshop/roles 2.0.0-beta8 → 2.0.0-rc.1

package/jest.config.js

@@ -2,4 +2,13 @@
 export default {
   preset: 'ts-jest',
   testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
 };

package/lib/roles-index.d.ts

@@ -1,3 +1,4 @@
 export { Roles, Role } from './roles';
 export { has } from './utils/has';
 export { isFunction } from './utils/isFunction';
+export { permissions } from './utils/permissions';

package/lib/roles-index.js

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

package/lib/roles-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"roles-index.js","sourceRoot":"","sources":["../src/roles-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"roles-index.js","sourceRoot":"","sources":["../src/roles-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/roles.js

@@ -117,6 +117,9 @@ export class Role {
      * 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);
         }

package/lib/roles.js.map

@@ -1 +1 @@
-{"version":3,"file":"roles.js","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,cAAc,CAAC;AAEjC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,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;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;IACH,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;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;YAClB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,EAAE;gBACX,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aAClC;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;oBAC/B,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBAC/B;aACF;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC;QAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAElE,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;gBAC7F,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;aACH;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;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK;QACjC,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC7B,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC;SACzB;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,IAAI;IAKI;IAJnB,UAAU,CAA0B;IAEpC,OAAO,CAA0B;IAEjC,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;YACnC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC;QAEpB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpC,QAAQ,GAAG,GAAG,EAAE;gBACd,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;SACH;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SAC3B;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,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACnC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SAC9B;QACD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACxB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,GAAG,GAAG,EAAE;gBACb,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;SACH;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"}
+{"version":3,"file":"roles.js","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,cAAc,CAAC;AAEjC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,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;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;IACH,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;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;YAClB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,EAAE;gBACX,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aAClC;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;oBAC/B,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBAC/B;aACF;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC;QAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAElE,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;gBAC7F,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;aACH;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;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK;QACjC,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC7B,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC;SACzB;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,IAAI;IAKI;IAJnB,UAAU,CAA0B;IAEpC,OAAO,CAA0B;IAEjC,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;YACnC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC;QAEpB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpC,QAAQ,GAAG,GAAG,EAAE;gBACd,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;SACH;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SAC3B;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;YACX,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACnC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SAC9B;QACD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACxB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,GAAG,GAAG,EAAE;gBACb,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC;SACH;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/permissions.d.ts

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

package/lib/utils/permissions.js

@@ -0,0 +1,25 @@
+export const permissions = async (userRoles, allRoles) => {
+    const actions = userRoles?.flatMap((role) => {
+        const foundRole = Object.values(allRoles).find((r) => r.name === role);
+        if (!foundRole)
+            return [];
+        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;
+                    return null;
+                }
+                catch (e) {
+                    return null;
+                }
+            });
+        });
+    });
+    const resolvedActions = await Promise.all(actions);
+    return [...new Set(resolvedActions)].filter(Boolean).sort((a, b) => a.localeCompare(b));
+};
+//# sourceMappingURL=permissions.js.map

package/lib/utils/permissions.js.map

@@ -0,0 +1 @@
+{"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;oBACF,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;iBACb;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,IAAI,CAAC;iBACb;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,IAAI,CAAC,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACpG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/roles",
-  "version": "2.0.0-beta8",
+  "version": "2.0.0-rc.1",
   "description": "Roles package for unchained engine",
   "main": "lib/roles-index.js",
   "exports": {
@@ -13,7 +13,8 @@
     "clean": "rm -rf lib",
     "build": "npm run clean && tsc",
     "watch": "tsc -w",
-    "test": "jest --watch"
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --detectOpenHandles --forceExit",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch --detectOpenHandles --forceExit"
   },
   "repository": {
     "type": "git",
@@ -33,10 +34,9 @@
     "lodash.clone": "4.5.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.9",
-    "@unchainedshop/types": "^2.0.0-beta8",
-    "chai": "^4.3.7",
+    "@types/node": "^18.11.17",
+    "@unchainedshop/types": "^2.0.0-rc.1",
     "jest": "^29.3.1",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.4"
   }
 }

package/src/roles-index.ts

@@ -2,3 +2,4 @@ export { Roles, Role } from './roles';
 
 export { has } from './utils/has';
 export { isFunction } from './utils/isFunction';
+export { permissions } from './utils/permissions';

package/src/roles.ts

@@ -139,6 +139,9 @@ export class Role implements RoleInterface {
    * 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);
     }

package/src/utils/permissions.ts

@@ -0,0 +1,21 @@
+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 (e) {
+          return null;
+        }
+      });
+    });
+  });
+  const resolvedActions = await Promise.all(actions);
+  return [...new Set(resolvedActions)].filter(Boolean).sort((a: any, b: any) => a.localeCompare(b));
+};

package/tests/roles.test.ts

@@ -0,0 +1,331 @@
+import { Role, Roles } from "../src/roles";
+import { has, isFunction, permissions } from "../src/roles-index";
+
+describe('Role', () => {
+  beforeEach(() => {
+    Roles.roles = {};
+    Roles.actions = [];
+    Roles.helpers = [];
+  });
+  describe('constructor', () => {
+    it('should create a new role with the given name', () => {
+      
+      
+      expect(new Role('admin').name).toBe('admin');
+    });
+
+    it('should throw an error if a role with the same name already exists', () => {
+      new Role('admin')
+      expect(() => new Role('admin')).toThrowError('"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);
+      expect(role.helpers.checkPermission).toEqual([expect.any(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);
+      expect(Roles.helpers).toEqual(['checkPermission']);
+    });
+
+    it('should convert a non-function value to a function that returns that value', () => {
+      const role = new Role('admin');
+      role.helper('checkPermission', true);
+      expect(role.helpers.checkPermission).toEqual([
+        expect.any(Function),
+      ]);
+      expect(role.helpers.checkPermission[0]()).toBe(true);
+    });
+  });
+
+  describe('allow', () => {
+    it('should add the allow function to the role', () => {
+      const role = new Role('admin');
+      role.allow('createUser', () => true);
+      expect(role.allowRules.createUser).toEqual([expect.any(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);
+      expect(Roles.actions).toEqual(['createUser']);
+    });
+
+    it('should throw an error if the action does not exist', () => {
+      const role = new Role('admin');
+      expect(() => role.allow(null, () => true)).toThrowError("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);
+      expect(role.allowRules.createUser).toEqual([
+        expect.any(Function),
+      ]);
+      expect(role.allowRules.createUser[0]()).toBe(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);
+      expect(testRole.allowRules[actionName]).toEqual(
+        expect.arrayContaining([allowFn])
+      );
+    });
+
+    it('should register a helper', () => {
+      const helperFn = () => true;
+      testRole.helper('test_helper', helperFn);
+      expect(testRole.helpers.test_helper).toEqual(
+        expect.arrayContaining([helperFn])
+      );
+    });
+
+  });
+  describe('Role Helper Registration', () => {
+    it('should add a helper', () => {
+      Roles.registerHelper('test_helper');
+      expect(Roles.helpers).toEqual(['test_helper']);
+    });
+
+    it('should add a helper attaching it to adminRole', () => {
+      Roles.registerHelper('test_admin_helper');
+      expect(Roles.helpers).toEqual(
+        expect.arrayContaining(['test_admin_helper'])
+      );
+    }); 
+
+    it('should skip adding helper if it already exists', () => {
+      Roles.registerHelper('test_helper');
+      Roles.registerHelper('test_admin_helper');
+
+      expect(Roles.helpers).toEqual(
+        expect.arrayContaining(['test_helper', 'test_admin_helper'])
+      );
+    });
+  });
+
+  describe('Action registration', () => {
+    it('should add an action', () => {
+      Roles.registerAction('test_action');
+      expect(Roles.actions).toEqual(['test_action']);
+    });
+
+    it('should skip adding action if it already exists', () => {
+      Roles.registerAction('test_action');
+      expect(Roles.actions).toEqual(['test_action']);
+    });
+  });
+
+  describe('Role contruction', () => {
+    it('should construct a new role', () => {
+      expect(new Role('test_role')).toMatchObject({
+        name: 'test_role',
+        allowRules: {},
+        helpers: {},
+      });
+    });
+
+    it('should throw an error if given a role with similar name', () => {
+      new Role('test_role');
+      expect(() => new Role('test_role')).toThrow();
+    });
+  });
+
+  describe('isFunction', () => {
+    test('it should return true give a function', () => {
+      expect(isFunction(() => {})).toBe(true);
+    });
+
+    test('it should return false given an improper function', () => {
+      expect(isFunction('false' as any)).toBe(false);
+    });
+  });
+
+  describe('has', () => {
+    test('it should return true for existent key', () => {
+      const obj = {
+        foo: 'bar',
+      };
+      expect(has(obj, 'foo')).toBe(true);
+    });
+
+    test('it should return true for existent nested key', () => {
+      const obj = {
+        foo: { bar: 'baz' },
+      };
+      expect(has(obj, 'foo.bar')).toBe(true);
+    });
+
+    test('it should return false for non existent', () => {
+      const obj = {
+        foo: 'bar',
+      };
+      expect(has(obj, 'baz')).toBe(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);
+    expect(result).toEqual([]);
+  });
+
+  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);
+    expect(result).toEqual(['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);
+    expect(result).toEqual(['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);
+    expect(result).toEqual(['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);
+      expect(Roles.actions).toContain(action);
+    });
+
+    it('should not add the same action multiple times', () => {
+      const action = 'createUser';
+      Roles.registerAction(action);
+      Roles.registerAction(action);
+      expect(Roles.actions).toEqual([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);
+      expect(Roles.helpers).toContain(helper);
+    });
+
+    it('should not add the same helper multiple times', () => {
+      const helper = 'checkAdmin';
+      Roles.registerHelper(helper);
+      Roles.registerHelper(helper);
+      expect(Roles.helpers).toEqual([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);
+      expect(result).toEqual(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);
+      expect(result).toEqual(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);
+      expect(result).toEqual(expected);
+    });
+  
+  
+});

package/index.ts

@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export { Roles, Role } from './src/roles';

package/test/roles.test.js

@@ -1,212 +0,0 @@
-import {
-  describe,
-  test,
-  expect,
-  it,
-  beforeAll,
-  afterEach,
-  jest,
-} from '@jest/globals';
-import { setupDatabase } from '../../tests/helpers';
-import { User } from '../../tests/seeds/users';
-import { isFunction, has } from './helpers';
-import { Role, Roles } from './index';
-
-describe('Roles', () => {
-  beforeAll(async () => {
-    // eslint-disable-next-line no-unused-vars
-    await setupDatabase();
-  });
-
-  afterEach(() => {
-    Roles.roles = {};
-    Roles.actions = [];
-    Roles.helpers = [];
-  });
-
-  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);
-      expect(testRole.allowRules[actionName]).toEqual(
-        expect.arrayContaining([allowFn])
-      );
-    });
-
-    it('should register a helper', () => {
-      const helperFn = () => true;
-      testRole.helper('test_helper', helperFn);
-      expect(testRole.helpers.test_helper).toEqual(
-        expect.arrayContaining([helperFn])
-      );
-    });
-
-    it('should return true if the user passes the allow check', () => {
-      const permissionTestRole = new Role('permission_test_role');
-      permissionTestRole.allow('view_data', () => true);
-
-      expect(Roles.allow('permission_user', 'view_data')).toBe(true);
-    });
-
-    it("should return false if the user doesn't pass the allow check", () => {
-      const permissionTestRole = new Role('permission_test_role');
-      permissionTestRole.allow('view_data', () => false);
-
-      expect(Roles.allow('permission_user', 'view_data')).toBe(false);
-    });
-
-    it('should return false given a false user id', () => {
-      const permissionTestRole = new Role('permission_test_role');
-      permissionTestRole.allow('view_data', () => false);
-
-      expect(Roles.allow('not_found_user', 'view_data')).toBe(false);
-    });
-
-    it('should return false given a false role', () => {
-      expect(Roles.allow('permission_user', 'view_data')).toBe(false);
-    });
-  });
-
-  describe('Add allow to role', () => {
-    it('allow', async () => {
-      const permissionTestRole = new Role('permission_test_role');
-      permissionTestRole.allow('view_data', () => true);
-
-      expect(Roles.userHasPermission('permission_user', 'view_data')).toBe(
-        true
-      );
-    });
-  });
-
-  describe('Retrieve Roles', () => {
-    it('should add roles to user document', async () => {
-      const result = Roles.addUserToRoles(User._id, 'test_role');
-      expect(result).toMatchObject({ ok: 1, nModified: 1, n: 1 });
-    });
-
-    it('should get roles attach to user', () => {
-      const roles = Roles.getUserRoles(User._id);
-      expect(roles).toEqual(expect.arrayContaining(['test_role']));
-    });
-
-    it('should get roles including special ones', () => {
-      const roles = Roles.getUserRoles(User._id, true);
-      expect(roles).toEqual(
-        expect.arrayContaining([
-          'test_role',
-          '__all__',
-          '__loggedIn__',
-          '__notAdmin__',
-        ])
-      );
-    });
-
-    it('should get admin user roles including special ones', () => {
-      const roles = Roles.getUserRoles('admin', true);
-      expect(roles).toEqual(
-        expect.arrayContaining([
-          'test_role',
-          'admin',
-          '__all__',
-          '__loggedIn__',
-        ])
-      );
-    });
-
-    it('should get roles including special ones as not logged in user', () => {
-      const roles = Roles.getUserRoles(null, true);
-      expect(roles).toEqual(
-        expect.arrayContaining(['__all__', '__notLoggedIn__'])
-      );
-    });
-  });
-
-  describe('Role Helper Registration', () => {
-    it('should add a helper', () => {
-      Roles.registerHelper('test_helper');
-      expect(Roles.helpers).toEqual(['test_helper']);
-    });
-
-    it('should add a helper attaching it to adminRole', () => {
-      Roles.registerHelper('test_admin_helper', jest.fn());
-      expect(Roles.helpers).toEqual(
-        expect.arrayContaining(['test_admin_helper'])
-      );
-    });
-
-    it('should skip adding helper if it already exists', () => {
-      Roles.registerHelper('test_helper');
-      Roles.registerHelper('test_admin_helper');
-
-      expect(Roles.helpers).toEqual(
-        expect.arrayContaining(['test_helper', 'test_admin_helper'])
-      );
-    });
-  });
-
-  // Roles.registerAction
-  describe('Action registration', () => {
-    it('should add an action', () => {
-      Roles.registerAction('test_action');
-      expect(Roles.actions).toEqual(['test_action']);
-    });
-
-    it('should skip adding action if it already exists', () => {
-      Roles.registerAction('test_action');
-      expect(Roles.actions).toEqual(['test_action']);
-    });
-  });
-
-  // Roles.Role
-  describe('Role contruction', () => {
-    it('should construct a new role', () => {
-      expect(new Role('test_role')).toMatchObject({
-        name: 'test_role',
-        allowRules: {},
-        helpers: {},
-      });
-    });
-
-    it('should throw an error if given a role with similar name', () => {
-      // eslint-disable-next-line no-new
-      new Role('test_role');
-      expect(() => new Role('test_role')).toThrow();
-    });
-  });
-
-  describe('isFunction', () => {
-    test('it should return true give a function', () => {
-      expect(isFunction(() => {})).toBe(true);
-    });
-
-    test('it should return false given an improper function', () => {
-      expect(isFunction('false')).toBe(false);
-    });
-  });
-
-  describe('has', () => {
-    test('it should return true for existent key', () => {
-      const obj = {
-        foo: 'bar',
-      };
-      expect(has(obj, 'foo')).toBe(true);
-    });
-
-    test('it should return true for existent nested key', () => {
-      const obj = {
-        foo: { bar: 'baz' },
-      };
-      expect(has(obj, 'foo.bar')).toBe(true);
-    });
-
-    test('it should return false for non existent', () => {
-      const obj = {
-        foo: 'bar',
-      };
-      expect(has(obj, 'baz')).toBe(false);
-    });
-  });
-});