@via-profit/ability 1.0.3 → 2.0.0-rc.2

package/dist/playground.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@via-profit/ability",
   "support": "https://via-profit.ru",
-  "version": "1.0.3",
+  "version": "2.0.0-rc.2",
   "description": "Via-Profit Ability service",
   "keywords": [
     "ability",
@@ -18,11 +18,13 @@
     "pretty": "prettier --write ./src",
     "build:dev": "cross-env NODE_ENV=development webpack --config ./webpack/webpack-config.ts --color --progress",
     "build:dist": "cross-env NODE_ENV=production webpack --config ./webpack/webpack-config.ts --color --progress",
+    "build:playground": "cross-env NODE_ENV=development webpack --config ./webpack/webpack-config-playground.ts --color --progress",
+    "playground": "npm run build:playground -- --watch",
     "test": "jest"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/via-profit/crm.graphql.git"
+    "url": "https://github.com/via-profit/ability.git"
   },
   "author": {
     "name": "Via Profit",

package/dist/AbilityService.d.ts

@@ -1,74 +0,0 @@
-import AbilityRule, { AbilityRuleStatus } from './AbilityRule';
-import AbilityPolicy, { AbilityCompareMethod, AbilityPolicyResult } from './AbilityPolicy';
-export type AbilityEnforceResult = {
-    readonly permission: AbilityRuleStatus;
-    readonly deniedRules: readonly AbilityRule[];
-    readonly deniedPolicies: readonly AbilityPolicy[];
-};
-declare class AbilityService {
-    /**
-     * Create the rule to compare
-     *
-     * @param ruleName {string} - The rule name
-     * @param effect {AbilityRuleStatus} - Return value
-     * @param matches {AbilityRuleMatches} - 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.**
-     */
-    createRule(...args: ConstructorParameters<typeof AbilityRule>): AbilityRule;
-    /**
-     * Create the Policy class instance
-     */
-    createPolicy(...args: ConstructorParameters<typeof AbilityPolicy>): AbilityPolicy;
-    checkPolicies(policiesResult: readonly AbilityPolicyResult[], compareMethod?: AbilityCompareMethod | undefined): AbilityEnforceResult;
-    enforcePolicies(policiesResult: readonly AbilityPolicyResult[], compareMethod?: AbilityCompareMethod | undefined): void | never;
-}
-export default AbilityService;

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;