law-common 14.1.2-beta.1 → 14.1.2-beta.2

package/dist/src/entities/flow-configs/utils/flow-config.utils.d.ts

@@ -1,15 +1,8 @@
 import { PermissionGroupEnum } from "../../enums/permission_group_enum";
 /**
- * Registry of per-entity action maps used by {@link FlowConfigUtils}.
- *
- * Every entry maps an {@link EntityEnum} member to the `ACTION_MAP` declared by that entity's
- * flow config file. To register another entity: add `export` to its `ACTION_MAP` (only
- * expense_type and work_from_home export it today) and add one line here. The typing below
- * follows automatically:
- * the entity parameter and the action parameter of `getPermissionGroupByAction` both derive
- * from this object, so a new entity's actions are accepted only with that entity, and rejected
- * for every other entity — including actions from a different enum that share the same string
- * value (string enums are nominal across types).
+ * Registry of per-entity action maps; each value is the whole ACTION_MAP that entity's flow config exports
+ * (register one by exporting its ACTION_MAP and adding a line here). Entity and action params derive from it.
+ * Example: enumToActionMap[EntityEnum.WORK_FROM_HOME] → { CREATE, UPDATE, DELETE, APPROVE, REJECT, RECALL: ActionMapEntry }
  */
 export declare const enumToActionMap: {
     expense_type: {
@@ -79,32 +72,18 @@ export declare const enumToActionMap: {
 };
 export type EnumToActionMap = typeof enumToActionMap;
 /**
- * The action enum registered for entity `E`, derived from {@link enumToActionMap}.
- *
- * Written as a mapped-union lookup rather than `EnumToActionMap[E]`'s `keyof`: both forms are
- * strict at the call site, but only this form also lets the method body index the erased map
- * below without a cast (TS cannot resolve `EnumToActionMap[E][keyof EnumToActionMap[E]]` —
- * property access on that deferred generic indexed access is a compile error). Intersected
- * with `string` because a bare `keyof` constraint includes `symbol`, which forbids template
- * interpolation of the parameter (TS2731); map keys are always string enum members, so the
- * intersection loses nothing.
+ * Action enum values registered for entity `E`, via a mapped-union lookup (bare keyof would include symbol,
+ * breaking template interpolation — TS2731).
+ *  Example: RegisteredActions<EntityEnum.WORK_FROM_HOME> → "CREATE" | "UPDATE" | "DELETE" | "APPROVE" | "REJECT" | "RECALL"
  */
 export type RegisteredActions<E extends keyof EnumToActionMap> = {
     [K in keyof EnumToActionMap]: keyof EnumToActionMap[K] & string;
 }[E];
 export declare class FlowConfigUtils {
     /**
-     * Resolves the permission group an entity's action is authorised under, from the entity's
-     * flat `ACTION_MAP`. Needs only the entity and the action — deliberately no status and no
-     * existing entity — so callers building search filters can use it before any entity data
-     * has been fetched.
-     *
-     * @param entity Registered entity; entities missing from `enumToActionMap` are compile errors.
-     * @param action That entity's action enum member. A member of another entity's action enum
-     *               is a compile error even when its string value coincides.
-     * @throws AppBadRequestException (400) when the registry, the action, or the action's
-     *         `group` annotation is missing. Never falls back to a default group: defaulting
-     *         would authorise the action under another action's permissions.
+     * Resolves the permission group an action is authorised under, from the entity's flat ACTION_MAP.
+     * Needs only entity + action (no status, no existing entity)
+     * Example: getPermissionGroupByAction(EntityEnum.WORK_FROM_HOME, WorkFromHomeActionEnum.APPROVE) → PermissionGroupEnum.APPROVAL_FLOW.
      */
     static getPermissionGroupByAction<E extends keyof EnumToActionMap>(entity: E, action: RegisteredActions<E>): PermissionGroupEnum;
 }

package/dist/src/entities/flow-configs/utils/flow-config.utils.js

@@ -7,16 +7,9 @@ const entity_utils_interface_1 = require("../../interface/entity.utils.interface
 const expense_type_flow_config_1 = require("../expense_type_flow.config");
 const work_from_home_flow_config_1 = require("../work_from_home_flow.config");
 /**
- * Registry of per-entity action maps used by {@link FlowConfigUtils}.
- *
- * Every entry maps an {@link EntityEnum} member to the `ACTION_MAP` declared by that entity's
- * flow config file. To register another entity: add `export` to its `ACTION_MAP` (only
- * expense_type and work_from_home export it today) and add one line here. The typing below
- * follows automatically:
- * the entity parameter and the action parameter of `getPermissionGroupByAction` both derive
- * from this object, so a new entity's actions are accepted only with that entity, and rejected
- * for every other entity — including actions from a different enum that share the same string
- * value (string enums are nominal across types).
+ * Registry of per-entity action maps; each value is the whole ACTION_MAP that entity's flow config exports
+ * (register one by exporting its ACTION_MAP and adding a line here). Entity and action params derive from it.
+ * Example: enumToActionMap[EntityEnum.WORK_FROM_HOME] → { CREATE, UPDATE, DELETE, APPROVE, REJECT, RECALL: ActionMapEntry }
  */
 exports.enumToActionMap = {
     [entity_utils_interface_1.EntityEnum.EXPENSE_TYPE]: expense_type_flow_config_1.ACTION_MAP,
@@ -24,17 +17,9 @@ exports.enumToActionMap = {
 };
 class FlowConfigUtils {
     /**
-     * Resolves the permission group an entity's action is authorised under, from the entity's
-     * flat `ACTION_MAP`. Needs only the entity and the action — deliberately no status and no
-     * existing entity — so callers building search filters can use it before any entity data
-     * has been fetched.
-     *
-     * @param entity Registered entity; entities missing from `enumToActionMap` are compile errors.
-     * @param action That entity's action enum member. A member of another entity's action enum
-     *               is a compile error even when its string value coincides.
-     * @throws AppBadRequestException (400) when the registry, the action, or the action's
-     *         `group` annotation is missing. Never falls back to a default group: defaulting
-     *         would authorise the action under another action's permissions.
+     * Resolves the permission group an action is authorised under, from the entity's flat ACTION_MAP.
+     * Needs only entity + action (no status, no existing entity)
+     * Example: getPermissionGroupByAction(EntityEnum.WORK_FROM_HOME, WorkFromHomeActionEnum.APPROVE) → PermissionGroupEnum.APPROVAL_FLOW.
      */
     static getPermissionGroupByAction(entity, action) {
         const actionMap = exports.enumToActionMap[entity];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "law-common",
-  "version": "14.1.2-beta.1",
+  "version": "14.1.2-beta.2",
   "description": "",
   "main": "dist/index.js",
   "files": [