packages/core/permissions/src/engine/hooks.ts - develop - githubmirror/strapi

packages/core/permissions/src/engine/hooks.ts
107 строк3 KB
Josh
fix(permissions): circular dependency (#18986)
06 дек 2023, 11:47
06 дек 2023, 11:47e85a23d
import { cloneDeep, has, isArray } from 'lodash/fp';
import { hooks } from '@strapi/utils';

import * as domain from '../domain';
import type { Permission } from '../domain/permission';
import type { PermissionRule } from '../types';

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

export type HookName = keyof PermissionEngineHooks;

/**
 * Create a hook map used by the permission Engine
 */
const createEngineHooks = (): PermissionEngineHooks => ({
  '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: Permission) => ({
  get permission(): Readonly<Permission> {
    return cloneDeep(permission);
  },
});

/**
 * Create a context from a domain {@link Permission} used by the before valuate hook
 */
const createBeforeEvaluateContext = (permission: Permission) => ({
  get permission(): Readonly<Permission> {
    return cloneDeep(permission);
  },

  addCondition(condition: string) {
    Object.assign(permission, domain.permission.addCondition(condition, permission));

    return this;
  },
});

interface WillRegisterContextParams {
  permission: PermissionRule;
  options: Record<string, unknown>;
}

/**
 * Create a context from a casl Permission & some options
 * @param caslPermission
 */
const createWillRegisterContext = ({ permission, options }: WillRegisterContextParams) => ({
  ...options,

  get permission() {
    return cloneDeep(permission);
  },

  condition: {
    and(rawConditionObject: unknown) {
      if (!permission.condition) {
        permission.condition = { $and: [] };
      }

      if (isArray(permission.condition.$and)) {
        permission.condition.$and.push(rawConditionObject);
      }

      return this;
    },

    or(rawConditionObject: unknown) {
      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 {
  createEngineHooks,
  createValidateContext,
  createBeforeEvaluateContext,
  createWillRegisterContext,
};