@via-profit/ability 2.0.0-rc.7 → 2.1.0

package/dist/index.js

@@ -9,9 +9,12 @@
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.AbilityCode = void 0;
 class AbilityCode {
-    code;
+    _code;
     constructor(code) {
-        this.code = code;
+        this._code = code;
+    }
+    get code() {
+        return this._code;
     }
     isEqual(compareWith) {
         return compareWith !== null && this.code === compareWith.code;
@@ -19,18 +22,6 @@ class AbilityCode {
     isNotEqual(compareWith) {
         return !this.isEqual(compareWith);
     }
-    static fromLiteral(literal) {
-        let Code = null;
-        Object.keys(this).forEach(member => {
-            if (member === literal) {
-                Code = this[member];
-            }
-        });
-        if (!Code) {
-            throw new Error(`Mismatch error. The literal ${literal} can not be find as a member of this class`);
-        }
-        return new this(Code.code);
-    }
 }
 exports.AbilityCode = AbilityCode;
 exports["default"] = AbilityCode;
@@ -68,15 +59,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.AbilityCondition = void 0;
 const AbilityCode_1 = __importDefault(__webpack_require__(19));
+const AbilityError_1 = __webpack_require__(122);
 class AbilityCondition extends AbilityCode_1.default {
-    static EQUAL = new AbilityCondition('=');
-    static NOT_EQUAL = new AbilityCondition('<>');
-    static MORE_THAN = new AbilityCondition('>');
-    static LESS_THAN = new AbilityCondition('<');
-    static LESS_OR_EQUAL = new AbilityCondition('<=');
-    static MORE_OR_EQUAL = new AbilityCondition('>=');
-    static IN = new AbilityCondition('in');
-    static NOT_IN = new AbilityCondition('not in');
+    static equal = new AbilityCondition('=');
+    static not_equal = new AbilityCondition('<>');
+    static more_than = new AbilityCondition('>');
+    static less_than = new AbilityCondition('<');
+    static less_or_equal = new AbilityCondition('<=');
+    static more_or_equal = new AbilityCondition('>=');
+    static in = new AbilityCondition('in');
+    static not_in = new AbilityCondition('not in');
+    static fromLiteral(literal) {
+        const code = AbilityCondition[literal]?.code || null;
+        if (code === null) {
+            throw new AbilityError_1.AbilityParserError(`Literal ${literal} does not found in AbilityCondition class`);
+        }
+        return new AbilityCondition(code);
+    }
+    get literal() {
+        const literal = Object.keys(AbilityCondition).find(member => {
+            const val = AbilityCondition[member];
+            return val.code === this.code;
+        });
+        if (typeof literal === 'undefined') {
+            throw new Error(`Literal value does not found in class AbilityCondition`);
+        }
+        return literal;
+    }
 }
 exports.AbilityCondition = AbilityCondition;
 exports["default"] = AbilityCondition;
@@ -89,7 +98,7 @@ exports["default"] = AbilityCondition;
 
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.PermissionError = exports.AbilityParserError = exports.AbilityError = void 0;
+exports.AbilityParserError = exports.AbilityError = void 0;
 class AbilityError extends Error {
     constructor(message) {
         super(message);
@@ -102,12 +111,6 @@ class AbilityParserError extends Error {
     }
 }
 exports.AbilityParserError = AbilityParserError;
-class PermissionError extends Error {
-    constructor(message) {
-        super(message);
-    }
-}
-exports.PermissionError = PermissionError;
 
 
 /***/ }),
@@ -191,18 +194,18 @@ class AbilityParser {
                 ruleSet.rules.forEach(rule => {
                     let value = 'any';
                     switch (true) {
-                        case rule.condition.isEqual(AbilityCondition_1.default.NOT_EQUAL):
-                        case rule.condition.isEqual(AbilityCondition_1.default.EQUAL):
+                        case rule.condition.isEqual(AbilityCondition_1.default.not_equal):
+                        case rule.condition.isEqual(AbilityCondition_1.default.equal):
                             value = typeof rule.resource;
                             break;
-                        case rule.condition.isEqual(AbilityCondition_1.default.IN):
-                        case rule.condition.isEqual(AbilityCondition_1.default.NOT_IN):
+                        case rule.condition.isEqual(AbilityCondition_1.default.in):
+                        case rule.condition.isEqual(AbilityCondition_1.default.not_in):
                             value = `${typeof rule.resource}[]`;
                             break;
-                        case rule.condition.isEqual(AbilityCondition_1.default.MORE_OR_EQUAL):
-                        case rule.condition.isEqual(AbilityCondition_1.default.MORE_THAN):
-                        case rule.condition.isEqual(AbilityCondition_1.default.LESS_OR_EQUAL):
-                        case rule.condition.isEqual(AbilityCondition_1.default.LESS_THAN):
+                        case rule.condition.isEqual(AbilityCondition_1.default.more_or_equal):
+                        case rule.condition.isEqual(AbilityCondition_1.default.more_than):
+                        case rule.condition.isEqual(AbilityCondition_1.default.less_or_equal):
+                        case rule.condition.isEqual(AbilityCondition_1.default.less_than):
                             value = 'number';
                             break;
                     }
@@ -313,7 +316,7 @@ class AbilityPolicy {
             action,
             effect: new AbilityPolicyEffect_1.default(effect),
         });
-        policy.compareMethod = AbilityCompare_1.default.fromLiteral(compareMethod);
+        policy.compareMethod = new AbilityCompare_1.default(compareMethod);
         ruleSet.forEach(ruleSetConfig => {
             policy.addRuleSet(AbilityRuleSet_1.default.parse(ruleSetConfig));
         });
@@ -391,10 +394,8 @@ class AbilityResolver {
     }
     enforce(action, resource) {
         const resolver = this.resolve(action, resource);
-        if (resolver) {
-            if (resolver.isDeny()) {
-                throw new AbilityError_1.PermissionError(resolver.getPolicy()?.name?.toString() || 'Unknown permission error');
-            }
+        if (resolver.isDeny()) {
+            throw new AbilityError_1.AbilityError(resolver.getMatchedPolicy()?.name?.toString() || 'Unknown permission error');
         }
     }
     /**
@@ -422,9 +423,10 @@ class AbilityResolver {
         const effect = this.getEffect();
         return effect !== null && effect.isEqual(AbilityPolicyEffect_1.default.deny);
     }
-    getPolicy() {
-        const lastPolicy = this.policies.length ? this.policies[this.policies.length - 1] : null;
-        return lastPolicy && lastPolicy.matchState.isEqual(AbilityMatch_1.default.match) ? lastPolicy : null;
+    getMatchedPolicy() {
+        const matchedPolicies = this.policies.filter(policy => policy.matchState.isEqual(AbilityMatch_1.default.match));
+        const lastPolicy = matchedPolicies.length ? matchedPolicies[matchedPolicies.length - 1] : null;
+        return lastPolicy || null;
     }
     /**
      * Check if the action is contained in another action
@@ -435,13 +437,12 @@ class AbilityResolver {
         const actionAArray = String(actionA).split('.');
         const actionBArray = String(actionB).split('.');
         const a = actionAArray.length >= actionBArray.length ? actionAArray : actionBArray;
-        const b = actionBArray.length >= actionAArray.length ? actionBArray : actionAArray;
-        return a
-            .reduce((acc, chunk, index) => {
+        const b = actionBArray.length <= actionAArray.length ? actionBArray : actionAArray;
+        const c = a.reduce((acc, chunk, index) => {
             const iterationRes = chunk === b[index] || b[index] === '*' || chunk === '*';
             return acc.concat(iterationRes);
-        }, [])
-            .every(Boolean);
+        }, []);
+        return c.every(Boolean);
     }
 }
 exports.AbilityResolver = AbilityResolver;
@@ -461,6 +462,9 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.AbilityRule = void 0;
 const AbilityMatch_1 = __importDefault(__webpack_require__(909));
 const AbilityCondition_1 = __importDefault(__webpack_require__(261));
+/**
+ * Represents a rule that defines a condition to be checked against a subject and resource.
+ */
 class AbilityRule {
     /**
      * Subject key path like a 'user.name'
@@ -474,13 +478,22 @@ class AbilityRule {
     name;
     id;
     state = AbilityMatch_1.default.pending;
+    /**
+     * Creates an instance of AbilityRule.
+     * @param {string} options.id - The unique identifier of the rule.
+     * @param {string} options.name - The name of the rule.
+     * @param {AbilityCondition} options.condition - The condition to evaluate.
+     * @param {string} options.subject - The subject of the rule.
+     * @param {string} options.resource - The resource to compare against.
+     * @param params
+     */
     constructor(params) {
         const { id, name, subject, resource, condition } = params;
         this.id = id;
         this.name = name;
         this.subject = subject;
         this.resource = resource;
-        this.condition = new AbilityCondition_1.default(condition);
+        this.condition = condition;
     }
     /**
      * Check if the rule is matched
@@ -489,25 +502,25 @@ class AbilityRule {
     check(resource) {
         let is = false;
         const [valueS, valueO] = this.extractValues(resource);
-        if (AbilityCondition_1.default.LESS_THAN.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.less_than.isEqual(this.condition)) {
             is = Number(valueS) < Number(valueO);
         }
-        if (AbilityCondition_1.default.LESS_OR_EQUAL.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.less_or_equal.isEqual(this.condition)) {
             is = Number(valueS) <= Number(valueO);
         }
-        if (AbilityCondition_1.default.MORE_THAN.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.more_than.isEqual(this.condition)) {
             is = Number(valueS) > Number(valueO);
         }
-        if (AbilityCondition_1.default.MORE_OR_EQUAL.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.more_or_equal.isEqual(this.condition)) {
             is = Number(valueS) >= Number(valueO);
         }
-        if (AbilityCondition_1.default.EQUAL.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.equal.isEqual(this.condition)) {
             is = valueS === valueO;
         }
-        if (AbilityCondition_1.default.NOT_EQUAL.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.not_equal.isEqual(this.condition)) {
             is = valueS !== valueO;
         }
-        if (AbilityCondition_1.default.IN.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.in.isEqual(this.condition)) {
             // [<some>] and [<some>]
             if (Array.isArray(valueS) && Array.isArray(valueO)) {
                 is = valueS.some(v => valueO.find(v1 => v1 === v));
@@ -521,7 +534,7 @@ class AbilityRule {
                 is = valueS.includes(valueO);
             }
         }
-        if (AbilityCondition_1.default.NOT_IN.isEqual(this.condition)) {
+        if (AbilityCondition_1.default.not_in.isEqual(this.condition)) {
             // [<some>] and [<some>]
             if (Array.isArray(valueS) && Array.isArray(valueO)) {
                 is = !valueS.some(v => valueO.find(v1 => v1 === v));
@@ -600,7 +613,7 @@ class AbilityRule {
             name,
             subject,
             resource,
-            condition,
+            condition: new AbilityCondition_1.default(condition),
         });
     }
     /**
@@ -659,16 +672,14 @@ class AbilityRuleSet {
         const { name, id, compareMethod } = params;
         this.name = name;
         this.id = id;
-        this.compareMethod = AbilityCompare_1.default.fromLiteral(compareMethod);
-        // this.compareMethod = new AbilityCompare(compareMethod);
+        this.compareMethod = compareMethod;
     }
-    addRule(rule, compareMethod) {
+    addRule(rule) {
         this.rules.push(rule);
-        this.compareMethod = compareMethod;
         return this;
     }
-    addRules(rules, compareMethod) {
-        rules.forEach(rule => this.addRule(rule, compareMethod));
+    addRules(rules) {
+        rules.forEach(rule => this.addRule(rule));
         return this;
     }
     check(resources) {
@@ -697,14 +708,14 @@ class AbilityRuleSet {
     static parse(config) {
         const { id, name, rules, compareMethod } = config;
         const ruleSet = new AbilityRuleSet({
-            compareMethod,
+            compareMethod: new AbilityCompare_1.default(compareMethod),
             name,
             id,
         });
         // Adding rules if exists
         if (rules && rules.length > 0) {
             const abilityRules = rules.map(ruleConfig => AbilityRule_1.default.parse(ruleConfig));
-            ruleSet.addRules(abilityRules, ruleSet.compareMethod);
+            ruleSet.addRules(abilityRules);
         }
         return ruleSet;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@via-profit/ability",
   "support": "https://via-profit.ru",
-  "version": "2.0.0-rc.7",
+  "version": "2.1.0",
   "description": "Via-Profit Ability service",
   "keywords": [
     "ability",
@@ -28,7 +28,6 @@
   },
   "author": {
     "name": "Via Profit",
-    "email": "promo@via-profit.ru",
     "url": "https://dev.via-profit.ru"
   },
   "contributors": [

package/dist/AbilityPolicyResult.d.ts

@@ -1,6 +0,0 @@
-import AbilityPolicy from './AbilityPolicy';
-export declare class AbilityPolicyResult {
-    policies: readonly AbilityPolicy[];
-    constructor(policies: readonly AbilityPolicy[]);
-}
-export default AbilityPolicyResult;

package/dist/playground.d.ts

@@ -1,26 +0,0 @@
-export type Resources = {
-    readonly ['account.read']: {
-        readonly account: {
-            readonly id: string;
-            readonly roles: readonly string[];
-        } | null;
-        readonly resource: {
-            readonly id: string;
-        };
-    };
-    readonly ['access.auth']: {
-        readonly token: {
-            readonly type: string;
-            readonly id: string;
-        } | null;
-    };
-    readonly ['order.update']: {
-        readonly account: {
-            readonly roles: readonly string[];
-            readonly department: string;
-        } | null;
-        readonly order: {
-            readonly status: string;
-        } | null;
-    };
-};