@strapi/permissions 0.0.0-next.e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98 → 0.0.0-next.e3eb76a86aff89979cc9098aec129d2ffa600c56

package/dist/engine/hooks.mjs

@@ -0,0 +1,76 @@
+import { cloneDeep, isArray, has } from 'lodash/fp';
+import { hooks } from '@strapi/utils';
+import { addCondition } from '../domain/permission/index.mjs';
+
+/**
+ * Create a hook map used by the permission Engine
+ */ const createEngineHooks = ()=>({
+        'before-format::validate.permission': hooks.createAsyncBailHook(),
+        'format.permission': hooks.createAsyncSeriesWaterfallHook(),
+        'after-format::validate.permission': hooks.createAsyncBailHook(),
+        'before-evaluate.permission': hooks.createAsyncSeriesHook(),
+        'before-register.permission': hooks.createAsyncSeriesHook()
+    });
+/**
+ * Create a context from a domain {@link Permission} used by the validate hooks
+ */ const createValidateContext = (permission)=>({
+        get permission () {
+            return cloneDeep(permission);
+        }
+    });
+/**
+ * Create a context from a domain {@link Permission} used by the before valuate hook
+ */ const createBeforeEvaluateContext = (permission)=>({
+        get permission () {
+            return cloneDeep(permission);
+        },
+        addCondition (condition) {
+            Object.assign(permission, addCondition(condition, permission));
+            return this;
+        }
+    });
+/**
+ * Create a context from a casl Permission & some options
+ * @param caslPermission
+ */ const createWillRegisterContext = ({ permission, options })=>({
+        ...options,
+        get permission () {
+            return cloneDeep(permission);
+        },
+        condition: {
+            and (rawConditionObject) {
+                if (!permission.condition) {
+                    permission.condition = {
+                        $and: []
+                    };
+                }
+                if (isArray(permission.condition.$and)) {
+                    permission.condition.$and.push(rawConditionObject);
+                }
+                return this;
+            },
+            or (rawConditionObject) {
+                if (!permission.condition) {
+                    permission.condition = {
+                        $and: []
+                    };
+                }
+                if (isArray(permission.condition.$and)) {
+                    const orClause = permission.condition.$and.find(has('$or'));
+                    if (orClause) {
+                        orClause.$or.push(rawConditionObject);
+                    } else {
+                        permission.condition.$and.push({
+                            $or: [
+                                rawConditionObject
+                            ]
+                        });
+                    }
+                }
+                return this;
+            }
+        }
+    });
+
+export { createBeforeEvaluateContext, createEngineHooks, createValidateContext, createWillRegisterContext };
+//# sourceMappingURL=hooks.mjs.map

package/dist/engine/hooks.mjs.map

@@ -0,0 +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

@@ -0,0 +1,28 @@
+import { Ability } from '@casl/ability';
+import { providerFactory } from '@strapi/utils';
+import type { PermissionEngineHooks, HookName } from './hooks';
+import * as abilities from './abilities';
+import { Permission } from '../domain/permission';
+import type { PermissionRule } from '../types';
+export { abilities };
+type Provider = Omit<ReturnType<typeof providerFactory>, 'register'> & {
+    register(...args: unknown[]): Promise<Provider> | Provider;
+};
+type ActionProvider = Provider;
+type ConditionProvider = Provider;
+export interface Engine {
+    hooks: PermissionEngineHooks;
+    on(hook: HookName, handler: (...args: any[]) => any): Engine;
+    generateAbility(permissions: Permission[], options?: object): Promise<Ability>;
+    createRegisterFunction(can: (permission: PermissionRule) => unknown, options: Record<string, unknown>): (permission: PermissionRule) => Promise<unknown>;
+}
+export interface EngineParams {
+    providers: {
+        action: ActionProvider;
+        condition: ConditionProvider;
+    };
+    abilityBuilderFactory?(): abilities.CustomAbilityBuilder;
+}
+declare const newEngine: (params: EngineParams) => Engine;
+export { newEngine as new };
+//# sourceMappingURL=index.d.ts.map

package/dist/engine/index.d.ts.map

@@ -0,0 +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

@@ -0,0 +1,141 @@
+'use strict';
+
+var _ = require('lodash/fp');
+var qs = require('qs');
+var hooks = require('./hooks.js');
+var index = require('./abilities/index.js');
+var caslAbility = require('./abilities/casl-ability.js');
+
+/**
+ * Create a default state object for the engine
+ */ const createEngineState = ()=>{
+    const hooks$1 = hooks.createEngineHooks();
+    return {
+        hooks: hooks$1
+    };
+};
+const newEngine = (params)=>{
+    const { providers, abilityBuilderFactory = caslAbility.caslAbilityBuilder } = params;
+    const state = createEngineState();
+    const runValidationHook = async (hook, context)=>state.hooks[hook].call(context);
+    /**
+   * Evaluate a permission using local and registered behaviors (using hooks).
+   * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission
+   */ const evaluate = async (params)=>{
+        const { options, register } = params;
+        const preFormatValidation = await runValidationHook('before-format::validate.permission', hooks.createBeforeEvaluateContext(params.permission));
+        if (preFormatValidation === false) {
+            return;
+        }
+        const permission = await state.hooks['format.permission'].call(params.permission);
+        const afterFormatValidation = await runValidationHook('after-format::validate.permission', hooks.createValidateContext(permission));
+        if (afterFormatValidation === false) {
+            return;
+        }
+        await state.hooks['before-evaluate.permission'].call(hooks.createBeforeEvaluateContext(permission));
+        const { action: actionName, subject, properties, conditions = [], actionParameters = {} } = permission;
+        let action = actionName;
+        if (actionParameters && Object.keys(actionParameters).length > 0) {
+            action = `${actionName}?${qs.stringify(actionParameters)}`;
+        }
+        if (conditions.length === 0) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        const resolveConditions = _.map(providers.condition.get);
+        const removeInvalidConditions = _.filter((condition)=>_.isFunction(condition.handler));
+        const evaluateConditions = (conditions)=>{
+            return Promise.all(conditions.map(async (condition)=>({
+                    condition,
+                    result: await condition.handler(_.merge(options, {
+                        permission: _.cloneDeep(permission)
+                    }))
+                })));
+        };
+        const removeInvalidResults = _.filter(({ result })=>_.isBoolean(result) || _.isObject(result));
+        const evaluatedConditions = await Promise.resolve(conditions).then(resolveConditions).then(removeInvalidConditions).then(evaluateConditions).then(removeInvalidResults);
+        const resultPropEq = _.propEq('result');
+        const pickResults = _.map(_.prop('result'));
+        if (evaluatedConditions.every(resultPropEq(false))) {
+            return;
+        }
+        if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(resultPropEq(true))) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        const results = pickResults(evaluatedConditions).filter(_.isObject);
+        if (_.isEmpty(results)) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        return register({
+            action,
+            subject,
+            properties,
+            condition: {
+                $and: [
+                    {
+                        $or: results
+                    }
+                ]
+            }
+        });
+    };
+    return {
+        get hooks () {
+            return state.hooks;
+        },
+        /**
+     * Create a register function that wraps a `can` function
+     * used to register a permission in the ability builder
+     */ createRegisterFunction (can, options) {
+            return async (permission)=>{
+                const hookContext = hooks.createWillRegisterContext({
+                    options,
+                    permission
+                });
+                await state.hooks['before-register.permission'].call(hookContext);
+                return can(permission);
+            };
+        },
+        /**
+     * Register a new handler for a given hook
+     */ on (hook, handler) {
+            const validHooks = Object.keys(state.hooks);
+            const isValidHook = validHooks.includes(hook);
+            if (!isValidHook) {
+                throw new Error(`Invalid hook supplied when trying to register an handler to the permission engine. Got "${hook}" but expected one of ${validHooks.join(', ')}`);
+            }
+            state.hooks[hook].register(handler);
+            return this;
+        },
+        /**
+     * Generate an ability based on the instance's
+     * ability builder and the given permissions
+     */ async generateAbility (permissions, options = {}) {
+            const { can, build } = abilityBuilderFactory();
+            for (const permission of permissions){
+                const register = this.createRegisterFunction(can, options);
+                await evaluate({
+                    permission,
+                    options,
+                    register
+                });
+            }
+            return build();
+        }
+    };
+};
+
+exports.abilities = index;
+exports.new = newEngine;
+//# sourceMappingURL=index.js.map

package/dist/engine/index.js.map

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

package/dist/engine/index.mjs

@@ -0,0 +1,139 @@
+import _ from 'lodash/fp';
+import qs from 'qs';
+import { createWillRegisterContext, createEngineHooks, createBeforeEvaluateContext, createValidateContext } from './hooks.mjs';
+import * as index from './abilities/index.mjs';
+export { index as abilities };
+import { caslAbilityBuilder } from './abilities/casl-ability.mjs';
+
+/**
+ * Create a default state object for the engine
+ */ const createEngineState = ()=>{
+    const hooks = createEngineHooks();
+    return {
+        hooks
+    };
+};
+const newEngine = (params)=>{
+    const { providers, abilityBuilderFactory = caslAbilityBuilder } = params;
+    const state = createEngineState();
+    const runValidationHook = async (hook, context)=>state.hooks[hook].call(context);
+    /**
+   * Evaluate a permission using local and registered behaviors (using hooks).
+   * Validate, format (add condition, etc...), evaluate (evaluate conditions) and register a permission
+   */ const evaluate = async (params)=>{
+        const { options, register } = params;
+        const preFormatValidation = await runValidationHook('before-format::validate.permission', createBeforeEvaluateContext(params.permission));
+        if (preFormatValidation === false) {
+            return;
+        }
+        const permission = await state.hooks['format.permission'].call(params.permission);
+        const afterFormatValidation = await runValidationHook('after-format::validate.permission', createValidateContext(permission));
+        if (afterFormatValidation === false) {
+            return;
+        }
+        await state.hooks['before-evaluate.permission'].call(createBeforeEvaluateContext(permission));
+        const { action: actionName, subject, properties, conditions = [], actionParameters = {} } = permission;
+        let action = actionName;
+        if (actionParameters && Object.keys(actionParameters).length > 0) {
+            action = `${actionName}?${qs.stringify(actionParameters)}`;
+        }
+        if (conditions.length === 0) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        const resolveConditions = _.map(providers.condition.get);
+        const removeInvalidConditions = _.filter((condition)=>_.isFunction(condition.handler));
+        const evaluateConditions = (conditions)=>{
+            return Promise.all(conditions.map(async (condition)=>({
+                    condition,
+                    result: await condition.handler(_.merge(options, {
+                        permission: _.cloneDeep(permission)
+                    }))
+                })));
+        };
+        const removeInvalidResults = _.filter(({ result })=>_.isBoolean(result) || _.isObject(result));
+        const evaluatedConditions = await Promise.resolve(conditions).then(resolveConditions).then(removeInvalidConditions).then(evaluateConditions).then(removeInvalidResults);
+        const resultPropEq = _.propEq('result');
+        const pickResults = _.map(_.prop('result'));
+        if (evaluatedConditions.every(resultPropEq(false))) {
+            return;
+        }
+        if (_.isEmpty(evaluatedConditions) || evaluatedConditions.some(resultPropEq(true))) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        const results = pickResults(evaluatedConditions).filter(_.isObject);
+        if (_.isEmpty(results)) {
+            return register({
+                action,
+                subject,
+                properties
+            });
+        }
+        return register({
+            action,
+            subject,
+            properties,
+            condition: {
+                $and: [
+                    {
+                        $or: results
+                    }
+                ]
+            }
+        });
+    };
+    return {
+        get hooks () {
+            return state.hooks;
+        },
+        /**
+     * Create a register function that wraps a `can` function
+     * used to register a permission in the ability builder
+     */ createRegisterFunction (can, options) {
+            return async (permission)=>{
+                const hookContext = createWillRegisterContext({
+                    options,
+                    permission
+                });
+                await state.hooks['before-register.permission'].call(hookContext);
+                return can(permission);
+            };
+        },
+        /**
+     * Register a new handler for a given hook
+     */ on (hook, handler) {
+            const validHooks = Object.keys(state.hooks);
+            const isValidHook = validHooks.includes(hook);
+            if (!isValidHook) {
+                throw new Error(`Invalid hook supplied when trying to register an handler to the permission engine. Got "${hook}" but expected one of ${validHooks.join(', ')}`);
+            }
+            state.hooks[hook].register(handler);
+            return this;
+        },
+        /**
+     * Generate an ability based on the instance's
+     * ability builder and the given permissions
+     */ async generateAbility (permissions, options = {}) {
+            const { can, build } = abilityBuilderFactory();
+            for (const permission of permissions){
+                const register = this.createRegisterFunction(can, options);
+                await evaluate({
+                    permission,
+                    options,
+                    register
+                });
+            }
+            return build();
+        }
+    };
+};
+
+export { newEngine as new };
+//# sourceMappingURL=index.mjs.map

package/dist/engine/index.mjs.map

@@ -0,0 +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 = _.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,KAAQC,GAAAA,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,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,2BAAAA,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,qBAAsBF,CAAAA,UAAAA,CAAAA,CAAAA;AAGxB,QAAA,IAAIC,0BAA0B,KAAO,EAAA;AACnC,YAAA;AACF;AAEA,QAAA,MAAMX,MAAMP,KAAK,CAAC,6BAA6B,CAACW,IAAI,CAACK,2BAA4BC,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,yBAA0B,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;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import * as domain from './domain';
+import * as engine from './engine';
+export { domain, engine };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var index = require('./domain/index.js');
+var index$1 = require('./engine/index.js');
+
+
+
+exports.domain = index;
+exports.engine = index$1;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.mjs

@@ -0,0 +1,5 @@
+import * as index from './domain/index.mjs';
+export { index as domain };
+import * as index$1 from './engine/index.mjs';
+export { index$1 as engine };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+/**
+ * These were imported from `@strapi/types` but if we do that
+ * it becomes a circular dependency. This is the source of truth,
+ * they're re-exported from `@strapi/types` for convenience.
+ */
+import type { Subject } from '@casl/ability';
+export interface ParametrizedAction {
+    name: string;
+    params: Record<string, unknown>;
+}
+export interface PermissionRule {
+    action: string | ParametrizedAction;
+    subject?: Subject | null;
+    properties?: {
+        fields?: string[];
+    };
+    condition?: Record<string, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AACD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACpC,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/permissions",
-  "version": "0.0.0-next.e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98",
+  "version": "0.0.0-next.e3eb76a86aff89979cc9098aec129d2ffa600c56",
   "description": "Strapi's permission layer.",
   "repository": {
     "type": "git",
@@ -19,21 +19,37 @@
       "url": "https://strapi.io"
     }
   ],
-  "main": "./lib/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
   "scripts": {
+    "build": "run -T npm-run-all clean --parallel build:code build:types",
+    "build:code": "run -T  rollup -c",
+    "build:types": "run -T tsc -p tsconfig.build.json --emitDeclarationOnly",
+    "clean": "run -T rimraf ./dist",
+    "lint": "run -T eslint .",
+    "test:ts": "run -T tsc --noEmit",
     "test:unit": "run -T jest",
     "test:unit:watch": "run -T jest --watch",
-    "lint": "run -T eslint ."
+    "watch": "run -T rollup -c -w"
   },
   "dependencies": {
-    "@casl/ability": "5.4.4",
-    "@strapi/utils": "0.0.0-next.e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98",
+    "@casl/ability": "6.5.0",
+    "@strapi/utils": "0.0.0-next.e3eb76a86aff89979cc9098aec129d2ffa600c56",
     "lodash": "4.17.21",
+    "qs": "6.11.1",
     "sift": "16.0.1"
   },
+  "devDependencies": {
+    "eslint-config-custom": "0.0.0-next.e3eb76a86aff89979cc9098aec129d2ffa600c56",
+    "tsconfig": "0.0.0-next.e3eb76a86aff89979cc9098aec129d2ffa600c56"
+  },
   "engines": {
-    "node": ">=14.19.1 <=18.x.x",
+    "node": ">=18.0.0 <=22.x.x",
     "npm": ">=6.0.0"
-  },
-  "gitHead": "e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98"
+  }
 }

package/.eslintignore

@@ -1,2 +0,0 @@
-node_modules/
-.eslintrc.js

package/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['custom/back'],
-};

package/index.d.ts

@@ -1,54 +0,0 @@
-import { hooks, providerFactory } from '@strapi/utils';
-
-interface Permission {
-  action: string;
-  subject?: string | object | null;
-  properties?: object;
-  conditions?: string[];
-}
-
-type Provider = ReturnType<typeof providerFactory>;
-
-interface BaseAction {
-  actionId: string;
-}
-
-interface BaseCondition {
-  name: string;
-  handler(...params: unknown[]): boolean | object;
-}
-
-interface ActionProvider<T extends Action = Action> extends Provider {}
-interface ConditionProvider<T extends Condition = Condition> extends Provider {}
-
-interface PermissionEngineHooks {
-  'before-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;
-  'format.permission': ReturnType<typeof hooks.createAsyncSeriesWaterfallHook>;
-  'after-format::validate.permission': ReturnType<typeof hooks.createAsyncBailHook>;
-  'before-evaluate.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;
-  'before-register.permission': ReturnType<typeof hooks.createAsyncSeriesHook>;
-}
-
-type PermissionEngineHookName = keyof PermissionEngineHooks;
-
-interface PermissionEngine {
-  hooks: object;
-
-  on(hook: PermissionEngineHookName, handler: Function): PermissionEngine;
-  generateAbility(permissions: Permission[], options?: object): Ability;
-  createRegisterFunction(can: Function, options: object): Function;
-}
-
-interface BaseAbility {
-  can: Function;
-}
-
-interface AbilityBuilder {
-  can(permission: Permission): void | Promise<void>;
-  build(): BaseAbility | Promise<BaseAbility>;
-}
-
-interface PermissionEngineParams {
-  providers: { action: ActionProvider; condition: ConditionProvider };
-  abilityBuilderFactory(): AbilityBuilder;
-}

package/lib/domain/index.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const permission = require('./permission');
-
-module.exports = {
-  permission,
-};