@strapi/permissions 0.0.0-next.e9bb5ccdc459f4c6b6717a2d5d86359b7a47d47d → 0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31

package/dist/index.mjs

@@ -0,0 +1,275 @@
+import _, { cloneDeep, isArray, has, pick, isNil, isObject } from "lodash/fp";
+import qs from "qs";
+import { hooks } from "@strapi/utils";
+import * as sift from "sift";
+import { AbilityBuilder, Ability } from "@casl/ability";
+const PERMISSION_FIELDS = ["action", "subject", "properties", "conditions"];
+const sanitizePermissionFields = _.pick(PERMISSION_FIELDS);
+const getDefaultPermission = () => ({
+  conditions: [],
+  properties: {},
+  subject: null
+});
+const create = _.pipe(_.pick(PERMISSION_FIELDS), _.merge(getDefaultPermission()));
+const addCondition = _.curry((condition, permission) => {
+  const { conditions } = permission;
+  const newConditions = Array.isArray(conditions) ? _.uniq(conditions.concat(condition)) : [condition];
+  return _.set("conditions", newConditions, permission);
+});
+const getProperty = _.curry(
+  (property, permission) => _.get(`properties.${property}`, permission)
+);
+const index$3 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  addCondition,
+  create,
+  getProperty,
+  sanitizePermissionFields
+}, Symbol.toStringTag, { value: "Module" }));
+const index$2 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  permission: index$3
+}, Symbol.toStringTag, { value: "Module" }));
+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()
+});
+const createValidateContext = (permission) => ({
+  get permission() {
+    return cloneDeep(permission);
+  }
+});
+const createBeforeEvaluateContext = (permission) => ({
+  get permission() {
+    return cloneDeep(permission);
+  },
+  addCondition(condition) {
+    Object.assign(permission, addCondition(condition, permission));
+    return this;
+  }
+});
+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;
+    }
+  }
+});
+const allowedOperations = [
+  "$or",
+  "$and",
+  "$eq",
+  "$ne",
+  "$in",
+  "$nin",
+  "$lt",
+  "$lte",
+  "$gt",
+  "$gte",
+  "$exists",
+  "$elemMatch"
+];
+const operations = pick(allowedOperations, sift);
+const conditionsMatcher = (conditions) => {
+  return sift.createQueryTester(conditions, { operations });
+};
+const buildParametrizedAction = ({ name, params }) => {
+  return `${name}?${qs.stringify(params)}`;
+};
+const caslAbilityBuilder = () => {
+  const { can, build, ...rest } = new AbilityBuilder(Ability);
+  return {
+    can(permission) {
+      const { action, subject, properties = {}, condition } = permission;
+      const { fields } = properties;
+      const caslAction = typeof action === "string" ? action : buildParametrizedAction(action);
+      return can(
+        caslAction,
+        isNil(subject) ? "all" : subject,
+        fields,
+        isObject(condition) ? condition : void 0
+      );
+    },
+    buildParametrizedAction({ name, params }) {
+      return `${name}?${qs.stringify(params)}`;
+    },
+    build() {
+      const ability = build({ conditionsMatcher });
+      function decorateCan(originalCan) {
+        return function(...args) {
+          const [action, ...rest2] = args;
+          const caslAction = typeof action === "string" ? action : buildParametrizedAction(action);
+          return originalCan.apply(ability, [caslAction, ...rest2]);
+        };
+      }
+      ability.can = decorateCan(ability.can);
+      return ability;
+    },
+    ...rest
+  };
+};
+const index$1 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  caslAbilityBuilder
+}, Symbol.toStringTag, { value: "Module" }));
+const createEngineState = () => {
+  const hooks2 = createEngineHooks();
+  return { hooks: hooks2 };
+};
+const newEngine = (params) => {
+  const { providers, abilityBuilderFactory = caslAbilityBuilder } = params;
+  const state = createEngineState();
+  const runValidationHook = async (hook, context) => state.hooks[hook].call(context);
+  const evaluate = async (params2) => {
+    const { options, register } = params2;
+    const preFormatValidation = await runValidationHook(
+      "before-format::validate.permission",
+      createBeforeEvaluateContext(params2.permission)
+    );
+    if (preFormatValidation === false) {
+      return;
+    }
+    const permission = await state.hooks["format.permission"].call(
+      params2.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 = (conditions2) => {
+      return Promise.all(
+        conditions2.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();
+    }
+  };
+};
+const index = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  abilities: index$1,
+  new: newEngine
+}, Symbol.toStringTag, { value: "Module" }));
+export {
+  index$2 as domain,
+  index as engine
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/domain/permission/index.ts","../src/engine/hooks.ts","../src/engine/abilities/casl-ability.ts","../src/engine/index.ts"],"sourcesContent":["import _ from 'lodash/fp';\n\nconst PERMISSION_FIELDS = ['action', 'subject', 'properties', 'conditions'] as const;\n\nconst sanitizePermissionFields = _.pick(PERMISSION_FIELDS);\n\nexport interface Permission {\n  action: string;\n  actionParameters?: Record<string, unknown>;\n  subject?: string | object | null;\n  properties?: Record<string, any>;\n  conditions?: string[];\n}\n\n/**\n * Creates a permission with default values for optional properties\n */\nconst getDefaultPermission = (): Pick<Permission, 'conditions' | 'properties' | 'subject'> => ({\n  conditions: [],\n  properties: {},\n  subject: null,\n});\n\n/**\n * Create a new permission based on given attributes\n *\n * @param {object} attributes\n */\nconst create = _.pipe(_.pick(PERMISSION_FIELDS), _.merge(getDefaultPermission()));\n\n/**\n * Add a condition to a permission\n */\nconst addCondition = _.curry((condition: string, permission: Permission): Permission => {\n  const { conditions } = permission;\n\n  const newConditions = Array.isArray(conditions)\n    ? _.uniq(conditions.concat(condition))\n    : [condition];\n\n  return _.set('conditions', newConditions, permission);\n});\n\n/**\n * Gets a property or a part of a property from a permission.\n */\nconst getProperty = _.curry(\n  <T extends keyof Permission['properties']>(\n    property: T,\n    permission: Permission\n  ): Permission['properties'][T] => _.get(`properties.${property}`, permission)\n);\n\nexport { create, sanitizePermissionFields, addCondition, getProperty };\n","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","import * as sift from 'sift';\nimport qs from 'qs';\nimport { AbilityBuilder, Ability } from '@casl/ability';\nimport { pick, isNil, isObject } from 'lodash/fp';\nimport type { ParametrizedAction, PermissionRule } from '../../types';\n\nexport interface CustomAbilityBuilder {\n  can(permission: PermissionRule): ReturnType<AbilityBuilder<Ability>['can']>;\n  buildParametrizedAction: (parametrizedAction: ParametrizedAction) => string;\n  build(): Ability;\n}\n\nconst allowedOperations = [\n  '$or',\n  '$and',\n  '$eq',\n  '$ne',\n  '$in',\n  '$nin',\n  '$lt',\n  '$lte',\n  '$gt',\n  '$gte',\n  '$exists',\n  '$elemMatch',\n] as const;\n\nconst operations = pick(allowedOperations, sift);\n\nconst conditionsMatcher = (conditions: unknown) => {\n  return sift.createQueryTester(conditions, { operations });\n};\n\nconst buildParametrizedAction = ({ name, params }: ParametrizedAction) => {\n  return `${name}?${qs.stringify(params)}`;\n};\n\n/**\n * Casl Ability Builder.\n */\nexport const caslAbilityBuilder = (): CustomAbilityBuilder => {\n  const { can, build, ...rest } = new AbilityBuilder(Ability);\n\n  return {\n    can(permission: PermissionRule) {\n      const { action, subject, properties = {}, condition } = permission;\n      const { fields } = properties;\n\n      const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n      return can(\n        caslAction,\n        isNil(subject) ? 'all' : subject,\n        fields,\n        isObject(condition) ? condition : undefined\n      );\n    },\n\n    buildParametrizedAction({ name, params }: ParametrizedAction) {\n      return `${name}?${qs.stringify(params)}`;\n    },\n\n    build() {\n      const ability = build({ conditionsMatcher });\n\n      function decorateCan(originalCan: Ability['can']) {\n        return function (...args: Parameters<Ability['can']>) {\n          const [action, ...rest] = args;\n          const caslAction = typeof action === 'string' ? action : buildParametrizedAction(action);\n\n          // Call the original `can` method\n          return originalCan.apply(ability, [caslAction, ...rest]);\n        };\n      }\n\n      ability.can = decorateCan(ability.can);\n      return ability;\n    },\n\n    ...rest,\n  };\n};\n","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":["domain.permission.addCondition","rest","hooks","abilities.caslAbilityBuilder","params","conditions"],"mappings":";;;;;AAEA,MAAM,oBAAoB,CAAC,UAAU,WAAW,cAAc,YAAY;AAE1E,MAAM,2BAA2B,EAAE,KAAK,iBAAiB;AAazD,MAAM,uBAAuB,OAAkE;AAAA,EAC7F,YAAY,CAAC;AAAA,EACb,YAAY,CAAC;AAAA,EACb,SAAS;AACX;AAOA,MAAM,SAAS,EAAE,KAAK,EAAE,KAAK,iBAAiB,GAAG,EAAE,MAAM,qBAAqB,CAAC,CAAC;AAKhF,MAAM,eAAe,EAAE,MAAM,CAAC,WAAmB,eAAuC;AAChF,QAAA,EAAE,WAAe,IAAA;AAEvB,QAAM,gBAAgB,MAAM,QAAQ,UAAU,IAC1C,EAAE,KAAK,WAAW,OAAO,SAAS,CAAC,IACnC,CAAC,SAAS;AAEd,SAAO,EAAE,IAAI,cAAc,eAAe,UAAU;AACtD,CAAC;AAKD,MAAM,cAAc,EAAE;AAAA,EACpB,CACE,UACA,eACgC,EAAE,IAAI,cAAc,QAAQ,IAAI,UAAU;AAC9E;;;;;;;;;;;;AC/BA,MAAM,oBAAoB,OAA8B;AAAA,EACtD,sCAAsC,MAAM,oBAAoB;AAAA,EAChE,qBAAqB,MAAM,+BAA+B;AAAA,EAC1D,qCAAqC,MAAM,oBAAoB;AAAA,EAC/D,8BAA8B,MAAM,sBAAsB;AAAA,EAC1D,8BAA8B,MAAM,sBAAsB;AAC5D;AAKA,MAAM,wBAAwB,CAAC,gBAA4B;AAAA,EACzD,IAAI,aAAmC;AACrC,WAAO,UAAU,UAAU;AAAA,EAC7B;AACF;AAKA,MAAM,8BAA8B,CAAC,gBAA4B;AAAA,EAC/D,IAAI,aAAmC;AACrC,WAAO,UAAU,UAAU;AAAA,EAC7B;AAAA,EAEA,aAAa,WAAmB;AAC9B,WAAO,OAAO,YAAYA,aAA+B,WAAW,UAAU,CAAC;AAExE,WAAA;AAAA,EACT;AACF;AAWA,MAAM,4BAA4B,CAAC,EAAE,YAAY,eAA0C;AAAA,EACzF,GAAG;AAAA,EAEH,IAAI,aAAa;AACf,WAAO,UAAU,UAAU;AAAA,EAC7B;AAAA,EAEA,WAAW;AAAA,IACT,IAAI,oBAA6B;AAC3B,UAAA,CAAC,WAAW,WAAW;AACzB,mBAAW,YAAY,EAAE,MAAM,CAAG,EAAA;AAAA,MACpC;AAEA,UAAI,QAAQ,WAAW,UAAU,IAAI,GAAG;AAC3B,mBAAA,UAAU,KAAK,KAAK,kBAAkB;AAAA,MACnD;AAEO,aAAA;AAAA,IACT;AAAA,IAEA,GAAG,oBAA6B;AAC1B,UAAA,CAAC,WAAW,WAAW;AACzB,mBAAW,YAAY,EAAE,MAAM,CAAG,EAAA;AAAA,MACpC;AAEA,UAAI,QAAQ,WAAW,UAAU,IAAI,GAAG;AACtC,cAAM,WAAW,WAAW,UAAU,KAAK,KAAK,IAAI,KAAK,CAAC;AAE1D,YAAI,UAAU;AACH,mBAAA,IAAI,KAAK,kBAAkB;AAAA,QAAA,OAC/B;AACM,qBAAA,UAAU,KAAK,KAAK,EAAE,KAAK,CAAC,kBAAkB,GAAG;AAAA,QAC9D;AAAA,MACF;AAEO,aAAA;AAAA,IACT;AAAA,EACF;AACF;ACvFA,MAAM,oBAAoB;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,MAAM,aAAa,KAAK,mBAAmB,IAAI;AAE/C,MAAM,oBAAoB,CAAC,eAAwB;AACjD,SAAO,KAAK,kBAAkB,YAAY,EAAE,WAAY,CAAA;AAC1D;AAEA,MAAM,0BAA0B,CAAC,EAAE,MAAM,aAAiC;AACxE,SAAO,GAAG,IAAI,IAAI,GAAG,UAAU,MAAM,CAAC;AACxC;AAKO,MAAM,qBAAqB,MAA4B;AACtD,QAAA,EAAE,KAAK,OAAO,GAAG,SAAS,IAAI,eAAe,OAAO;AAEnD,SAAA;AAAA,IACL,IAAI,YAA4B;AAC9B,YAAM,EAAE,QAAQ,SAAS,aAAa,CAAA,GAAI,UAAc,IAAA;AAClD,YAAA,EAAE,OAAW,IAAA;AAEnB,YAAM,aAAa,OAAO,WAAW,WAAW,SAAS,wBAAwB,MAAM;AAEhF,aAAA;AAAA,QACL;AAAA,QACA,MAAM,OAAO,IAAI,QAAQ;AAAA,QACzB;AAAA,QACA,SAAS,SAAS,IAAI,YAAY;AAAA,MAAA;AAAA,IAEtC;AAAA,IAEA,wBAAwB,EAAE,MAAM,UAA8B;AAC5D,aAAO,GAAG,IAAI,IAAI,GAAG,UAAU,MAAM,CAAC;AAAA,IACxC;AAAA,IAEA,QAAQ;AACN,YAAM,UAAU,MAAM,EAAE,kBAAmB,CAAA;AAE3C,eAAS,YAAY,aAA6B;AAChD,eAAO,YAAa,MAAkC;AACpD,gBAAM,CAAC,QAAQ,GAAGC,KAAI,IAAI;AAC1B,gBAAM,aAAa,OAAO,WAAW,WAAW,SAAS,wBAAwB,MAAM;AAGvF,iBAAO,YAAY,MAAM,SAAS,CAAC,YAAY,GAAGA,KAAI,CAAC;AAAA,QAAA;AAAA,MAE3D;AAEQ,cAAA,MAAM,YAAY,QAAQ,GAAG;AAC9B,aAAA;AAAA,IACT;AAAA,IAEA,GAAG;AAAA,EAAA;AAEP;;;;;AC1BA,MAAM,oBAAoB,MAAM;AAC9B,QAAMC,SAAQ;AAEd,SAAO,EAAE,OAAAA,OAAM;AACjB;AAEA,MAAM,YAAY,CAAC,WAAiC;AAClD,QAAM,EAAE,WAAW,wBAAwBC,uBAAiC;AAE5E,QAAM,QAAQ;AAER,QAAA,oBAAoB,OAAO,MAAgB,YAC/C,MAAM,MAAM,IAAI,EAAE,KAAK,OAAO;AAM1B,QAAA,WAAW,OAAOC,YAA2B;AAC3C,UAAA,EAAE,SAAS,SAAaA,IAAAA;AAE9B,UAAM,sBAAsB,MAAM;AAAA,MAChC;AAAA,MACA,4BAA4BA,QAAO,UAAU;AAAA,IAAA;AAG/C,QAAI,wBAAwB,OAAO;AACjC;AAAA,IACF;AAEA,UAAM,aAAc,MAAM,MAAM,MAAM,mBAAmB,EAAE;AAAA,MACzDA,QAAO;AAAA,IAAA;AAGT,UAAM,wBAAwB,MAAM;AAAA,MAClC;AAAA,MACA,sBAAsB,UAAU;AAAA,IAAA;AAGlC,QAAI,0BAA0B,OAAO;AACnC;AAAA,IACF;AAEA,UAAM,MAAM,MAAM,4BAA4B,EAAE,KAAK,4BAA4B,UAAU,CAAC;AAEtF,UAAA;AAAA,MACJ,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA,aAAa,CAAC;AAAA,MACd,mBAAmB,CAAC;AAAA,IAClB,IAAA;AAEJ,QAAI,SAAS;AAEb,QAAI,oBAAoB,OAAO,KAAK,gBAAgB,EAAE,SAAS,GAAG;AAChE,eAAS,GAAG,UAAU,IAAI,GAAG,UAAU,gBAAgB,CAAC;AAAA,IAC1D;AAEI,QAAA,WAAW,WAAW,GAAG;AAC3B,aAAO,SAAS,EAAE,QAAQ,SAAS,WAAY,CAAA;AAAA,IACjD;AAEA,UAAM,oBAAoB,EAAE,IAAI,UAAU,UAAU,GAAG;AAEvD,UAAM,0BAA0B,EAAE;AAAA,MAAO,CAAC,cACxC,EAAE,WAAW,UAAU,OAAO;AAAA,IAAA;AAG1B,UAAA,qBAAqB,CAACC,gBAA4B;AACtD,aAAO,QAAQ;AAAA,QACbA,YAAW,IAAI,OAAO,eAAe;AAAA,UACnC;AAAA,UACA,QAAQ,MAAM,UAAU;AAAA,YACtB,EAAE,MAAM,SAAS,EAAE,YAAY,EAAE,UAAU,UAAU,GAAG;AAAA,UAC1D;AAAA,QAAA,EACA;AAAA,MAAA;AAAA,IACJ;AAGF,UAAM,uBAAuB,EAAE;AAAA,MAC7B,CAAC,EAAE,OAAa,MAAA,EAAE,UAAU,MAAM,KAAK,EAAE,SAAS,MAAM;AAAA,IAAA;AAG1D,UAAM,sBAAsB,MAAM,QAAQ,QAAQ,UAAU,EACzD,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB;AAEtB,UAAA,eAAe,EAAE,OAAO,QAAQ;AACtC,UAAM,cAAc,EAAE,IAAI,EAAE,KAAK,QAAQ,CAAC;AAE1C,QAAI,oBAAoB,MAAM,aAAa,KAAK,CAAC,GAAG;AAClD;AAAA,IACF;AAEI,QAAA,EAAE,QAAQ,mBAAmB,KAAK,oBAAoB,KAAK,aAAa,IAAI,CAAC,GAAG;AAClF,aAAO,SAAS,EAAE,QAAQ,SAAS,WAAY,CAAA;AAAA,IACjD;AAEA,UAAM,UAAU,YAAY,mBAAmB,EAAE,OAAO,EAAE,QAAQ;AAE9D,QAAA,EAAE,QAAQ,OAAO,GAAG;AACtB,aAAO,SAAS,EAAE,QAAQ,SAAS,WAAY,CAAA;AAAA,IACjD;AAEA,WAAO,SAAS;AAAA,MACd;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW,EAAE,MAAM,CAAC,EAAE,KAAK,QAAS,CAAA,EAAE;AAAA,IAAA,CACvC;AAAA,EAAA;AAGI,SAAA;AAAA,IACL,IAAI,QAAQ;AACV,aAAO,MAAM;AAAA,IACf;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,uBAAuB,KAAK,SAAkC;AAC5D,aAAO,OAAO,eAA+B;AAC3C,cAAM,cAAc,0BAA0B,EAAE,SAAS,WAAY,CAAA;AAErE,cAAM,MAAM,MAAM,4BAA4B,EAAE,KAAK,WAAW;AAEhE,eAAO,IAAI,UAAU;AAAA,MAAA;AAAA,IAEzB;AAAA;AAAA;AAAA;AAAA,IAKA,GAAG,MAAM,SAAS;AAChB,YAAM,aAAa,OAAO,KAAK,MAAM,KAAK;AACpC,YAAA,cAAc,WAAW,SAAS,IAAI;AAE5C,UAAI,CAAC,aAAa;AAChB,cAAM,IAAI;AAAA,UACR,2FAA2F,IAAI,yBAAyB,WAAW;AAAA,YACjI;AAAA,UAAA,CACD;AAAA,QAAA;AAAA,MAEL;AAEA,YAAM,MAAM,IAAI,EAAE,SAAS,OAAO;AAE3B,aAAA;AAAA,IACT;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,MAAM,gBAAgB,aAAa,UAAmC,IAAI;AACxE,YAAM,EAAE,KAAK,MAAM,IAAI,sBAAsB;AAE7C,iBAAW,cAAc,aAAa;AACpC,cAAM,WAAW,KAAK,uBAAuB,KAAK,OAAO;AAEzD,cAAM,SAAS,EAAE,YAAY,SAAS,SAAU,CAAA;AAAA,MAClD;AAEA,aAAO,MAAM;AAAA,IACf;AAAA,EAAA;AAEJ;;;;;;"}

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.e9bb5ccdc459f4c6b6717a2d5d86359b7a47d47d",
+  "version": "0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31",
   "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": "pack-up build",
+    "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": "pack-up watch"
   },
   "dependencies": {
-    "@casl/ability": "5.4.4",
-    "@strapi/utils": "0.0.0-next.e9bb5ccdc459f4c6b6717a2d5d86359b7a47d47d",
+    "@casl/ability": "6.5.0",
+    "@strapi/utils": "0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31",
     "lodash": "4.17.21",
+    "qs": "6.11.1",
     "sift": "16.0.1"
   },
+  "devDependencies": {
+    "@strapi/pack-up": "5.0.0",
+    "eslint-config-custom": "0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31",
+    "tsconfig": "0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31"
+  },
   "engines": {
-    "node": ">=14.19.1 <=18.x.x",
+    "node": ">=18.0.0 <=22.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "e9bb5ccdc459f4c6b6717a2d5d86359b7a47d47d"
+  "gitHead": "ea6e3b80ab37f554da4f8bde08dbfe9b57400d31"
 }

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,
-};

package/lib/domain/permission/index.js

@@ -1,68 +0,0 @@
-'use strict';
-
-const _ = require('lodash/fp');
-
-const PERMISSION_FIELDS = ['action', 'subject', 'properties', 'conditions'];
-
-const sanitizePermissionFields = _.pick(PERMISSION_FIELDS);
-
-/**
- * @typedef {import("../../..").Permission} Permission
- */
-
-/**
- * Creates a permission with default values for optional properties
- *
- * @return {Pick<Permission, 'conditions' | 'properties' | 'subject'>}
- */
-const getDefaultPermission = () => ({
-  conditions: [],
-  properties: {},
-  subject: null,
-});
-
-/**
- * Create a new permission based on given attributes
- *
- * @param {object} attributes
- *
- * @return {Permission}
- */
-const create = _.pipe(_.pick(PERMISSION_FIELDS), _.merge(getDefaultPermission()));
-
-/**
- * Add a condition to a permission
- *
- * @param {string} condition The condition to add
- * @param {Permission} permission The permission on which we want to add the condition
- *
- * @return {Permission}
- */
-const addCondition = _.curry((condition, permission) => {
-  const { conditions } = permission;
-
-  const newConditions = Array.isArray(conditions)
-    ? _.uniq(conditions.concat(condition))
-    : [condition];
-
-  return _.set('conditions', newConditions, permission);
-});
-
-/**
- * Gets a property or a part of a property from a permission.
- *
- * @function
- *
- * @param {string} property - The property to get
- * @param {Permission} permission - The permission on which we want to access the property
- *
- * @return {Permission}
- */
-const getProperty = _.curry((property, permission) => _.get(`properties.${property}`, permission));
-
-module.exports = {
-  create,
-  sanitizePermissionFields,
-  addCondition,
-  getProperty,
-};

package/lib/engine/abilities/casl-ability.js

@@ -1,57 +0,0 @@
-'use strict';
-
-const sift = require('sift');
-const { AbilityBuilder, Ability } = require('@casl/ability');
-const { pick, isNil, isObject } = require('lodash/fp');
-
-const allowedOperations = [
-  '$or',
-  '$and',
-  '$eq',
-  '$ne',
-  '$in',
-  '$nin',
-  '$lt',
-  '$lte',
-  '$gt',
-  '$gte',
-  '$exists',
-  '$elemMatch',
-];
-
-const operations = pick(allowedOperations, sift);
-
-const conditionsMatcher = (conditions) => {
-  return sift.createQueryTester(conditions, { operations });
-};
-
-/**
- * Casl Ability Builder.
- */
-const caslAbilityBuilder = () => {
-  const { can, build, ...rest } = new AbilityBuilder(Ability);
-
-  return {
-    can(permission) {
-      const { action, subject, properties = {}, condition } = permission;
-      const { fields } = properties;
-
-      return can(
-        action,
-        isNil(subject) ? 'all' : subject,
-        fields,
-        isObject(condition) ? condition : undefined
-      );
-    },
-
-    build() {
-      return build({ conditionsMatcher });
-    },
-
-    ...rest,
-  };
-};
-
-module.exports = {
-  caslAbilityBuilder,
-};

package/lib/engine/abilities/index.js

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