@via-profit/ability 3.5.0 → 3.5.1

package/dist/index.d.ts

@@ -338,6 +338,13 @@ declare class AbilityTypeGenerator {
     private formatNestedObject;
 }
 
+type AbilityResultStateCodeType = 'allow' | 'deny' | 'neutral';
+declare class AbilityResultState extends AbilityCode<AbilityResultStateCodeType> {
+    static allow: AbilityResultState;
+    static deny: AbilityResultState;
+    static neutral: AbilityResultState;
+}
+
 declare class AbilityResult<Resource extends ResourceObject = Record<string, unknown>> {
     /**
      * Already checked policies (after call the policy.check())
@@ -352,14 +359,9 @@ declare class AbilityResult<Resource extends ResourceObject = Record<string, unk
      */
     explain(): readonly AbilityExplain[];
     getLastMatchedPolicy(): AbilityPolicy<Resource> | null;
+    getFinalState(): AbilityResultState;
     isAllowed(): boolean;
     isDenied(): boolean;
-    /**
-     * Get the last effect of the policy
-     *
-     * @returns {AbilityPolicyEffect | null}
-     */
-    getLastEffectOfMatchedPolicy(): AbilityPolicyEffect | null;
 }
 
 declare class AbilityResolver<Resources extends ResourcesMap, Environment = unknown> {
@@ -570,5 +572,5 @@ declare class AbilityDSLLexer {
     private isAtEnd;
 }
 
-export { AbilityCode, AbilityCompare, AbilityCondition, AbilityDSLLexer, AbilityDSLParser, AbilityDSLToken, AbilityError, AbilityExplain, AbilityExplainPolicy, AbilityExplainRule, AbilityExplainRuleSet, AbilityJSONParser, AbilityMatch, AbilityParserError, AbilityPolicy, AbilityPolicyEffect, AbilityResolver, AbilityResult, AbilityRule, AbilityRuleSet, AbilityTypeGenerator };
-export type { AbilityCompareCodeType, AbilityConditionCodeType, AbilityConditionLiteralType, AbilityExplainConfig, AbilityExplainType, AbilityMatchCodeType, AbilityPolicyConfig, AbilityPolicyConstructorProps, AbilityPolicyEffectCodeType, AbilityRuleConfig, AbilityRuleConstructorProps, AbilityRuleSetConfig, AbilityRuleSetConstructorProps, NestedDict, Primitive, ResourceObject, ResourcesMap, TokenType };
+export { AbilityCode, AbilityCompare, AbilityCondition, AbilityDSLLexer, AbilityDSLParser, AbilityDSLToken, AbilityError, AbilityExplain, AbilityExplainPolicy, AbilityExplainRule, AbilityExplainRuleSet, AbilityJSONParser, AbilityMatch, AbilityParserError, AbilityPolicy, AbilityPolicyEffect, AbilityResolver, AbilityResult, AbilityResultState, AbilityRule, AbilityRuleSet, AbilityTypeGenerator };
+export type { AbilityCompareCodeType, AbilityConditionCodeType, AbilityConditionLiteralType, AbilityExplainConfig, AbilityExplainType, AbilityMatchCodeType, AbilityPolicyConfig, AbilityPolicyConstructorProps, AbilityPolicyEffectCodeType, AbilityResultStateCodeType, AbilityRuleConfig, AbilityRuleConstructorProps, AbilityRuleSetConfig, AbilityRuleSetConstructorProps, NestedDict, Primitive, ResourceObject, ResourcesMap, TokenType };

package/dist/index.js

@@ -364,7 +364,11 @@ class AbilityExplain {
     toString(indent = 0) {
         const pad = ' '.repeat(indent);
         const mark = this.match.code === AbilityMatch.match.code ? '✓' : '✗';
-        let out = `${pad}${mark} ${this.type} «${this.name}» is ${this.match.code}`;
+        let out = '';
+        if (this.type === 'policy') {
+            out += '\n';
+        }
+        out += `${pad}${mark} ${this.type} «${this.name}» is ${this.match.code}`;
         this.children.forEach(child => {
             out += '\n' + child.toString(indent + 1);
         });
@@ -518,6 +522,12 @@ class AbilityPolicyEffect extends AbilityCode {
     static permit = new AbilityPolicyEffect('permit');
 }
 
+class AbilityResultState extends AbilityCode {
+    static allow = new AbilityResultState('allow');
+    static deny = new AbilityResultState('deny');
+    static neutral = new AbilityResultState('neutral');
+}
+
 class AbilityResult {
     /**
      * Already checked policies (after call the policy.check())
@@ -545,27 +555,28 @@ class AbilityResult {
         }
         return null;
     }
-    isAllowed() {
-        const effect = this.getLastEffectOfMatchedPolicy();
-        return effect?.isEqual(AbilityPolicyEffect.permit) ?? false;
-    }
-    isDenied() {
-        const effect = this.getLastEffectOfMatchedPolicy();
-        return effect?.isEqual(AbilityPolicyEffect.deny) ?? true;
-    }
-    /**
-     * Get the last effect of the policy
-     *
-     * @returns {AbilityPolicyEffect | null}
-     */
-    getLastEffectOfMatchedPolicy() {
-        for (let i = this.policies.length - 1; i >= 0; i--) {
-            const p = this.policies[i];
+    getFinalState() {
+        let state = AbilityResultState.neutral;
+        for (const p of this.policies) {
             if (p.matchState.isEqual(AbilityMatch.match)) {
-                return p.effect;
+                if (p.effect.isEqual(AbilityPolicyEffect.permit)) {
+                    state = AbilityResultState.allow;
+                }
+                else if (p.effect.isEqual(AbilityPolicyEffect.deny)) {
+                    state = AbilityResultState.deny;
+                }
+            }
+            else if (p.matchState.isEqual(AbilityMatch.mismatch)) {
+                state = AbilityResultState.neutral;
             }
         }
-        return null;
+        return state;
+    }
+    isAllowed() {
+        return this.getFinalState().isEqual(AbilityResultState.allow);
+    }
+    isDenied() {
+        return this.getFinalState().isNotEqual(AbilityResultState.allow);
     }
 }
 
@@ -2185,6 +2196,7 @@ exports.AbilityPolicy = AbilityPolicy;
 exports.AbilityPolicyEffect = AbilityPolicyEffect;
 exports.AbilityResolver = AbilityResolver;
 exports.AbilityResult = AbilityResult;
+exports.AbilityResultState = AbilityResultState;
 exports.AbilityRule = AbilityRule;
 exports.AbilityRuleSet = AbilityRuleSet;
 exports.AbilityTypeGenerator = AbilityTypeGenerator;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@via-profit/ability",
   "support": "https://via-profit.ru",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "description": "Via-Profit Ability service",
   "keywords": [
     "ability",