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

package/build/playground.js

@@ -12,9 +12,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;
@@ -22,46 +25,11 @@ 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;
 
 
-/***/ }),
-
-/***/ "./src/AbilityCompare.ts":
-/*!*******************************!*\
-  !*** ./src/AbilityCompare.ts ***!
-  \*******************************/
-/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
-
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.AbilityCompare = void 0;
-const AbilityCode_1 = __importDefault(__webpack_require__(/*! ./AbilityCode */ "./src/AbilityCode.ts"));
-class AbilityCompare extends AbilityCode_1.default {
-    static and = new AbilityCompare('and');
-    static or = new AbilityCompare('or');
-}
-exports.AbilityCompare = AbilityCompare;
-exports["default"] = AbilityCompare;
-
-
 /***/ }),
 
 /***/ "./src/AbilityCondition.ts":
@@ -77,15 +45,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.AbilityCondition = void 0;
 const AbilityCode_1 = __importDefault(__webpack_require__(/*! ./AbilityCode */ "./src/AbilityCode.ts"));
+const AbilityError_1 = __webpack_require__(/*! ~/AbilityError */ "./src/AbilityError.ts");
 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;
@@ -146,246 +132,6 @@ exports.AbilityMatch = AbilityMatch;
 exports["default"] = AbilityMatch;
 
 
-/***/ }),
-
-/***/ "./src/AbilityPolicy.ts":
-/*!******************************!*\
-  !*** ./src/AbilityPolicy.ts ***!
-  \******************************/
-/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
-
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.AbilityPolicy = void 0;
-const AbilityRuleSet_1 = __importDefault(__webpack_require__(/*! ./AbilityRuleSet */ "./src/AbilityRuleSet.ts"));
-const AbilityMatch_1 = __importDefault(__webpack_require__(/*! ./AbilityMatch */ "./src/AbilityMatch.ts"));
-const AbilityCompare_1 = __importDefault(__webpack_require__(/*! ./AbilityCompare */ "./src/AbilityCompare.ts"));
-const AbilityPolicyEffect_1 = __importDefault(__webpack_require__(/*! ./AbilityPolicyEffect */ "./src/AbilityPolicyEffect.ts"));
-class AbilityPolicy {
-    matchState = AbilityMatch_1.default.pending;
-    /**
-     * List of rules
-     */
-    ruleSet = [];
-    /**
-     * Policy effect
-     */
-    effect;
-    /**
-     * Rules compare method.\
-     * For the «and» method the rule will be permitted if all\
-     * rules will be returns «permit» status and for the «or» - if\
-     * one of the rules returns as «permit»
-     */
-    compareMethod = AbilityCompare_1.default.and;
-    /**
-     * Policy name
-     */
-    name;
-    /**
-     * Policy ID
-     */
-    id;
-    /**
-     * Soon
-     */
-    action;
-    constructor(params) {
-        const { name, id, action, effect } = params;
-        this.name = name;
-        this.id = id;
-        this.action = action;
-        this.effect = effect;
-    }
-    /**
-     * Add rule set to the policy
-     * @param ruleSet - The rule set to add
-     */
-    addRuleSet(ruleSet) {
-        this.ruleSet.push(ruleSet);
-        return this;
-    }
-    /**
-     * Check if the policy is matched
-     * @param resources - The resource to check
-     */
-    check(resources) {
-        this.matchState = AbilityMatch_1.default.mismatch;
-        if (!this.ruleSet.length) {
-            return this.matchState;
-        }
-        const rulesetCheckStates = this.ruleSet.reduce((collect, ruleSet) => {
-            return collect.concat(ruleSet.check(resources));
-        }, []);
-        if (AbilityCompare_1.default.and.isEqual(this.compareMethod)) {
-            if (rulesetCheckStates.every(ruleState => AbilityMatch_1.default.match.isEqual(ruleState))) {
-                this.matchState = AbilityMatch_1.default.match;
-            }
-        }
-        if (AbilityCompare_1.default.or.isEqual(this.compareMethod)) {
-            if (rulesetCheckStates.some(ruleState => AbilityMatch_1.default.match.isEqual(ruleState))) {
-                this.matchState = AbilityMatch_1.default.match;
-            }
-        }
-        return this.matchState;
-    }
-    /**
-     * Parse the config JSON format to Policy class instance
-     */
-    static parse(config) {
-        const { id, name, ruleSet, compareMethod, action, effect } = config;
-        // Create the empty policy
-        const policy = new AbilityPolicy({
-            name,
-            id,
-            action,
-            effect: new AbilityPolicyEffect_1.default(effect),
-        });
-        policy.compareMethod = AbilityCompare_1.default.fromLiteral(compareMethod);
-        ruleSet.forEach(ruleSetConfig => {
-            policy.addRuleSet(AbilityRuleSet_1.default.parse(ruleSetConfig));
-        });
-        return policy;
-    }
-    export() {
-        return {
-            id: this.id.toString(),
-            name: this.name.toString(),
-            compareMethod: this.compareMethod.code.toString(),
-            ruleSet: this.ruleSet.map(rule => rule.export()),
-            action: this.action,
-            effect: this.effect.code,
-        };
-    }
-}
-exports.AbilityPolicy = AbilityPolicy;
-exports["default"] = AbilityPolicy;
-
-
-/***/ }),
-
-/***/ "./src/AbilityPolicyEffect.ts":
-/*!************************************!*\
-  !*** ./src/AbilityPolicyEffect.ts ***!
-  \************************************/
-/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
-
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.AbilityPolicyEffect = void 0;
-const AbilityCode_1 = __importDefault(__webpack_require__(/*! ./AbilityCode */ "./src/AbilityCode.ts"));
-class AbilityPolicyEffect extends AbilityCode_1.default {
-    static deny = new AbilityPolicyEffect('deny');
-    static permit = new AbilityPolicyEffect('permit');
-}
-exports.AbilityPolicyEffect = AbilityPolicyEffect;
-exports["default"] = AbilityPolicyEffect;
-
-
-/***/ }),
-
-/***/ "./src/AbilityResolver.ts":
-/*!********************************!*\
-  !*** ./src/AbilityResolver.ts ***!
-  \********************************/
-/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
-
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.AbilityResolver = void 0;
-const AbilityPolicyEffect_1 = __importDefault(__webpack_require__(/*! ./AbilityPolicyEffect */ "./src/AbilityPolicyEffect.ts"));
-const AbilityMatch_1 = __importDefault(__webpack_require__(/*! ./AbilityMatch */ "./src/AbilityMatch.ts"));
-const AbilityError_1 = __webpack_require__(/*! ./AbilityError */ "./src/AbilityError.ts");
-class AbilityResolver {
-    policies;
-    constructor(policyOrListOfPolicies) {
-        this.policies = Array.isArray(policyOrListOfPolicies)
-            ? policyOrListOfPolicies
-            : [policyOrListOfPolicies];
-    }
-    /**
-     * Resolve policy for the resource and action
-     *
-     @param action - Action
-     * @param resource - Resource
-     */
-    resolve(action, resource) {
-        const filteredPolicies = this.policies.filter(policy => {
-            return AbilityResolver.isInActionContain(policy.action, String(action));
-        });
-        filteredPolicies.map(policy => policy.check(resource));
-        this.policies = filteredPolicies;
-        return this;
-    }
-    enforce(action, resource) {
-        const resolver = this.resolve(action, resource);
-        if (resolver) {
-            if (resolver.isDeny()) {
-                throw new AbilityError_1.PermissionError(resolver.getMatchedPolicy()?.name?.toString() || 'Unknown permission error');
-            }
-        }
-    }
-    /**
-     * Get the last effect of the policy
-     *
-     * @returns {AbilityPolicyEffect | null}
-     */
-    getEffect() {
-        const effects = this.policies.reduce((collect, policy, _index) => {
-            if (policy.matchState.isEqual(AbilityMatch_1.default.match)) {
-                return collect.concat(policy.effect);
-            }
-            return collect;
-        }, []);
-        if (effects.length) {
-            return effects[effects.length - 1];
-        }
-        return null;
-    }
-    isPermit() {
-        const effect = this.getEffect();
-        return effect !== null && effect.isEqual(AbilityPolicyEffect_1.default.permit);
-    }
-    isDeny() {
-        const effect = this.getEffect();
-        return effect !== null && effect.isEqual(AbilityPolicyEffect_1.default.deny);
-    }
-    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
-     * @param actionA - The first action to check
-     * @param actionB - The second action to check
-     */
-    static isInActionContain(actionA, actionB) {
-        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;
-        const c = a
-            .reduce((acc, chunk, index) => {
-            const iterationRes = chunk === b[index] || b[index] === '*' || chunk === '*';
-            return acc.concat(iterationRes);
-        }, []);
-        return c.every(Boolean);
-    }
-}
-exports.AbilityResolver = AbilityResolver;
-exports["default"] = AbilityResolver;
-
-
 /***/ }),
 
 /***/ "./src/AbilityRule.ts":
@@ -421,7 +167,7 @@ class AbilityRule {
         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
@@ -430,25 +176,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));
@@ -462,7 +208,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));
@@ -541,7 +287,7 @@ class AbilityRule {
             name,
             subject,
             resource,
-            condition,
+            condition: new AbilityCondition_1.default(condition),
         });
     }
     /**
@@ -561,110 +307,6 @@ exports.AbilityRule = AbilityRule;
 exports["default"] = AbilityRule;
 
 
-/***/ }),
-
-/***/ "./src/AbilityRuleSet.ts":
-/*!*******************************!*\
-  !*** ./src/AbilityRuleSet.ts ***!
-  \*******************************/
-/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
-
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.AbilityRuleSet = void 0;
-const AbilityRule_1 = __importDefault(__webpack_require__(/*! ./AbilityRule */ "./src/AbilityRule.ts"));
-const AbilityCompare_1 = __importDefault(__webpack_require__(/*! ./AbilityCompare */ "./src/AbilityCompare.ts"));
-const AbilityMatch_1 = __importDefault(__webpack_require__(/*! ./AbilityMatch */ "./src/AbilityMatch.ts"));
-class AbilityRuleSet {
-    state = AbilityMatch_1.default.pending;
-    /**
-     * List of rules
-     */
-    rules = [];
-    /**
-     * Rules compare method.\
-     * For the «and» method the rule will be permitted if all\
-     * rules will be returns «permit» status and for the «or» - if\
-     * one of the rules returns as «permit»
-     */
-    compareMethod = AbilityCompare_1.default.and;
-    /**
-     * Group name
-     */
-    name;
-    /**
-     * Group ID
-     */
-    id;
-    constructor(params) {
-        const { name, id, compareMethod } = params;
-        this.name = name;
-        this.id = id;
-        this.compareMethod = AbilityCompare_1.default.fromLiteral(compareMethod);
-        // this.compareMethod = new AbilityCompare(compareMethod);
-    }
-    addRule(rule, compareMethod) {
-        this.rules.push(rule);
-        this.compareMethod = compareMethod;
-        return this;
-    }
-    addRules(rules, compareMethod) {
-        rules.forEach(rule => this.addRule(rule, compareMethod));
-        return this;
-    }
-    check(resources) {
-        this.state = AbilityMatch_1.default.mismatch;
-        if (!this.rules.length) {
-            return this.state;
-        }
-        const ruleCheckStates = this.rules.reduce((collect, rule) => {
-            return collect.concat(rule.check(resources));
-        }, []);
-        if (AbilityCompare_1.default.and.isEqual(this.compareMethod)) {
-            if (ruleCheckStates.every(ruleState => AbilityMatch_1.default.match.isEqual(ruleState))) {
-                this.state = AbilityMatch_1.default.match;
-            }
-        }
-        if (AbilityCompare_1.default.or.isEqual(this.compareMethod)) {
-            if (ruleCheckStates.some(ruleState => AbilityMatch_1.default.match.isEqual(ruleState))) {
-                this.state = AbilityMatch_1.default.match;
-            }
-        }
-        return this.state;
-    }
-    /**
-     * Parse the config JSON format to Group class instance
-     */
-    static parse(config) {
-        const { id, name, rules, compareMethod } = config;
-        const ruleSet = new AbilityRuleSet({
-            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);
-        }
-        return ruleSet;
-    }
-    export() {
-        return {
-            id: this.id.toString(),
-            name: this.name.toString(),
-            compareMethod: this.compareMethod.code.toString(),
-            rules: this.rules.map(rule => rule.export()),
-        };
-    }
-}
-exports.AbilityRuleSet = AbilityRuleSet;
-exports["default"] = AbilityRuleSet;
-
-
 /***/ }),
 
 /***/ "./src/playground.ts":
@@ -679,8 +321,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 const node_http_1 = __importDefault(__webpack_require__(/*! node:http */ "node:http"));
-const AbilityPolicy_1 = __importDefault(__webpack_require__(/*! ./AbilityPolicy */ "./src/AbilityPolicy.ts"));
-const AbilityResolver_1 = __importDefault(__webpack_require__(/*! ~/AbilityResolver */ "./src/AbilityResolver.ts"));
+const AbilityCondition_1 = __importDefault(__webpack_require__(/*! ~/AbilityCondition */ "./src/AbilityCondition.ts"));
+const AbilityRule_1 = __importDefault(__webpack_require__(/*! ./AbilityRule */ "./src/AbilityRule.ts"));
+const AbilityMatch_1 = __importDefault(__webpack_require__(/*! ./AbilityMatch */ "./src/AbilityMatch.ts"));
 const server = node_http_1.default.createServer();
 server.on('request', (_req, res) => {
     const config = [
@@ -705,7 +348,7 @@ server.on('request', (_req, res) => {
                         },
                     ],
                 },
-            ]
+            ],
         },
         {
             id: 'bb758c1b-1015-4894-ba25-d23156e063cf',
@@ -738,28 +381,27 @@ server.on('request', (_req, res) => {
             ],
         },
     ];
-    const policies = config.map(cfg => AbilityPolicy_1.default.parse(cfg));
-    const result = new AbilityResolver_1.default(policies).resolve('order.status', {
-        account: {
-            roles: ['user', 'couch'],
-        },
-        order: {
-            status: 'не обработан',
-        },
-        feature: {
-            status: 'отменен',
-            // status: 'завершен'
-        },
+    const rule = new AbilityRule_1.default({
+        id: '<rule-id>',
+        name: 'Пользователь является владельцем заказа',
+        condition: AbilityCondition_1.default.equal,
+        subject: 'user.id',
+        resource: 'order.owner',
+    });
+    const matchState = rule.check({
+        user: { id: '1' },
+        order: { owner: '1' },
     });
+    const is = matchState.isEqual(AbilityMatch_1.default.match); // true
     res.statusCode = 200;
     res.setHeader('content-type', 'application/json');
     res.write(JSON.stringify({
-        status: result.isDeny() ? 'deny' : 'permit',
+        status: 'ok',
     }));
     res.end();
 });
 server.listen(8081, 'localhost', () => {
-    console.debug('server started at http://localhost:8080');
+    console.debug('server started at http://localhost:8081');
 });