law-common 10.74.0 → 10.75.1-beta.1

package/README.md

@@ -1 +1 @@
-# law-common
+# law-common

package/dist/src/api/index.d.ts

@@ -97,3 +97,5 @@ export * from "./interface/client_quote_rate.update.dto.interface";
 export * from "./interface/project-revenue-split.create.dto";
 export * from "./interface/entity_history.create.dto.interface";
 export * from "./interface/entity_history.update.dto.interface";
+export * from "./interface/vendor_invoice_payment.create.dto.interface";
+export * from "./interface/vendor_invoice_payment.update.dto.interface";

package/dist/src/api/index.js

@@ -117,3 +117,5 @@ __exportStar(require("./interface/client_quote_rate.update.dto.interface"), expo
 __exportStar(require("./interface/project-revenue-split.create.dto"), exports);
 __exportStar(require("./interface/entity_history.create.dto.interface"), exports);
 __exportStar(require("./interface/entity_history.update.dto.interface"), exports);
+__exportStar(require("./interface/vendor_invoice_payment.create.dto.interface"), exports);
+__exportStar(require("./interface/vendor_invoice_payment.update.dto.interface"), exports);

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

@@ -8,8 +8,11 @@ export interface IStateActionDataDto {
     remark?: string;
 }
 export declare enum StateActionEnum {
-    VIEW = "view",
-    EDIT = "edit",
+    UPDATE = "update",
     DELETE = "delete",
-    CREATE = "create"
+    CREATE = "create",
+    APPROVE = "approve",
+    REJECT = "reject",
+    RECALL = "recall",
+    DEACTIVATE = "deactivate"
 }

package/dist/src/api/interface/state.update.dto.interface.js

@@ -3,8 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StateActionEnum = void 0;
 var StateActionEnum;
 (function (StateActionEnum) {
-    StateActionEnum["VIEW"] = "view";
-    StateActionEnum["EDIT"] = "edit";
+    // VIEW = "view",
+    StateActionEnum["UPDATE"] = "update";
     StateActionEnum["DELETE"] = "delete";
     StateActionEnum["CREATE"] = "create";
+    StateActionEnum["APPROVE"] = "approve";
+    StateActionEnum["REJECT"] = "reject";
+    StateActionEnum["RECALL"] = "recall";
+    StateActionEnum["DEACTIVATE"] = "deactivate";
 })(StateActionEnum || (exports.StateActionEnum = StateActionEnum = {}));

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

@@ -0,0 +1,5 @@
+import { IEntityCreateDto } from "../../entities";
+import { IVendorInvoicePaymentEntity } from "../../entities/interface/vendor_invoice_payment.entity.interface";
+export type IVendorInvoicePaymentCreateExclude = "status";
+export interface IVendorInvoicePaymentCreateDto extends Omit<IEntityCreateDto<IVendorInvoicePaymentEntity>, IVendorInvoicePaymentCreateExclude> {
+}

package/dist/src/api/interface/vendor_invoice_payment.create.dto.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+import { DeepPartialButRequired } from "./api.utils.interface";
+import { IVendorInvoicePaymentCreateDto } from "./vendor_invoice_payment.create.dto.interface";
+export type IVendorInvoicePaymentUpdateDto = DeepPartialButRequired<IVendorInvoicePaymentCreateDto, never> & {
+    actionData: IVendorInvoicePaymentActionDataDto;
+};
+export interface IVendorInvoicePaymentActionDataDto {
+    action: VendorInvoicePaymentActionEnum;
+    remark?: string;
+}
+export declare enum VendorInvoicePaymentActionEnum {
+    UPDATE = "update",
+    DELETE = "delete",
+    CREATE = "create",
+    APPROVE = "approve",
+    REJECT = "reject",
+    RECALL = "recall",
+    DEACTIVATE = "deactivate"
+}

package/dist/src/api/interface/vendor_invoice_payment.update.dto.interface.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VendorInvoicePaymentActionEnum = void 0;
+var VendorInvoicePaymentActionEnum;
+(function (VendorInvoicePaymentActionEnum) {
+    VendorInvoicePaymentActionEnum["UPDATE"] = "update";
+    VendorInvoicePaymentActionEnum["DELETE"] = "delete";
+    VendorInvoicePaymentActionEnum["CREATE"] = "create";
+    VendorInvoicePaymentActionEnum["APPROVE"] = "approve";
+    VendorInvoicePaymentActionEnum["REJECT"] = "reject";
+    VendorInvoicePaymentActionEnum["RECALL"] = "recall";
+    VendorInvoicePaymentActionEnum["DEACTIVATE"] = "deactivate";
+})(VendorInvoicePaymentActionEnum || (exports.VendorInvoicePaymentActionEnum = VendorInvoicePaymentActionEnum = {}));

package/dist/src/entities/enums/configuration-key.enum.d.ts

@@ -1,8 +1,14 @@
 import { CronJobNames } from "./cron-jobs-name.enum";
 export declare enum ConfigurationKeyEnum {
-    PENDING_APPROVAL_TIMESHEET_REMINDER = "pendingApprovalTimesheetReminder"
+    PENDING_APPROVAL_TIMESHEET_REMINDER = "pendingApprovalTimesheetReminder",
+    TIMESHEET_VIEW_RANGE = "timesheetViewRange",
+    TIMESHEET_VIEW_THRESHOLD = "timesheetViewThreshold",
+    TIMESHEET_THRESHOLD = "timesheetThreshold",
+    TIMESHEET_ENTER_THRESHOLD = "timesheetEnterThreshold",
+    ORGANIZATION_BILLING_OVERDUE_THRESHOLD = "organization_billing_overdue_threshold",
+    PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET = "projectEntityUsageNotificationSentPercentageReset"
 }
 export declare namespace ConfigurationKeyEnum {
     function IsCronJobConfigurationKey(key: ConfigurationKeyEnum): boolean;
-    function getCronJobName(configurationKey: ConfigurationKeyEnum): CronJobNames;
+    function getCronJobName(configurationKey: ConfigurationKeyEnum): CronJobNames | undefined;
 }

package/dist/src/entities/enums/configuration-key.enum.js

@@ -5,6 +5,12 @@ const cron_jobs_name_enum_1 = require("./cron-jobs-name.enum");
 var ConfigurationKeyEnum;
 (function (ConfigurationKeyEnum) {
     ConfigurationKeyEnum["PENDING_APPROVAL_TIMESHEET_REMINDER"] = "pendingApprovalTimesheetReminder";
+    ConfigurationKeyEnum["TIMESHEET_VIEW_RANGE"] = "timesheetViewRange";
+    ConfigurationKeyEnum["TIMESHEET_VIEW_THRESHOLD"] = "timesheetViewThreshold";
+    ConfigurationKeyEnum["TIMESHEET_THRESHOLD"] = "timesheetThreshold";
+    ConfigurationKeyEnum["TIMESHEET_ENTER_THRESHOLD"] = "timesheetEnterThreshold";
+    ConfigurationKeyEnum["ORGANIZATION_BILLING_OVERDUE_THRESHOLD"] = "organization_billing_overdue_threshold";
+    ConfigurationKeyEnum["PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET"] = "projectEntityUsageNotificationSentPercentageReset";
 })(ConfigurationKeyEnum || (exports.ConfigurationKeyEnum = ConfigurationKeyEnum = {}));
 (function (ConfigurationKeyEnum) {
     function IsCronJobConfigurationKey(key) {
@@ -16,6 +22,7 @@ var ConfigurationKeyEnum;
     function getCronJobName(configurationKey) {
         const cronJobConfigurationKeyMapping = {
             [ConfigurationKeyEnum.PENDING_APPROVAL_TIMESHEET_REMINDER]: cron_jobs_name_enum_1.CronJobNames.PENDING_APPROVAL_TIMESHEET_REMINDER,
+            [ConfigurationKeyEnum.PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET]: cron_jobs_name_enum_1.CronJobNames.PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET,
         };
         return cronJobConfigurationKeyMapping[configurationKey];
     }

package/dist/src/entities/enums/cron-jobs-name.enum.d.ts

@@ -1,3 +1,4 @@
 export declare enum CronJobNames {
-    PENDING_APPROVAL_TIMESHEET_REMINDER = "pending_approval_timesheet_reminder"
+    PENDING_APPROVAL_TIMESHEET_REMINDER = "pending_approval_timesheet_reminder",
+    PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET = "project_entity_usage_notification_sent_percentage_reset"
 }

package/dist/src/entities/enums/cron-jobs-name.enum.js

@@ -4,4 +4,5 @@ exports.CronJobNames = void 0;
 var CronJobNames;
 (function (CronJobNames) {
     CronJobNames["PENDING_APPROVAL_TIMESHEET_REMINDER"] = "pending_approval_timesheet_reminder";
+    CronJobNames["PROJECT_ENTITY_USAGE_NOTIFICATION_SENT_PERCENTAGE_RESET"] = "project_entity_usage_notification_sent_percentage_reset";
 })(CronJobNames || (exports.CronJobNames = CronJobNames = {}));

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

@@ -1,5 +1,12 @@
 export declare enum StateStatusEnum {
-    ACTIVE = "ACTIVE",
-    DEACTIVE = "DEACTIVE",
-    INACTIVE = "INACTIVE"
+    DEACTIVATED = "DEACTIVATED",
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    DELETED = "DELETED",
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    CREATE_APPROVAL_PENDING = "CREATE_APPROVAL_PENDING",
+    UPDATE_APPROVAL_PENDING = "UPDATE_APPROVAL_PENDING",
+    DELETE_APPROVAL_PENDING = "DELETE_APPROVAL_PENDING",
+    RESOLVED_REJECTED = "RESOLVED_REJECTED"
 }

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

@@ -3,7 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StateStatusEnum = void 0;
 var StateStatusEnum;
 (function (StateStatusEnum) {
-    StateStatusEnum["ACTIVE"] = "ACTIVE";
-    StateStatusEnum["DEACTIVE"] = "DEACTIVE";
-    StateStatusEnum["INACTIVE"] = "INACTIVE";
+    // NO_ROW = "NO_ROW",
+    // ACTIVE = "ACTIVE",
+    StateStatusEnum["DEACTIVATED"] = "DEACTIVATED";
+    // INACTIVE = "INACTIVE",
+    StateStatusEnum["CREATED"] = "CREATED";
+    StateStatusEnum["UPDATED"] = "UPDATED";
+    StateStatusEnum["DELETED"] = "DELETED";
+    StateStatusEnum["APPROVED"] = "APPROVED";
+    StateStatusEnum["REJECTED"] = "REJECTED";
+    StateStatusEnum["CREATE_APPROVAL_PENDING"] = "CREATE_APPROVAL_PENDING";
+    StateStatusEnum["UPDATE_APPROVAL_PENDING"] = "UPDATE_APPROVAL_PENDING";
+    StateStatusEnum["DELETE_APPROVAL_PENDING"] = "DELETE_APPROVAL_PENDING";
+    StateStatusEnum["RESOLVED_REJECTED"] = "RESOLVED_REJECTED";
 })(StateStatusEnum || (exports.StateStatusEnum = StateStatusEnum = {}));

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

@@ -0,0 +1,7 @@
+export declare enum VendorInvoicePaymentModeEnum {
+    CASH = "CASH",
+    NEFT = "NEFT",
+    RTGS = "RTGS",
+    UPI = "UPI",
+    CHEQUE = "CHEQUE"
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VendorInvoicePaymentModeEnum = void 0;
+var VendorInvoicePaymentModeEnum;
+(function (VendorInvoicePaymentModeEnum) {
+    VendorInvoicePaymentModeEnum["CASH"] = "CASH";
+    VendorInvoicePaymentModeEnum["NEFT"] = "NEFT";
+    VendorInvoicePaymentModeEnum["RTGS"] = "RTGS";
+    VendorInvoicePaymentModeEnum["UPI"] = "UPI";
+    VendorInvoicePaymentModeEnum["CHEQUE"] = "CHEQUE";
+})(VendorInvoicePaymentModeEnum || (exports.VendorInvoicePaymentModeEnum = VendorInvoicePaymentModeEnum = {}));

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

@@ -0,0 +1,12 @@
+export declare enum VendorInvoicePaymentStatusEnum {
+    DEACTIVATED = "DEACTIVATED",
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    DELETED = "DELETED",
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    CREATE_APPROVAL_PENDING = "CREATE_APPROVAL_PENDING",
+    UPDATE_APPROVAL_PENDING = "UPDATE_APPROVAL_PENDING",
+    DELETE_APPROVAL_PENDING = "DELETE_APPROVAL_PENDING",
+    RESOLVED_REJECTED = "RESOLVED_REJECTED"
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VendorInvoicePaymentStatusEnum = void 0;
+var VendorInvoicePaymentStatusEnum;
+(function (VendorInvoicePaymentStatusEnum) {
+    VendorInvoicePaymentStatusEnum["DEACTIVATED"] = "DEACTIVATED";
+    VendorInvoicePaymentStatusEnum["CREATED"] = "CREATED";
+    VendorInvoicePaymentStatusEnum["UPDATED"] = "UPDATED";
+    VendorInvoicePaymentStatusEnum["DELETED"] = "DELETED";
+    VendorInvoicePaymentStatusEnum["APPROVED"] = "APPROVED";
+    VendorInvoicePaymentStatusEnum["REJECTED"] = "REJECTED";
+    VendorInvoicePaymentStatusEnum["CREATE_APPROVAL_PENDING"] = "CREATE_APPROVAL_PENDING";
+    VendorInvoicePaymentStatusEnum["UPDATE_APPROVAL_PENDING"] = "UPDATE_APPROVAL_PENDING";
+    VendorInvoicePaymentStatusEnum["DELETE_APPROVAL_PENDING"] = "DELETE_APPROVAL_PENDING";
+    VendorInvoicePaymentStatusEnum["RESOLVED_REJECTED"] = "RESOLVED_REJECTED";
+})(VendorInvoicePaymentStatusEnum || (exports.VendorInvoicePaymentStatusEnum = VendorInvoicePaymentStatusEnum = {}));

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

@@ -0,0 +1,74 @@
+/**
+ * Base action enum shared across all entity flow configs.
+ *
+ * Entity-specific action enums should re-use these values for common actions
+ * and declare additional values for entity-specific actions.
+ *
+ * @example
+ * // Extending with entity-specific actions
+ * export enum VendorActionEnum {
+ *   // — base actions (re-declare to keep enum self-contained) —
+ *   VIEW     = BaseFlowActionEnum.VIEW,
+ *   CREATE   = BaseFlowActionEnum.CREATE,
+ *   UPDATE   = BaseFlowActionEnum.UPDATE,
+ *   DELETE   = BaseFlowActionEnum.DELETE,
+ *   APPROVE  = BaseFlowActionEnum.APPROVE,
+ *   REJECT   = BaseFlowActionEnum.REJECT,
+ *   RECALL   = BaseFlowActionEnum.RECALL,
+ *   DEACTIVATE = BaseFlowActionEnum.DEACTIVATE,
+ *   // — entity-specific additions —
+ *   SUBMIT   = "submit",
+ *   ESCALATE = "escalate",
+ * }
+ */
+export declare enum BaseFlowActionEnum {
+    VIEW = "view",
+    CREATE = "create",
+    UPDATE = "update",
+    DELETE = "delete",
+    APPROVE = "approve",
+    REJECT = "reject",
+    RECALL = "recall",
+    DEACTIVATE = "deactivate"
+}
+/**
+ * Base status enum shared across all entity flow configs.
+ *
+ * Entity-specific status enums should re-use these values for common statuses
+ * and declare additional values for entity-specific statuses.
+ *
+ * @example
+ * // Extending with entity-specific statuses
+ * export enum VendorStatusEnum {
+ *   // — base statuses —
+ *   ACTIVE                  = BaseFlowStatusEnum.ACTIVE,
+ *   INACTIVE                = BaseFlowStatusEnum.INACTIVE,
+ *   DEACTIVATED             = BaseFlowStatusEnum.DEACTIVATED,
+ *   CREATED                 = BaseFlowStatusEnum.CREATED,
+ *   UPDATED                 = BaseFlowStatusEnum.UPDATED,
+ *   DELETED                 = BaseFlowStatusEnum.DELETED,
+ *   APPROVED                = BaseFlowStatusEnum.APPROVED,
+ *   REJECTED                = BaseFlowStatusEnum.REJECTED,
+ *   RESOLVED_REJECTED       = BaseFlowStatusEnum.RESOLVED_REJECTED,
+ *   CREATE_APPROVAL_PENDING = BaseFlowStatusEnum.CREATE_APPROVAL_PENDING,
+ *   UPDATE_APPROVAL_PENDING = BaseFlowStatusEnum.UPDATE_APPROVAL_PENDING,
+ *   DELETE_APPROVAL_PENDING = BaseFlowStatusEnum.DELETE_APPROVAL_PENDING,
+ *   // — entity-specific additions —
+ *   UNDER_REVIEW            = "UNDER_REVIEW",
+ *   SUBMITTED               = "SUBMITTED",
+ * }
+ */
+export declare enum BaseFlowStatusEnum {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    DEACTIVATED = "DEACTIVATED",
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    DELETED = "DELETED",
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    RESOLVED_REJECTED = "RESOLVED_REJECTED",
+    CREATE_APPROVAL_PENDING = "CREATE_APPROVAL_PENDING",
+    UPDATE_APPROVAL_PENDING = "UPDATE_APPROVAL_PENDING",
+    DELETE_APPROVAL_PENDING = "DELETE_APPROVAL_PENDING"
+}

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

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseFlowStatusEnum = exports.BaseFlowActionEnum = void 0;
+/**
+ * Base action enum shared across all entity flow configs.
+ *
+ * Entity-specific action enums should re-use these values for common actions
+ * and declare additional values for entity-specific actions.
+ *
+ * @example
+ * // Extending with entity-specific actions
+ * export enum VendorActionEnum {
+ *   // — base actions (re-declare to keep enum self-contained) —
+ *   VIEW     = BaseFlowActionEnum.VIEW,
+ *   CREATE   = BaseFlowActionEnum.CREATE,
+ *   UPDATE   = BaseFlowActionEnum.UPDATE,
+ *   DELETE   = BaseFlowActionEnum.DELETE,
+ *   APPROVE  = BaseFlowActionEnum.APPROVE,
+ *   REJECT   = BaseFlowActionEnum.REJECT,
+ *   RECALL   = BaseFlowActionEnum.RECALL,
+ *   DEACTIVATE = BaseFlowActionEnum.DEACTIVATE,
+ *   // — entity-specific additions —
+ *   SUBMIT   = "submit",
+ *   ESCALATE = "escalate",
+ * }
+ */
+var BaseFlowActionEnum;
+(function (BaseFlowActionEnum) {
+    BaseFlowActionEnum["VIEW"] = "view";
+    BaseFlowActionEnum["CREATE"] = "create";
+    BaseFlowActionEnum["UPDATE"] = "update";
+    BaseFlowActionEnum["DELETE"] = "delete";
+    BaseFlowActionEnum["APPROVE"] = "approve";
+    BaseFlowActionEnum["REJECT"] = "reject";
+    BaseFlowActionEnum["RECALL"] = "recall";
+    BaseFlowActionEnum["DEACTIVATE"] = "deactivate";
+})(BaseFlowActionEnum || (exports.BaseFlowActionEnum = BaseFlowActionEnum = {}));
+/**
+ * Base status enum shared across all entity flow configs.
+ *
+ * Entity-specific status enums should re-use these values for common statuses
+ * and declare additional values for entity-specific statuses.
+ *
+ * @example
+ * // Extending with entity-specific statuses
+ * export enum VendorStatusEnum {
+ *   // — base statuses —
+ *   ACTIVE                  = BaseFlowStatusEnum.ACTIVE,
+ *   INACTIVE                = BaseFlowStatusEnum.INACTIVE,
+ *   DEACTIVATED             = BaseFlowStatusEnum.DEACTIVATED,
+ *   CREATED                 = BaseFlowStatusEnum.CREATED,
+ *   UPDATED                 = BaseFlowStatusEnum.UPDATED,
+ *   DELETED                 = BaseFlowStatusEnum.DELETED,
+ *   APPROVED                = BaseFlowStatusEnum.APPROVED,
+ *   REJECTED                = BaseFlowStatusEnum.REJECTED,
+ *   RESOLVED_REJECTED       = BaseFlowStatusEnum.RESOLVED_REJECTED,
+ *   CREATE_APPROVAL_PENDING = BaseFlowStatusEnum.CREATE_APPROVAL_PENDING,
+ *   UPDATE_APPROVAL_PENDING = BaseFlowStatusEnum.UPDATE_APPROVAL_PENDING,
+ *   DELETE_APPROVAL_PENDING = BaseFlowStatusEnum.DELETE_APPROVAL_PENDING,
+ *   // — entity-specific additions —
+ *   UNDER_REVIEW            = "UNDER_REVIEW",
+ *   SUBMITTED               = "SUBMITTED",
+ * }
+ */
+var BaseFlowStatusEnum;
+(function (BaseFlowStatusEnum) {
+    BaseFlowStatusEnum["ACTIVE"] = "ACTIVE";
+    BaseFlowStatusEnum["INACTIVE"] = "INACTIVE";
+    BaseFlowStatusEnum["DEACTIVATED"] = "DEACTIVATED";
+    BaseFlowStatusEnum["CREATED"] = "CREATED";
+    BaseFlowStatusEnum["UPDATED"] = "UPDATED";
+    BaseFlowStatusEnum["DELETED"] = "DELETED";
+    BaseFlowStatusEnum["APPROVED"] = "APPROVED";
+    BaseFlowStatusEnum["REJECTED"] = "REJECTED";
+    BaseFlowStatusEnum["RESOLVED_REJECTED"] = "RESOLVED_REJECTED";
+    BaseFlowStatusEnum["CREATE_APPROVAL_PENDING"] = "CREATE_APPROVAL_PENDING";
+    BaseFlowStatusEnum["UPDATE_APPROVAL_PENDING"] = "UPDATE_APPROVAL_PENDING";
+    BaseFlowStatusEnum["DELETE_APPROVAL_PENDING"] = "DELETE_APPROVAL_PENDING";
+})(BaseFlowStatusEnum || (exports.BaseFlowStatusEnum = BaseFlowStatusEnum = {}));

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

@@ -0,0 +1,116 @@
+/**
+ * Generic flow-config factory.
+ *
+ * Provides a reusable, type-safe `createActionConfig` helper for any entity
+ * flow configuration. Eliminates boilerplate type plumbing (ActionStatusMap,
+ * StateStatusForAction, createTransition) that would otherwise be duplicated
+ * in every flow config file.
+ *
+ * ---
+ * **Usage — basic**
+ * ```typescript
+ * import { createFlowConfigFactory } from "./base-flow-config.factory";
+ *
+ * const ACTION_MAP = {
+ *   [MyActionEnum.APPROVE]: { statuses: [MyStatusEnum.APPROVED] as const, permissions: ["MY_APPROVE"] },
+ *   [MyActionEnum.REJECT]:  { statuses: [MyStatusEnum.REJECTED]  as const, permissions: ["MY_REJECT"]  },
+ * } satisfies ActionMap<MyActionEnum, MyStatusEnum>;
+ *
+ * const { createActionConfig } = createFlowConfigFactory<IMyContextData>()(ACTION_MAP);
+ *
+ * const transition = createActionConfig(MyStatusEnum.APPROVED, MyActionEnum.APPROVE);
+ * ```
+ *
+ * ---
+ * **Usage — overriding a transition permission**
+ * ```typescript
+ * createActionConfig(MyStatusEnum.APPROVED, MyActionEnum.APPROVE, ["CUSTOM_APPROVE_PERM"]);
+ * ```
+ *
+ * ---
+ * **Usage — context-driven (multi-outcome) transition**
+ * ```typescript
+ * createActionConfig(
+ *   (ctx: IMyContextData) => ctx.fast ? MyStatusEnum.APPROVED : MyStatusEnum.PENDING,
+ *   MyActionEnum.APPROVE,
+ * );
+ * ```
+ *
+ * ---
+ * **Usage — subset narrowing**
+ * Restrict the compiler to a subset of the action's possible target statuses:
+ * ```typescript
+ * createActionConfig<MyActionEnum.APPROVE, MyStatusEnum.APPROVED>(
+ *   MyStatusEnum.APPROVED,
+ *   MyActionEnum.APPROVE,
+ * );
+ * ```
+ *
+ * ---
+ * **Extending base enums**
+ * TypeScript enums cannot be inherited, but entity-specific enums can
+ * re-declare base values and add new ones:
+ * ```typescript
+ * import { BaseFlowActionEnum, BaseFlowStatusEnum } from "./base-flow-config.enums";
+ *
+ * export enum VendorActionEnum {
+ *   VIEW       = BaseFlowActionEnum.VIEW,
+ *   CREATE     = BaseFlowActionEnum.CREATE,
+ *   UPDATE     = BaseFlowActionEnum.UPDATE,
+ *   DELETE     = BaseFlowActionEnum.DELETE,
+ *   APPROVE    = BaseFlowActionEnum.APPROVE,
+ *   REJECT     = BaseFlowActionEnum.REJECT,
+ *   RECALL     = BaseFlowActionEnum.RECALL,
+ *   DEACTIVATE = BaseFlowActionEnum.DEACTIVATE,
+ *   SUBMIT     = "submit",   // ← extension
+ * }
+ *
+ * export enum VendorStatusEnum {
+ *   ACTIVE                  = BaseFlowStatusEnum.ACTIVE,
+ *   // ... all base statuses ...
+ *   SUBMITTED               = "SUBMITTED",   // ← extension
+ * }
+ * ```
+ */
+/**
+ * Shape of a single entry in the action map.
+ * `statuses` must be a `const` tuple so TypeScript preserves the exact union
+ * of reachable statuses for subset-narrowing in `createActionConfig`.
+ */
+export type ActionMapEntry<S extends string> = {
+    readonly statuses: readonly S[];
+    readonly permissions: string[];
+};
+/**
+ * Full action map: one entry per action value.
+ * Use `satisfies ActionMap<MyActionEnum, MyStatusEnum>` on your map literal
+ * so that the compiler catches missing/misspelled keys while still preserving
+ * the precise `as const` tuple types for subset-narrowing.
+ *
+ * @example
+ * const ACTION_MAP = {
+ *   [MyActionEnum.APPROVE]: { statuses: [MyStatusEnum.APPROVED] as const, permissions: ["MY_APPROVE"] },
+ * } satisfies ActionMap<MyActionEnum, MyStatusEnum>;
+ */
+export type ActionMap<A extends string, S extends string> = {
+    readonly [key in A]: ActionMapEntry<S>;
+};
+/**
+ * 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`.
+ */
+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]["statuses"]; }[Act][number] = { [key in A]: AM[key]["statuses"]; }[Act][number]>(action: Act, nextStatus: Subset | ((context: CTX) => Subset), overridePermissions?: string[]) => {
+        permissions: string[];
+        next: (context: CTX) => Subset;
+    };
+    createTransition: <Act extends A, Subset_1 extends { [key in A]: AM[key]["statuses"]; }[Act][number] = { [key in A]: AM[key]["statuses"]; }[Act][number]>(transition: Subset_1 | ((context: CTX) => Subset_1)) => (context: CTX) => Subset_1;
+};

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

@@ -0,0 +1,120 @@
+"use strict";
+/**
+ * Generic flow-config factory.
+ *
+ * Provides a reusable, type-safe `createActionConfig` helper for any entity
+ * flow configuration. Eliminates boilerplate type plumbing (ActionStatusMap,
+ * StateStatusForAction, createTransition) that would otherwise be duplicated
+ * in every flow config file.
+ *
+ * ---
+ * **Usage — basic**
+ * ```typescript
+ * import { createFlowConfigFactory } from "./base-flow-config.factory";
+ *
+ * const ACTION_MAP = {
+ *   [MyActionEnum.APPROVE]: { statuses: [MyStatusEnum.APPROVED] as const, permissions: ["MY_APPROVE"] },
+ *   [MyActionEnum.REJECT]:  { statuses: [MyStatusEnum.REJECTED]  as const, permissions: ["MY_REJECT"]  },
+ * } satisfies ActionMap<MyActionEnum, MyStatusEnum>;
+ *
+ * const { createActionConfig } = createFlowConfigFactory<IMyContextData>()(ACTION_MAP);
+ *
+ * const transition = createActionConfig(MyStatusEnum.APPROVED, MyActionEnum.APPROVE);
+ * ```
+ *
+ * ---
+ * **Usage — overriding a transition permission**
+ * ```typescript
+ * createActionConfig(MyStatusEnum.APPROVED, MyActionEnum.APPROVE, ["CUSTOM_APPROVE_PERM"]);
+ * ```
+ *
+ * ---
+ * **Usage — context-driven (multi-outcome) transition**
+ * ```typescript
+ * createActionConfig(
+ *   (ctx: IMyContextData) => ctx.fast ? MyStatusEnum.APPROVED : MyStatusEnum.PENDING,
+ *   MyActionEnum.APPROVE,
+ * );
+ * ```
+ *
+ * ---
+ * **Usage — subset narrowing**
+ * Restrict the compiler to a subset of the action's possible target statuses:
+ * ```typescript
+ * createActionConfig<MyActionEnum.APPROVE, MyStatusEnum.APPROVED>(
+ *   MyStatusEnum.APPROVED,
+ *   MyActionEnum.APPROVE,
+ * );
+ * ```
+ *
+ * ---
+ * **Extending base enums**
+ * TypeScript enums cannot be inherited, but entity-specific enums can
+ * re-declare base values and add new ones:
+ * ```typescript
+ * import { BaseFlowActionEnum, BaseFlowStatusEnum } from "./base-flow-config.enums";
+ *
+ * export enum VendorActionEnum {
+ *   VIEW       = BaseFlowActionEnum.VIEW,
+ *   CREATE     = BaseFlowActionEnum.CREATE,
+ *   UPDATE     = BaseFlowActionEnum.UPDATE,
+ *   DELETE     = BaseFlowActionEnum.DELETE,
+ *   APPROVE    = BaseFlowActionEnum.APPROVE,
+ *   REJECT     = BaseFlowActionEnum.REJECT,
+ *   RECALL     = BaseFlowActionEnum.RECALL,
+ *   DEACTIVATE = BaseFlowActionEnum.DEACTIVATE,
+ *   SUBMIT     = "submit",   // ← extension
+ * }
+ *
+ * export enum VendorStatusEnum {
+ *   ACTIVE                  = BaseFlowStatusEnum.ACTIVE,
+ *   // ... all base statuses ...
+ *   SUBMITTED               = "SUBMITTED",   // ← extension
+ * }
+ * ```
+ */
+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) => {
+            if (typeof transition === "function") {
+                return transition(context);
+            }
+            return transition;
+        };
+        /**
+         * Builds a single typed action-config entry for use inside a
+         * `FlowConfig` status block.
+         *
+         * @param nextStatus   Fixed target status, or a function `(ctx) => status`
+         *                     for context-driven transitions.
+         * @param action       The action this config is for (used to look up
+         *                     default permissions from `actionMap`).
+         * @param overridePermissions  Optional permission list that replaces the
+         *                     default from `actionMap[action].permissions`.
+         *
+         * @typeParam Act    Specific action enum member (narrows `StatusForAction`).
+         * @typeParam Subset Subset of reachable statuses to enforce at this
+         *                   (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),
+        });
+        return { createActionConfig, createTransition };
+    };
+}