bigcapital/packages/server/src/modules/Roles/utils.ts

import { keyBy } from 'lodash';
import { ISubjectAbilitiesSchema } from './Roles.types';
import { CommandRolePermissionDto } from './dtos/Role.dto';
import { AbilitySchema } from './AbilitySchema';
import { ServiceError } from '../Items/ServiceError';
import { ERRORS } from './constants';

/**
 * Transformes ability schema to map.
 */
export function transformAbilitySchemaToMap(schema: ISubjectAbilitiesSchema[]) {
  return keyBy(
    schema.map((item) => ({
      ...item,
      abilities: keyBy(item.abilities, 'key'),
      extraAbilities: keyBy(item.extraAbilities, 'key'),
    })),
    'subject',
  );
}

/**
 * Retrieve the invalid permissions from the given defined schema.
 * @param {ISubjectAbilitiesSchema[]} schema
 * @param permissions
 * @returns
 */
export function getInvalidPermissions(
  schema: ISubjectAbilitiesSchema[],
  permissions,
) {
  const schemaMap = transformAbilitySchemaToMap(schema);

  return permissions.filter((permission) => {
    const { subject, ability } = permission;

    if (
      !schemaMap[subject] ||
      (!schemaMap[subject].abilities[ability] &&
        !schemaMap[subject].extraAbilities[ability])
    ) {
      return true;
    }
    return false;
  });
}

/**
 * Validates the invalid given permissions.
 * @param {ICreateRolePermissionDTO[]} permissions -
 */
export const validateInvalidPermissions = (
  permissions: CommandRolePermissionDto[],
) => {
  const invalidPerms = getInvalidPermissions(AbilitySchema, permissions);

  if (invalidPerms.length > 0) {
    throw new ServiceError(ERRORS.INVALIDATE_PERMISSIONS, null, {
      invalidPermissions: invalidPerms,
    });
  }
};