@unchainedshop/roles 1.1.0-1

package/.npm/package/README

@@ -0,0 +1,7 @@
+This directory and the files immediately inside it are automatically generated
+when you change this package's NPM dependencies. Commit the files in this
+directory (npm-shrinkwrap.json, .gitignore, and this README) to source control
+so that others run the same versions of sub-dependencies.
+
+You should NOT check in the node_modules directory that Meteor automatically
+creates; if you are using git, the .gitignore file tells git to ignore it.

package/.npm/package/npm-shrinkwrap.json

@@ -0,0 +1,10 @@
+{
+  "lockfileVersion": 1,
+  "dependencies": {
+    "lodash.clone": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.clone/-/lodash.clone-4.5.0.tgz",
+      "integrity": "sha512-GhrVeweiTD6uTmmn5hV/lzgCQhccwReIVRLHp7LT4SopOjqEZ5BbX8b5WWEtAKasjmy8hR7ZPwsYlxRCku5odg=="
+    }
+  }
+}

package/.versions

@@ -0,0 +1,18 @@
+babel-compiler@7.9.0
+babel-runtime@1.5.1
+dynamic-import@0.7.2
+ecmascript@0.16.2
+ecmascript-runtime@0.8.0
+ecmascript-runtime-client@0.12.1
+ecmascript-runtime-server@0.11.0
+fetch@0.1.1
+inter-process-messaging@0.1.1
+local-test:unchained:roles@1.1.0
+meteor@1.10.0
+modern-browsers@0.1.8
+modules@0.18.0
+modules-runtime@0.13.0
+promise@0.12.0
+react-fast-refresh@0.2.3
+typescript@4.5.4
+unchained:roles@1.1.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+### v3.0.0
+
+- Meteor 1.7 Compatibility
+- Fork of https://github.com/nicolaslopezj/roles

package/README.md

@@ -0,0 +1,5 @@
+# Roles (Unchained Engine)
+
+This package delivers inner logic for the ACL layer of all Unchained API's.
+
+Thanks to Nicolás López for the initial version of Roles: https://github.com/nicolaslopezj/roles

package/index.ts

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

package/lib/roles-index.d.ts

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

package/lib/roles-index.js

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

package/lib/roles-index.js.map

@@ -0,0 +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"}

package/lib/roles.d.ts

@@ -0,0 +1,23 @@
+import { RoleInterface, RolesInterface } from '@unchainedshop/types/roles';
+export declare const Roles: RolesInterface;
+/**
+ * Constructs a new role
+ */
+export declare class Role implements RoleInterface {
+    name: string;
+    allowRules: {
+        [name: string]: any;
+    };
+    helpers: {
+        [name: 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;
+}

package/lib/roles.js

@@ -0,0 +1,146 @@
+import clone from 'lodash.clone';
+import { has } from './utils/has';
+import { isFunction } from './utils/isFunction';
+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) {
+            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, [obj, params]) {
+        const userRoles = Roles.getUserRoles(context.userId, roles, true);
+        return userRoles.reduce(async (roleIsAllowedPromise, 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, allowFn) => {
+                    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;
+    },
+    /**
+     * Adds roles to a user
+     */
+    async addUserToRoles(context, roles) {
+        let userRoles = roles;
+        if (!Array.isArray(userRoles)) {
+            userRoles = [userRoles];
+        }
+        return context.modules.users.addRoles(context.userId, userRoles);
+    },
+};
+/**
+ * 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.allowRules = {};
+        this.helpers = {};
+        Roles.roles[name] = this;
+    }
+    /**
+     * Adds a helper to a role
+     */
+    helper(helper, func) {
+        if (!Roles.helpers.includes(helper)) {
+            Roles.registerHelper(helper);
+        }
+        let helperFn = func;
+        if (!isFunction(helperFn)) {
+            const clonedValue = clone(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 (!Roles.actions.includes(action)) {
+            Roles.registerAction(action);
+        }
+        let allowFn = allow;
+        if (!isFunction(allowFn)) {
+            const clonedValue = clone(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');
+/**
+ * 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/roles.js.map

@@ -0,0 +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"}

package/lib/utils/has.d.ts

@@ -0,0 +1,3 @@
+export declare const has: (obj: {
+    [key: string]: any;
+}, key: string) => boolean;

package/lib/utils/has.js

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

package/lib/utils/has.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"has.js","sourceRoot":"","sources":["../../src/utils/has.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,GAA2B,EAAE,GAAW,EAAW,EAAE;IACvE,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

@@ -0,0 +1 @@
+export declare const isFunction: (func: () => any) => boolean;

package/lib/utils/isFunction.js

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

package/lib/utils/isFunction.js.map

@@ -0,0 +1 @@
+{"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/package.js

@@ -0,0 +1,25 @@
+Package.describe({
+  name: 'unchained:roles',
+  version: '1.1.0',
+  summary: 'Unchained Engine: Roles',
+  git: 'https://github.com/unchainedshop/unchained',
+  documentation: 'README.md',
+});
+
+Npm.depends({
+  'lodash.clone': '4.5.0',
+});
+
+Package.onUse((api) => {
+  api.versionsFrom('2.7.3');
+
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.mainModule('src/roles-index.ts');
+});
+
+Package.onTest((api) => {
+  api.use('ecmascript');
+  api.use('unchained:roles');
+});

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@unchainedshop/roles",
+  "version": "1.1.0-1",
+  "description": "Roles package for unchained engine",
+  "main": "lib/roles-index.js",
+  "types": "lib/roles-index.d.ts",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "watch": "tsc --watch",
+    "link:core": "npm link @unchainedshop/types",
+    "test": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unchainedshop/unchained.git"
+  },
+  "keywords": [
+    "unchained",
+    "ecommerce"
+  ],
+  "author": "Joël Meiller",
+  "license": "EUPL-1.2",
+  "bugs": {
+    "url": "https://github.com/unchainedshop/unchained/issues"
+  },
+  "homepage": "https://github.com/unchainedshop/unchained#readme",
+  "dependencies": {
+    "lodash.clone": "4.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^16.11.41",
+    "@unchainedshop/types": "../@unchainedshop/types",
+    "chai": "^4.3.6",
+    "typescript": "^4.7.3"
+  }
+}

package/roles.test.js

@@ -0,0 +1,212 @@
+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);
+    });
+  });
+});

package/src/roles-index.ts

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

package/src/roles.ts

@@ -0,0 +1,168 @@
+import clone from 'lodash.clone';
+import { RoleInterface, RolesInterface } from '@unchainedshop/types/roles';
+import { has } from './utils/has';
+import { isFunction } from './utils/isFunction';
+
+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, [obj, params]) {
+    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;
+  },
+
+  /**
+   * Adds roles to a user
+   */
+  async addUserToRoles(context, roles) {
+    let userRoles = roles;
+    if (!Array.isArray(userRoles)) {
+      userRoles = [userRoles];
+    }
+
+    return context.modules.users.addRoles(context.userId, userRoles);
+  },
+};
+
+/**
+ * Constructs a new role
+ */
+export class Role implements RoleInterface {
+  allowRules: { [name: string]: any };
+
+  helpers: { [name: 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 = clone(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 (!Roles.actions.includes(action)) {
+      Roles.registerAction(action);
+    }
+    let allowFn = allow;
+    if (!isFunction(allowFn)) {
+      const clonedValue = clone(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

@@ -0,0 +1,10 @@
+export const has = (obj: { [key: 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

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

package/tsconfig.build.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": "lib",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "types": ["node"],
+    "baseUrl": ".", // This must be specified if "paths" is.
+    "paths": {
+      "meteor/unchained:*": ["node_modules/@unchainedshop/types/index.d.ts"]
+    }
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha"]
+  },
+  "include": ["src", "tests"]
+}