@via-profit/ability 1.0.3 → 1.1.0

package/dist/AbilityPolicy.d.ts

@@ -73,6 +73,7 @@ export declare class AbilityPolicy<Subject = unknown, Resource = unknown, Enviro
      * Parse the config JSON format to Policy class instance
      */
     static parse<Subject = unknown, Resource = unknown, Environment = unknown>(configOrJson: AbilityPolicyConfig | string): AbilityPolicy<Subject, Resource, Environment>;
+    static export(policy: AbilityPolicy): AbilityPolicyConfig;
     static validatePolicy(policy: AbilityPolicy): void | never;
 }
 export default AbilityPolicy;

package/dist/AbilityRule.d.ts

@@ -104,5 +104,9 @@ export declare class AbilityRule<Subject = unknown, Resource = unknown, Environm
      * of config and returns the AbilityRule class instance
      */
     static parse<Subject = unknown, Resource = unknown, Environment = unknown>(configOrJson: AbilityRuleConfig | string): AbilityRule<Subject, Resource, Environment>;
+    /**
+     * Export the rule to config object
+     */
+    static export(rule: AbilityRule): AbilityRuleConfig;
 }
 export default AbilityRule;

package/dist/index.js

@@ -150,6 +150,12 @@ class AbilityPolicy {
             : configOrJson;
         // Create the empty policy
         const policy = new AbilityPolicy(name, id, description);
+        if (policiesCompareMethod) {
+            policy.policiesCompareMethod = policiesCompareMethod;
+        }
+        if (rulesCompareMethod) {
+            policy.rulesCompareMethod = rulesCompareMethod;
+        }
         if (description) {
             policy.setDescription(description);
         }
@@ -165,6 +171,17 @@ class AbilityPolicy {
         }
         return policy;
     }
+    static export(policy) {
+        const config = {
+            id: policy.id.toString(),
+            name: policy.name.toString(),
+            rulesCompareMethod: policy.rulesCompareMethod,
+            policiesCompareMethod: policy.policiesCompareMethod,
+            policies: policy.policies ? policy.policies.map(p => AbilityPolicy.export(p)) : undefined,
+            rules: policy.rules ? policy.rules.map(rule => AbilityRule_1.default.export(rule)) : undefined,
+        };
+        return config;
+    }
     static validatePolicy(policy) {
         if (policy.policies.length > 0 && policy.rules.length > 0) {
             throw new Error("The policy can't have a policies and rules at the same time");
@@ -384,6 +401,17 @@ class AbilityRule {
             : configOrJson;
         return new AbilityRule(matches, effect, name);
     }
+    /**
+     * Export the rule to config object
+     */
+    static export(rule) {
+        const config = {
+            name: rule.name,
+            effect: rule.effect,
+            matches: rule.matches,
+        };
+        return config;
+    }
 }
 exports.AbilityRule = AbilityRule;
 exports["default"] = AbilityRule;

package/package.json

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

package/dist/AbilityStatement.d.ts

@@ -1,98 +0,0 @@
-export type AbilityStatementStatus = 'permit' | 'deny';
-type SubjectPrefix = 'subject.' | 'environment.';
-export type AbilityStatementMatches = [
-    `${SubjectPrefix}${string}`,
-    AbilityCondition,
-    string | number | boolean
-];
-export type AbilityCondition = '=' | '<>' | '>' | '<' | '<=' | '>=' | 'in';
-declare class AbilityStatement {
-    matches: AbilityStatementMatches;
-    name: string;
-    effect: AbilityStatementStatus;
-    /**
-     * Create the statement to compare
-     *
-     * @param statementName {string} - The statement name
-     * @param effect {AbilityStatementStatus} - Return value
-     * @param matches {AbilityStatementMatches} - The matching rule he matching rule can be on of the format:
-     * \
-     * For example, be compared two's data\
-     * \
-     * _The subject_
-     * ```json
-     * {"userID": "1", "userDepartament": "NBC"}
-     * ```
-     * and _The resource_
-     * ```json
-     * {"departamentID": "154", "departamentName": "NBC"}
-     * ```
-     * \
-     * Now we can make the matching rule:
-     * ```json
-     * ["subject.userDepartament", "=", "resource.departamentName"]
-     * ```
-     *
-     * \
-     * **Example 2.**\
-     * In this case will be compared resource and string:
-     * \
-     * _The subject_
-     * ```json
-     * {"userID": "1", "userDepartament": "NBC"}
-     * ```
-     * and _The resource_ will be «undefined».\
-     * Now we can make the matching rule:
-     * ```json
-     * ["subject.userDepartament", "=", "NBC"]
-     * ```
-     * \
-     * **Example 3.**\
-     * In this case will be compared resource and array of string:\
-     * \
-     * _The subject_
-     * ```json
-     * {"userID": "1", "userDepartament": "NBC"}
-     * ```
-     * and _The resource_
-     * ```json
-     * ["FOX", "NBC", "AONE"]
-     * ```
-     * \
-     * Now we can make the matching rule:
-     * ```json
-     * ["subject.userDepartament", "=", "resource"]
-     * ```
-     * **Note: In this rule whe set the resource field as the «resource» string.\
-     * This means that we will compare the entire resource as a whole,\
-     * and not search for it by field name.**
-     * \
-     * **Example 4.**\
-     * In this case will be compared resource and array of string:\
-     * \
-     * _The subject_
-     * ```json
-     * {"user": {"account": {"roles": ["admin", "viewer"]}}}
-     * ```
-     * and _The resource_
-     * ```json
-     * undefined
-     * ```
-     * \
-     * Now we can make the matching rule:
-     * ```json
-     * ["subject.user.account.roles", "in", "admin"]
-     */
-    constructor(statementName: string, matches: AbilityStatementMatches, effect?: AbilityStatementStatus);
-    getName(): string;
-    getEffect(): AbilityStatementStatus;
-    isPermit(...args: Parameters<AbilityStatement['check']>): boolean;
-    isDeny(...args: Parameters<AbilityStatement['check']>): boolean;
-    check(subject: unknown, resource?: unknown | undefined, environment?: unknown | undefined): AbilityStatementStatus;
-    extractValues(sub: unknown, res?: unknown | undefined, env?: unknown | undefined): [
-        string | number | boolean | (string | number)[] | null | undefined,
-        string | number | boolean | (string | number)[] | null | undefined
-    ];
-    getDotNotationValue(resource: unknown, desc: string): unknown;
-}
-export default AbilityStatement;