@strapi/permissions 0.0.0-next.fab38a080023b0850fc7a8ec8605d1ee6970e3c9 → 0.0.0-next.fb92031f3d90f3d2a2d191ba65725b6c8e329a5d
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/LICENSE +18 -3
- package/dist/domain/index.d.ts +1 -0
- package/dist/domain/index.d.ts.map +1 -0
- package/dist/domain/index.js +8 -29
- package/dist/domain/index.js.map +1 -1
- package/dist/domain/index.mjs +3 -0
- package/dist/domain/index.mjs.map +1 -0
- package/dist/domain/permission/index.d.ts +2 -1
- package/dist/domain/permission/index.d.ts.map +1 -0
- package/dist/domain/permission/index.js +28 -29
- package/dist/domain/permission/index.js.map +1 -1
- package/dist/domain/permission/index.mjs +36 -0
- package/dist/domain/permission/index.mjs.map +1 -0
- package/dist/engine/abilities/casl-ability.d.ts +3 -13
- package/dist/engine/abilities/casl-ability.d.ts.map +1 -0
- package/dist/engine/abilities/casl-ability.js +52 -52
- package/dist/engine/abilities/casl-ability.js.map +1 -1
- package/dist/engine/abilities/casl-ability.mjs +66 -0
- package/dist/engine/abilities/casl-ability.mjs.map +1 -0
- package/dist/engine/abilities/index.d.ts +1 -0
- package/dist/engine/abilities/index.d.ts.map +1 -0
- package/dist/engine/abilities/index.js +8 -18
- package/dist/engine/abilities/index.js.map +1 -1
- package/dist/engine/abilities/index.mjs +2 -0
- package/dist/engine/abilities/index.mjs.map +1 -0
- package/dist/engine/hooks.d.ts +2 -1
- package/dist/engine/hooks.d.ts.map +1 -0
- package/dist/engine/hooks.js +67 -86
- package/dist/engine/hooks.js.map +1 -1
- package/dist/engine/hooks.mjs +76 -0
- package/dist/engine/hooks.mjs.map +1 -0
- package/dist/engine/index.d.ts +3 -1
- package/dist/engine/index.d.ts.map +1 -0
- package/dist/engine/index.js +87 -91
- package/dist/engine/index.js.map +1 -1
- package/dist/engine/index.mjs +139 -0
- package/dist/engine/index.mjs.map +1 -0
- package/dist/index.d.ts +2 -5
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -31
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +5 -0
- package/dist/index.mjs.map +1 -0
- package/dist/types.d.ts +19 -0
- package/dist/types.d.ts.map +1 -0
- package/package.json +17 -15
package/dist/engine/hooks.js
CHANGED
|
@@ -1,100 +1,81 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.createWillRegisterContext = exports.createBeforeEvaluateContext = exports.createValidateContext = exports.createEngineHooks = void 0;
|
|
27
|
-
const fp_1 = require("lodash/fp");
|
|
28
|
-
const utils_1 = require("@strapi/utils");
|
|
29
|
-
const domain = __importStar(require("../domain"));
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var _ = require('lodash/fp');
|
|
4
|
+
var utils = require('@strapi/utils');
|
|
5
|
+
var index = require('../domain/permission/index.js');
|
|
6
|
+
|
|
30
7
|
/**
|
|
31
8
|
* Create a hook map used by the permission Engine
|
|
32
|
-
*/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
});
|
|
40
|
-
exports.createEngineHooks = createEngineHooks;
|
|
9
|
+
*/ const createEngineHooks = ()=>({
|
|
10
|
+
'before-format::validate.permission': utils.hooks.createAsyncBailHook(),
|
|
11
|
+
'format.permission': utils.hooks.createAsyncSeriesWaterfallHook(),
|
|
12
|
+
'after-format::validate.permission': utils.hooks.createAsyncBailHook(),
|
|
13
|
+
'before-evaluate.permission': utils.hooks.createAsyncSeriesHook(),
|
|
14
|
+
'before-register.permission': utils.hooks.createAsyncSeriesHook()
|
|
15
|
+
});
|
|
41
16
|
/**
|
|
42
17
|
* Create a context from a domain {@link Permission} used by the validate hooks
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
48
|
-
});
|
|
49
|
-
exports.createValidateContext = createValidateContext;
|
|
18
|
+
*/ const createValidateContext = (permission)=>({
|
|
19
|
+
get permission () {
|
|
20
|
+
return _.cloneDeep(permission);
|
|
21
|
+
}
|
|
22
|
+
});
|
|
50
23
|
/**
|
|
51
24
|
* Create a context from a domain {@link Permission} used by the before valuate hook
|
|
52
|
-
*/
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
}
|
|
61
|
-
});
|
|
62
|
-
exports.createBeforeEvaluateContext = createBeforeEvaluateContext;
|
|
25
|
+
*/ const createBeforeEvaluateContext = (permission)=>({
|
|
26
|
+
get permission () {
|
|
27
|
+
return _.cloneDeep(permission);
|
|
28
|
+
},
|
|
29
|
+
addCondition (condition) {
|
|
30
|
+
Object.assign(permission, index.addCondition(condition, permission));
|
|
31
|
+
return this;
|
|
32
|
+
}
|
|
33
|
+
});
|
|
63
34
|
/**
|
|
64
35
|
* Create a context from a casl Permission & some options
|
|
65
36
|
* @param caslPermission
|
|
66
|
-
*/
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
return (0, fp_1.cloneDeep)(permission);
|
|
71
|
-
},
|
|
72
|
-
condition: {
|
|
73
|
-
and(rawConditionObject) {
|
|
74
|
-
if (!permission.condition) {
|
|
75
|
-
permission.condition = { $and: [] };
|
|
76
|
-
}
|
|
77
|
-
if ((0, fp_1.isArray)(permission.condition.$and)) {
|
|
78
|
-
permission.condition.$and.push(rawConditionObject);
|
|
79
|
-
}
|
|
80
|
-
return this;
|
|
37
|
+
*/ const createWillRegisterContext = ({ permission, options })=>({
|
|
38
|
+
...options,
|
|
39
|
+
get permission () {
|
|
40
|
+
return _.cloneDeep(permission);
|
|
81
41
|
},
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
permission.condition
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
42
|
+
condition: {
|
|
43
|
+
and (rawConditionObject) {
|
|
44
|
+
if (!permission.condition) {
|
|
45
|
+
permission.condition = {
|
|
46
|
+
$and: []
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
if (_.isArray(permission.condition.$and)) {
|
|
50
|
+
permission.condition.$and.push(rawConditionObject);
|
|
90
51
|
}
|
|
91
|
-
|
|
92
|
-
|
|
52
|
+
return this;
|
|
53
|
+
},
|
|
54
|
+
or (rawConditionObject) {
|
|
55
|
+
if (!permission.condition) {
|
|
56
|
+
permission.condition = {
|
|
57
|
+
$and: []
|
|
58
|
+
};
|
|
93
59
|
}
|
|
60
|
+
if (_.isArray(permission.condition.$and)) {
|
|
61
|
+
const orClause = permission.condition.$and.find(_.has('$or'));
|
|
62
|
+
if (orClause) {
|
|
63
|
+
orClause.$or.push(rawConditionObject);
|
|
64
|
+
} else {
|
|
65
|
+
permission.condition.$and.push({
|
|
66
|
+
$or: [
|
|
67
|
+
rawConditionObject
|
|
68
|
+
]
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return this;
|
|
94
73
|
}
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
exports.createBeforeEvaluateContext = createBeforeEvaluateContext;
|
|
78
|
+
exports.createEngineHooks = createEngineHooks;
|
|
79
|
+
exports.createValidateContext = createValidateContext;
|
|
99
80
|
exports.createWillRegisterContext = createWillRegisterContext;
|
|
100
|
-
//# sourceMappingURL=hooks.js.map
|
|
81
|
+
//# sourceMappingURL=hooks.js.map
|
package/dist/engine/hooks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","
|
|
1
|
+
{"version":3,"file":"hooks.js","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has, isArray } from 'lodash/fp';\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 (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 (isArray(permission.condition.$and)) {\n const orClause = permission.condition.$and.find(has('$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","isArray","push","or","orClause","find","has","$or"],"mappings":";;;;;;AAiBA;;IAGA,MAAMA,iBAAoB,GAAA,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,IACKC,MAAAA,qBAAAA,GAAwB,CAACC,UAAAA,IAA4B;AACzD,QAAA,IAAIA,UAAmC,CAAA,GAAA;AACrC,YAAA,OAAOC,WAAUD,CAAAA,UAAAA,CAAAA;AACnB;KACF;AAEA;;AAEC,IACKE,MAAAA,2BAAAA,GAA8B,CAACF,UAAAA,IAA4B;AAC/D,QAAA,IAAIA,UAAmC,CAAA,GAAA;AACrC,YAAA,OAAOC,WAAUD,CAAAA,UAAAA,CAAAA;AACnB,SAAA;AAEAG,QAAAA,YAAAA,CAAAA,CAAaC,SAAiB,EAAA;YAC5BC,MAAOC,CAAAA,MAAM,CAACN,UAAYO,EAAAA,kBAA8B,CAACH,SAAWJ,EAAAA,UAAAA,CAAAA,CAAAA;AAEpE,YAAA,OAAO,IAAI;AACb;KACF;AAOA;;;IAIA,MAAMQ,4BAA4B,CAAC,EAAER,UAAU,EAAES,OAAO,EAA6B,IAAM;AACzF,QAAA,GAAGA,OAAO;AAEV,QAAA,IAAIT,UAAa,CAAA,GAAA;AACf,YAAA,OAAOC,WAAUD,CAAAA,UAAAA,CAAAA;AACnB,SAAA;QAEAI,SAAW,EAAA;AACTM,YAAAA,GAAAA,CAAAA,CAAIC,kBAA2B,EAAA;gBAC7B,IAAI,CAACX,UAAWI,CAAAA,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC;AAEA,gBAAA,IAAIC,SAAQb,CAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAAG,EAAA;AACtCZ,oBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACE,IAAI,CAACH,kBAAAA,CAAAA;AACjC;AAEA,gBAAA,OAAO,IAAI;AACb,aAAA;AAEAI,YAAAA,EAAAA,CAAAA,CAAGJ,kBAA2B,EAAA;gBAC5B,IAAI,CAACX,UAAWI,CAAAA,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC;AAEA,gBAAA,IAAIC,SAAQb,CAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAAG,EAAA;oBACtC,MAAMI,QAAAA,GAAWhB,WAAWI,SAAS,CAACQ,IAAI,CAACK,IAAI,CAACC,KAAI,CAAA,KAAA,CAAA,CAAA;AAEpD,oBAAA,IAAIF,QAAU,EAAA;wBACZA,QAASG,CAAAA,GAAG,CAACL,IAAI,CAACH,kBAAAA,CAAAA;qBACb,MAAA;AACLX,wBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACE,IAAI,CAAC;4BAAEK,GAAK,EAAA;AAACR,gCAAAA;AAAmB;AAAC,yBAAA,CAAA;AAC7D;AACF;AAEA,gBAAA,OAAO,IAAI;AACb;AACF;KACF;;;;;;;"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { cloneDeep, isArray, has } from 'lodash/fp';
|
|
2
|
+
import { hooks } from '@strapi/utils';
|
|
3
|
+
import { addCondition } from '../domain/permission/index.mjs';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Create a hook map used by the permission Engine
|
|
7
|
+
*/ const createEngineHooks = ()=>({
|
|
8
|
+
'before-format::validate.permission': hooks.createAsyncBailHook(),
|
|
9
|
+
'format.permission': hooks.createAsyncSeriesWaterfallHook(),
|
|
10
|
+
'after-format::validate.permission': hooks.createAsyncBailHook(),
|
|
11
|
+
'before-evaluate.permission': hooks.createAsyncSeriesHook(),
|
|
12
|
+
'before-register.permission': hooks.createAsyncSeriesHook()
|
|
13
|
+
});
|
|
14
|
+
/**
|
|
15
|
+
* Create a context from a domain {@link Permission} used by the validate hooks
|
|
16
|
+
*/ const createValidateContext = (permission)=>({
|
|
17
|
+
get permission () {
|
|
18
|
+
return cloneDeep(permission);
|
|
19
|
+
}
|
|
20
|
+
});
|
|
21
|
+
/**
|
|
22
|
+
* Create a context from a domain {@link Permission} used by the before valuate hook
|
|
23
|
+
*/ const createBeforeEvaluateContext = (permission)=>({
|
|
24
|
+
get permission () {
|
|
25
|
+
return cloneDeep(permission);
|
|
26
|
+
},
|
|
27
|
+
addCondition (condition) {
|
|
28
|
+
Object.assign(permission, addCondition(condition, permission));
|
|
29
|
+
return this;
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
/**
|
|
33
|
+
* Create a context from a casl Permission & some options
|
|
34
|
+
* @param caslPermission
|
|
35
|
+
*/ const createWillRegisterContext = ({ permission, options })=>({
|
|
36
|
+
...options,
|
|
37
|
+
get permission () {
|
|
38
|
+
return cloneDeep(permission);
|
|
39
|
+
},
|
|
40
|
+
condition: {
|
|
41
|
+
and (rawConditionObject) {
|
|
42
|
+
if (!permission.condition) {
|
|
43
|
+
permission.condition = {
|
|
44
|
+
$and: []
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
if (isArray(permission.condition.$and)) {
|
|
48
|
+
permission.condition.$and.push(rawConditionObject);
|
|
49
|
+
}
|
|
50
|
+
return this;
|
|
51
|
+
},
|
|
52
|
+
or (rawConditionObject) {
|
|
53
|
+
if (!permission.condition) {
|
|
54
|
+
permission.condition = {
|
|
55
|
+
$and: []
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
if (isArray(permission.condition.$and)) {
|
|
59
|
+
const orClause = permission.condition.$and.find(has('$or'));
|
|
60
|
+
if (orClause) {
|
|
61
|
+
orClause.$or.push(rawConditionObject);
|
|
62
|
+
} else {
|
|
63
|
+
permission.condition.$and.push({
|
|
64
|
+
$or: [
|
|
65
|
+
rawConditionObject
|
|
66
|
+
]
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return this;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
export { createBeforeEvaluateContext, createEngineHooks, createValidateContext, createWillRegisterContext };
|
|
76
|
+
//# sourceMappingURL=hooks.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hooks.mjs","sources":["../../src/engine/hooks.ts"],"sourcesContent":["import { cloneDeep, has, isArray } from 'lodash/fp';\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 (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 (isArray(permission.condition.$and)) {\n const orClause = permission.condition.$and.find(has('$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","isArray","push","or","orClause","find","has","$or"],"mappings":";;;;AAiBA;;IAGA,MAAMA,iBAAoB,GAAA,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,IACKC,MAAAA,qBAAAA,GAAwB,CAACC,UAAAA,IAA4B;AACzD,QAAA,IAAIA,UAAmC,CAAA,GAAA;AACrC,YAAA,OAAOC,SAAUD,CAAAA,UAAAA,CAAAA;AACnB;KACF;AAEA;;AAEC,IACKE,MAAAA,2BAAAA,GAA8B,CAACF,UAAAA,IAA4B;AAC/D,QAAA,IAAIA,UAAmC,CAAA,GAAA;AACrC,YAAA,OAAOC,SAAUD,CAAAA,UAAAA,CAAAA;AACnB,SAAA;AAEAG,QAAAA,YAAAA,CAAAA,CAAaC,SAAiB,EAAA;YAC5BC,MAAOC,CAAAA,MAAM,CAACN,UAAYO,EAAAA,YAA8B,CAACH,SAAWJ,EAAAA,UAAAA,CAAAA,CAAAA;AAEpE,YAAA,OAAO,IAAI;AACb;KACF;AAOA;;;IAIA,MAAMQ,4BAA4B,CAAC,EAAER,UAAU,EAAES,OAAO,EAA6B,IAAM;AACzF,QAAA,GAAGA,OAAO;AAEV,QAAA,IAAIT,UAAa,CAAA,GAAA;AACf,YAAA,OAAOC,SAAUD,CAAAA,UAAAA,CAAAA;AACnB,SAAA;QAEAI,SAAW,EAAA;AACTM,YAAAA,GAAAA,CAAAA,CAAIC,kBAA2B,EAAA;gBAC7B,IAAI,CAACX,UAAWI,CAAAA,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC;AAEA,gBAAA,IAAIC,OAAQb,CAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAAG,EAAA;AACtCZ,oBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACE,IAAI,CAACH,kBAAAA,CAAAA;AACjC;AAEA,gBAAA,OAAO,IAAI;AACb,aAAA;AAEAI,YAAAA,EAAAA,CAAAA,CAAGJ,kBAA2B,EAAA;gBAC5B,IAAI,CAACX,UAAWI,CAAAA,SAAS,EAAE;AACzBJ,oBAAAA,UAAAA,CAAWI,SAAS,GAAG;AAAEQ,wBAAAA,IAAAA,EAAM;AAAG,qBAAA;AACpC;AAEA,gBAAA,IAAIC,OAAQb,CAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAAG,EAAA;oBACtC,MAAMI,QAAAA,GAAWhB,WAAWI,SAAS,CAACQ,IAAI,CAACK,IAAI,CAACC,GAAI,CAAA,KAAA,CAAA,CAAA;AAEpD,oBAAA,IAAIF,QAAU,EAAA;wBACZA,QAASG,CAAAA,GAAG,CAACL,IAAI,CAACH,kBAAAA,CAAAA;qBACb,MAAA;AACLX,wBAAAA,UAAAA,CAAWI,SAAS,CAACQ,IAAI,CAACE,IAAI,CAAC;4BAAEK,GAAK,EAAA;AAACR,gCAAAA;AAAmB;AAAC,yBAAA,CAAA;AAC7D;AACF;AAEA,gBAAA,OAAO,IAAI;AACb;AACF;KACF;;;;"}
|
package/dist/engine/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { providerFactory } from '@strapi/utils';
|
|
|
3
3
|
import type { PermissionEngineHooks, HookName } from './hooks';
|
|
4
4
|
import * as abilities from './abilities';
|
|
5
5
|
import { Permission } from '../domain/permission';
|
|
6
|
+
import type { PermissionRule } from '../types';
|
|
6
7
|
export { abilities };
|
|
7
8
|
type Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {
|
|
8
9
|
register(...args: unknown[]): Promise<Provider> | Provider;
|
|
@@ -13,7 +14,7 @@ export interface Engine {
|
|
|
13
14
|
hooks: PermissionEngineHooks;
|
|
14
15
|
on(hook: HookName, handler: (...args: any[]) => any): Engine;
|
|
15
16
|
generateAbility(permissions: Permission[], options?: object): Promise<Ability>;
|
|
16
|
-
createRegisterFunction(can: (permission:
|
|
17
|
+
createRegisterFunction(can: (permission: PermissionRule) => unknown, options: Record<string, unknown>): (permission: PermissionRule) => Promise<unknown>;
|
|
17
18
|
}
|
|
18
19
|
export interface EngineParams {
|
|
19
20
|
providers: {
|
|
@@ -24,3 +25,4 @@ export interface EngineParams {
|
|
|
24
25
|
}
|
|
25
26
|
declare const newEngine: (params: EngineParams) => Engine;
|
|
26
27
|
export { newEngine as new };
|
|
28
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +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,WAAY,YAAY,KAAG,MAoKzC,CAAC;AAEF,OAAO,EAAE,SAAS,IAAI,GAAG,EAAE,CAAC"}
|
package/dist/engine/index.js
CHANGED
|
@@ -1,124 +1,115 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
26
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
27
|
-
};
|
|
28
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.new = exports.abilities = void 0;
|
|
30
|
-
const fp_1 = __importDefault(require("lodash/fp"));
|
|
31
|
-
const qs_1 = __importDefault(require("qs"));
|
|
32
|
-
const hooks_1 = require("./hooks");
|
|
33
|
-
const abilities = __importStar(require("./abilities"));
|
|
34
|
-
exports.abilities = abilities;
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var _ = require('lodash/fp');
|
|
4
|
+
var qs = require('qs');
|
|
5
|
+
var hooks = require('./hooks.js');
|
|
6
|
+
var index = require('./abilities/index.js');
|
|
7
|
+
var caslAbility = require('./abilities/casl-ability.js');
|
|
8
|
+
|
|
35
9
|
/**
|
|
36
10
|
* Create a default state object for the engine
|
|
37
|
-
*/
|
|
38
|
-
const
|
|
39
|
-
|
|
40
|
-
|
|
11
|
+
*/ const createEngineState = ()=>{
|
|
12
|
+
const hooks$1 = hooks.createEngineHooks();
|
|
13
|
+
return {
|
|
14
|
+
hooks: hooks$1
|
|
15
|
+
};
|
|
41
16
|
};
|
|
42
|
-
const newEngine = (params)
|
|
43
|
-
const { providers, abilityBuilderFactory =
|
|
17
|
+
const newEngine = (params)=>{
|
|
18
|
+
const { providers, abilityBuilderFactory = caslAbility.caslAbilityBuilder } = params;
|
|
44
19
|
const state = createEngineState();
|
|
45
|
-
const runValidationHook = async (hook, context)
|
|
20
|
+
const runValidationHook = async (hook, context)=>state.hooks[hook].call(context);
|
|
46
21
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
const evaluate = async (params) => {
|
|
22
|
+
* Evaluate a permission using local and registered behaviors (using hooks).
|
|
23
|
+
* Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission
|
|
24
|
+
*/ const evaluate = async (params)=>{
|
|
51
25
|
const { options, register } = params;
|
|
52
|
-
const preFormatValidation = await runValidationHook('before-format::validate.permission',
|
|
26
|
+
const preFormatValidation = await runValidationHook('before-format::validate.permission', hooks.createBeforeEvaluateContext(params.permission));
|
|
53
27
|
if (preFormatValidation === false) {
|
|
54
28
|
return;
|
|
55
29
|
}
|
|
56
|
-
const permission =
|
|
57
|
-
const afterFormatValidation = await runValidationHook('after-format::validate.permission',
|
|
30
|
+
const permission = await state.hooks['format.permission'].call(params.permission);
|
|
31
|
+
const afterFormatValidation = await runValidationHook('after-format::validate.permission', hooks.createValidateContext(permission));
|
|
58
32
|
if (afterFormatValidation === false) {
|
|
59
33
|
return;
|
|
60
34
|
}
|
|
61
|
-
await state.hooks['before-evaluate.permission'].call(
|
|
62
|
-
const { action: actionName, subject, properties, conditions = [], actionParameters = {}
|
|
35
|
+
await state.hooks['before-evaluate.permission'].call(hooks.createBeforeEvaluateContext(permission));
|
|
36
|
+
const { action: actionName, subject, properties, conditions = [], actionParameters = {} } = permission;
|
|
63
37
|
let action = actionName;
|
|
64
38
|
if (actionParameters && Object.keys(actionParameters).length > 0) {
|
|
65
|
-
action = `${actionName}?${
|
|
39
|
+
action = `${actionName}?${qs.stringify(actionParameters)}`;
|
|
66
40
|
}
|
|
67
41
|
if (conditions.length === 0) {
|
|
68
|
-
return register({
|
|
42
|
+
return register({
|
|
43
|
+
action,
|
|
44
|
+
subject,
|
|
45
|
+
properties
|
|
46
|
+
});
|
|
69
47
|
}
|
|
70
|
-
const resolveConditions =
|
|
71
|
-
const removeInvalidConditions =
|
|
72
|
-
const evaluateConditions = (conditions)
|
|
73
|
-
return Promise.all(conditions.map(async (condition)
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
48
|
+
const resolveConditions = _.map(providers.condition.get);
|
|
49
|
+
const removeInvalidConditions = _.filter((condition)=>_.isFunction(condition.handler));
|
|
50
|
+
const evaluateConditions = (conditions)=>{
|
|
51
|
+
return Promise.all(conditions.map(async (condition)=>({
|
|
52
|
+
condition,
|
|
53
|
+
result: await condition.handler(_.merge(options, {
|
|
54
|
+
permission: _.cloneDeep(permission)
|
|
55
|
+
}))
|
|
56
|
+
})));
|
|
77
57
|
};
|
|
78
|
-
const removeInvalidResults =
|
|
79
|
-
const evaluatedConditions = await Promise.resolve(conditions)
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
.then(evaluateConditions)
|
|
83
|
-
.then(removeInvalidResults);
|
|
84
|
-
const resultPropEq = fp_1.default.propEq('result');
|
|
85
|
-
const pickResults = fp_1.default.map(fp_1.default.prop('result'));
|
|
58
|
+
const removeInvalidResults = _.filter(({ result })=>_.isBoolean(result) || _.isObject(result));
|
|
59
|
+
const evaluatedConditions = await Promise.resolve(conditions).then(resolveConditions).then(removeInvalidConditions).then(evaluateConditions).then(removeInvalidResults);
|
|
60
|
+
const resultPropEq = _.propEq('result');
|
|
61
|
+
const pickResults = _.map(_.prop('result'));
|
|
86
62
|
if (evaluatedConditions.every(resultPropEq(false))) {
|
|
87
63
|
return;
|
|
88
64
|
}
|
|
89
|
-
if (
|
|
90
|
-
return register({
|
|
65
|
+
if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(resultPropEq(true))) {
|
|
66
|
+
return register({
|
|
67
|
+
action,
|
|
68
|
+
subject,
|
|
69
|
+
properties
|
|
70
|
+
});
|
|
91
71
|
}
|
|
92
|
-
const results = pickResults(evaluatedConditions).filter(
|
|
93
|
-
if (
|
|
94
|
-
return register({
|
|
72
|
+
const results = pickResults(evaluatedConditions).filter(_.isObject);
|
|
73
|
+
if (_.isEmpty(results)) {
|
|
74
|
+
return register({
|
|
75
|
+
action,
|
|
76
|
+
subject,
|
|
77
|
+
properties
|
|
78
|
+
});
|
|
95
79
|
}
|
|
96
80
|
return register({
|
|
97
81
|
action,
|
|
98
82
|
subject,
|
|
99
83
|
properties,
|
|
100
|
-
condition: {
|
|
84
|
+
condition: {
|
|
85
|
+
$and: [
|
|
86
|
+
{
|
|
87
|
+
$or: results
|
|
88
|
+
}
|
|
89
|
+
]
|
|
90
|
+
}
|
|
101
91
|
});
|
|
102
92
|
};
|
|
103
93
|
return {
|
|
104
|
-
get hooks() {
|
|
94
|
+
get hooks () {
|
|
105
95
|
return state.hooks;
|
|
106
96
|
},
|
|
107
97
|
/**
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
98
|
+
* Create a register function that wraps a `can` function
|
|
99
|
+
* used to register a permission in the ability builder
|
|
100
|
+
*/ createRegisterFunction (can, options) {
|
|
101
|
+
return async (permission)=>{
|
|
102
|
+
const hookContext = hooks.createWillRegisterContext({
|
|
103
|
+
options,
|
|
104
|
+
permission
|
|
105
|
+
});
|
|
114
106
|
await state.hooks['before-register.permission'].call(hookContext);
|
|
115
107
|
return can(permission);
|
|
116
108
|
};
|
|
117
109
|
},
|
|
118
110
|
/**
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
on(hook, handler) {
|
|
111
|
+
* Register a new handler for a given hook
|
|
112
|
+
*/ on (hook, handler) {
|
|
122
113
|
const validHooks = Object.keys(state.hooks);
|
|
123
114
|
const isValidHook = validHooks.includes(hook);
|
|
124
115
|
if (!isValidHook) {
|
|
@@ -128,18 +119,23 @@ const newEngine = (params) => {
|
|
|
128
119
|
return this;
|
|
129
120
|
},
|
|
130
121
|
/**
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
async generateAbility(permissions, options = {}) {
|
|
122
|
+
* Generate an ability based on the instance's
|
|
123
|
+
* ability builder and the given permissions
|
|
124
|
+
*/ async generateAbility (permissions, options = {}) {
|
|
135
125
|
const { can, build } = abilityBuilderFactory();
|
|
136
|
-
for (const permission of permissions)
|
|
126
|
+
for (const permission of permissions){
|
|
137
127
|
const register = this.createRegisterFunction(can, options);
|
|
138
|
-
await evaluate({
|
|
128
|
+
await evaluate({
|
|
129
|
+
permission,
|
|
130
|
+
options,
|
|
131
|
+
register
|
|
132
|
+
});
|
|
139
133
|
}
|
|
140
134
|
return build();
|
|
141
|
-
}
|
|
135
|
+
}
|
|
142
136
|
};
|
|
143
137
|
};
|
|
138
|
+
|
|
139
|
+
exports.abilities = index;
|
|
144
140
|
exports.new = newEngine;
|
|
145
|
-
//# sourceMappingURL=index.js.map
|
|
141
|
+
//# sourceMappingURL=index.js.map
|
package/dist/engine/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAA0B;AAC1B,4CAAoB;AAIpB,mCAKiB;AAGjB,uDAAyC;AAGhC,8BAAS;AAmClB;;GAEG;AACH,MAAM,iBAAiB,GAAG,GAAG,EAAE;IAC7B,MAAM,KAAK,GAAG,IAAA,yBAAiB,GAAE,CAAC;IAElC,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,MAAoB,EAAU,EAAE;IACjD,MAAM,EAAE,SAAS,EAAE,qBAAqB,GAAG,SAAS,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAAC;IAEnF,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;IAElC,MAAM,iBAAiB,GAAG,KAAK,EAAE,IAAc,EAAE,OAAgB,EAAE,EAAE,CACnE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE;QAChD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAErC,MAAM,mBAAmB,GAAG,MAAM,iBAAiB,CACjD,oCAAoC,EACpC,IAAA,mCAA2B,EAAC,MAAM,CAAC,UAAU,CAAC,CAC/C,CAAC;QAEF,IAAI,mBAAmB,KAAK,KAAK,EAAE;YACjC,OAAO;SACR;QAED,MAAM,UAAU,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAC7D,MAAM,CAAC,UAAU,CAClB,CAAe,CAAC;QAEjB,MAAM,qBAAqB,GAAG,MAAM,iBAAiB,CACnD,mCAAmC,EACnC,IAAA,6BAAqB,EAAC,UAAU,CAAC,CAClC,CAAC;QAEF,IAAI,qBAAqB,KAAK,KAAK,EAAE;YACnC,OAAO;SACR;QAED,MAAM,KAAK,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,IAAA,mCAA2B,EAAC,UAAU,CAAC,CAAC,CAAC;QAE9F,MAAM,EACJ,MAAM,EAAE,UAAU,EAClB,OAAO,EACP,UAAU,EACV,UAAU,GAAG,EAAE,EACf,gBAAgB,GAAG,EAAE,GACtB,GAAG,UAAU,CAAC;QAEf,IAAI,MAAM,GAAG,UAAU,CAAC;QAExB,IAAI,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAChE,MAAM,GAAG,GAAG,UAAU,IAAI,YAAE,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;SAC5D;QAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;SAClD;QAED,MAAM,iBAAiB,GAAG,YAAC,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEzD,MAAM,uBAAuB,GAAG,YAAC,CAAC,MAAM,CAAC,CAAC,SAAoB,EAAE,EAAE,CAChE,YAAC,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAChC,CAAC;QAEF,MAAM,kBAAkB,GAAG,CAAC,UAAuB,EAAE,EAAE;YACrD,OAAO,OAAO,CAAC,GAAG,CAChB,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;gBACnC,SAAS;gBACT,MAAM,EAAE,MAAM,SAAS,CAAC,OAAO,CAC7B,YAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,YAAC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAC1D;aACF,CAAC,CAAC,CACJ,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,oBAAoB,GAAG,YAAC,CAAC,MAAM,CACnC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,YAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,YAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC1D,CAAC;QAEF,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;aAC1D,IAAI,CAAC,iBAAiB,CAAC;aACvB,IAAI,CAAC,uBAAuB,CAAC;aAC7B,IAAI,CAAC,kBAAkB,CAAC;aACxB,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE9B,MAAM,YAAY,GAAG,YAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,YAAC,CAAC,GAAG,CAAC,YAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5C,IAAI,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE;YAClD,OAAO;SACR;QAED,IAAI,YAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE;YAClF,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;SAClD;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,YAAC,CAAC,QAAQ,CAAC,CAAC;QAEpE,IAAI,YAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtB,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;SAClD;QAED,OAAO,QAAQ,CAAC;YACd,MAAM;YACN,OAAO;YACP,UAAU;YACV,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE;SACxC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,KAAK;YACP,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QAED;;;WAGG;QACH,sBAAsB,CAAC,GAAG,EAAE,OAAgC;YAC1D,OAAO,KAAK,EAAE,UAAoC,EAAE,EAAE;gBACpD,MAAM,WAAW,GAAG,IAAA,iCAAyB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;gBAEvE,MAAM,KAAK,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAElE,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,CAAC;QACJ,CAAC;QAED;;WAEG;QACH,EAAE,CAAC,IAAI,EAAE,OAAO;YACd,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAE9C,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,KAAK,CACb,2FAA2F,IAAI,yBAAyB,UAAU,CAAC,IAAI,CACrI,IAAI,CACL,EAAE,CACJ,CAAC;aACH;YAED,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;WAGG;QACH,KAAK,CAAC,eAAe,CAAC,WAAW,EAAE,UAAmC,EAAE;YACtE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,qBAAqB,EAAE,CAAC;YAE/C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;gBACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBAE3D,MAAM,QAAQ,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;aACnD;YAED,OAAO,KAAK,EAAE,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEoB,wBAAG"}
|
|
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 = _.map(providers.condition.get);\n\n const removeInvalidConditions = _.filter((condition: Condition) =>\n _.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","_","map","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,iBAAoB,GAAA,IAAA;AACxB,IAAA,MAAMC,OAAQC,GAAAA,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,KAAQR,GAAAA,iBAAAA,EAAAA;IAEd,MAAMS,iBAAAA,GAAoB,OAAOC,IAAAA,EAAgBC,OAC/CH,GAAAA,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,oCACAQ,EAAAA,iCAAAA,CAA4Bb,OAAOc,UAAU,CAAA,CAAA;AAG/C,QAAA,IAAIF,wBAAwB,KAAO,EAAA;AACjC,YAAA;AACF;QAEA,MAAME,UAAAA,GAAc,MAAMV,KAAAA,CAAMP,KAAK,CAAC,oBAAoB,CAACW,IAAI,CAC7DR,MAAAA,CAAOc,UAAU,CAAA;AAGnB,QAAA,MAAMC,qBAAwB,GAAA,MAAMV,iBAClC,CAAA,mCAAA,EACAW,2BAAsBF,CAAAA,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAO,EAAA;AACnC,YAAA;AACF;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,iCAA4BC,CAAAA,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,MAASC,GAAAA,UAAAA;AAEb,QAAA,IAAII,oBAAoBC,MAAOC,CAAAA,IAAI,CAACF,gBAAkBG,CAAAA,CAAAA,MAAM,GAAG,CAAG,EAAA;YAChER,MAAS,GAAA,CAAC,EAAEC,UAAW,CAAA,CAAC,EAAEQ,EAAGC,CAAAA,SAAS,CAACL,gBAAAA,CAAAA,CAAkB,CAAC;AAC5D;QAEA,IAAID,UAAAA,CAAWI,MAAM,KAAK,CAAG,EAAA;AAC3B,YAAA,OAAOd,QAAS,CAAA;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD;AAEA,QAAA,MAAMQ,oBAAoBC,CAAEC,CAAAA,GAAG,CAAC7B,SAAU8B,CAAAA,SAAS,CAACC,GAAG,CAAA;QAEvD,MAAMC,uBAAAA,GAA0BJ,CAAEK,CAAAA,MAAM,CAAC,CAACH,YACxCF,CAAEM,CAAAA,UAAU,CAACJ,SAAAA,CAAUK,OAAO,CAAA,CAAA;AAGhC,QAAA,MAAMC,qBAAqB,CAAChB,UAAAA,GAAAA;YAC1B,OAAOiB,OAAAA,CAAQC,GAAG,CAChBlB,UAAAA,CAAWS,GAAG,CAAC,OAAOC,aAAe;AACnCA,oBAAAA,SAAAA;AACAS,oBAAAA,MAAAA,EAAQ,MAAMT,SAAUK,CAAAA,OAAO,CAC7BP,CAAEY,CAAAA,KAAK,CAAC/B,OAAS,EAAA;wBAAEI,UAAYe,EAAAA,CAAAA,CAAEa,SAAS,CAAC5B,UAAAA;AAAY,qBAAA,CAAA;iBAE3D,CAAA,CAAA,CAAA;AAEJ,SAAA;AAEA,QAAA,MAAM6B,oBAAuBd,GAAAA,CAAAA,CAAEK,MAAM,CACnC,CAAC,EAAEM,MAAM,EAAE,GAAKX,EAAEe,SAAS,CAACJ,MAAWX,CAAAA,IAAAA,CAAAA,CAAEgB,QAAQ,CAACL,MAAAA,CAAAA,CAAAA;AAGpD,QAAA,MAAMM,sBAAsB,MAAMR,OAAAA,CAAQS,OAAO,CAAC1B,YAC/C2B,IAAI,CAACpB,iBACLoB,CAAAA,CAAAA,IAAI,CAACf,uBACLe,CAAAA,CAAAA,IAAI,CAACX,kBAAAA,CAAAA,CACLW,IAAI,CAACL,oBAAAA,CAAAA;QAER,MAAMM,YAAAA,GAAepB,CAAEqB,CAAAA,MAAM,CAAC,QAAA,CAAA;AAC9B,QAAA,MAAMC,cAActB,CAAEC,CAAAA,GAAG,CAACD,CAAAA,CAAEuB,IAAI,CAAC,QAAA,CAAA,CAAA;AAEjC,QAAA,IAAIN,mBAAoBO,CAAAA,KAAK,CAACJ,YAAAA,CAAa,KAAS,CAAA,CAAA,EAAA;AAClD,YAAA;AACF;QAEA,IAAIpB,CAAAA,CAAEyB,OAAO,CAACR,mBAAAA,CAAAA,IAAwBA,oBAAoBS,IAAI,CAACN,aAAa,IAAQ,CAAA,CAAA,EAAA;AAClF,YAAA,OAAOtC,QAAS,CAAA;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD;AAEA,QAAA,MAAMoC,UAAUL,WAAYL,CAAAA,mBAAAA,CAAAA,CAAqBZ,MAAM,CAACL,EAAEgB,QAAQ,CAAA;QAElE,IAAIhB,CAAAA,CAAEyB,OAAO,CAACE,OAAU,CAAA,EAAA;AACtB,YAAA,OAAO7C,QAAS,CAAA;AAAEM,gBAAAA,MAAAA;AAAQE,gBAAAA,OAAAA;AAASC,gBAAAA;AAAW,aAAA,CAAA;AAChD;AAEA,QAAA,OAAOT,QAAS,CAAA;AACdM,YAAAA,MAAAA;AACAE,YAAAA,OAAAA;AACAC,YAAAA,UAAAA;YACAW,SAAW,EAAA;gBAAE0B,IAAM,EAAA;AAAC,oBAAA;wBAAEC,GAAKF,EAAAA;AAAQ;AAAE;AAAC;AACxC,SAAA,CAAA;AACF,KAAA;IAEA,OAAO;AACL,QAAA,IAAI3D,KAAQ,CAAA,GAAA;AACV,YAAA,OAAOO,MAAMP,KAAK;AACpB,SAAA;AAEA;;;QAIA8D,sBAAAA,CAAAA,CAAuBC,GAAG,EAAElD,OAAgC,EAAA;AAC1D,YAAA,OAAO,OAAOI,UAAAA,GAAAA;AACZ,gBAAA,MAAM+C,cAAcC,+BAA0B,CAAA;AAAEpD,oBAAAA,OAAAA;AAASI,oBAAAA;AAAW,iBAAA,CAAA;AAEpE,gBAAA,MAAMV,MAAMP,KAAK,CAAC,4BAA6B,CAAA,CAACW,IAAI,CAACqD,WAAAA,CAAAA;AAErD,gBAAA,OAAOD,GAAI9C,CAAAA,UAAAA,CAAAA;AACb,aAAA;AACF,SAAA;AAEA;;QAGAiD,EAAAA,CAAAA,CAAGzD,IAAI,EAAE8B,OAAO,EAAA;AACd,YAAA,MAAM4B,UAAazC,GAAAA,MAAAA,CAAOC,IAAI,CAACpB,MAAMP,KAAK,CAAA;YAC1C,MAAMoE,WAAAA,GAAcD,UAAWE,CAAAA,QAAQ,CAAC5D,IAAAA,CAAAA;AAExC,YAAA,IAAI,CAAC2D,WAAa,EAAA;AAChB,gBAAA,MAAM,IAAIE,KAAAA,CACR,CAAC,wFAAwF,EAAE7D,IAAAA,CAAK,sBAAsB,EAAE0D,UAAWI,CAAAA,IAAI,CACrI,IAAA,CAAA,CACA,CAAC,CAAA;AAEP;AAEAhE,YAAAA,KAAAA,CAAMP,KAAK,CAACS,IAAK,CAAA,CAACK,QAAQ,CAACyB,OAAAA,CAAAA;AAE3B,YAAA,OAAO,IAAI;AACb,SAAA;AAEA;;;AAGC,QACD,MAAMiC,eAAgBC,CAAAA,CAAAA,WAAW,EAAE5D,OAAAA,GAAmC,EAAE,EAAA;AACtE,YAAA,MAAM,EAAEkD,GAAG,EAAEW,KAAK,EAAE,GAAGrE,qBAAAA,EAAAA;YAEvB,KAAK,MAAMY,cAAcwD,WAAa,CAAA;AACpC,gBAAA,MAAM3D,QAAW,GAAA,IAAI,CAACgD,sBAAsB,CAACC,GAAKlD,EAAAA,OAAAA,CAAAA;AAElD,gBAAA,MAAMD,QAAS,CAAA;AAAEK,oBAAAA,UAAAA;AAAYJ,oBAAAA,OAAAA;AAASC,oBAAAA;AAAS,iBAAA,CAAA;AACjD;YAEA,OAAO4D,KAAAA,EAAAA;AACT;AACF,KAAA;AACF;;;;;"}
|