@strapi/permissions 5.55.1 → 5.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/domain/permission/index.d.ts +5 -4
- package/dist/domain/permission/index.d.ts.map +1 -1
- package/dist/domain/permission/index.js +11 -6
- package/dist/domain/permission/index.js.map +1 -1
- package/dist/domain/permission/index.mjs +11 -6
- package/dist/domain/permission/index.mjs.map +1 -1
- package/dist/engine/abilities/casl-ability.js +3 -3
- package/dist/engine/abilities/casl-ability.js.map +1 -1
- package/dist/engine/abilities/casl-ability.mjs +3 -3
- package/dist/engine/abilities/casl-ability.mjs.map +1 -1
- package/dist/engine/hooks.js +4 -4
- package/dist/engine/hooks.js.map +1 -1
- package/dist/engine/hooks.mjs +4 -4
- package/dist/engine/hooks.mjs.map +1 -1
- package/dist/engine/index.d.ts.map +1 -1
- package/dist/engine/index.js +7 -9
- package/dist/engine/index.js.map +1 -1
- package/dist/engine/index.mjs +7 -9
- package/dist/engine/index.mjs.map +1 -1
- package/package.json +6 -6
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import _ from 'lodash
|
|
2
|
-
|
|
1
|
+
import _ from 'lodash';
|
|
2
|
+
/** Retains only fields supported by the permission domain. */
|
|
3
|
+
declare const sanitizePermissionFields: <T extends Partial<Permission>>(permission: T) => Pick<T, "action" | "subject" | "properties" | "conditions">;
|
|
3
4
|
export interface Permission {
|
|
4
5
|
action: string;
|
|
5
6
|
actionParameters?: Record<string, unknown>;
|
|
@@ -12,11 +13,11 @@ export interface Permission {
|
|
|
12
13
|
*
|
|
13
14
|
* @param {object} attributes
|
|
14
15
|
*/
|
|
15
|
-
declare const create: <T
|
|
16
|
+
declare const create: <T extends Partial<Permission>>(attributes: T) => Required<Pick<Permission, "subject" | "properties" | "conditions">> & Pick<T, "action" | "subject" | "properties" | "conditions">;
|
|
16
17
|
/**
|
|
17
18
|
* Add a condition to a permission
|
|
18
19
|
*/
|
|
19
|
-
declare const addCondition:
|
|
20
|
+
declare const addCondition: _.CurriedFunction2<string, Permission, Permission>;
|
|
20
21
|
/**
|
|
21
22
|
* Gets a property or a part of a property from a permission.
|
|
22
23
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/domain/permission/index.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/domain/permission/index.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAIvB,8DAA8D;AAC9D,QAAA,MAAM,wBAAwB,GAAI,CAAC,SAAS,OAAO,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,gEACvC,CAAC;AAExC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAaD;;;;GAIG;AACH,QAAA,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,sIACW,CAAC;AAExE;;GAEG;AACH,QAAA,MAAM,YAAY,oDAQhB,CAAC;AAEH;;GAEG;AACH,QAAA,MAAM,WAAW,yBAKhB,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var _ = require('lodash
|
|
3
|
+
var _ = require('lodash');
|
|
4
4
|
|
|
5
5
|
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
6
6
|
|
|
@@ -12,7 +12,7 @@ const PERMISSION_FIELDS = [
|
|
|
12
12
|
'properties',
|
|
13
13
|
'conditions'
|
|
14
14
|
];
|
|
15
|
-
const sanitizePermissionFields = ___default.default.pick(PERMISSION_FIELDS);
|
|
15
|
+
/** Retains only fields supported by the permission domain. */ const sanitizePermissionFields = (permission)=>___default.default.pick(permission, PERMISSION_FIELDS);
|
|
16
16
|
/**
|
|
17
17
|
* Creates a permission with default values for optional properties
|
|
18
18
|
*/ const getDefaultPermission = ()=>({
|
|
@@ -24,19 +24,24 @@ const sanitizePermissionFields = ___default.default.pick(PERMISSION_FIELDS);
|
|
|
24
24
|
* Create a new permission based on given attributes
|
|
25
25
|
*
|
|
26
26
|
* @param {object} attributes
|
|
27
|
-
*/ const create =
|
|
27
|
+
*/ const create = (attributes)=>___default.default.merge(getDefaultPermission(), sanitizePermissionFields(attributes));
|
|
28
28
|
/**
|
|
29
29
|
* Add a condition to a permission
|
|
30
30
|
*/ const addCondition = ___default.default.curry((condition, permission)=>{
|
|
31
31
|
const { conditions } = permission;
|
|
32
|
-
const newConditions = Array.isArray(conditions) ?
|
|
32
|
+
const newConditions = Array.isArray(conditions) ? [
|
|
33
|
+
...new Set(conditions.concat(condition))
|
|
34
|
+
] : [
|
|
33
35
|
condition
|
|
34
36
|
];
|
|
35
|
-
return
|
|
37
|
+
return {
|
|
38
|
+
...permission,
|
|
39
|
+
conditions: newConditions
|
|
40
|
+
};
|
|
36
41
|
});
|
|
37
42
|
/**
|
|
38
43
|
* Gets a property or a part of a property from a permission.
|
|
39
|
-
*/ const getProperty = ___default.default.curry((property, permission)=>___default.default.get(`properties.${property}
|
|
44
|
+
*/ const getProperty = ___default.default.curry((property, permission)=>___default.default.get(permission, `properties.${property}`));
|
|
40
45
|
|
|
41
46
|
exports.addCondition = addCondition;
|
|
42
47
|
exports.create = create;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../../src/domain/permission/index.ts"],"sourcesContent":["import _ from 'lodash
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../../src/domain/permission/index.ts"],"sourcesContent":["import _ from 'lodash';\n\nconst PERMISSION_FIELDS = ['action', 'subject', 'properties', 'conditions'] as const;\n\n/** Retains only fields supported by the permission domain. */\nconst sanitizePermissionFields = <T extends Partial<Permission>>(permission: T) =>\n _.pick(permission, PERMISSION_FIELDS);\n\nexport interface Permission {\n action: string;\n actionParameters?: Record<string, unknown>;\n subject?: string | object | null;\n properties?: Record<string, any>;\n conditions?: string[];\n}\n\n/**\n * Creates a permission with default values for optional properties\n */\nconst getDefaultPermission = (): Required<\n Pick<Permission, 'conditions' | 'properties' | 'subject'>\n> => ({\n conditions: [],\n properties: {},\n subject: null,\n});\n\n/**\n * Create a new permission based on given attributes\n *\n * @param {object} attributes\n */\nconst create = <T extends Partial<Permission>>(attributes: T) =>\n _.merge(getDefaultPermission(), sanitizePermissionFields(attributes));\n\n/**\n * Add a condition to a permission\n */\nconst addCondition = _.curry((condition: string, permission: Permission): Permission => {\n const { conditions } = permission;\n\n const newConditions = Array.isArray(conditions)\n ? [...new Set(conditions.concat(condition))]\n : [condition];\n\n return { ...permission, conditions: newConditions };\n});\n\n/**\n * Gets a property or a part of a property from a permission.\n */\nconst getProperty = _.curry(\n <T extends keyof Permission['properties']>(\n property: T,\n permission: Permission\n ): Permission['properties'][T] => _.get(permission, `properties.${property}`)\n);\n\nexport { create, sanitizePermissionFields, addCondition, getProperty };\n"],"names":["PERMISSION_FIELDS","sanitizePermissionFields","permission","_","pick","getDefaultPermission","conditions","properties","subject","create","attributes","merge","addCondition","curry","condition","newConditions","Array","isArray","Set","concat","getProperty","property","get"],"mappings":";;;;;;;;AAEA,MAAMA,iBAAAA,GAAoB;AAAC,IAAA,QAAA;AAAU,IAAA,SAAA;AAAW,IAAA,YAAA;AAAc,IAAA;AAAa,CAAA;AAE3E,qEACMC,wBAAAA,GAA2B,CAAgCC,aAC/DC,kBAAAA,CAAEC,IAAI,CAACF,UAAAA,EAAYF,iBAAAA;AAUrB;;IAGA,MAAMK,oBAAAA,GAAuB,KAEvB;AACJC,QAAAA,UAAAA,EAAY,EAAE;AACdC,QAAAA,UAAAA,EAAY,EAAC;QACbC,OAAAA,EAAS;KACX,CAAA;AAEA;;;;IAKA,MAAMC,SAAS,CAAgCC,UAAAA,GAC7CP,mBAAEQ,KAAK,CAACN,wBAAwBJ,wBAAAA,CAAyBS,UAAAA,CAAAA;AAE3D;;AAEC,UACKE,YAAAA,GAAeT,kBAAAA,CAAEU,KAAK,CAAC,CAACC,SAAAA,EAAmBZ,UAAAA,GAAAA;IAC/C,MAAM,EAAEI,UAAU,EAAE,GAAGJ,UAAAA;AAEvB,IAAA,MAAMa,aAAAA,GAAgBC,KAAAA,CAAMC,OAAO,CAACX,UAAAA,CAAAA,GAChC;WAAI,IAAIY,GAAAA,CAAIZ,UAAAA,CAAWa,MAAM,CAACL,SAAAA,CAAAA;KAAY,GAC1C;AAACA,QAAAA;AAAU,KAAA;IAEf,OAAO;AAAE,QAAA,GAAGZ,UAAU;QAAEI,UAAAA,EAAYS;AAAc,KAAA;AACpD,CAAA;AAEA;;AAEC,IACD,MAAMK,WAAAA,GAAcjB,kBAAAA,CAAEU,KAAK,CACzB,CACEQ,QAAAA,EACAnB,UAAAA,GACgCC,kBAAAA,CAAEmB,GAAG,CAACpB,UAAAA,EAAY,CAAC,WAAW,EAAEmB,QAAAA,CAAAA,CAAU,CAAA;;;;;;;"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import _ from 'lodash
|
|
1
|
+
import _ from 'lodash';
|
|
2
2
|
|
|
3
3
|
const PERMISSION_FIELDS = [
|
|
4
4
|
'action',
|
|
@@ -6,7 +6,7 @@ const PERMISSION_FIELDS = [
|
|
|
6
6
|
'properties',
|
|
7
7
|
'conditions'
|
|
8
8
|
];
|
|
9
|
-
const sanitizePermissionFields = _.pick(PERMISSION_FIELDS);
|
|
9
|
+
/** Retains only fields supported by the permission domain. */ const sanitizePermissionFields = (permission)=>_.pick(permission, PERMISSION_FIELDS);
|
|
10
10
|
/**
|
|
11
11
|
* Creates a permission with default values for optional properties
|
|
12
12
|
*/ const getDefaultPermission = ()=>({
|
|
@@ -18,19 +18,24 @@ const sanitizePermissionFields = _.pick(PERMISSION_FIELDS);
|
|
|
18
18
|
* Create a new permission based on given attributes
|
|
19
19
|
*
|
|
20
20
|
* @param {object} attributes
|
|
21
|
-
*/ const create =
|
|
21
|
+
*/ const create = (attributes)=>_.merge(getDefaultPermission(), sanitizePermissionFields(attributes));
|
|
22
22
|
/**
|
|
23
23
|
* Add a condition to a permission
|
|
24
24
|
*/ const addCondition = _.curry((condition, permission)=>{
|
|
25
25
|
const { conditions } = permission;
|
|
26
|
-
const newConditions = Array.isArray(conditions) ?
|
|
26
|
+
const newConditions = Array.isArray(conditions) ? [
|
|
27
|
+
...new Set(conditions.concat(condition))
|
|
28
|
+
] : [
|
|
27
29
|
condition
|
|
28
30
|
];
|
|
29
|
-
return
|
|
31
|
+
return {
|
|
32
|
+
...permission,
|
|
33
|
+
conditions: newConditions
|
|
34
|
+
};
|
|
30
35
|
});
|
|
31
36
|
/**
|
|
32
37
|
* Gets a property or a part of a property from a permission.
|
|
33
|
-
*/ const getProperty = _.curry((property, permission)=>_.get(`properties.${property}
|
|
38
|
+
*/ const getProperty = _.curry((property, permission)=>_.get(permission, `properties.${property}`));
|
|
34
39
|
|
|
35
40
|
export { addCondition, create, getProperty, sanitizePermissionFields };
|
|
36
41
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":["../../../src/domain/permission/index.ts"],"sourcesContent":["import _ from 'lodash
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":["../../../src/domain/permission/index.ts"],"sourcesContent":["import _ from 'lodash';\n\nconst PERMISSION_FIELDS = ['action', 'subject', 'properties', 'conditions'] as const;\n\n/** Retains only fields supported by the permission domain. */\nconst sanitizePermissionFields = <T extends Partial<Permission>>(permission: T) =>\n _.pick(permission, PERMISSION_FIELDS);\n\nexport interface Permission {\n action: string;\n actionParameters?: Record<string, unknown>;\n subject?: string | object | null;\n properties?: Record<string, any>;\n conditions?: string[];\n}\n\n/**\n * Creates a permission with default values for optional properties\n */\nconst getDefaultPermission = (): Required<\n Pick<Permission, 'conditions' | 'properties' | 'subject'>\n> => ({\n conditions: [],\n properties: {},\n subject: null,\n});\n\n/**\n * Create a new permission based on given attributes\n *\n * @param {object} attributes\n */\nconst create = <T extends Partial<Permission>>(attributes: T) =>\n _.merge(getDefaultPermission(), sanitizePermissionFields(attributes));\n\n/**\n * Add a condition to a permission\n */\nconst addCondition = _.curry((condition: string, permission: Permission): Permission => {\n const { conditions } = permission;\n\n const newConditions = Array.isArray(conditions)\n ? [...new Set(conditions.concat(condition))]\n : [condition];\n\n return { ...permission, conditions: newConditions };\n});\n\n/**\n * Gets a property or a part of a property from a permission.\n */\nconst getProperty = _.curry(\n <T extends keyof Permission['properties']>(\n property: T,\n permission: Permission\n ): Permission['properties'][T] => _.get(permission, `properties.${property}`)\n);\n\nexport { create, sanitizePermissionFields, addCondition, getProperty };\n"],"names":["PERMISSION_FIELDS","sanitizePermissionFields","permission","_","pick","getDefaultPermission","conditions","properties","subject","create","attributes","merge","addCondition","curry","condition","newConditions","Array","isArray","Set","concat","getProperty","property","get"],"mappings":";;AAEA,MAAMA,iBAAAA,GAAoB;AAAC,IAAA,QAAA;AAAU,IAAA,SAAA;AAAW,IAAA,YAAA;AAAc,IAAA;AAAa,CAAA;AAE3E,qEACMC,wBAAAA,GAA2B,CAAgCC,aAC/DC,CAAAA,CAAEC,IAAI,CAACF,UAAAA,EAAYF,iBAAAA;AAUrB;;IAGA,MAAMK,oBAAAA,GAAuB,KAEvB;AACJC,QAAAA,UAAAA,EAAY,EAAE;AACdC,QAAAA,UAAAA,EAAY,EAAC;QACbC,OAAAA,EAAS;KACX,CAAA;AAEA;;;;IAKA,MAAMC,SAAS,CAAgCC,UAAAA,GAC7CP,EAAEQ,KAAK,CAACN,wBAAwBJ,wBAAAA,CAAyBS,UAAAA,CAAAA;AAE3D;;AAEC,UACKE,YAAAA,GAAeT,CAAAA,CAAEU,KAAK,CAAC,CAACC,SAAAA,EAAmBZ,UAAAA,GAAAA;IAC/C,MAAM,EAAEI,UAAU,EAAE,GAAGJ,UAAAA;AAEvB,IAAA,MAAMa,aAAAA,GAAgBC,KAAAA,CAAMC,OAAO,CAACX,UAAAA,CAAAA,GAChC;WAAI,IAAIY,GAAAA,CAAIZ,UAAAA,CAAWa,MAAM,CAACL,SAAAA,CAAAA;KAAY,GAC1C;AAACA,QAAAA;AAAU,KAAA;IAEf,OAAO;AAAE,QAAA,GAAGZ,UAAU;QAAEI,UAAAA,EAAYS;AAAc,KAAA;AACpD,CAAA;AAEA;;AAEC,IACD,MAAMK,WAAAA,GAAcjB,CAAAA,CAAEU,KAAK,CACzB,CACEQ,QAAAA,EACAnB,UAAAA,GACgCC,CAAAA,CAAEmB,GAAG,CAACpB,UAAAA,EAAY,CAAC,WAAW,EAAEmB,QAAAA,CAAAA,CAAU,CAAA;;;;"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
var sift = require('sift');
|
|
4
4
|
var qs = require('qs');
|
|
5
5
|
var ability = require('@casl/ability');
|
|
6
|
-
var _ = require('lodash
|
|
6
|
+
var _ = require('lodash');
|
|
7
7
|
|
|
8
8
|
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
9
9
|
|
|
@@ -42,7 +42,7 @@ const allowedOperations = [
|
|
|
42
42
|
'$exists',
|
|
43
43
|
'$elemMatch'
|
|
44
44
|
];
|
|
45
|
-
const operations = _.pick(
|
|
45
|
+
const operations = _.pick(sift__namespace, allowedOperations);
|
|
46
46
|
/**
|
|
47
47
|
* Match an RBAC condition query against an entity in memory with sift.
|
|
48
48
|
*/ const conditionsMatcher = (conditions)=>{
|
|
@@ -72,7 +72,7 @@ const buildParametrizedAction = ({ name, params })=>{
|
|
|
72
72
|
const { action, subject, properties = {}, condition } = permission;
|
|
73
73
|
const { fields } = properties;
|
|
74
74
|
const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);
|
|
75
|
-
return can(caslAction,
|
|
75
|
+
return can(caslAction, subject == null ? 'all' : subject, fields, _.isObject(condition) ? condition : undefined);
|
|
76
76
|
},
|
|
77
77
|
buildParametrizedAction ({ name, params }) {
|
|
78
78
|
return `${name}?${qs__default.default.stringify(params)}`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"casl-ability.js","sources":["../../../src/engine/abilities/casl-ability.ts"],"sourcesContent":["import * as sift from 'sift';\nimport qs from 'qs';\nimport { AbilityBuilder, Ability } from '@casl/ability';\nimport { pick,
|
|
1
|
+
{"version":3,"file":"casl-ability.js","sources":["../../../src/engine/abilities/casl-ability.ts"],"sourcesContent":["import * as sift from 'sift';\nimport qs from 'qs';\nimport { AbilityBuilder, Ability } from '@casl/ability';\nimport { pick, isObject } from 'lodash';\nimport type { ParametrizedAction, PermissionRule } from '../../types';\n\nexport interface CustomAbilityBuilder {\n can(permission: PermissionRule): ReturnType<AbilityBuilder<Ability>['can']>;\n buildParametrizedAction: (parametrizedAction: ParametrizedAction) => string;\n build(): Ability;\n}\n\nconst allowedOperations = [\n '$or',\n '$and',\n '$eq',\n '$ne',\n '$in',\n '$nin',\n '$lt',\n '$lte',\n '$gt',\n '$gte',\n '$exists',\n '$elemMatch',\n] as const;\n\nconst operations = pick(sift, allowedOperations);\n\n/**\n * Match an RBAC condition query against an entity in memory with sift.\n */\nconst conditionsMatcher = (conditions: unknown) => {\n try {\n return sift.createQueryTester(conditions, { operations });\n } catch (error) {\n if (error instanceof Error) {\n const [, operator] = error.message.match(/^Unsupported operation: (.+)$/) ?? [];\n\n if (operator) {\n throw new Error(\n `RBAC condition uses unsupported operator \"${operator}\". Conditions are matched in memory and support only: ${allowedOperations.join(\n ', '\n )}.`\n );\n }\n }\n\n throw error;\n }\n};\n\nconst buildParametrizedAction = ({ name, params }: ParametrizedAction) => {\n return `${name}?${qs.stringify(params)}`;\n};\n\n/**\n * Casl Ability Builder.\n */\nexport const caslAbilityBuilder = (): CustomAbilityBuilder => {\n const { can, build, ...rest } = new AbilityBuilder(Ability);\n\n return {\n can(permission: PermissionRule) {\n const { action, subject, properties = {}, condition } = permission;\n const { fields } = properties;\n\n const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n return can(\n caslAction,\n subject == null ? 'all' : subject,\n fields,\n isObject(condition) ? condition : undefined\n );\n },\n\n buildParametrizedAction({ name, params }: ParametrizedAction) {\n return `${name}?${qs.stringify(params)}`;\n },\n\n build() {\n const ability = build({ conditionsMatcher });\n\n function decorateCan(originalCan: Ability['can']) {\n return function canWithParametrizedAction(...args: Parameters<Ability['can']>) {\n const [action, ...rest] = args;\n const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n // Call the original `can` method\n return originalCan.apply(ability, [caslAction, ...rest]);\n };\n }\n\n ability.can = decorateCan(ability.can);\n return ability;\n },\n\n ...rest,\n };\n};\n"],"names":["allowedOperations","operations","pick","sift","conditionsMatcher","conditions","createQueryTester","error","Error","operator","message","match","join","buildParametrizedAction","name","params","qs","stringify","caslAbilityBuilder","can","build","rest","AbilityBuilder","Ability","permission","action","subject","properties","condition","fields","caslAction","isObject","undefined","ability","decorateCan","originalCan","canWithParametrizedAction","args","apply"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,MAAMA,iBAAAA,GAAoB;AACxB,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,KAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,SAAA;AACA,IAAA;AACD,CAAA;AAED,MAAMC,UAAAA,GAAaC,OAAKC,eAAAA,EAAMH,iBAAAA,CAAAA;AAE9B;;IAGA,MAAMI,oBAAoB,CAACC,UAAAA,GAAAA;IACzB,IAAI;QACF,OAAOF,eAAAA,CAAKG,iBAAiB,CAACD,UAAAA,EAAY;AAAEJ,YAAAA;AAAW,SAAA,CAAA;AACzD,IAAA,CAAA,CAAE,OAAOM,KAAAA,EAAO;AACd,QAAA,IAAIA,iBAAiBC,KAAAA,EAAO;YAC1B,MAAM,GAAGC,SAAS,GAAGF,KAAAA,CAAMG,OAAO,CAACC,KAAK,CAAC,+BAAA,CAAA,IAAoC,EAAE;AAE/E,YAAA,IAAIF,QAAAA,EAAU;AACZ,gBAAA,MAAM,IAAID,KAAAA,CACR,CAAC,0CAA0C,EAAEC,QAAAA,CAAS,sDAAsD,EAAET,iBAAAA,CAAkBY,IAAI,CAClI,IAAA,CAAA,CACA,CAAC,CAAC,CAAA;AAER,YAAA;AACF,QAAA;QAEA,MAAML,KAAAA;AACR,IAAA;AACF,CAAA;AAEA,MAAMM,0BAA0B,CAAC,EAAEC,IAAI,EAAEC,MAAM,EAAsB,GAAA;AACnE,IAAA,OAAO,GAAGD,IAAAA,CAAK,CAAC,EAAEE,mBAAAA,CAAGC,SAAS,CAACF,MAAAA,CAAAA,CAAAA,CAAS;AAC1C,CAAA;AAEA;;UAGaG,kBAAAA,GAAqB,IAAA;IAChC,MAAM,EAAEC,GAAG,EAAEC,KAAK,EAAE,GAAGC,IAAAA,EAAM,GAAG,IAAIC,sBAAAA,CAAeC,eAAAA,CAAAA;IAEnD,OAAO;AACLJ,QAAAA,GAAAA,CAAAA,CAAIK,UAA0B,EAAA;YAC5B,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,UAAAA,GAAa,EAAE,EAAEC,SAAS,EAAE,GAAGJ,UAAAA;YACxD,MAAM,EAAEK,MAAM,EAAE,GAAGF,UAAAA;AAEnB,YAAA,MAAMG,UAAAA,GAAa,OAAOL,MAAAA,KAAW,QAAA,GAAWA,SAASZ,uBAAAA,CAAwBY,MAAAA,CAAAA;YAEjF,OAAON,GAAAA,CACLW,YACAJ,OAAAA,IAAW,IAAA,GAAO,QAAQA,OAAAA,EAC1BG,MAAAA,EACAE,UAAAA,CAASH,SAAAA,CAAAA,GAAaA,SAAAA,GAAYI,SAAAA,CAAAA;AAEtC,QAAA,CAAA;AAEAnB,QAAAA,uBAAAA,CAAAA,CAAwB,EAAEC,IAAI,EAAEC,MAAM,EAAsB,EAAA;AAC1D,YAAA,OAAO,GAAGD,IAAAA,CAAK,CAAC,EAAEE,mBAAAA,CAAGC,SAAS,CAACF,MAAAA,CAAAA,CAAAA,CAAS;AAC1C,QAAA,CAAA;AAEAK,QAAAA,KAAAA,CAAAA,GAAAA;AACE,YAAA,MAAMa,UAAUb,KAAAA,CAAM;AAAEhB,gBAAAA;AAAkB,aAAA,CAAA;AAE1C,YAAA,SAAS8B,YAAYC,WAA2B,EAAA;gBAC9C,OAAO,SAASC,yBAAAA,CAA0B,GAAGC,IAAgC,EAAA;AAC3E,oBAAA,MAAM,CAACZ,MAAAA,EAAQ,GAAGJ,IAAAA,CAAK,GAAGgB,IAAAA;AAC1B,oBAAA,MAAMP,UAAAA,GAAa,OAAOL,MAAAA,KAAW,QAAA,GAAWA,SAASZ,uBAAAA,CAAwBY,MAAAA,CAAAA;;oBAGjF,OAAOU,WAAAA,CAAYG,KAAK,CAACL,OAAAA,EAAS;AAACH,wBAAAA,UAAAA;AAAeT,wBAAAA,GAAAA;AAAK,qBAAA,CAAA;AACzD,gBAAA,CAAA;AACF,YAAA;AAEAY,YAAAA,OAAAA,CAAQd,GAAG,GAAGe,WAAAA,CAAYD,OAAAA,CAAQd,GAAG,CAAA;YACrC,OAAOc,OAAAA;AACT,QAAA,CAAA;AAEA,QAAA,GAAGZ;AACL,KAAA;AACF;;;;"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as sift from 'sift';
|
|
2
2
|
import qs from 'qs';
|
|
3
3
|
import { AbilityBuilder, Ability } from '@casl/ability';
|
|
4
|
-
import { pick,
|
|
4
|
+
import { pick, isObject } from 'lodash';
|
|
5
5
|
|
|
6
6
|
const allowedOperations = [
|
|
7
7
|
'$or',
|
|
@@ -17,7 +17,7 @@ const allowedOperations = [
|
|
|
17
17
|
'$exists',
|
|
18
18
|
'$elemMatch'
|
|
19
19
|
];
|
|
20
|
-
const operations = pick(
|
|
20
|
+
const operations = pick(sift, allowedOperations);
|
|
21
21
|
/**
|
|
22
22
|
* Match an RBAC condition query against an entity in memory with sift.
|
|
23
23
|
*/ const conditionsMatcher = (conditions)=>{
|
|
@@ -47,7 +47,7 @@ const buildParametrizedAction = ({ name, params })=>{
|
|
|
47
47
|
const { action, subject, properties = {}, condition } = permission;
|
|
48
48
|
const { fields } = properties;
|
|
49
49
|
const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);
|
|
50
|
-
return can(caslAction,
|
|
50
|
+
return can(caslAction, subject == null ? 'all' : subject, fields, isObject(condition) ? condition : undefined);
|
|
51
51
|
},
|
|
52
52
|
buildParametrizedAction ({ name, params }) {
|
|
53
53
|
return `${name}?${qs.stringify(params)}`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"casl-ability.mjs","sources":["../../../src/engine/abilities/casl-ability.ts"],"sourcesContent":["import * as sift from 'sift';\nimport qs from 'qs';\nimport { AbilityBuilder, Ability } from '@casl/ability';\nimport { pick,
|
|
1
|
+
{"version":3,"file":"casl-ability.mjs","sources":["../../../src/engine/abilities/casl-ability.ts"],"sourcesContent":["import * as sift from 'sift';\nimport qs from 'qs';\nimport { AbilityBuilder, Ability } from '@casl/ability';\nimport { pick, isObject } from 'lodash';\nimport type { ParametrizedAction, PermissionRule } from '../../types';\n\nexport interface CustomAbilityBuilder {\n can(permission: PermissionRule): ReturnType<AbilityBuilder<Ability>['can']>;\n buildParametrizedAction: (parametrizedAction: ParametrizedAction) => string;\n build(): Ability;\n}\n\nconst allowedOperations = [\n '$or',\n '$and',\n '$eq',\n '$ne',\n '$in',\n '$nin',\n '$lt',\n '$lte',\n '$gt',\n '$gte',\n '$exists',\n '$elemMatch',\n] as const;\n\nconst operations = pick(sift, allowedOperations);\n\n/**\n * Match an RBAC condition query against an entity in memory with sift.\n */\nconst conditionsMatcher = (conditions: unknown) => {\n try {\n return sift.createQueryTester(conditions, { operations });\n } catch (error) {\n if (error instanceof Error) {\n const [, operator] = error.message.match(/^Unsupported operation: (.+)$/) ?? [];\n\n if (operator) {\n throw new Error(\n `RBAC condition uses unsupported operator \"${operator}\". Conditions are matched in memory and support only: ${allowedOperations.join(\n ', '\n )}.`\n );\n }\n }\n\n throw error;\n }\n};\n\nconst buildParametrizedAction = ({ name, params }: ParametrizedAction) => {\n return `${name}?${qs.stringify(params)}`;\n};\n\n/**\n * Casl Ability Builder.\n */\nexport const caslAbilityBuilder = (): CustomAbilityBuilder => {\n const { can, build, ...rest } = new AbilityBuilder(Ability);\n\n return {\n can(permission: PermissionRule) {\n const { action, subject, properties = {}, condition } = permission;\n const { fields } = properties;\n\n const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n return can(\n caslAction,\n subject == null ? 'all' : subject,\n fields,\n isObject(condition) ? condition : undefined\n );\n },\n\n buildParametrizedAction({ name, params }: ParametrizedAction) {\n return `${name}?${qs.stringify(params)}`;\n },\n\n build() {\n const ability = build({ conditionsMatcher });\n\n function decorateCan(originalCan: Ability['can']) {\n return function canWithParametrizedAction(...args: Parameters<Ability['can']>) {\n const [action, ...rest] = args;\n const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n // Call the original `can` method\n return originalCan.apply(ability, [caslAction, ...rest]);\n };\n }\n\n ability.can = decorateCan(ability.can);\n return ability;\n },\n\n ...rest,\n };\n};\n"],"names":["allowedOperations","operations","pick","sift","conditionsMatcher","conditions","createQueryTester","error","Error","operator","message","match","join","buildParametrizedAction","name","params","qs","stringify","caslAbilityBuilder","can","build","rest","AbilityBuilder","Ability","permission","action","subject","properties","condition","fields","caslAction","isObject","undefined","ability","decorateCan","originalCan","canWithParametrizedAction","args","apply"],"mappings":";;;;;AAYA,MAAMA,iBAAAA,GAAoB;AACxB,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,KAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA,SAAA;AACA,IAAA;AACD,CAAA;AAED,MAAMC,UAAAA,GAAaC,KAAKC,IAAAA,EAAMH,iBAAAA,CAAAA;AAE9B;;IAGA,MAAMI,oBAAoB,CAACC,UAAAA,GAAAA;IACzB,IAAI;QACF,OAAOF,IAAAA,CAAKG,iBAAiB,CAACD,UAAAA,EAAY;AAAEJ,YAAAA;AAAW,SAAA,CAAA;AACzD,IAAA,CAAA,CAAE,OAAOM,KAAAA,EAAO;AACd,QAAA,IAAIA,iBAAiBC,KAAAA,EAAO;YAC1B,MAAM,GAAGC,SAAS,GAAGF,KAAAA,CAAMG,OAAO,CAACC,KAAK,CAAC,+BAAA,CAAA,IAAoC,EAAE;AAE/E,YAAA,IAAIF,QAAAA,EAAU;AACZ,gBAAA,MAAM,IAAID,KAAAA,CACR,CAAC,0CAA0C,EAAEC,QAAAA,CAAS,sDAAsD,EAAET,iBAAAA,CAAkBY,IAAI,CAClI,IAAA,CAAA,CACA,CAAC,CAAC,CAAA;AAER,YAAA;AACF,QAAA;QAEA,MAAML,KAAAA;AACR,IAAA;AACF,CAAA;AAEA,MAAMM,0BAA0B,CAAC,EAAEC,IAAI,EAAEC,MAAM,EAAsB,GAAA;AACnE,IAAA,OAAO,GAAGD,IAAAA,CAAK,CAAC,EAAEE,EAAAA,CAAGC,SAAS,CAACF,MAAAA,CAAAA,CAAAA,CAAS;AAC1C,CAAA;AAEA;;UAGaG,kBAAAA,GAAqB,IAAA;IAChC,MAAM,EAAEC,GAAG,EAAEC,KAAK,EAAE,GAAGC,IAAAA,EAAM,GAAG,IAAIC,cAAAA,CAAeC,OAAAA,CAAAA;IAEnD,OAAO;AACLJ,QAAAA,GAAAA,CAAAA,CAAIK,UAA0B,EAAA;YAC5B,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,UAAAA,GAAa,EAAE,EAAEC,SAAS,EAAE,GAAGJ,UAAAA;YACxD,MAAM,EAAEK,MAAM,EAAE,GAAGF,UAAAA;AAEnB,YAAA,MAAMG,UAAAA,GAAa,OAAOL,MAAAA,KAAW,QAAA,GAAWA,SAASZ,uBAAAA,CAAwBY,MAAAA,CAAAA;YAEjF,OAAON,GAAAA,CACLW,YACAJ,OAAAA,IAAW,IAAA,GAAO,QAAQA,OAAAA,EAC1BG,MAAAA,EACAE,QAAAA,CAASH,SAAAA,CAAAA,GAAaA,SAAAA,GAAYI,SAAAA,CAAAA;AAEtC,QAAA,CAAA;AAEAnB,QAAAA,uBAAAA,CAAAA,CAAwB,EAAEC,IAAI,EAAEC,MAAM,EAAsB,EAAA;AAC1D,YAAA,OAAO,GAAGD,IAAAA,CAAK,CAAC,EAAEE,EAAAA,CAAGC,SAAS,CAACF,MAAAA,CAAAA,CAAAA,CAAS;AAC1C,QAAA,CAAA;AAEAK,QAAAA,KAAAA,CAAAA,GAAAA;AACE,YAAA,MAAMa,UAAUb,KAAAA,CAAM;AAAEhB,gBAAAA;AAAkB,aAAA,CAAA;AAE1C,YAAA,SAAS8B,YAAYC,WAA2B,EAAA;gBAC9C,OAAO,SAASC,yBAAAA,CAA0B,GAAGC,IAAgC,EAAA;AAC3E,oBAAA,MAAM,CAACZ,MAAAA,EAAQ,GAAGJ,IAAAA,CAAK,GAAGgB,IAAAA;AAC1B,oBAAA,MAAMP,UAAAA,GAAa,OAAOL,MAAAA,KAAW,QAAA,GAAWA,SAASZ,uBAAAA,CAAwBY,MAAAA,CAAAA;;oBAGjF,OAAOU,WAAAA,CAAYG,KAAK,CAACL,OAAAA,EAAS;AAACH,wBAAAA,UAAAA;AAAeT,wBAAAA,GAAAA;AAAK,qBAAA,CAAA;AACzD,gBAAA,CAAA;AACF,YAAA;AAEAY,YAAAA,OAAAA,CAAQd,GAAG,GAAGe,WAAAA,CAAYD,OAAAA,CAAQd,GAAG,CAAA;YACrC,OAAOc,OAAAA;AACT,QAAA,CAAA;AAEA,QAAA,GAAGZ;AACL,KAAA;AACF;;;;"}
|
package/dist/engine/hooks.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var _ = require('lodash
|
|
3
|
+
var _ = require('lodash');
|
|
4
4
|
var utils = require('@strapi/utils');
|
|
5
5
|
var index = require('../domain/permission/index.js');
|
|
6
6
|
|
|
@@ -46,7 +46,7 @@ var index = require('../domain/permission/index.js');
|
|
|
46
46
|
$and: []
|
|
47
47
|
};
|
|
48
48
|
}
|
|
49
|
-
if (
|
|
49
|
+
if (Array.isArray(permission.condition.$and)) {
|
|
50
50
|
permission.condition.$and.push(rawConditionObject);
|
|
51
51
|
}
|
|
52
52
|
return this;
|
|
@@ -57,8 +57,8 @@ var index = require('../domain/permission/index.js');
|
|
|
57
57
|
$and: []
|
|
58
58
|
};
|
|
59
59
|
}
|
|
60
|
-
if (
|
|
61
|
-
const orClause = permission.condition.$and.find(_.has('$or'));
|
|
60
|
+
if (Array.isArray(permission.condition.$and)) {
|
|
61
|
+
const orClause = permission.condition.$and.find((clause)=>_.has(clause, '$or'));
|
|
62
62
|
if (orClause) {
|
|
63
63
|
orClause.$or.push(rawConditionObject);
|
|
64
64
|
} else {
|
package/dist/engine/hooks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has
|
|
1
|
+
{"version":3,"file":"hooks.js","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has } from 'lodash';\nimport { hooks } from '@strapi/utils';\n\nimport * as domain from '../domain';\nimport type { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport interface PermissionEngineHooks {\n 'before-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;\n 'format.permission': ReturnType<typeof hooks.createAsyncSeriesWaterfallHook>;\n 'after-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;\n 'before-evaluate.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;\n 'before-register.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;\n}\n\nexport type HookName = keyof PermissionEngineHooks;\n\n/**\n * Create a hook map used by the permission Engine\n */\nconst createEngineHooks = (): PermissionEngineHooks => ({\n 'before-format::validate.permission': hooks.createAsyncBailHook(),\n 'format.permission': hooks.createAsyncSeriesWaterfallHook(),\n 'after-format::validate.permission': hooks.createAsyncBailHook(),\n 'before-evaluate.permission': hooks.createAsyncSeriesHook(),\n 'before-register.permission': hooks.createAsyncSeriesHook(),\n});\n\n/**\n * Create a context from a domain {@link Permission} used by the validate hooks\n */\nconst createValidateContext = (permission: Permission) => ({\n get permission(): Readonly<Permission> {\n return cloneDeep(permission);\n },\n});\n\n/**\n * Create a context from a domain {@link Permission} used by the before valuate hook\n */\nconst createBeforeEvaluateContext = (permission: Permission) => ({\n get permission(): Readonly<Permission> {\n return cloneDeep(permission);\n },\n\n addCondition(condition: string) {\n Object.assign(permission, domain.permission.addCondition(condition, permission));\n\n return this;\n },\n});\n\ninterface WillRegisterContextParams {\n permission: PermissionRule;\n options: Record<string, unknown>;\n}\n\n/**\n * Create a context from a casl Permission & some options\n * @param caslPermission\n */\nconst createWillRegisterContext = ({ permission, options }: WillRegisterContextParams) => ({\n ...options,\n\n get permission() {\n return cloneDeep(permission);\n },\n\n condition: {\n and(rawConditionObject: unknown) {\n if (!permission.condition) {\n permission.condition = { $and: [] };\n }\n\n if (Array.isArray(permission.condition.$and)) {\n permission.condition.$and.push(rawConditionObject);\n }\n\n return this;\n },\n\n or(rawConditionObject: unknown) {\n if (!permission.condition) {\n permission.condition = { $and: [] };\n }\n\n if (Array.isArray(permission.condition.$and)) {\n const orClause = permission.condition.$and.find((clause) => has(clause, '$or'));\n\n if (orClause) {\n orClause.$or.push(rawConditionObject);\n } else {\n permission.condition.$and.push({ $or: [rawConditionObject] });\n }\n }\n\n return this;\n },\n },\n});\n\nexport {\n createEngineHooks,\n createValidateContext,\n createBeforeEvaluateContext,\n createWillRegisterContext,\n};\n"],"names":["createEngineHooks","hooks","createAsyncBailHook","createAsyncSeriesWaterfallHook","createAsyncSeriesHook","createValidateContext","permission","cloneDeep","createBeforeEvaluateContext","addCondition","condition","Object","assign","domain","createWillRegisterContext","options","and","rawConditionObject","$and","Array","isArray","push","or","orClause","find","clause","has","$or"],"mappings":";;;;;;AAiBA;;IAGA,MAAMA,iBAAAA,GAAoB,KAA8B;AACtD,QAAA,oCAAA,EAAsCC,YAAMC,mBAAmB,EAAA;AAC/D,QAAA,mBAAA,EAAqBD,YAAME,8BAA8B,EAAA;AACzD,QAAA,mCAAA,EAAqCF,YAAMC,mBAAmB,EAAA;AAC9D,QAAA,4BAAA,EAA8BD,YAAMG,qBAAqB,EAAA;AACzD,QAAA,4BAAA,EAA8BH,YAAMG,qBAAqB;KAC3D;AAEA;;AAEC,IACD,MAAMC,qBAAAA,GAAwB,CAACC,UAAAA,IAA4B;AACzD,QAAA,IAAIA,UAAAA,CAAAA,GAAmC;AACrC,YAAA,OAAOC,WAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA;KACF;AAEA;;AAEC,IACD,MAAME,2BAAAA,GAA8B,CAACF,UAAAA,IAA4B;AAC/D,QAAA,IAAIA,UAAAA,CAAAA,GAAmC;AACrC,YAAA,OAAOC,WAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA,CAAA;AAEAG,QAAAA,YAAAA,CAAAA,CAAaC,SAAiB,EAAA;YAC5BC,MAAAA,CAAOC,MAAM,CAACN,UAAAA,EAAYO,kBAA8B,CAACH,SAAAA,EAAWJ,UAAAA,CAAAA,CAAAA;AAEpE,YAAA,OAAO,IAAI;AACb,QAAA;KACF;AAOA;;;IAIA,MAAMQ,4BAA4B,CAAC,EAAER,UAAU,EAAES,OAAO,EAA6B,IAAM;AACzF,QAAA,GAAGA,OAAO;AAEV,QAAA,IAAIT,UAAAA,CAAAA,GAAa;AACf,YAAA,OAAOC,WAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA,CAAA;QAEAI,SAAAA,EAAW;AACTM,YAAAA,GAAAA,CAAAA,CAAIC,kBAA2B,EAAA;gBAC7B,IAAI,CAACX,UAAAA,CAAWI,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC,gBAAA;AAEA,gBAAA,IAAIC,MAAMC,OAAO,CAACd,WAAWI,SAAS,CAACQ,IAAI,CAAA,EAAG;AAC5CZ,oBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACG,IAAI,CAACJ,kBAAAA,CAAAA;AACjC,gBAAA;AAEA,gBAAA,OAAO,IAAI;AACb,YAAA,CAAA;AAEAK,YAAAA,EAAAA,CAAAA,CAAGL,kBAA2B,EAAA;gBAC5B,IAAI,CAACX,UAAAA,CAAWI,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC,gBAAA;AAEA,gBAAA,IAAIC,MAAMC,OAAO,CAACd,WAAWI,SAAS,CAACQ,IAAI,CAAA,EAAG;oBAC5C,MAAMK,QAAAA,GAAWjB,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACM,IAAI,CAAC,CAACC,MAAAA,GAAWC,KAAAA,CAAID,MAAAA,EAAQ,KAAA,CAAA,CAAA;AAExE,oBAAA,IAAIF,QAAAA,EAAU;wBACZA,QAAAA,CAASI,GAAG,CAACN,IAAI,CAACJ,kBAAAA,CAAAA;oBACpB,CAAA,MAAO;AACLX,wBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACG,IAAI,CAAC;4BAAEM,GAAAA,EAAK;AAACV,gCAAAA;AAAmB;AAAC,yBAAA,CAAA;AAC7D,oBAAA;AACF,gBAAA;AAEA,gBAAA,OAAO,IAAI;AACb,YAAA;AACF;KACF;;;;;;;"}
|
package/dist/engine/hooks.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { has, cloneDeep } from 'lodash';
|
|
2
2
|
import { hooks } from '@strapi/utils';
|
|
3
3
|
import { addCondition } from '../domain/permission/index.mjs';
|
|
4
4
|
|
|
@@ -44,7 +44,7 @@ import { addCondition } from '../domain/permission/index.mjs';
|
|
|
44
44
|
$and: []
|
|
45
45
|
};
|
|
46
46
|
}
|
|
47
|
-
if (isArray(permission.condition.$and)) {
|
|
47
|
+
if (Array.isArray(permission.condition.$and)) {
|
|
48
48
|
permission.condition.$and.push(rawConditionObject);
|
|
49
49
|
}
|
|
50
50
|
return this;
|
|
@@ -55,8 +55,8 @@ import { addCondition } from '../domain/permission/index.mjs';
|
|
|
55
55
|
$and: []
|
|
56
56
|
};
|
|
57
57
|
}
|
|
58
|
-
if (isArray(permission.condition.$and)) {
|
|
59
|
-
const orClause = permission.condition.$and.find(has('$or'));
|
|
58
|
+
if (Array.isArray(permission.condition.$and)) {
|
|
59
|
+
const orClause = permission.condition.$and.find((clause)=>has(clause, '$or'));
|
|
60
60
|
if (orClause) {
|
|
61
61
|
orClause.$or.push(rawConditionObject);
|
|
62
62
|
} else {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.mjs","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has
|
|
1
|
+
{"version":3,"file":"hooks.mjs","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has } from 'lodash';\nimport { hooks } from '@strapi/utils';\n\nimport * as domain from '../domain';\nimport type { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport interface PermissionEngineHooks {\n 'before-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;\n 'format.permission': ReturnType<typeof hooks.createAsyncSeriesWaterfallHook>;\n 'after-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;\n 'before-evaluate.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;\n 'before-register.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;\n}\n\nexport type HookName = keyof PermissionEngineHooks;\n\n/**\n * Create a hook map used by the permission Engine\n */\nconst createEngineHooks = (): PermissionEngineHooks => ({\n 'before-format::validate.permission': hooks.createAsyncBailHook(),\n 'format.permission': hooks.createAsyncSeriesWaterfallHook(),\n 'after-format::validate.permission': hooks.createAsyncBailHook(),\n 'before-evaluate.permission': hooks.createAsyncSeriesHook(),\n 'before-register.permission': hooks.createAsyncSeriesHook(),\n});\n\n/**\n * Create a context from a domain {@link Permission} used by the validate hooks\n */\nconst createValidateContext = (permission: Permission) => ({\n get permission(): Readonly<Permission> {\n return cloneDeep(permission);\n },\n});\n\n/**\n * Create a context from a domain {@link Permission} used by the before valuate hook\n */\nconst createBeforeEvaluateContext = (permission: Permission) => ({\n get permission(): Readonly<Permission> {\n return cloneDeep(permission);\n },\n\n addCondition(condition: string) {\n Object.assign(permission, domain.permission.addCondition(condition, permission));\n\n return this;\n },\n});\n\ninterface WillRegisterContextParams {\n permission: PermissionRule;\n options: Record<string, unknown>;\n}\n\n/**\n * Create a context from a casl Permission & some options\n * @param caslPermission\n */\nconst createWillRegisterContext = ({ permission, options }: WillRegisterContextParams) => ({\n ...options,\n\n get permission() {\n return cloneDeep(permission);\n },\n\n condition: {\n and(rawConditionObject: unknown) {\n if (!permission.condition) {\n permission.condition = { $and: [] };\n }\n\n if (Array.isArray(permission.condition.$and)) {\n permission.condition.$and.push(rawConditionObject);\n }\n\n return this;\n },\n\n or(rawConditionObject: unknown) {\n if (!permission.condition) {\n permission.condition = { $and: [] };\n }\n\n if (Array.isArray(permission.condition.$and)) {\n const orClause = permission.condition.$and.find((clause) => has(clause, '$or'));\n\n if (orClause) {\n orClause.$or.push(rawConditionObject);\n } else {\n permission.condition.$and.push({ $or: [rawConditionObject] });\n }\n }\n\n return this;\n },\n },\n});\n\nexport {\n createEngineHooks,\n createValidateContext,\n createBeforeEvaluateContext,\n createWillRegisterContext,\n};\n"],"names":["createEngineHooks","hooks","createAsyncBailHook","createAsyncSeriesWaterfallHook","createAsyncSeriesHook","createValidateContext","permission","cloneDeep","createBeforeEvaluateContext","addCondition","condition","Object","assign","domain","createWillRegisterContext","options","and","rawConditionObject","$and","Array","isArray","push","or","orClause","find","clause","has","$or"],"mappings":";;;;AAiBA;;IAGA,MAAMA,iBAAAA,GAAoB,KAA8B;AACtD,QAAA,oCAAA,EAAsCC,MAAMC,mBAAmB,EAAA;AAC/D,QAAA,mBAAA,EAAqBD,MAAME,8BAA8B,EAAA;AACzD,QAAA,mCAAA,EAAqCF,MAAMC,mBAAmB,EAAA;AAC9D,QAAA,4BAAA,EAA8BD,MAAMG,qBAAqB,EAAA;AACzD,QAAA,4BAAA,EAA8BH,MAAMG,qBAAqB;KAC3D;AAEA;;AAEC,IACD,MAAMC,qBAAAA,GAAwB,CAACC,UAAAA,IAA4B;AACzD,QAAA,IAAIA,UAAAA,CAAAA,GAAmC;AACrC,YAAA,OAAOC,SAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA;KACF;AAEA;;AAEC,IACD,MAAME,2BAAAA,GAA8B,CAACF,UAAAA,IAA4B;AAC/D,QAAA,IAAIA,UAAAA,CAAAA,GAAmC;AACrC,YAAA,OAAOC,SAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA,CAAA;AAEAG,QAAAA,YAAAA,CAAAA,CAAaC,SAAiB,EAAA;YAC5BC,MAAAA,CAAOC,MAAM,CAACN,UAAAA,EAAYO,YAA8B,CAACH,SAAAA,EAAWJ,UAAAA,CAAAA,CAAAA;AAEpE,YAAA,OAAO,IAAI;AACb,QAAA;KACF;AAOA;;;IAIA,MAAMQ,4BAA4B,CAAC,EAAER,UAAU,EAAES,OAAO,EAA6B,IAAM;AACzF,QAAA,GAAGA,OAAO;AAEV,QAAA,IAAIT,UAAAA,CAAAA,GAAa;AACf,YAAA,OAAOC,SAAAA,CAAUD,UAAAA,CAAAA;AACnB,QAAA,CAAA;QAEAI,SAAAA,EAAW;AACTM,YAAAA,GAAAA,CAAAA,CAAIC,kBAA2B,EAAA;gBAC7B,IAAI,CAACX,UAAAA,CAAWI,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC,gBAAA;AAEA,gBAAA,IAAIC,MAAMC,OAAO,CAACd,WAAWI,SAAS,CAACQ,IAAI,CAAA,EAAG;AAC5CZ,oBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACG,IAAI,CAACJ,kBAAAA,CAAAA;AACjC,gBAAA;AAEA,gBAAA,OAAO,IAAI;AACb,YAAA,CAAA;AAEAK,YAAAA,EAAAA,CAAAA,CAAGL,kBAA2B,EAAA;gBAC5B,IAAI,CAACX,UAAAA,CAAWI,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC,gBAAA;AAEA,gBAAA,IAAIC,MAAMC,OAAO,CAACd,WAAWI,SAAS,CAACQ,IAAI,CAAA,EAAG;oBAC5C,MAAMK,QAAAA,GAAWjB,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACM,IAAI,CAAC,CAACC,MAAAA,GAAWC,GAAAA,CAAID,MAAAA,EAAQ,KAAA,CAAA,CAAA;AAExE,oBAAA,IAAIF,QAAAA,EAAU;wBACZA,QAAAA,CAASI,GAAG,CAACN,IAAI,CAACJ,kBAAAA,CAAAA;oBACpB,CAAA,MAAO;AACLX,wBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACG,IAAI,CAAC;4BAAEM,GAAAA,EAAK;AAACV,gCAAAA;AAAmB;AAAC,yBAAA,CAAA;AAC7D,oBAAA;AACF,gBAAA;AAEA,gBAAA,OAAO,IAAI;AACb,YAAA;AACF;KACF;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAQhD,OAAO,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB,KAAK,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,UAAU,CAAC,GAAG;IACrE,QAAQ,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;CAC5D,CAAC;AAEF,KAAK,cAAc,GAAG,QAAQ,CAAC;AAC/B,KAAK,iBAAiB,GAAG,QAAQ,CAAC;AAElC,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,qBAAqB,CAAC;IAC7B,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,MAAM,CAAC;IAC7D,eAAe,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/E,sBAAsB,CACpB,GAAG,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,OAAO,EAC5C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,CAAC,UAAU,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,SAAS,EAAE,iBAAiB,CAAA;KAAE,CAAC;IACpE,qBAAqB,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC;CAC1D;AAsBD,QAAA,MAAM,SAAS,GAAI,QAAQ,YAAY,KAAG,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAQhD,OAAO,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB,KAAK,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,UAAU,CAAC,GAAG;IACrE,QAAQ,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;CAC5D,CAAC;AAEF,KAAK,cAAc,GAAG,QAAQ,CAAC;AAC/B,KAAK,iBAAiB,GAAG,QAAQ,CAAC;AAElC,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,qBAAqB,CAAC;IAC7B,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,MAAM,CAAC;IAC7D,eAAe,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/E,sBAAsB,CACpB,GAAG,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,OAAO,EAC5C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,CAAC,UAAU,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,SAAS,EAAE,iBAAiB,CAAA;KAAE,CAAC;IACpE,qBAAqB,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC;CAC1D;AAsBD,QAAA,MAAM,SAAS,GAAI,QAAQ,YAAY,KAAG,MAwKzC,CAAC;AAEF,OAAO,EAAE,SAAS,IAAI,GAAG,EAAE,CAAC"}
|
package/dist/engine/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var _ = require('lodash
|
|
3
|
+
var _ = require('lodash');
|
|
4
4
|
var qs = require('qs');
|
|
5
5
|
var hooks = require('./hooks.js');
|
|
6
6
|
var index = require('./abilities/index.js');
|
|
@@ -51,30 +51,28 @@ const newEngine = (params)=>{
|
|
|
51
51
|
});
|
|
52
52
|
}
|
|
53
53
|
const resolveConditions = (ids)=>ids.map((id)=>providers.condition.get(id));
|
|
54
|
-
const removeInvalidConditions =
|
|
54
|
+
const removeInvalidConditions = (conditions)=>conditions.filter((condition)=>condition != null && typeof condition.handler === 'function');
|
|
55
55
|
const evaluateConditions = (conditions)=>{
|
|
56
56
|
return Promise.all(conditions.map(async (condition)=>({
|
|
57
57
|
condition,
|
|
58
|
-
result: await condition.handler(___default.default.merge(options, {
|
|
58
|
+
result: await condition.handler(___default.default.merge({}, options, {
|
|
59
59
|
permission: ___default.default.cloneDeep(permission)
|
|
60
60
|
}))
|
|
61
61
|
})));
|
|
62
62
|
};
|
|
63
|
-
const removeInvalidResults =
|
|
63
|
+
const removeInvalidResults = (results)=>results.filter(({ result })=>___default.default.isBoolean(result) || ___default.default.isObject(result));
|
|
64
64
|
const evaluatedConditions = await Promise.resolve(conditions).then(resolveConditions).then(removeInvalidConditions).then(evaluateConditions).then(removeInvalidResults);
|
|
65
|
-
|
|
66
|
-
const pickResults = ___default.default.map(___default.default.prop('result'));
|
|
67
|
-
if (evaluatedConditions.every(resultPropEq(false))) {
|
|
65
|
+
if (evaluatedConditions.every(({ result })=>result === false)) {
|
|
68
66
|
return;
|
|
69
67
|
}
|
|
70
|
-
if (___default.default.isEmpty(evaluatedConditions) || evaluatedConditions.some(
|
|
68
|
+
if (___default.default.isEmpty(evaluatedConditions) || evaluatedConditions.some(({ result })=>result === true)) {
|
|
71
69
|
return register({
|
|
72
70
|
action,
|
|
73
71
|
subject,
|
|
74
72
|
properties
|
|
75
73
|
});
|
|
76
74
|
}
|
|
77
|
-
const results =
|
|
75
|
+
const results = evaluatedConditions.map(({ result })=>result).filter((result)=>___default.default.isObject(result));
|
|
78
76
|
if (___default.default.isEmpty(results)) {
|
|
79
77
|
return register({
|
|
80
78
|
action,
|
package/dist/engine/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../src/engine/index.ts"],"sourcesContent":["import _ from 'lodash/fp';\nimport qs from 'qs';\nimport { Ability } from '@casl/ability';\nimport { providerFactory } from '@strapi/utils';\n\nimport {\n createEngineHooks,\n createWillRegisterContext,\n createBeforeEvaluateContext,\n createValidateContext,\n} from './hooks';\nimport type { PermissionEngineHooks, HookName } from './hooks';\n\nimport * as abilities from './abilities';\nimport { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport { abilities };\n\ntype Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {\n register(...args: unknown[]): Promise<Provider> | Provider;\n};\n\ntype ActionProvider = Provider;\ntype ConditionProvider = Provider;\n\nexport interface Engine {\n hooks: PermissionEngineHooks;\n on(hook: HookName, handler: (...args: any[]) => any): Engine;\n generateAbility(permissions: Permission[], options?: object): Promise<Ability>;\n createRegisterFunction(\n can: (permission: PermissionRule) => unknown,\n options: Record<string, unknown>\n ): (permission: PermissionRule) => Promise<unknown>;\n}\n\nexport interface EngineParams {\n providers: { action: ActionProvider; condition: ConditionProvider };\n abilityBuilderFactory?(): abilities.CustomAbilityBuilder;\n}\n\ninterface EvaluateParams {\n options: Record<string, unknown>;\n register: (permission: PermissionRule) => Promise<unknown>;\n permission: Permission;\n}\n\ninterface Condition {\n name: string;\n handler(...params: unknown[]): boolean | object;\n}\n\n/**\n * Create a default state object for the engine\n */\nconst createEngineState = () => {\n const hooks = createEngineHooks();\n\n return { hooks };\n};\n\nconst newEngine = (params: EngineParams): Engine => {\n const { providers, abilityBuilderFactory = abilities.caslAbilityBuilder } = params;\n\n const state = createEngineState();\n\n const runValidationHook = async (hook: HookName, context: unknown) =>\n state.hooks[hook].call(context);\n\n /**\n * Evaluate a permission using local and registered behaviors (using hooks).\n * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission\n */\n const evaluate = async (params: EvaluateParams) => {\n const { options, register } = params;\n\n const preFormatValidation = await runValidationHook(\n 'before-format::validate.permission',\n createBeforeEvaluateContext(params.permission)\n );\n\n if (preFormatValidation === false) {\n return;\n }\n\n const permission = (await state.hooks['format.permission'].call(\n params.permission\n )) as Permission;\n\n const afterFormatValidation = await runValidationHook(\n 'after-format::validate.permission',\n createValidateContext(permission)\n );\n\n if (afterFormatValidation === false) {\n return;\n }\n\n await state.hooks['before-evaluate.permission'].call(createBeforeEvaluateContext(permission));\n\n const {\n action: actionName,\n subject,\n properties,\n conditions = [],\n actionParameters = {},\n } = permission;\n\n let action = actionName;\n\n if (actionParameters && Object.keys(actionParameters).length > 0) {\n action = `${actionName}?${qs.stringify(actionParameters)}`;\n }\n\n if (conditions.length === 0) {\n return register({ action, subject, properties });\n }\n\n const resolveConditions = (ids: string[]): (Condition | undefined)[] =>\n ids.map((id) => providers.condition.get(id) as Condition | undefined);\n\n const removeInvalidConditions = _.filter(\n (condition: Condition | undefined): condition is Condition =>\n condition != null && _.isFunction(condition.handler)\n );\n\n const evaluateConditions = (conditions: Condition[]) => {\n return Promise.all(\n conditions.map(async (condition) => ({\n condition,\n result: await condition.handler(\n _.merge(options, { permission: _.cloneDeep(permission) })\n ),\n }))\n );\n };\n\n const removeInvalidResults = _.filter(\n ({ result }) => _.isBoolean(result) || _.isObject(result)\n );\n\n const evaluatedConditions = await Promise.resolve(conditions)\n .then(resolveConditions)\n .then(removeInvalidConditions)\n .then(evaluateConditions)\n .then(removeInvalidResults);\n\n const resultPropEq = _.propEq('result');\n const pickResults = _.map(_.prop('result'));\n\n if (evaluatedConditions.every(resultPropEq(false))) {\n return;\n }\n\n if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(resultPropEq(true))) {\n return register({ action, subject, properties });\n }\n\n const results = pickResults(evaluatedConditions).filter(_.isObject);\n\n if (_.isEmpty(results)) {\n return register({ action, subject, properties });\n }\n\n return register({\n action,\n subject,\n properties,\n condition: { $and: [{ $or: results }] },\n });\n };\n\n return {\n get hooks() {\n return state.hooks;\n },\n\n /**\n * Create a register function that wraps a `can` function\n * used to register a permission in the ability builder\n */\n createRegisterFunction(can, options: Record<string, unknown>) {\n return async (permission: PermissionRule) => {\n const hookContext = createWillRegisterContext({ options, permission });\n\n await state.hooks['before-register.permission'].call(hookContext);\n\n return can(permission);\n };\n },\n\n /**\n * Register a new handler for a given hook\n */\n on(hook, handler) {\n const validHooks = Object.keys(state.hooks);\n const isValidHook = validHooks.includes(hook);\n\n if (!isValidHook) {\n throw new Error(\n `Invalid hook supplied when trying to register an handler to the permission engine. Got \"${hook}\" but expected one of ${validHooks.join(\n ', '\n )}`\n );\n }\n\n state.hooks[hook].register(handler);\n\n return this;\n },\n\n /**\n * Generate an ability based on the instance's\n * ability builder and the given permissions\n */\n async generateAbility(permissions, options: Record<string, unknown> = {}) {\n const { can, build } = abilityBuilderFactory();\n\n for (const permission of permissions) {\n const register = this.createRegisterFunction(can, options);\n\n await evaluate({ permission, options, register });\n }\n\n return build();\n },\n };\n};\n\nexport { newEngine as new };\n"],"names":["createEngineState","hooks","createEngineHooks","newEngine","params","providers","abilityBuilderFactory","abilities","state","runValidationHook","hook","context","call","evaluate","options","register","preFormatValidation","createBeforeEvaluateContext","permission","afterFormatValidation","createValidateContext","action","actionName","subject","properties","conditions","actionParameters","Object","keys","length","qs","stringify","resolveConditions","ids","map","id","condition","get","removeInvalidConditions","_","filter","isFunction","handler","evaluateConditions","Promise","all","result","merge","cloneDeep","removeInvalidResults","isBoolean","isObject","evaluatedConditions","resolve","then","resultPropEq","propEq","pickResults","prop","every","isEmpty","some","results","$and","$or","createRegisterFunction","can","hookContext","createWillRegisterContext","on","validHooks","isValidHook","includes","Error","join","generateAbility","permissions","build"],"mappings":";;;;;;;;;;;;;AAoDA;;AAEC,IACD,MAAMA,iBAAAA,GAAoB,IAAA;AACxB,IAAA,MAAMC,OAAAA,GAAQC,uBAAAA,EAAAA;IAEd,OAAO;AAAED,eAAAA;AAAM,KAAA;AACjB,CAAA;AAEA,MAAME,YAAY,CAACC,MAAAA,GAAAA;AACjB,IAAA,MAAM,EAAEC,SAAS,EAAEC,wBAAwBC,8BAA4B,EAAE,GAAGH,MAAAA;AAE5E,IAAA,MAAMI,KAAAA,GAAQR,iBAAAA,EAAAA;IAEd,MAAMS,iBAAAA,GAAoB,OAAOC,IAAAA,EAAgBC,OAAAA,GAC/CH,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACE,IAAI,CAACD,OAAAA,CAAAA;AAEzB;;;MAIA,MAAME,WAAW,OAAOT,MAAAA,GAAAA;AACtB,QAAA,MAAM,EAAEU,OAAO,EAAEC,QAAQ,EAAE,GAAGX,MAAAA;AAE9B,QAAA,MAAMY,sBAAsB,MAAMP,iBAAAA,CAChC,oCAAA,EACAQ,iCAAAA,CAA4Bb,OAAOc,UAAU,CAAA,CAAA;AAG/C,QAAA,IAAIF,wBAAwB,KAAA,EAAO;AACjC,YAAA;AACF,QAAA;QAEA,MAAME,UAAAA,GAAc,MAAMV,KAAAA,CAAMP,KAAK,CAAC,oBAAoB,CAACW,IAAI,CAC7DR,MAAAA,CAAOc,UAAU,CAAA;AAGnB,QAAA,MAAMC,qBAAAA,GAAwB,MAAMV,iBAAAA,CAClC,mCAAA,EACAW,2BAAAA,CAAsBF,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAA,EAAO;AACnC,YAAA;AACF,QAAA;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,iCAAAA,CAA4BC,UAAAA,CAAAA,CAAAA;AAEjF,QAAA,MAAM,EACJG,MAAAA,EAAQC,UAAU,EAClBC,OAAO,EACPC,UAAU,EACVC,UAAAA,GAAa,EAAE,EACfC,gBAAAA,GAAmB,EAAE,EACtB,GAAGR,UAAAA;AAEJ,QAAA,IAAIG,MAAAA,GAASC,UAAAA;AAEb,QAAA,IAAII,oBAAoBC,MAAAA,CAAOC,IAAI,CAACF,gBAAAA,CAAAA,CAAkBG,MAAM,GAAG,CAAA,EAAG;AAChER,YAAAA,MAAAA,GAAS,GAAGC,UAAAA,CAAW,CAAC,EAAEQ,mBAAAA,CAAGC,SAAS,CAACL,gBAAAA,CAAAA,CAAAA,CAAmB;AAC5D,QAAA;QAEA,IAAID,UAAAA,CAAWI,MAAM,KAAK,CAAA,EAAG;AAC3B,YAAA,OAAOd,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMQ,iBAAAA,GAAoB,CAACC,GAAAA,GACzBA,GAAAA,CAAIC,GAAG,CAAC,CAACC,EAAAA,GAAO9B,SAAAA,CAAU+B,SAAS,CAACC,GAAG,CAACF,EAAAA,CAAAA,CAAAA;AAE1C,QAAA,MAAMG,uBAAAA,GAA0BC,kBAAAA,CAAEC,MAAM,CACtC,CAACJ,SAAAA,GACCA,SAAAA,IAAa,IAAA,IAAQG,kBAAAA,CAAEE,UAAU,CAACL,SAAAA,CAAUM,OAAO,CAAA,CAAA;AAGvD,QAAA,MAAMC,qBAAqB,CAAClB,UAAAA,GAAAA;YAC1B,OAAOmB,OAAAA,CAAQC,GAAG,CAChBpB,UAAAA,CAAWS,GAAG,CAAC,OAAOE,aAAe;AACnCA,oBAAAA,SAAAA;AACAU,oBAAAA,MAAAA,EAAQ,MAAMV,SAAAA,CAAUM,OAAO,CAC7BH,kBAAAA,CAAEQ,KAAK,CAACjC,OAAAA,EAAS;wBAAEI,UAAAA,EAAYqB,kBAAAA,CAAES,SAAS,CAAC9B,UAAAA;AAAY,qBAAA,CAAA;iBAE3D,CAAA,CAAA,CAAA;AAEJ,QAAA,CAAA;AAEA,QAAA,MAAM+B,oBAAAA,GAAuBV,kBAAAA,CAAEC,MAAM,CACnC,CAAC,EAAEM,MAAM,EAAE,GAAKP,mBAAEW,SAAS,CAACJ,MAAAA,CAAAA,IAAWP,kBAAAA,CAAEY,QAAQ,CAACL,MAAAA,CAAAA,CAAAA;AAGpD,QAAA,MAAMM,sBAAsB,MAAMR,OAAAA,CAAQS,OAAO,CAAC5B,YAC/C6B,IAAI,CAACtB,iBAAAA,CAAAA,CACLsB,IAAI,CAAChB,uBAAAA,CAAAA,CACLgB,IAAI,CAACX,kBAAAA,CAAAA,CACLW,IAAI,CAACL,oBAAAA,CAAAA;QAER,MAAMM,YAAAA,GAAehB,kBAAAA,CAAEiB,MAAM,CAAC,QAAA,CAAA;AAC9B,QAAA,MAAMC,cAAclB,kBAAAA,CAAEL,GAAG,CAACK,kBAAAA,CAAEmB,IAAI,CAAC,QAAA,CAAA,CAAA;AAEjC,QAAA,IAAIN,mBAAAA,CAAoBO,KAAK,CAACJ,YAAAA,CAAa,KAAA,CAAA,CAAA,EAAS;AAClD,YAAA;AACF,QAAA;QAEA,IAAIhB,kBAAAA,CAAEqB,OAAO,CAACR,mBAAAA,CAAAA,IAAwBA,oBAAoBS,IAAI,CAACN,aAAa,IAAA,CAAA,CAAA,EAAQ;AAClF,YAAA,OAAOxC,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMsC,UAAUL,WAAAA,CAAYL,mBAAAA,CAAAA,CAAqBZ,MAAM,CAACD,mBAAEY,QAAQ,CAAA;QAElE,IAAIZ,kBAAAA,CAAEqB,OAAO,CAACE,OAAAA,CAAAA,EAAU;AACtB,YAAA,OAAO/C,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,OAAOT,QAAAA,CAAS;AACdM,YAAAA,MAAAA;AACAE,YAAAA,OAAAA;AACAC,YAAAA,UAAAA;YACAY,SAAAA,EAAW;gBAAE2B,IAAAA,EAAM;AAAC,oBAAA;wBAAEC,GAAAA,EAAKF;AAAQ;AAAE;AAAC;AACxC,SAAA,CAAA;AACF,IAAA,CAAA;IAEA,OAAO;AACL,QAAA,IAAI7D,KAAAA,CAAAA,GAAQ;AACV,YAAA,OAAOO,MAAMP,KAAK;AACpB,QAAA,CAAA;AAEA;;;QAIAgE,sBAAAA,CAAAA,CAAuBC,GAAG,EAAEpD,OAAgC,EAAA;AAC1D,YAAA,OAAO,OAAOI,UAAAA,GAAAA;AACZ,gBAAA,MAAMiD,cAAcC,+BAAAA,CAA0B;AAAEtD,oBAAAA,OAAAA;AAASI,oBAAAA;AAAW,iBAAA,CAAA;AAEpE,gBAAA,MAAMV,MAAMP,KAAK,CAAC,4BAAA,CAA6B,CAACW,IAAI,CAACuD,WAAAA,CAAAA;AAErD,gBAAA,OAAOD,GAAAA,CAAIhD,UAAAA,CAAAA;AACb,YAAA,CAAA;AACF,QAAA,CAAA;AAEA;;QAGAmD,EAAAA,CAAAA,CAAG3D,IAAI,EAAEgC,OAAO,EAAA;AACd,YAAA,MAAM4B,UAAAA,GAAa3C,MAAAA,CAAOC,IAAI,CAACpB,MAAMP,KAAK,CAAA;YAC1C,MAAMsE,WAAAA,GAAcD,UAAAA,CAAWE,QAAQ,CAAC9D,IAAAA,CAAAA;AAExC,YAAA,IAAI,CAAC6D,WAAAA,EAAa;gBAChB,MAAM,IAAIE,KAAAA,CACR,CAAC,wFAAwF,EAAE/D,IAAAA,CAAK,sBAAsB,EAAE4D,UAAAA,CAAWI,IAAI,CACrI,IAAA,CAAA,CAAA,CACC,CAAA;AAEP,YAAA;AAEAlE,YAAAA,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACK,QAAQ,CAAC2B,OAAAA,CAAAA;AAE3B,YAAA,OAAO,IAAI;AACb,QAAA,CAAA;AAEA;;;AAGC,QACD,MAAMiC,eAAAA,CAAAA,CAAgBC,WAAW,EAAE9D,OAAAA,GAAmC,EAAE,EAAA;AACtE,YAAA,MAAM,EAAEoD,GAAG,EAAEW,KAAK,EAAE,GAAGvE,qBAAAA,EAAAA;YAEvB,KAAK,MAAMY,cAAc0D,WAAAA,CAAa;AACpC,gBAAA,MAAM7D,QAAAA,GAAW,IAAI,CAACkD,sBAAsB,CAACC,GAAAA,EAAKpD,OAAAA,CAAAA;AAElD,gBAAA,MAAMD,QAAAA,CAAS;AAAEK,oBAAAA,UAAAA;AAAYJ,oBAAAA,OAAAA;AAASC,oBAAAA;AAAS,iBAAA,CAAA;AACjD,YAAA;YAEA,OAAO8D,KAAAA,EAAAA;AACT,QAAA;AACF,KAAA;AACF;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../src/engine/index.ts"],"sourcesContent":["import _ from 'lodash';\nimport qs from 'qs';\nimport { Ability } from '@casl/ability';\nimport { providerFactory } from '@strapi/utils';\n\nimport {\n createEngineHooks,\n createWillRegisterContext,\n createBeforeEvaluateContext,\n createValidateContext,\n} from './hooks';\nimport type { PermissionEngineHooks, HookName } from './hooks';\n\nimport * as abilities from './abilities';\nimport { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport { abilities };\n\ntype Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {\n register(...args: unknown[]): Promise<Provider> | Provider;\n};\n\ntype ActionProvider = Provider;\ntype ConditionProvider = Provider;\n\nexport interface Engine {\n hooks: PermissionEngineHooks;\n on(hook: HookName, handler: (...args: any[]) => any): Engine;\n generateAbility(permissions: Permission[], options?: object): Promise<Ability>;\n createRegisterFunction(\n can: (permission: PermissionRule) => unknown,\n options: Record<string, unknown>\n ): (permission: PermissionRule) => Promise<unknown>;\n}\n\nexport interface EngineParams {\n providers: { action: ActionProvider; condition: ConditionProvider };\n abilityBuilderFactory?(): abilities.CustomAbilityBuilder;\n}\n\ninterface EvaluateParams {\n options: Record<string, unknown>;\n register: (permission: PermissionRule) => Promise<unknown>;\n permission: Permission;\n}\n\ninterface Condition {\n name: string;\n handler(...params: unknown[]): boolean | object;\n}\n\n/**\n * Create a default state object for the engine\n */\nconst createEngineState = () => {\n const hooks = createEngineHooks();\n\n return { hooks };\n};\n\nconst newEngine = (params: EngineParams): Engine => {\n const { providers, abilityBuilderFactory = abilities.caslAbilityBuilder } = params;\n\n const state = createEngineState();\n\n const runValidationHook = async (hook: HookName, context: unknown) =>\n state.hooks[hook].call(context);\n\n /**\n * Evaluate a permission using local and registered behaviors (using hooks).\n * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission\n */\n const evaluate = async (params: EvaluateParams) => {\n const { options, register } = params;\n\n const preFormatValidation = await runValidationHook(\n 'before-format::validate.permission',\n createBeforeEvaluateContext(params.permission)\n );\n\n if (preFormatValidation === false) {\n return;\n }\n\n const permission = (await state.hooks['format.permission'].call(\n params.permission\n )) as Permission;\n\n const afterFormatValidation = await runValidationHook(\n 'after-format::validate.permission',\n createValidateContext(permission)\n );\n\n if (afterFormatValidation === false) {\n return;\n }\n\n await state.hooks['before-evaluate.permission'].call(createBeforeEvaluateContext(permission));\n\n const {\n action: actionName,\n subject,\n properties,\n conditions = [],\n actionParameters = {},\n } = permission;\n\n let action = actionName;\n\n if (actionParameters && Object.keys(actionParameters).length > 0) {\n action = `${actionName}?${qs.stringify(actionParameters)}`;\n }\n\n if (conditions.length === 0) {\n return register({ action, subject, properties });\n }\n\n const resolveConditions = (ids: string[]): (Condition | undefined)[] =>\n ids.map((id) => providers.condition.get(id) as Condition | undefined);\n\n const removeInvalidConditions = (conditions: (Condition | undefined)[]) =>\n conditions.filter(\n (condition): condition is Condition =>\n condition != null && typeof condition.handler === 'function'\n );\n\n const evaluateConditions = (conditions: Condition[]) => {\n return Promise.all(\n conditions.map(async (condition) => ({\n condition,\n result: await condition.handler(\n _.merge({}, options, { permission: _.cloneDeep(permission) })\n ),\n }))\n );\n };\n\n const removeInvalidResults = (results: Awaited<ReturnType<typeof evaluateConditions>>) =>\n results.filter(({ result }) => _.isBoolean(result) || _.isObject(result));\n\n const evaluatedConditions = await Promise.resolve(conditions)\n .then(resolveConditions)\n .then(removeInvalidConditions)\n .then(evaluateConditions)\n .then(removeInvalidResults);\n\n if (evaluatedConditions.every(({ result }) => result === false)) {\n return;\n }\n\n if (\n _.isEmpty(evaluatedConditions) ||\n evaluatedConditions.some(({ result }) => result === true)\n ) {\n return register({ action, subject, properties });\n }\n\n const results = evaluatedConditions\n .map(({ result }) => result)\n .filter((result) => _.isObject(result));\n\n if (_.isEmpty(results)) {\n return register({ action, subject, properties });\n }\n\n return register({\n action,\n subject,\n properties,\n condition: { $and: [{ $or: results }] },\n });\n };\n\n return {\n get hooks() {\n return state.hooks;\n },\n\n /**\n * Create a register function that wraps a `can` function\n * used to register a permission in the ability builder\n */\n createRegisterFunction(can, options: Record<string, unknown>) {\n return async (permission: PermissionRule) => {\n const hookContext = createWillRegisterContext({ options, permission });\n\n await state.hooks['before-register.permission'].call(hookContext);\n\n return can(permission);\n };\n },\n\n /**\n * Register a new handler for a given hook\n */\n on(hook, handler) {\n const validHooks = Object.keys(state.hooks);\n const isValidHook = validHooks.includes(hook);\n\n if (!isValidHook) {\n throw new Error(\n `Invalid hook supplied when trying to register an handler to the permission engine. Got \"${hook}\" but expected one of ${validHooks.join(\n ', '\n )}`\n );\n }\n\n state.hooks[hook].register(handler);\n\n return this;\n },\n\n /**\n * Generate an ability based on the instance's\n * ability builder and the given permissions\n */\n async generateAbility(permissions, options: Record<string, unknown> = {}) {\n const { can, build } = abilityBuilderFactory();\n\n for (const permission of permissions) {\n const register = this.createRegisterFunction(can, options);\n\n await evaluate({ permission, options, register });\n }\n\n return build();\n },\n };\n};\n\nexport { newEngine as new };\n"],"names":["createEngineState","hooks","createEngineHooks","newEngine","params","providers","abilityBuilderFactory","abilities","state","runValidationHook","hook","context","call","evaluate","options","register","preFormatValidation","createBeforeEvaluateContext","permission","afterFormatValidation","createValidateContext","action","actionName","subject","properties","conditions","actionParameters","Object","keys","length","qs","stringify","resolveConditions","ids","map","id","condition","get","removeInvalidConditions","filter","handler","evaluateConditions","Promise","all","result","_","merge","cloneDeep","removeInvalidResults","results","isBoolean","isObject","evaluatedConditions","resolve","then","every","isEmpty","some","$and","$or","createRegisterFunction","can","hookContext","createWillRegisterContext","on","validHooks","isValidHook","includes","Error","join","generateAbility","permissions","build"],"mappings":";;;;;;;;;;;;;AAoDA;;AAEC,IACD,MAAMA,iBAAAA,GAAoB,IAAA;AACxB,IAAA,MAAMC,OAAAA,GAAQC,uBAAAA,EAAAA;IAEd,OAAO;AAAED,eAAAA;AAAM,KAAA;AACjB,CAAA;AAEA,MAAME,YAAY,CAACC,MAAAA,GAAAA;AACjB,IAAA,MAAM,EAAEC,SAAS,EAAEC,wBAAwBC,8BAA4B,EAAE,GAAGH,MAAAA;AAE5E,IAAA,MAAMI,KAAAA,GAAQR,iBAAAA,EAAAA;IAEd,MAAMS,iBAAAA,GAAoB,OAAOC,IAAAA,EAAgBC,OAAAA,GAC/CH,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACE,IAAI,CAACD,OAAAA,CAAAA;AAEzB;;;MAIA,MAAME,WAAW,OAAOT,MAAAA,GAAAA;AACtB,QAAA,MAAM,EAAEU,OAAO,EAAEC,QAAQ,EAAE,GAAGX,MAAAA;AAE9B,QAAA,MAAMY,sBAAsB,MAAMP,iBAAAA,CAChC,oCAAA,EACAQ,iCAAAA,CAA4Bb,OAAOc,UAAU,CAAA,CAAA;AAG/C,QAAA,IAAIF,wBAAwB,KAAA,EAAO;AACjC,YAAA;AACF,QAAA;QAEA,MAAME,UAAAA,GAAc,MAAMV,KAAAA,CAAMP,KAAK,CAAC,oBAAoB,CAACW,IAAI,CAC7DR,MAAAA,CAAOc,UAAU,CAAA;AAGnB,QAAA,MAAMC,qBAAAA,GAAwB,MAAMV,iBAAAA,CAClC,mCAAA,EACAW,2BAAAA,CAAsBF,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAA,EAAO;AACnC,YAAA;AACF,QAAA;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,iCAAAA,CAA4BC,UAAAA,CAAAA,CAAAA;AAEjF,QAAA,MAAM,EACJG,MAAAA,EAAQC,UAAU,EAClBC,OAAO,EACPC,UAAU,EACVC,UAAAA,GAAa,EAAE,EACfC,gBAAAA,GAAmB,EAAE,EACtB,GAAGR,UAAAA;AAEJ,QAAA,IAAIG,MAAAA,GAASC,UAAAA;AAEb,QAAA,IAAII,oBAAoBC,MAAAA,CAAOC,IAAI,CAACF,gBAAAA,CAAAA,CAAkBG,MAAM,GAAG,CAAA,EAAG;AAChER,YAAAA,MAAAA,GAAS,GAAGC,UAAAA,CAAW,CAAC,EAAEQ,mBAAAA,CAAGC,SAAS,CAACL,gBAAAA,CAAAA,CAAAA,CAAmB;AAC5D,QAAA;QAEA,IAAID,UAAAA,CAAWI,MAAM,KAAK,CAAA,EAAG;AAC3B,YAAA,OAAOd,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMQ,iBAAAA,GAAoB,CAACC,GAAAA,GACzBA,GAAAA,CAAIC,GAAG,CAAC,CAACC,EAAAA,GAAO9B,SAAAA,CAAU+B,SAAS,CAACC,GAAG,CAACF,EAAAA,CAAAA,CAAAA;AAE1C,QAAA,MAAMG,uBAAAA,GAA0B,CAACb,UAAAA,GAC/BA,UAAAA,CAAWc,MAAM,CACf,CAACH,SAAAA,GACCA,SAAAA,IAAa,IAAA,IAAQ,OAAOA,SAAAA,CAAUI,OAAO,KAAK,UAAA,CAAA;AAGxD,QAAA,MAAMC,qBAAqB,CAAChB,UAAAA,GAAAA;YAC1B,OAAOiB,OAAAA,CAAQC,GAAG,CAChBlB,UAAAA,CAAWS,GAAG,CAAC,OAAOE,aAAe;AACnCA,oBAAAA,SAAAA;oBACAQ,MAAAA,EAAQ,MAAMR,UAAUI,OAAO,CAC7BK,mBAAEC,KAAK,CAAC,EAAC,EAAGhC,OAAAA,EAAS;wBAAEI,UAAAA,EAAY2B,kBAAAA,CAAEE,SAAS,CAAC7B,UAAAA;AAAY,qBAAA,CAAA;iBAE/D,CAAA,CAAA,CAAA;AAEJ,QAAA,CAAA;AAEA,QAAA,MAAM8B,uBAAuB,CAACC,OAAAA,GAC5BA,OAAAA,CAAQV,MAAM,CAAC,CAAC,EAAEK,MAAM,EAAE,GAAKC,kBAAAA,CAAEK,SAAS,CAACN,MAAAA,CAAAA,IAAWC,kBAAAA,CAAEM,QAAQ,CAACP,MAAAA,CAAAA,CAAAA;AAEnE,QAAA,MAAMQ,sBAAsB,MAAMV,OAAAA,CAAQW,OAAO,CAAC5B,YAC/C6B,IAAI,CAACtB,iBAAAA,CAAAA,CACLsB,IAAI,CAAChB,uBAAAA,CAAAA,CACLgB,IAAI,CAACb,kBAAAA,CAAAA,CACLa,IAAI,CAACN,oBAAAA,CAAAA;QAER,IAAII,mBAAAA,CAAoBG,KAAK,CAAC,CAAC,EAAEX,MAAM,EAAE,GAAKA,MAAAA,KAAW,KAAA,CAAA,EAAQ;AAC/D,YAAA;AACF,QAAA;AAEA,QAAA,IACEC,kBAAAA,CAAEW,OAAO,CAACJ,mBAAAA,CAAAA,IACVA,mBAAAA,CAAoBK,IAAI,CAAC,CAAC,EAAEb,MAAM,EAAE,GAAKA,WAAW,IAAA,CAAA,EACpD;AACA,YAAA,OAAO7B,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMyB,UAAUG,mBAAAA,CACblB,GAAG,CAAC,CAAC,EAAEU,MAAM,EAAE,GAAKA,MAAAA,CAAAA,CACpBL,MAAM,CAAC,CAACK,MAAAA,GAAWC,kBAAAA,CAAEM,QAAQ,CAACP,MAAAA,CAAAA,CAAAA;QAEjC,IAAIC,kBAAAA,CAAEW,OAAO,CAACP,OAAAA,CAAAA,EAAU;AACtB,YAAA,OAAOlC,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,OAAOT,QAAAA,CAAS;AACdM,YAAAA,MAAAA;AACAE,YAAAA,OAAAA;AACAC,YAAAA,UAAAA;YACAY,SAAAA,EAAW;gBAAEsB,IAAAA,EAAM;AAAC,oBAAA;wBAAEC,GAAAA,EAAKV;AAAQ;AAAE;AAAC;AACxC,SAAA,CAAA;AACF,IAAA,CAAA;IAEA,OAAO;AACL,QAAA,IAAIhD,KAAAA,CAAAA,GAAQ;AACV,YAAA,OAAOO,MAAMP,KAAK;AACpB,QAAA,CAAA;AAEA;;;QAIA2D,sBAAAA,CAAAA,CAAuBC,GAAG,EAAE/C,OAAgC,EAAA;AAC1D,YAAA,OAAO,OAAOI,UAAAA,GAAAA;AACZ,gBAAA,MAAM4C,cAAcC,+BAAAA,CAA0B;AAAEjD,oBAAAA,OAAAA;AAASI,oBAAAA;AAAW,iBAAA,CAAA;AAEpE,gBAAA,MAAMV,MAAMP,KAAK,CAAC,4BAAA,CAA6B,CAACW,IAAI,CAACkD,WAAAA,CAAAA;AAErD,gBAAA,OAAOD,GAAAA,CAAI3C,UAAAA,CAAAA;AACb,YAAA,CAAA;AACF,QAAA,CAAA;AAEA;;QAGA8C,EAAAA,CAAAA,CAAGtD,IAAI,EAAE8B,OAAO,EAAA;AACd,YAAA,MAAMyB,UAAAA,GAAatC,MAAAA,CAAOC,IAAI,CAACpB,MAAMP,KAAK,CAAA;YAC1C,MAAMiE,WAAAA,GAAcD,UAAAA,CAAWE,QAAQ,CAACzD,IAAAA,CAAAA;AAExC,YAAA,IAAI,CAACwD,WAAAA,EAAa;gBAChB,MAAM,IAAIE,KAAAA,CACR,CAAC,wFAAwF,EAAE1D,IAAAA,CAAK,sBAAsB,EAAEuD,UAAAA,CAAWI,IAAI,CACrI,IAAA,CAAA,CAAA,CACC,CAAA;AAEP,YAAA;AAEA7D,YAAAA,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACK,QAAQ,CAACyB,OAAAA,CAAAA;AAE3B,YAAA,OAAO,IAAI;AACb,QAAA,CAAA;AAEA;;;AAGC,QACD,MAAM8B,eAAAA,CAAAA,CAAgBC,WAAW,EAAEzD,OAAAA,GAAmC,EAAE,EAAA;AACtE,YAAA,MAAM,EAAE+C,GAAG,EAAEW,KAAK,EAAE,GAAGlE,qBAAAA,EAAAA;YAEvB,KAAK,MAAMY,cAAcqD,WAAAA,CAAa;AACpC,gBAAA,MAAMxD,QAAAA,GAAW,IAAI,CAAC6C,sBAAsB,CAACC,GAAAA,EAAK/C,OAAAA,CAAAA;AAElD,gBAAA,MAAMD,QAAAA,CAAS;AAAEK,oBAAAA,UAAAA;AAAYJ,oBAAAA,OAAAA;AAASC,oBAAAA;AAAS,iBAAA,CAAA;AACjD,YAAA;YAEA,OAAOyD,KAAAA,EAAAA;AACT,QAAA;AACF,KAAA;AACF;;;;;"}
|
package/dist/engine/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import _ from 'lodash
|
|
1
|
+
import _ from 'lodash';
|
|
2
2
|
import qs from 'qs';
|
|
3
3
|
import { createWillRegisterContext, createEngineHooks, createBeforeEvaluateContext, createValidateContext } from './hooks.mjs';
|
|
4
4
|
import * as index from './abilities/index.mjs';
|
|
@@ -45,30 +45,28 @@ const newEngine = (params)=>{
|
|
|
45
45
|
});
|
|
46
46
|
}
|
|
47
47
|
const resolveConditions = (ids)=>ids.map((id)=>providers.condition.get(id));
|
|
48
|
-
const removeInvalidConditions =
|
|
48
|
+
const removeInvalidConditions = (conditions)=>conditions.filter((condition)=>condition != null && typeof condition.handler === 'function');
|
|
49
49
|
const evaluateConditions = (conditions)=>{
|
|
50
50
|
return Promise.all(conditions.map(async (condition)=>({
|
|
51
51
|
condition,
|
|
52
|
-
result: await condition.handler(_.merge(options, {
|
|
52
|
+
result: await condition.handler(_.merge({}, options, {
|
|
53
53
|
permission: _.cloneDeep(permission)
|
|
54
54
|
}))
|
|
55
55
|
})));
|
|
56
56
|
};
|
|
57
|
-
const removeInvalidResults =
|
|
57
|
+
const removeInvalidResults = (results)=>results.filter(({ result })=>_.isBoolean(result) || _.isObject(result));
|
|
58
58
|
const evaluatedConditions = await Promise.resolve(conditions).then(resolveConditions).then(removeInvalidConditions).then(evaluateConditions).then(removeInvalidResults);
|
|
59
|
-
|
|
60
|
-
const pickResults = _.map(_.prop('result'));
|
|
61
|
-
if (evaluatedConditions.every(resultPropEq(false))) {
|
|
59
|
+
if (evaluatedConditions.every(({ result })=>result === false)) {
|
|
62
60
|
return;
|
|
63
61
|
}
|
|
64
|
-
if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(
|
|
62
|
+
if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(({ result })=>result === true)) {
|
|
65
63
|
return register({
|
|
66
64
|
action,
|
|
67
65
|
subject,
|
|
68
66
|
properties
|
|
69
67
|
});
|
|
70
68
|
}
|
|
71
|
-
const results =
|
|
69
|
+
const results = evaluatedConditions.map(({ result })=>result).filter((result)=>_.isObject(result));
|
|
72
70
|
if (_.isEmpty(results)) {
|
|
73
71
|
return register({
|
|
74
72
|
action,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":["../../src/engine/index.ts"],"sourcesContent":["import _ from 'lodash/fp';\nimport qs from 'qs';\nimport { Ability } from '@casl/ability';\nimport { providerFactory } from '@strapi/utils';\n\nimport {\n createEngineHooks,\n createWillRegisterContext,\n createBeforeEvaluateContext,\n createValidateContext,\n} from './hooks';\nimport type { PermissionEngineHooks, HookName } from './hooks';\n\nimport * as abilities from './abilities';\nimport { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport { abilities };\n\ntype Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {\n register(...args: unknown[]): Promise<Provider> | Provider;\n};\n\ntype ActionProvider = Provider;\ntype ConditionProvider = Provider;\n\nexport interface Engine {\n hooks: PermissionEngineHooks;\n on(hook: HookName, handler: (...args: any[]) => any): Engine;\n generateAbility(permissions: Permission[], options?: object): Promise<Ability>;\n createRegisterFunction(\n can: (permission: PermissionRule) => unknown,\n options: Record<string, unknown>\n ): (permission: PermissionRule) => Promise<unknown>;\n}\n\nexport interface EngineParams {\n providers: { action: ActionProvider; condition: ConditionProvider };\n abilityBuilderFactory?(): abilities.CustomAbilityBuilder;\n}\n\ninterface EvaluateParams {\n options: Record<string, unknown>;\n register: (permission: PermissionRule) => Promise<unknown>;\n permission: Permission;\n}\n\ninterface Condition {\n name: string;\n handler(...params: unknown[]): boolean | object;\n}\n\n/**\n * Create a default state object for the engine\n */\nconst createEngineState = () => {\n const hooks = createEngineHooks();\n\n return { hooks };\n};\n\nconst newEngine = (params: EngineParams): Engine => {\n const { providers, abilityBuilderFactory = abilities.caslAbilityBuilder } = params;\n\n const state = createEngineState();\n\n const runValidationHook = async (hook: HookName, context: unknown) =>\n state.hooks[hook].call(context);\n\n /**\n * Evaluate a permission using local and registered behaviors (using hooks).\n * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission\n */\n const evaluate = async (params: EvaluateParams) => {\n const { options, register } = params;\n\n const preFormatValidation = await runValidationHook(\n 'before-format::validate.permission',\n createBeforeEvaluateContext(params.permission)\n );\n\n if (preFormatValidation === false) {\n return;\n }\n\n const permission = (await state.hooks['format.permission'].call(\n params.permission\n )) as Permission;\n\n const afterFormatValidation = await runValidationHook(\n 'after-format::validate.permission',\n createValidateContext(permission)\n );\n\n if (afterFormatValidation === false) {\n return;\n }\n\n await state.hooks['before-evaluate.permission'].call(createBeforeEvaluateContext(permission));\n\n const {\n action: actionName,\n subject,\n properties,\n conditions = [],\n actionParameters = {},\n } = permission;\n\n let action = actionName;\n\n if (actionParameters && Object.keys(actionParameters).length > 0) {\n action = `${actionName}?${qs.stringify(actionParameters)}`;\n }\n\n if (conditions.length === 0) {\n return register({ action, subject, properties });\n }\n\n const resolveConditions = (ids: string[]): (Condition | undefined)[] =>\n ids.map((id) => providers.condition.get(id) as Condition | undefined);\n\n const removeInvalidConditions = _.filter(\n (condition: Condition | undefined): condition is Condition =>\n condition != null && _.isFunction(condition.handler)\n );\n\n const evaluateConditions = (conditions: Condition[]) => {\n return Promise.all(\n conditions.map(async (condition) => ({\n condition,\n result: await condition.handler(\n _.merge(options, { permission: _.cloneDeep(permission) })\n ),\n }))\n );\n };\n\n const removeInvalidResults = _.filter(\n ({ result }) => _.isBoolean(result) || _.isObject(result)\n );\n\n const evaluatedConditions = await Promise.resolve(conditions)\n .then(resolveConditions)\n .then(removeInvalidConditions)\n .then(evaluateConditions)\n .then(removeInvalidResults);\n\n const resultPropEq = _.propEq('result');\n const pickResults = _.map(_.prop('result'));\n\n if (evaluatedConditions.every(resultPropEq(false))) {\n return;\n }\n\n if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(resultPropEq(true))) {\n return register({ action, subject, properties });\n }\n\n const results = pickResults(evaluatedConditions).filter(_.isObject);\n\n if (_.isEmpty(results)) {\n return register({ action, subject, properties });\n }\n\n return register({\n action,\n subject,\n properties,\n condition: { $and: [{ $or: results }] },\n });\n };\n\n return {\n get hooks() {\n return state.hooks;\n },\n\n /**\n * Create a register function that wraps a `can` function\n * used to register a permission in the ability builder\n */\n createRegisterFunction(can, options: Record<string, unknown>) {\n return async (permission: PermissionRule) => {\n const hookContext = createWillRegisterContext({ options, permission });\n\n await state.hooks['before-register.permission'].call(hookContext);\n\n return can(permission);\n };\n },\n\n /**\n * Register a new handler for a given hook\n */\n on(hook, handler) {\n const validHooks = Object.keys(state.hooks);\n const isValidHook = validHooks.includes(hook);\n\n if (!isValidHook) {\n throw new Error(\n `Invalid hook supplied when trying to register an handler to the permission engine. Got \"${hook}\" but expected one of ${validHooks.join(\n ', '\n )}`\n );\n }\n\n state.hooks[hook].register(handler);\n\n return this;\n },\n\n /**\n * Generate an ability based on the instance's\n * ability builder and the given permissions\n */\n async generateAbility(permissions, options: Record<string, unknown> = {}) {\n const { can, build } = abilityBuilderFactory();\n\n for (const permission of permissions) {\n const register = this.createRegisterFunction(can, options);\n\n await evaluate({ permission, options, register });\n }\n\n return build();\n },\n };\n};\n\nexport { newEngine as new };\n"],"names":["createEngineState","hooks","createEngineHooks","newEngine","params","providers","abilityBuilderFactory","abilities","state","runValidationHook","hook","context","call","evaluate","options","register","preFormatValidation","createBeforeEvaluateContext","permission","afterFormatValidation","createValidateContext","action","actionName","subject","properties","conditions","actionParameters","Object","keys","length","qs","stringify","resolveConditions","ids","map","id","condition","get","removeInvalidConditions","_","filter","isFunction","handler","evaluateConditions","Promise","all","result","merge","cloneDeep","removeInvalidResults","isBoolean","isObject","evaluatedConditions","resolve","then","resultPropEq","propEq","pickResults","prop","every","isEmpty","some","results","$and","$or","createRegisterFunction","can","hookContext","createWillRegisterContext","on","validHooks","isValidHook","includes","Error","join","generateAbility","permissions","build"],"mappings":";;;;;;;AAoDA;;AAEC,IACD,MAAMA,iBAAAA,GAAoB,IAAA;AACxB,IAAA,MAAMC,KAAAA,GAAQC,iBAAAA,EAAAA;IAEd,OAAO;AAAED,QAAAA;AAAM,KAAA;AACjB,CAAA;AAEA,MAAME,YAAY,CAACC,MAAAA,GAAAA;AACjB,IAAA,MAAM,EAAEC,SAAS,EAAEC,wBAAwBC,kBAA4B,EAAE,GAAGH,MAAAA;AAE5E,IAAA,MAAMI,KAAAA,GAAQR,iBAAAA,EAAAA;IAEd,MAAMS,iBAAAA,GAAoB,OAAOC,IAAAA,EAAgBC,OAAAA,GAC/CH,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACE,IAAI,CAACD,OAAAA,CAAAA;AAEzB;;;MAIA,MAAME,WAAW,OAAOT,MAAAA,GAAAA;AACtB,QAAA,MAAM,EAAEU,OAAO,EAAEC,QAAQ,EAAE,GAAGX,MAAAA;AAE9B,QAAA,MAAMY,sBAAsB,MAAMP,iBAAAA,CAChC,oCAAA,EACAQ,2BAAAA,CAA4Bb,OAAOc,UAAU,CAAA,CAAA;AAG/C,QAAA,IAAIF,wBAAwB,KAAA,EAAO;AACjC,YAAA;AACF,QAAA;QAEA,MAAME,UAAAA,GAAc,MAAMV,KAAAA,CAAMP,KAAK,CAAC,oBAAoB,CAACW,IAAI,CAC7DR,MAAAA,CAAOc,UAAU,CAAA;AAGnB,QAAA,MAAMC,qBAAAA,GAAwB,MAAMV,iBAAAA,CAClC,mCAAA,EACAW,qBAAAA,CAAsBF,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAA,EAAO;AACnC,YAAA;AACF,QAAA;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,2BAAAA,CAA4BC,UAAAA,CAAAA,CAAAA;AAEjF,QAAA,MAAM,EACJG,MAAAA,EAAQC,UAAU,EAClBC,OAAO,EACPC,UAAU,EACVC,UAAAA,GAAa,EAAE,EACfC,gBAAAA,GAAmB,EAAE,EACtB,GAAGR,UAAAA;AAEJ,QAAA,IAAIG,MAAAA,GAASC,UAAAA;AAEb,QAAA,IAAII,oBAAoBC,MAAAA,CAAOC,IAAI,CAACF,gBAAAA,CAAAA,CAAkBG,MAAM,GAAG,CAAA,EAAG;AAChER,YAAAA,MAAAA,GAAS,GAAGC,UAAAA,CAAW,CAAC,EAAEQ,EAAAA,CAAGC,SAAS,CAACL,gBAAAA,CAAAA,CAAAA,CAAmB;AAC5D,QAAA;QAEA,IAAID,UAAAA,CAAWI,MAAM,KAAK,CAAA,EAAG;AAC3B,YAAA,OAAOd,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMQ,iBAAAA,GAAoB,CAACC,GAAAA,GACzBA,GAAAA,CAAIC,GAAG,CAAC,CAACC,EAAAA,GAAO9B,SAAAA,CAAU+B,SAAS,CAACC,GAAG,CAACF,EAAAA,CAAAA,CAAAA;AAE1C,QAAA,MAAMG,uBAAAA,GAA0BC,CAAAA,CAAEC,MAAM,CACtC,CAACJ,SAAAA,GACCA,SAAAA,IAAa,IAAA,IAAQG,CAAAA,CAAEE,UAAU,CAACL,SAAAA,CAAUM,OAAO,CAAA,CAAA;AAGvD,QAAA,MAAMC,qBAAqB,CAAClB,UAAAA,GAAAA;YAC1B,OAAOmB,OAAAA,CAAQC,GAAG,CAChBpB,UAAAA,CAAWS,GAAG,CAAC,OAAOE,aAAe;AACnCA,oBAAAA,SAAAA;AACAU,oBAAAA,MAAAA,EAAQ,MAAMV,SAAAA,CAAUM,OAAO,CAC7BH,CAAAA,CAAEQ,KAAK,CAACjC,OAAAA,EAAS;wBAAEI,UAAAA,EAAYqB,CAAAA,CAAES,SAAS,CAAC9B,UAAAA;AAAY,qBAAA,CAAA;iBAE3D,CAAA,CAAA,CAAA;AAEJ,QAAA,CAAA;AAEA,QAAA,MAAM+B,oBAAAA,GAAuBV,CAAAA,CAAEC,MAAM,CACnC,CAAC,EAAEM,MAAM,EAAE,GAAKP,EAAEW,SAAS,CAACJ,MAAAA,CAAAA,IAAWP,CAAAA,CAAEY,QAAQ,CAACL,MAAAA,CAAAA,CAAAA;AAGpD,QAAA,MAAMM,sBAAsB,MAAMR,OAAAA,CAAQS,OAAO,CAAC5B,YAC/C6B,IAAI,CAACtB,iBAAAA,CAAAA,CACLsB,IAAI,CAAChB,uBAAAA,CAAAA,CACLgB,IAAI,CAACX,kBAAAA,CAAAA,CACLW,IAAI,CAACL,oBAAAA,CAAAA;QAER,MAAMM,YAAAA,GAAehB,CAAAA,CAAEiB,MAAM,CAAC,QAAA,CAAA;AAC9B,QAAA,MAAMC,cAAclB,CAAAA,CAAEL,GAAG,CAACK,CAAAA,CAAEmB,IAAI,CAAC,QAAA,CAAA,CAAA;AAEjC,QAAA,IAAIN,mBAAAA,CAAoBO,KAAK,CAACJ,YAAAA,CAAa,KAAA,CAAA,CAAA,EAAS;AAClD,YAAA;AACF,QAAA;QAEA,IAAIhB,CAAAA,CAAEqB,OAAO,CAACR,mBAAAA,CAAAA,IAAwBA,oBAAoBS,IAAI,CAACN,aAAa,IAAA,CAAA,CAAA,EAAQ;AAClF,YAAA,OAAOxC,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMsC,UAAUL,WAAAA,CAAYL,mBAAAA,CAAAA,CAAqBZ,MAAM,CAACD,EAAEY,QAAQ,CAAA;QAElE,IAAIZ,CAAAA,CAAEqB,OAAO,CAACE,OAAAA,CAAAA,EAAU;AACtB,YAAA,OAAO/C,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,OAAOT,QAAAA,CAAS;AACdM,YAAAA,MAAAA;AACAE,YAAAA,OAAAA;AACAC,YAAAA,UAAAA;YACAY,SAAAA,EAAW;gBAAE2B,IAAAA,EAAM;AAAC,oBAAA;wBAAEC,GAAAA,EAAKF;AAAQ;AAAE;AAAC;AACxC,SAAA,CAAA;AACF,IAAA,CAAA;IAEA,OAAO;AACL,QAAA,IAAI7D,KAAAA,CAAAA,GAAQ;AACV,YAAA,OAAOO,MAAMP,KAAK;AACpB,QAAA,CAAA;AAEA;;;QAIAgE,sBAAAA,CAAAA,CAAuBC,GAAG,EAAEpD,OAAgC,EAAA;AAC1D,YAAA,OAAO,OAAOI,UAAAA,GAAAA;AACZ,gBAAA,MAAMiD,cAAcC,yBAAAA,CAA0B;AAAEtD,oBAAAA,OAAAA;AAASI,oBAAAA;AAAW,iBAAA,CAAA;AAEpE,gBAAA,MAAMV,MAAMP,KAAK,CAAC,4BAAA,CAA6B,CAACW,IAAI,CAACuD,WAAAA,CAAAA;AAErD,gBAAA,OAAOD,GAAAA,CAAIhD,UAAAA,CAAAA;AACb,YAAA,CAAA;AACF,QAAA,CAAA;AAEA;;QAGAmD,EAAAA,CAAAA,CAAG3D,IAAI,EAAEgC,OAAO,EAAA;AACd,YAAA,MAAM4B,UAAAA,GAAa3C,MAAAA,CAAOC,IAAI,CAACpB,MAAMP,KAAK,CAAA;YAC1C,MAAMsE,WAAAA,GAAcD,UAAAA,CAAWE,QAAQ,CAAC9D,IAAAA,CAAAA;AAExC,YAAA,IAAI,CAAC6D,WAAAA,EAAa;gBAChB,MAAM,IAAIE,KAAAA,CACR,CAAC,wFAAwF,EAAE/D,IAAAA,CAAK,sBAAsB,EAAE4D,UAAAA,CAAWI,IAAI,CACrI,IAAA,CAAA,CAAA,CACC,CAAA;AAEP,YAAA;AAEAlE,YAAAA,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACK,QAAQ,CAAC2B,OAAAA,CAAAA;AAE3B,YAAA,OAAO,IAAI;AACb,QAAA,CAAA;AAEA;;;AAGC,QACD,MAAMiC,eAAAA,CAAAA,CAAgBC,WAAW,EAAE9D,OAAAA,GAAmC,EAAE,EAAA;AACtE,YAAA,MAAM,EAAEoD,GAAG,EAAEW,KAAK,EAAE,GAAGvE,qBAAAA,EAAAA;YAEvB,KAAK,MAAMY,cAAc0D,WAAAA,CAAa;AACpC,gBAAA,MAAM7D,QAAAA,GAAW,IAAI,CAACkD,sBAAsB,CAACC,GAAAA,EAAKpD,OAAAA,CAAAA;AAElD,gBAAA,MAAMD,QAAAA,CAAS;AAAEK,oBAAAA,UAAAA;AAAYJ,oBAAAA,OAAAA;AAASC,oBAAAA;AAAS,iBAAA,CAAA;AACjD,YAAA;YAEA,OAAO8D,KAAAA,EAAAA;AACT,QAAA;AACF,KAAA;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":["../../src/engine/index.ts"],"sourcesContent":["import _ from 'lodash';\nimport qs from 'qs';\nimport { Ability } from '@casl/ability';\nimport { providerFactory } from '@strapi/utils';\n\nimport {\n createEngineHooks,\n createWillRegisterContext,\n createBeforeEvaluateContext,\n createValidateContext,\n} from './hooks';\nimport type { PermissionEngineHooks, HookName } from './hooks';\n\nimport * as abilities from './abilities';\nimport { Permission } from '../domain/permission';\nimport type { PermissionRule } from '../types';\n\nexport { abilities };\n\ntype Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {\n register(...args: unknown[]): Promise<Provider> | Provider;\n};\n\ntype ActionProvider = Provider;\ntype ConditionProvider = Provider;\n\nexport interface Engine {\n hooks: PermissionEngineHooks;\n on(hook: HookName, handler: (...args: any[]) => any): Engine;\n generateAbility(permissions: Permission[], options?: object): Promise<Ability>;\n createRegisterFunction(\n can: (permission: PermissionRule) => unknown,\n options: Record<string, unknown>\n ): (permission: PermissionRule) => Promise<unknown>;\n}\n\nexport interface EngineParams {\n providers: { action: ActionProvider; condition: ConditionProvider };\n abilityBuilderFactory?(): abilities.CustomAbilityBuilder;\n}\n\ninterface EvaluateParams {\n options: Record<string, unknown>;\n register: (permission: PermissionRule) => Promise<unknown>;\n permission: Permission;\n}\n\ninterface Condition {\n name: string;\n handler(...params: unknown[]): boolean | object;\n}\n\n/**\n * Create a default state object for the engine\n */\nconst createEngineState = () => {\n const hooks = createEngineHooks();\n\n return { hooks };\n};\n\nconst newEngine = (params: EngineParams): Engine => {\n const { providers, abilityBuilderFactory = abilities.caslAbilityBuilder } = params;\n\n const state = createEngineState();\n\n const runValidationHook = async (hook: HookName, context: unknown) =>\n state.hooks[hook].call(context);\n\n /**\n * Evaluate a permission using local and registered behaviors (using hooks).\n * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission\n */\n const evaluate = async (params: EvaluateParams) => {\n const { options, register } = params;\n\n const preFormatValidation = await runValidationHook(\n 'before-format::validate.permission',\n createBeforeEvaluateContext(params.permission)\n );\n\n if (preFormatValidation === false) {\n return;\n }\n\n const permission = (await state.hooks['format.permission'].call(\n params.permission\n )) as Permission;\n\n const afterFormatValidation = await runValidationHook(\n 'after-format::validate.permission',\n createValidateContext(permission)\n );\n\n if (afterFormatValidation === false) {\n return;\n }\n\n await state.hooks['before-evaluate.permission'].call(createBeforeEvaluateContext(permission));\n\n const {\n action: actionName,\n subject,\n properties,\n conditions = [],\n actionParameters = {},\n } = permission;\n\n let action = actionName;\n\n if (actionParameters && Object.keys(actionParameters).length > 0) {\n action = `${actionName}?${qs.stringify(actionParameters)}`;\n }\n\n if (conditions.length === 0) {\n return register({ action, subject, properties });\n }\n\n const resolveConditions = (ids: string[]): (Condition | undefined)[] =>\n ids.map((id) => providers.condition.get(id) as Condition | undefined);\n\n const removeInvalidConditions = (conditions: (Condition | undefined)[]) =>\n conditions.filter(\n (condition): condition is Condition =>\n condition != null && typeof condition.handler === 'function'\n );\n\n const evaluateConditions = (conditions: Condition[]) => {\n return Promise.all(\n conditions.map(async (condition) => ({\n condition,\n result: await condition.handler(\n _.merge({}, options, { permission: _.cloneDeep(permission) })\n ),\n }))\n );\n };\n\n const removeInvalidResults = (results: Awaited<ReturnType<typeof evaluateConditions>>) =>\n results.filter(({ result }) => _.isBoolean(result) || _.isObject(result));\n\n const evaluatedConditions = await Promise.resolve(conditions)\n .then(resolveConditions)\n .then(removeInvalidConditions)\n .then(evaluateConditions)\n .then(removeInvalidResults);\n\n if (evaluatedConditions.every(({ result }) => result === false)) {\n return;\n }\n\n if (\n _.isEmpty(evaluatedConditions) ||\n evaluatedConditions.some(({ result }) => result === true)\n ) {\n return register({ action, subject, properties });\n }\n\n const results = evaluatedConditions\n .map(({ result }) => result)\n .filter((result) => _.isObject(result));\n\n if (_.isEmpty(results)) {\n return register({ action, subject, properties });\n }\n\n return register({\n action,\n subject,\n properties,\n condition: { $and: [{ $or: results }] },\n });\n };\n\n return {\n get hooks() {\n return state.hooks;\n },\n\n /**\n * Create a register function that wraps a `can` function\n * used to register a permission in the ability builder\n */\n createRegisterFunction(can, options: Record<string, unknown>) {\n return async (permission: PermissionRule) => {\n const hookContext = createWillRegisterContext({ options, permission });\n\n await state.hooks['before-register.permission'].call(hookContext);\n\n return can(permission);\n };\n },\n\n /**\n * Register a new handler for a given hook\n */\n on(hook, handler) {\n const validHooks = Object.keys(state.hooks);\n const isValidHook = validHooks.includes(hook);\n\n if (!isValidHook) {\n throw new Error(\n `Invalid hook supplied when trying to register an handler to the permission engine. Got \"${hook}\" but expected one of ${validHooks.join(\n ', '\n )}`\n );\n }\n\n state.hooks[hook].register(handler);\n\n return this;\n },\n\n /**\n * Generate an ability based on the instance's\n * ability builder and the given permissions\n */\n async generateAbility(permissions, options: Record<string, unknown> = {}) {\n const { can, build } = abilityBuilderFactory();\n\n for (const permission of permissions) {\n const register = this.createRegisterFunction(can, options);\n\n await evaluate({ permission, options, register });\n }\n\n return build();\n },\n };\n};\n\nexport { newEngine as new };\n"],"names":["createEngineState","hooks","createEngineHooks","newEngine","params","providers","abilityBuilderFactory","abilities","state","runValidationHook","hook","context","call","evaluate","options","register","preFormatValidation","createBeforeEvaluateContext","permission","afterFormatValidation","createValidateContext","action","actionName","subject","properties","conditions","actionParameters","Object","keys","length","qs","stringify","resolveConditions","ids","map","id","condition","get","removeInvalidConditions","filter","handler","evaluateConditions","Promise","all","result","_","merge","cloneDeep","removeInvalidResults","results","isBoolean","isObject","evaluatedConditions","resolve","then","every","isEmpty","some","$and","$or","createRegisterFunction","can","hookContext","createWillRegisterContext","on","validHooks","isValidHook","includes","Error","join","generateAbility","permissions","build"],"mappings":";;;;;;;AAoDA;;AAEC,IACD,MAAMA,iBAAAA,GAAoB,IAAA;AACxB,IAAA,MAAMC,KAAAA,GAAQC,iBAAAA,EAAAA;IAEd,OAAO;AAAED,QAAAA;AAAM,KAAA;AACjB,CAAA;AAEA,MAAME,YAAY,CAACC,MAAAA,GAAAA;AACjB,IAAA,MAAM,EAAEC,SAAS,EAAEC,wBAAwBC,kBAA4B,EAAE,GAAGH,MAAAA;AAE5E,IAAA,MAAMI,KAAAA,GAAQR,iBAAAA,EAAAA;IAEd,MAAMS,iBAAAA,GAAoB,OAAOC,IAAAA,EAAgBC,OAAAA,GAC/CH,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACE,IAAI,CAACD,OAAAA,CAAAA;AAEzB;;;MAIA,MAAME,WAAW,OAAOT,MAAAA,GAAAA;AACtB,QAAA,MAAM,EAAEU,OAAO,EAAEC,QAAQ,EAAE,GAAGX,MAAAA;AAE9B,QAAA,MAAMY,sBAAsB,MAAMP,iBAAAA,CAChC,oCAAA,EACAQ,2BAAAA,CAA4Bb,OAAOc,UAAU,CAAA,CAAA;AAG/C,QAAA,IAAIF,wBAAwB,KAAA,EAAO;AACjC,YAAA;AACF,QAAA;QAEA,MAAME,UAAAA,GAAc,MAAMV,KAAAA,CAAMP,KAAK,CAAC,oBAAoB,CAACW,IAAI,CAC7DR,MAAAA,CAAOc,UAAU,CAAA;AAGnB,QAAA,MAAMC,qBAAAA,GAAwB,MAAMV,iBAAAA,CAClC,mCAAA,EACAW,qBAAAA,CAAsBF,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAA,EAAO;AACnC,YAAA;AACF,QAAA;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,2BAAAA,CAA4BC,UAAAA,CAAAA,CAAAA;AAEjF,QAAA,MAAM,EACJG,MAAAA,EAAQC,UAAU,EAClBC,OAAO,EACPC,UAAU,EACVC,UAAAA,GAAa,EAAE,EACfC,gBAAAA,GAAmB,EAAE,EACtB,GAAGR,UAAAA;AAEJ,QAAA,IAAIG,MAAAA,GAASC,UAAAA;AAEb,QAAA,IAAII,oBAAoBC,MAAAA,CAAOC,IAAI,CAACF,gBAAAA,CAAAA,CAAkBG,MAAM,GAAG,CAAA,EAAG;AAChER,YAAAA,MAAAA,GAAS,GAAGC,UAAAA,CAAW,CAAC,EAAEQ,EAAAA,CAAGC,SAAS,CAACL,gBAAAA,CAAAA,CAAAA,CAAmB;AAC5D,QAAA;QAEA,IAAID,UAAAA,CAAWI,MAAM,KAAK,CAAA,EAAG;AAC3B,YAAA,OAAOd,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMQ,iBAAAA,GAAoB,CAACC,GAAAA,GACzBA,GAAAA,CAAIC,GAAG,CAAC,CAACC,EAAAA,GAAO9B,SAAAA,CAAU+B,SAAS,CAACC,GAAG,CAACF,EAAAA,CAAAA,CAAAA;AAE1C,QAAA,MAAMG,uBAAAA,GAA0B,CAACb,UAAAA,GAC/BA,UAAAA,CAAWc,MAAM,CACf,CAACH,SAAAA,GACCA,SAAAA,IAAa,IAAA,IAAQ,OAAOA,SAAAA,CAAUI,OAAO,KAAK,UAAA,CAAA;AAGxD,QAAA,MAAMC,qBAAqB,CAAChB,UAAAA,GAAAA;YAC1B,OAAOiB,OAAAA,CAAQC,GAAG,CAChBlB,UAAAA,CAAWS,GAAG,CAAC,OAAOE,aAAe;AACnCA,oBAAAA,SAAAA;oBACAQ,MAAAA,EAAQ,MAAMR,UAAUI,OAAO,CAC7BK,EAAEC,KAAK,CAAC,EAAC,EAAGhC,OAAAA,EAAS;wBAAEI,UAAAA,EAAY2B,CAAAA,CAAEE,SAAS,CAAC7B,UAAAA;AAAY,qBAAA,CAAA;iBAE/D,CAAA,CAAA,CAAA;AAEJ,QAAA,CAAA;AAEA,QAAA,MAAM8B,uBAAuB,CAACC,OAAAA,GAC5BA,OAAAA,CAAQV,MAAM,CAAC,CAAC,EAAEK,MAAM,EAAE,GAAKC,CAAAA,CAAEK,SAAS,CAACN,MAAAA,CAAAA,IAAWC,CAAAA,CAAEM,QAAQ,CAACP,MAAAA,CAAAA,CAAAA;AAEnE,QAAA,MAAMQ,sBAAsB,MAAMV,OAAAA,CAAQW,OAAO,CAAC5B,YAC/C6B,IAAI,CAACtB,iBAAAA,CAAAA,CACLsB,IAAI,CAAChB,uBAAAA,CAAAA,CACLgB,IAAI,CAACb,kBAAAA,CAAAA,CACLa,IAAI,CAACN,oBAAAA,CAAAA;QAER,IAAII,mBAAAA,CAAoBG,KAAK,CAAC,CAAC,EAAEX,MAAM,EAAE,GAAKA,MAAAA,KAAW,KAAA,CAAA,EAAQ;AAC/D,YAAA;AACF,QAAA;AAEA,QAAA,IACEC,CAAAA,CAAEW,OAAO,CAACJ,mBAAAA,CAAAA,IACVA,mBAAAA,CAAoBK,IAAI,CAAC,CAAC,EAAEb,MAAM,EAAE,GAAKA,WAAW,IAAA,CAAA,EACpD;AACA,YAAA,OAAO7B,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,MAAMyB,UAAUG,mBAAAA,CACblB,GAAG,CAAC,CAAC,EAAEU,MAAM,EAAE,GAAKA,MAAAA,CAAAA,CACpBL,MAAM,CAAC,CAACK,MAAAA,GAAWC,CAAAA,CAAEM,QAAQ,CAACP,MAAAA,CAAAA,CAAAA;QAEjC,IAAIC,CAAAA,CAAEW,OAAO,CAACP,OAAAA,CAAAA,EAAU;AACtB,YAAA,OAAOlC,QAAAA,CAAS;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD,QAAA;AAEA,QAAA,OAAOT,QAAAA,CAAS;AACdM,YAAAA,MAAAA;AACAE,YAAAA,OAAAA;AACAC,YAAAA,UAAAA;YACAY,SAAAA,EAAW;gBAAEsB,IAAAA,EAAM;AAAC,oBAAA;wBAAEC,GAAAA,EAAKV;AAAQ;AAAE;AAAC;AACxC,SAAA,CAAA;AACF,IAAA,CAAA;IAEA,OAAO;AACL,QAAA,IAAIhD,KAAAA,CAAAA,GAAQ;AACV,YAAA,OAAOO,MAAMP,KAAK;AACpB,QAAA,CAAA;AAEA;;;QAIA2D,sBAAAA,CAAAA,CAAuBC,GAAG,EAAE/C,OAAgC,EAAA;AAC1D,YAAA,OAAO,OAAOI,UAAAA,GAAAA;AACZ,gBAAA,MAAM4C,cAAcC,yBAAAA,CAA0B;AAAEjD,oBAAAA,OAAAA;AAASI,oBAAAA;AAAW,iBAAA,CAAA;AAEpE,gBAAA,MAAMV,MAAMP,KAAK,CAAC,4BAAA,CAA6B,CAACW,IAAI,CAACkD,WAAAA,CAAAA;AAErD,gBAAA,OAAOD,GAAAA,CAAI3C,UAAAA,CAAAA;AACb,YAAA,CAAA;AACF,QAAA,CAAA;AAEA;;QAGA8C,EAAAA,CAAAA,CAAGtD,IAAI,EAAE8B,OAAO,EAAA;AACd,YAAA,MAAMyB,UAAAA,GAAatC,MAAAA,CAAOC,IAAI,CAACpB,MAAMP,KAAK,CAAA;YAC1C,MAAMiE,WAAAA,GAAcD,UAAAA,CAAWE,QAAQ,CAACzD,IAAAA,CAAAA;AAExC,YAAA,IAAI,CAACwD,WAAAA,EAAa;gBAChB,MAAM,IAAIE,KAAAA,CACR,CAAC,wFAAwF,EAAE1D,IAAAA,CAAK,sBAAsB,EAAEuD,UAAAA,CAAWI,IAAI,CACrI,IAAA,CAAA,CAAA,CACC,CAAA;AAEP,YAAA;AAEA7D,YAAAA,KAAAA,CAAMP,KAAK,CAACS,IAAAA,CAAK,CAACK,QAAQ,CAACyB,OAAAA,CAAAA;AAE3B,YAAA,OAAO,IAAI;AACb,QAAA,CAAA;AAEA;;;AAGC,QACD,MAAM8B,eAAAA,CAAAA,CAAgBC,WAAW,EAAEzD,OAAAA,GAAmC,EAAE,EAAA;AACtE,YAAA,MAAM,EAAE+C,GAAG,EAAEW,KAAK,EAAE,GAAGlE,qBAAAA,EAAAA;YAEvB,KAAK,MAAMY,cAAcqD,WAAAA,CAAa;AACpC,gBAAA,MAAMxD,QAAAA,GAAW,IAAI,CAAC6C,sBAAsB,CAACC,GAAAA,EAAK/C,OAAAA,CAAAA;AAElD,gBAAA,MAAMD,QAAAA,CAAS;AAAEK,oBAAAA,UAAAA;AAAYJ,oBAAAA,OAAAA;AAASC,oBAAAA;AAAS,iBAAA,CAAA;AACjD,YAAA;YAEA,OAAOyD,KAAAA,EAAAA;AACT,QAAA;AACF,KAAA;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@strapi/permissions",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.57.0",
|
|
4
4
|
"description": "Strapi's permission layer.",
|
|
5
5
|
"homepage": "https://strapi.io",
|
|
6
6
|
"bugs": {
|
|
@@ -44,17 +44,17 @@
|
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
46
|
"@casl/ability": "6.7.5",
|
|
47
|
-
"@strapi/utils": "5.
|
|
47
|
+
"@strapi/utils": "5.57.0",
|
|
48
48
|
"lodash": "4.18.1",
|
|
49
|
-
"qs": "6.
|
|
49
|
+
"qs": "6.16.0",
|
|
50
50
|
"sift": "16.0.1"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@types/node": "20.19.41",
|
|
54
|
-
"eslint-config-custom": "5.
|
|
55
|
-
"tsconfig": "5.
|
|
54
|
+
"eslint-config-custom": "5.57.0",
|
|
55
|
+
"tsconfig": "5.57.0",
|
|
56
56
|
"vitest": "catalog:",
|
|
57
|
-
"vitest-config": "5.
|
|
57
|
+
"vitest-config": "5.57.0"
|
|
58
58
|
},
|
|
59
59
|
"engines": {
|
|
60
60
|
"node": ">=20.0.0 <=26.x.x",
|