law-common 13.0.1-beta.8 → 13.0.2

package/dist/src/api/interface/bank.entity.response.d.ts

@@ -1,14 +1,11 @@
-import { BankActionEnum, BankStatusEnum, IBankEntity, IIntermediaryBankEntity } from "../../entities";
-export type IBankFlowConfig = {
-    [key in BankStatusEnum]?: {
-        actions: {
-            [key in BankActionEnum]?: {
-                permissions: string[];
-                next: () => BankStatusEnum;
-            };
-        };
-    };
-};
+import { BankActionEnum, BankStatusEnum, FlowConfig, IBankEntity, IIntermediaryBankEntity } from "../../entities";
+/**
+ * LW-828: this used to re-declare the flow-config shape by hand. It is now an alias of the shared
+ * `FlowConfig`, instantiated with `void` as the context type because `next` here is called with no
+ * arguments (`BankService.getBankNextStatus`). Kept as a named type so every consumer — including
+ * law-admin-web, which receives this config over `GET /bank/flow-config` — keeps compiling unchanged.
+ */
+export type IBankFlowConfig = FlowConfig<BankStatusEnum, BankActionEnum, void>;
 export interface IBankEntityGet extends IBankEntity {
     intermediaryBankDetails?: IIntermediaryBankEntity[];
 }

package/dist/src/api/interface/document_upload.create.dto.interface.d.ts

@@ -1,7 +1,8 @@
 import { IEntityCreateDto, Nullable } from "../../entities";
 import { IAppFileConfig, IFilePayload, MulterFileWithUrl } from "../../misc";
 import { IDocumentUploadEntity } from "../../entities/interface/document_upload.entity.interface";
-export type IDocumentUploadCreateExclude = "gstDocument" | "additionalDocuments";
+/** status is set by the entity flow, never by the client */
+export type IDocumentUploadCreateExclude = "gstDocument" | "additionalDocuments" | "status";
 export interface IDocumentUploadCreateDto extends Omit<IEntityCreateDto<IDocumentUploadEntity>, IDocumentUploadCreateExclude> {
     gstDocument?: Nullable<MulterFileWithUrl>;
     additionalDocuments?: Nullable<MulterFileWithUrl[]>;

package/dist/src/api/interface/reimbursement.entity.response.d.ts

@@ -1,4 +1,4 @@
-import { IReimbursementEntity, IReimbursementExpenseEntity, IUserEntity, ReimbursementActionEnum, ReimbursementExpenseActionEnum, ReimbursementExpenseState, ReimbursementStatusEnum } from "../../entities";
+import { IReimbursementEntity, IReimbursementExpenseEntity, IUserEntity, ParentChildFlowConfig, ReimbursementActionEnum, ReimbursementExpenseActionEnum, ReimbursementExpenseState, ReimbursementStatusEnum } from "../../entities";
 import { IProjectEntityGet } from "./project.entity.response";
 export type IReimbursementEntityGet = {
     reimbursements: IReimbursementResponse[];
@@ -7,28 +7,14 @@ export type IReimbursementEntityGet = {
     };
     projects: IProjectEntityGet;
 };
-export type IReimbursementFlowConfig = {
-    parent: {
-        [key in ReimbursementStatusEnum]?: {
-            actions: {
-                [key in ReimbursementActionEnum]?: {
-                    permissions: string[];
-                    next?: (data: IReimbursementFlowContextData) => ReimbursementStatusEnum;
-                };
-            };
-        };
-    };
-    child: {
-        [key in ReimbursementExpenseState]?: {
-            actions: {
-                [key in ReimbursementExpenseActionEnum]?: {
-                    permissions: string[];
-                    next?: () => ReimbursementExpenseState;
-                };
-            };
-        };
-    };
-};
+/**
+ * LW-828: this used to re-declare the parent/child flow-config shape by hand. It is now an alias of the
+ * shared `ParentChildFlowConfig`, instantiated with `IReimbursementFlowContextData` for the parent and
+ * `void` for the child — the child's `next` is called with no argument in
+ * `ReimbursementExpenseService.getReimbursementNextStatusForChild`. Kept as a named type so every
+ * existing consumer keeps compiling unchanged.
+ */
+export type IReimbursementFlowConfig = ParentChildFlowConfig<ReimbursementStatusEnum, ReimbursementActionEnum, ReimbursementExpenseState, ReimbursementExpenseActionEnum, IReimbursementFlowContextData, void>;
 export type IReimbursementFlowContextData = {
     expenseDetails: IReimbursementExpenseEntity[];
 };

package/dist/src/api/interface/timesheet.entity.response.interface.d.ts

@@ -1,4 +1,4 @@
-import { IProjectUserMappingEntity, ITimesheetEntity, IUserEntity, TimesheetActionEnum, TimesheetEntityModel, TimesheetStatusEnum } from "../../entities";
+import { FlowConfig, IProjectUserMappingEntity, ITimesheetEntity, IUserEntity, TimesheetActionEnum, TimesheetEntityModel, TimesheetStatusEnum } from "../../entities";
 import { IClientApiEntityDependent } from "./client.entity.response";
 import { IProjectApiEntityDependent } from "./project.entity.response";
 import { ITimesheetEntityUpdateDto } from "./timesheet.update.dto.interface";
@@ -15,18 +15,12 @@ export type ITimesheetEntityGet = {
     };
     tasks: string[];
 };
-export type ITimesheetFlowConfig = {
-    [key in TimesheetStatusEnum]?: {
-        actions: {
-            [key in TimesheetActionEnum]?: {
-                permissions: string[];
-                isApplicable?: (data: ITimesheetFlowContextData) => boolean;
-                next: (data: ITimesheetFlowContextData) => TimesheetStatusEnum;
-                validActionPastThreshold?: boolean;
-            };
-        };
-    };
-};
+/**
+ * LW-828: this used to re-declare the flow-config shape by hand. It is now an alias of the shared
+ * `FlowConfig`, whose action config carries the optional `isApplicable` and `validActionPastThreshold`
+ * this entity relies on. Kept as a named type so every existing consumer keeps compiling unchanged.
+ */
+export type ITimesheetFlowConfig = FlowConfig<TimesheetStatusEnum, TimesheetActionEnum, ITimesheetFlowContextData>;
 export type ITimesheetFlowContextData = {
     currentTimesheet?: TimesheetEntityModel;
     projectUserMapping?: IProjectUserMappingEntity;

package/dist/src/api/interface/to_do_list.create.dto.interface.d.ts

@@ -1,3 +1,5 @@
 import { IEntityCreateDto, IToDoListEntity } from "../../entities";
-export interface IToDoListCreateDto extends IEntityCreateDto<IToDoListEntity> {
+/** status is set by the entity flow, never by the client */
+export type IToDoListExclude = "status";
+export interface IToDoListCreateDto extends Omit<IEntityCreateDto<IToDoListEntity>, IToDoListExclude> {
 }

package/dist/src/api/interface/to_do_list.update.dto.interface.d.ts

@@ -1,5 +1,6 @@
 import { IEntityUpdateDto, IToDoListEntity } from "../../entities";
-export interface IToDoListUpdateDto extends IEntityUpdateDto<IToDoListEntity> {
+import { IToDoListExclude } from "./to_do_list.create.dto.interface";
+export interface IToDoListUpdateDto extends Omit<IEntityUpdateDto<IToDoListEntity>, IToDoListExclude> {
 }
 export interface IToDoListEntityUpdateDtoValidationData {
     toDoListEntity: IToDoListEntity;

package/dist/src/entities/enums/document_upload_status_enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum DocumentUploadStatusEnum {
+    APPROVED = "APPROVED",
+    DEACTIVATED = "DEACTIVATED",
+    DELETED = "DELETED"
+}

package/dist/src/entities/enums/document_upload_status_enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadStatusEnum = void 0;
+var DocumentUploadStatusEnum;
+(function (DocumentUploadStatusEnum) {
+    DocumentUploadStatusEnum["APPROVED"] = "APPROVED";
+    DocumentUploadStatusEnum["DEACTIVATED"] = "DEACTIVATED";
+    DocumentUploadStatusEnum["DELETED"] = "DELETED";
+})(DocumentUploadStatusEnum || (exports.DocumentUploadStatusEnum = DocumentUploadStatusEnum = {}));

package/dist/src/entities/enums/to_do_list_status_enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ToDoListStatusEnum {
+    APPROVED = "APPROVED",
+    DEACTIVATED = "DEACTIVATED",
+    DELETED = "DELETED"
+}

package/dist/src/entities/enums/to_do_list_status_enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToDoListStatusEnum = void 0;
+var ToDoListStatusEnum;
+(function (ToDoListStatusEnum) {
+    ToDoListStatusEnum["APPROVED"] = "APPROVED";
+    ToDoListStatusEnum["DEACTIVATED"] = "DEACTIVATED";
+    ToDoListStatusEnum["DELETED"] = "DELETED";
+})(ToDoListStatusEnum || (exports.ToDoListStatusEnum = ToDoListStatusEnum = {}));

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

@@ -0,0 +1,9 @@
+import { BankActionEnum } from "../enums/bank_action_enum";
+import { BankStatusEnum } from "../enums/bank_status_enum";
+import { FlowConfig } from "./flow-config.type";
+/**
+ * Typed with `FlowConfig` directly rather than importing `IBankFlowConfig` from `src/api`, so that
+ * `entities` does not reach into `api` for a type it can express itself. `IBankFlowConfig` is now an
+ * alias of this same instantiation, so the two cannot drift.
+ */
+export declare const bankFlowConfig: FlowConfig<BankStatusEnum, BankActionEnum, void>;

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bankFlowConfig = void 0;
+const bank_action_enum_1 = require("../enums/bank_action_enum");
+const bank_status_enum_1 = require("../enums/bank_status_enum");
+const base_flow_config_factory_1 = require("./base-flow-config.factory");
+const BANK_APPROVER_PERMISSION = ["BANK_APPROVER_ORG"];
+const BANK_UPDATE_PERMISSION = ["BANK_UPDATE_ORG"];
+const ACTION_MAP = {
+    // VIEW and CREATE are declared on BankActionEnum but carry no transition in this flow. They are
+    // listed so the map covers every enum member; the empty reachable set makes createActionConfig
+    // uncallable for them.
+    [bank_action_enum_1.BankActionEnum.VIEW]: {
+        reachableStatues: [],
+        permissions: [],
+    },
+    [bank_action_enum_1.BankActionEnum.CREATE]: {
+        reachableStatues: [],
+        permissions: [],
+    },
+    [bank_action_enum_1.BankActionEnum.UPDATE]: {
+        reachableStatues: [bank_status_enum_1.BankStatusEnum.CREATE_APPROVAL_PENDING, bank_status_enum_1.BankStatusEnum.UPDATE_APPROVAL_PENDING],
+        permissions: BANK_UPDATE_PERMISSION,
+    },
+    [bank_action_enum_1.BankActionEnum.DELETE]: {
+        reachableStatues: [bank_status_enum_1.BankStatusEnum.DELETE_APPROVAL_PENDING, bank_status_enum_1.BankStatusEnum.DELETED],
+        permissions: BANK_UPDATE_PERMISSION,
+    },
+    [bank_action_enum_1.BankActionEnum.APPROVE]: {
+        reachableStatues: [bank_status_enum_1.BankStatusEnum.APPROVED, bank_status_enum_1.BankStatusEnum.DELETED],
+        permissions: BANK_APPROVER_PERMISSION,
+    },
+    [bank_action_enum_1.BankActionEnum.REJECT]: {
+        reachableStatues: [bank_status_enum_1.BankStatusEnum.REJECTED, bank_status_enum_1.BankStatusEnum.RESOLVED_REJECTED],
+        permissions: BANK_APPROVER_PERMISSION,
+    },
+    [bank_action_enum_1.BankActionEnum.RECALL]: {
+        reachableStatues: [bank_status_enum_1.BankStatusEnum.DELETED],
+        permissions: BANK_UPDATE_PERMISSION,
+    },
+};
+/**
+ * The context type is `void` rather than `never` or an empty interface, because `IBankFlowConfig`
+ * declares `next: () => BankStatusEnum` and `BankService.getBankNextStatus` calls
+ * `matchingPermissionConfig.next()` with no arguments. A `void` parameter may be omitted at the call
+ * site, so that call keeps compiling; `never` would have required an argument nobody can produce.
+ */
+const { createActionConfig } = (0, base_flow_config_factory_1.createFlowConfigFactory)()(ACTION_MAP);
+// CREATE_APPROVAL_PENDING status transitions
+const transitionCreateApprovalPendingStatusApproveAction = createActionConfig(bank_action_enum_1.BankActionEnum.APPROVE, bank_status_enum_1.BankStatusEnum.APPROVED);
+const transitionCreateApprovalPendingStatusUpdateAction = createActionConfig(bank_action_enum_1.BankActionEnum.UPDATE, bank_status_enum_1.BankStatusEnum.CREATE_APPROVAL_PENDING);
+const transitionCreateApprovalPendingStatusRejectAction = createActionConfig(bank_action_enum_1.BankActionEnum.REJECT, bank_status_enum_1.BankStatusEnum.REJECTED);
+const transitionCreateApprovalPendingStatusDeleteAction = createActionConfig(bank_action_enum_1.BankActionEnum.DELETE, bank_status_enum_1.BankStatusEnum.DELETED);
+// UPDATE_APPROVAL_PENDING status transitions
+const transitionUpdateApprovalPendingStatusApproveAction = createActionConfig(bank_action_enum_1.BankActionEnum.APPROVE, bank_status_enum_1.BankStatusEnum.APPROVED);
+const transitionUpdateApprovalPendingStatusUpdateAction = createActionConfig(bank_action_enum_1.BankActionEnum.UPDATE, bank_status_enum_1.BankStatusEnum.UPDATE_APPROVAL_PENDING);
+const transitionUpdateApprovalPendingStatusRejectAction = createActionConfig(bank_action_enum_1.BankActionEnum.REJECT, bank_status_enum_1.BankStatusEnum.RESOLVED_REJECTED);
+const transitionUpdateApprovalPendingStatusRecallAction = createActionConfig(bank_action_enum_1.BankActionEnum.RECALL, bank_status_enum_1.BankStatusEnum.DELETED);
+// DELETE_APPROVAL_PENDING status transitions
+const transitionDeleteApprovalPendingStatusApproveAction = createActionConfig(bank_action_enum_1.BankActionEnum.APPROVE, bank_status_enum_1.BankStatusEnum.DELETED);
+const transitionDeleteApprovalPendingStatusRejectAction = createActionConfig(bank_action_enum_1.BankActionEnum.REJECT, bank_status_enum_1.BankStatusEnum.RESOLVED_REJECTED);
+const transitionDeleteApprovalPendingStatusRecallAction = createActionConfig(bank_action_enum_1.BankActionEnum.RECALL, bank_status_enum_1.BankStatusEnum.DELETED);
+// APPROVED status transitions
+const transitionApprovedStatusUpdateAction = createActionConfig(bank_action_enum_1.BankActionEnum.UPDATE, bank_status_enum_1.BankStatusEnum.UPDATE_APPROVAL_PENDING);
+const transitionApprovedStatusDeleteAction = createActionConfig(bank_action_enum_1.BankActionEnum.DELETE, bank_status_enum_1.BankStatusEnum.DELETE_APPROVAL_PENDING);
+// RESOLVED_REJECTED status transitions
+const transitionResolvedRejectedStatusUpdateAction = createActionConfig(bank_action_enum_1.BankActionEnum.UPDATE, bank_status_enum_1.BankStatusEnum.UPDATE_APPROVAL_PENDING);
+const transitionResolvedRejectedStatusDeleteAction = createActionConfig(bank_action_enum_1.BankActionEnum.DELETE, bank_status_enum_1.BankStatusEnum.DELETE_APPROVAL_PENDING);
+/**
+ * Typed with `FlowConfig` directly rather than importing `IBankFlowConfig` from `src/api`, so that
+ * `entities` does not reach into `api` for a type it can express itself. `IBankFlowConfig` is now an
+ * alias of this same instantiation, so the two cannot drift.
+ */
+exports.bankFlowConfig = {
+    [bank_status_enum_1.BankStatusEnum.CREATE_APPROVAL_PENDING]: {
+        actions: {
+            [bank_action_enum_1.BankActionEnum.APPROVE]: transitionCreateApprovalPendingStatusApproveAction,
+            [bank_action_enum_1.BankActionEnum.UPDATE]: transitionCreateApprovalPendingStatusUpdateAction,
+            [bank_action_enum_1.BankActionEnum.REJECT]: transitionCreateApprovalPendingStatusRejectAction,
+            [bank_action_enum_1.BankActionEnum.DELETE]: transitionCreateApprovalPendingStatusDeleteAction,
+        },
+    },
+    [bank_status_enum_1.BankStatusEnum.UPDATE_APPROVAL_PENDING]: {
+        actions: {
+            [bank_action_enum_1.BankActionEnum.APPROVE]: transitionUpdateApprovalPendingStatusApproveAction,
+            [bank_action_enum_1.BankActionEnum.UPDATE]: transitionUpdateApprovalPendingStatusUpdateAction,
+            [bank_action_enum_1.BankActionEnum.REJECT]: transitionUpdateApprovalPendingStatusRejectAction,
+            [bank_action_enum_1.BankActionEnum.RECALL]: transitionUpdateApprovalPendingStatusRecallAction,
+        },
+    },
+    [bank_status_enum_1.BankStatusEnum.DELETE_APPROVAL_PENDING]: {
+        actions: {
+            [bank_action_enum_1.BankActionEnum.APPROVE]: transitionDeleteApprovalPendingStatusApproveAction,
+            [bank_action_enum_1.BankActionEnum.REJECT]: transitionDeleteApprovalPendingStatusRejectAction,
+            [bank_action_enum_1.BankActionEnum.RECALL]: transitionDeleteApprovalPendingStatusRecallAction,
+        },
+    },
+    [bank_status_enum_1.BankStatusEnum.APPROVED]: {
+        actions: {
+            [bank_action_enum_1.BankActionEnum.UPDATE]: transitionApprovedStatusUpdateAction,
+            [bank_action_enum_1.BankActionEnum.DELETE]: transitionApprovedStatusDeleteAction,
+        },
+    },
+    [bank_status_enum_1.BankStatusEnum.RESOLVED_REJECTED]: {
+        actions: {
+            [bank_action_enum_1.BankActionEnum.UPDATE]: transitionResolvedRejectedStatusUpdateAction,
+            [bank_action_enum_1.BankActionEnum.DELETE]: transitionResolvedRejectedStatusDeleteAction,
+        },
+    },
+};

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

@@ -107,8 +107,27 @@ export type ActionMap<A extends string, S extends string> = {
  *
  * @returns A function that accepts an `ActionMap` and returns `createActionConfig`.
  */
+/**
+ * Optional per-transition extras. Both are spread onto the action config only when supplied, so a
+ * call site that does not pass them produces exactly the object it produced before this argument
+ * existed — the sixteen already-converted flow configs are byte-identical.
+ *
+ * @property isApplicable            runtime guard evaluated against the same context as `next()`
+ * @property validActionPastThreshold whether the action survives a consumer's data-entry threshold
+ * @property description             human-readable copy for this transition. Already part of
+ *                                   `IFlowConfigActionConfig` and rendered by the entity-flow
+ *                                   component, so a converted config must be able to emit it.
+ */
+export type ActionConfigOptions<CTX> = {
+    isApplicable?: (context: CTX) => boolean;
+    validActionPastThreshold?: boolean;
+    description?: string;
+};
 export declare function createFlowConfigFactory<CTX = never>(): <A extends string, S extends string, AM extends ActionMap<A, S>>(actionMap: AM) => {
-    createActionConfig: <Act extends A, Subset extends { [key in A]: AM[key]["reachableStatues"]; }[Act][number] = { [key in A]: AM[key]["reachableStatues"]; }[Act][number]>(action: Act, nextStatus: Subset | ((context: CTX) => Subset), overridePermissions?: string[]) => {
+    createActionConfig: <Act extends A, Subset extends { [key in A]: AM[key]["reachableStatues"]; }[Act][number] = { [key in A]: AM[key]["reachableStatues"]; }[Act][number]>(action: Act, nextStatus: Subset | ((context: CTX) => Subset), overridePermissions?: string[], options?: ActionConfigOptions<CTX>) => {
+        description?: string | undefined;
+        validActionPastThreshold?: boolean | undefined;
+        isApplicable?: ((context: CTX) => boolean) | undefined;
         permissions: string[];
         next: (context: CTX) => Subset;
     };

package/dist/src/entities/flow-configs/base-flow-config.factory.js

@@ -75,18 +75,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFlowConfigFactory = createFlowConfigFactory;
-/**
- * Curried factory — call with the context-data type first, then pass the
- * action map. This two-step pattern lets TypeScript infer the precise action
- * map type (preserving `as const` tuple narrowing) while still allowing the
- * caller to set the context-data type explicitly.
- *
- * @template CTX - Shape of the context object passed to function-based
- *                 transition resolvers. Use `never` for flows where `next()`
- *                 needs no runtime data (equivalent to `() => status`).
- *
- * @returns A function that accepts an `ActionMap` and returns `createActionConfig`.
- */
 function createFlowConfigFactory() {
     return function (actionMap) {
         const createTransition = (transition) => (context) => {
@@ -111,10 +99,7 @@ function createFlowConfigFactory() {
          *                   (currentStatus, action) pair. Must be a subtype of
          *                   `StatusForAction<Act>`.
          */
-        const createActionConfig = (action, nextStatus, overridePermissions) => ({
-            permissions: overridePermissions !== null && overridePermissions !== void 0 ? overridePermissions : actionMap[action].permissions,
-            next: createTransition(nextStatus),
-        });
+        const createActionConfig = (action, nextStatus, overridePermissions, options) => (Object.assign(Object.assign(Object.assign({ permissions: overridePermissions !== null && overridePermissions !== void 0 ? overridePermissions : actionMap[action].permissions, next: createTransition(nextStatus) }, ((options === null || options === void 0 ? void 0 : options.isApplicable) !== undefined ? { isApplicable: options.isApplicable } : {})), ((options === null || options === void 0 ? void 0 : options.validActionPastThreshold) !== undefined ? { validActionPastThreshold: options.validActionPastThreshold } : {})), ((options === null || options === void 0 ? void 0 : options.description) !== undefined ? { description: options.description } : {})));
         return { createActionConfig, createTransition };
     };
 }

package/dist/src/entities/flow-configs/{billing.flow.config.d.ts → billing_flow.config.d.ts}

@@ -2,5 +2,5 @@ import { IBillingFlowContextData } from "../../api";
 import { BillingActionsEnum } from "../enums/billing_action_enum";
 import { BillingStatusEnum } from "../enums/billing_status_enum";
 import { FlowConfig } from "./flow-config.type";
-export declare let billingFlowConfig: FlowConfig<BillingStatusEnum, BillingActionsEnum, IBillingFlowContextData>;
+export declare const billingFlowConfig: FlowConfig<BillingStatusEnum, BillingActionsEnum, IBillingFlowContextData>;
 export declare function getNextStatusTotalAmount(data: IBillingFlowContextData): BillingStatusEnum;