law-common 13.0.1-beta.2 → 13.0.1-beta.21

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

@@ -0,0 +1,305 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.billingFlowConfig = void 0;
+exports.getNextStatusTotalAmount = getNextStatusTotalAmount;
+const error_key_enum_1 = require("../../enums/error.key.enum");
+const exceptions_1 = require("../../exceptions");
+const billing_action_enum_1 = require("../enums/billing_action_enum");
+const billing_status_enum_1 = require("../enums/billing_status_enum");
+const base_flow_config_factory_1 = require("./base-flow-config.factory");
+const BILLING_APPROVER_PERMISSION = ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"];
+const BILLING_AMENDMENT_PERMISSION = ["BILLING_AMENDMENT_ORG"];
+const BILLING_REGENERATE_PERMISSION = ["BILLING_UPDATE"];
+const BILLING_PDF_VIEW_PERMISSION = ["BILLING_VIEW_PDF"];
+/**
+ * Every status this flow declares a block for. PDF_VIEW is an identity transition available from each
+ * of them, so this is exactly its reachable set.
+ *
+ * CANCELLED is a target (REJECT, REGENERATE) but has no block of its own — it is terminal.
+ */
+const BILLING_FLOW_STATUSES = [
+    billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL,
+    billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
+    billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED,
+    billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW,
+    billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL,
+    billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION,
+    billing_status_enum_1.BillingStatusEnum.INVOICE_SENT,
+    billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT,
+    billing_status_enum_1.BillingStatusEnum.SETTLED,
+];
+const ACTION_MAP = {
+    [billing_action_enum_1.BillingActionsEnum.APPROVE]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED],
+        permissions: BILLING_APPROVER_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.REJECT]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.CANCELLED, billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION],
+        permissions: BILLING_APPROVER_PERMISSION,
+    },
+    /**
+     * UPDATE is the one action whose permission is not constant across its transitions: four of the five
+     * use the approver list, but REQUEST_CHANGES uses the amendment list. The approver list is the default
+     * here and REQUEST_CHANGES passes the amendment list as an override.
+     */
+    [billing_action_enum_1.BillingActionsEnum.UPDATE]: {
+        reachableStatues: [
+            billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL,
+            billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
+            billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL,
+            billing_status_enum_1.BillingStatusEnum.INVOICE_SENT,
+        ],
+        permissions: BILLING_APPROVER_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES],
+        permissions: BILLING_APPROVER_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.SENT_FOR_APPROVAL]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL],
+        permissions: BILLING_AMENDMENT_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.SEND_FOR_CLIENT_REVIEW]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW],
+        permissions: BILLING_AMENDMENT_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.CLIENT_REVISION]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL],
+        permissions: BILLING_AMENDMENT_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.SEND_INVOICE]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT],
+        permissions: BILLING_AMENDMENT_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.APPROVAL]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES],
+        permissions: BILLING_APPROVER_PERMISSION,
+    },
+    /**
+     * UPDATE_PAYMENT is context-driven: `getNextStatusTotalAmount` returns SETTLED once the outstanding
+     * amount reaches zero and PENDING_PAYMENT otherwise. The from-status is also reachable, because both
+     * transitions fall back to it when called without context — which the entity-flow component does.
+     */
+    [billing_action_enum_1.BillingActionsEnum.UPDATE_PAYMENT]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.SETTLED, billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT],
+        permissions: BILLING_AMENDMENT_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.REGENERATE]: {
+        reachableStatues: [billing_status_enum_1.BillingStatusEnum.CANCELLED],
+        permissions: BILLING_REGENERATE_PERMISSION,
+    },
+    [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: {
+        reachableStatues: BILLING_FLOW_STATUSES,
+        permissions: BILLING_PDF_VIEW_PERMISSION,
+    },
+    // CREDIT_NOTE, WRITE_OFF and TDS are declared on BillingActionsEnum 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.
+    [billing_action_enum_1.BillingActionsEnum.CREDIT_NOTE]: {
+        reachableStatues: [],
+        permissions: [],
+    },
+    [billing_action_enum_1.BillingActionsEnum.WRITE_OFF]: {
+        reachableStatues: [],
+        permissions: [],
+    },
+    [billing_action_enum_1.BillingActionsEnum.TDS]: {
+        reachableStatues: [],
+        permissions: [],
+    },
+};
+const { createActionConfig } = (0, base_flow_config_factory_1.createFlowConfigFactory)()(ACTION_MAP);
+// PENDING_APPROVAL status transitions
+const transitionPendingApprovalStatusApproveAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.APPROVE, billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED, undefined, {
+    description: "Internal Approved state signifies that the Proforma Invoice has been reviewed and verified by internal stakeholders.",
+});
+const transitionPendingApprovalStatusRejectAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REJECT, billing_status_enum_1.BillingStatusEnum.CANCELLED, undefined, {
+    description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
+});
+const transitionPendingApprovalStatusUpdateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE, billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL, undefined, {
+    description: "Allows stakeholders to edit the Proforma Invoice while keeping it in Pending Approval status.",
+});
+const transitionPendingApprovalStatusRequestForChangesAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES, billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES, undefined, { description: "Stakeholders have requested changes before approving the Proforma Invoice." });
+// REQUEST_CHANGES status transitions
+const transitionRequestChangesStatusUpdateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE, billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES, BILLING_AMENDMENT_PERMISSION, // differs from the action default — amendment, not approver
+{ description: "Allows modification of the Proforma Invoice based on stakeholder feedback." });
+const transitionRequestChangesStatusSentForApprovalAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.SENT_FOR_APPROVAL, billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL, undefined, { description: "Resubmits the updated Proforma Invoice for stakeholder approval." });
+// INTERNAL_APPROVED status transitions
+const transitionInternalApprovedStatusSendForClientReviewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.SEND_FOR_CLIENT_REVIEW, billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW, undefined, { description: "Invoice has been internally approved and is sent to the client for review." });
+// PENDING_CLIENT_REVIEW status transitions
+const transitionPendingClientReviewStatusClientRevisionAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.CLIENT_REVISION, billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL, undefined, { description: "Client has requested revisions to the Proforma Invoice." });
+const transitionPendingClientReviewStatusSendInvoiceAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.SEND_INVOICE, billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT, undefined, {
+    description: "Final invoice has been shared with the client and payment is awaited.",
+});
+// CLIENT_REVISION_APPROVAL status transitions
+const transitionClientRevisionApprovalStatusApprovalAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.APPROVAL, billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES, undefined, {
+    description: "Client revision has been reviewed and approved for further amendments.",
+});
+const transitionClientRevisionApprovalStatusRejectAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REJECT, billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION, undefined, {
+    description: "Client revision request has been rejected by stakeholders.",
+});
+const transitionClientRevisionApprovalStatusUpdateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE, billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL, undefined, { description: "Allows editing while client revision approval is in progress." });
+const transitionClientRevisionApprovalStatusRequestForChangesAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES, billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES, undefined, { description: "Requests additional changes before approving the client revision." });
+// REJECT_CLIENT_REVISION status transitions
+const transitionRejectClientRevisionStatusSendInvoiceAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.SEND_INVOICE, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT, undefined, {
+    description: "Invoice has been sent despite client revision rejection.",
+});
+// INVOICE_SENT status transitions
+const transitionInvoiceSentStatusUpdatePaymentAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE_PAYMENT, (data) => {
+    return data ? getNextStatusTotalAmount(data) : billing_status_enum_1.BillingStatusEnum.INVOICE_SENT;
+}, undefined, { description: "Updates received payment details and recalculates outstanding amount." });
+const transitionInvoiceSentStatusRejectAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REJECT, billing_status_enum_1.BillingStatusEnum.CANCELLED, undefined, {
+    description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
+});
+const transitionInvoiceSentStatusUpdateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT, undefined, {
+    description: "Allows stakeholders to edit the invoice while keeping it in Invoice Sent status.",
+});
+const transitionInvoiceSentStatusRegenerateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REGENERATE, billing_status_enum_1.BillingStatusEnum.CANCELLED, undefined, {
+    description: "Regenerates the billing by cancelling the current one and creating a replacement",
+});
+// PENDING_PAYMENT status transitions
+const transitionPendingPaymentStatusUpdatePaymentAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE_PAYMENT, (data) => {
+    return data ? getNextStatusTotalAmount(data) : billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT;
+}, undefined, { description: "Tracks partial or full payments until the invoice is completely settled." });
+const transitionPendingPaymentStatusRejectAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REJECT, billing_status_enum_1.BillingStatusEnum.CANCELLED, undefined, {
+    description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
+});
+const transitionPendingPaymentStatusUpdateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.UPDATE, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT, undefined, {
+    description: "Allows stakeholders to edit the invoice while keeping it in Invoice Sent status.",
+});
+const transitionPendingPaymentStatusRegenerateAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.REGENERATE, billing_status_enum_1.BillingStatusEnum.CANCELLED, undefined, {
+    description: "Regenerates the billing by cancelling the current one and creating a replacement",
+});
+/**
+ * PDF_VIEW status transitions — one per status block, each keeping the row where it is. These were
+ * previously attached by mutating the config through `addPdfViewToAllStatuses` after definition; they
+ * are written out explicitly so the exported object is complete and immutable.
+ */
+const transitionPendingApprovalStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL, undefined, {
+    description: "",
+});
+const transitionRequestChangesStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES, undefined, {
+    description: "",
+});
+const transitionInternalApprovedStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED, undefined, {
+    description: "",
+});
+const transitionPendingClientReviewStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW, undefined, {
+    description: "",
+});
+const transitionClientRevisionApprovalStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL, undefined, { description: "" });
+const transitionRejectClientRevisionStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION, undefined, {
+    description: "",
+});
+const transitionInvoiceSentStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.INVOICE_SENT, undefined, {
+    description: "",
+});
+const transitionPendingPaymentStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT, undefined, {
+    description: "",
+});
+const transitionSettledStatusPdfViewAction = createActionConfig(billing_action_enum_1.BillingActionsEnum.PDF_VIEW, billing_status_enum_1.BillingStatusEnum.SETTLED, undefined, { description: "" });
+exports.billingFlowConfig = {
+    [billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL]: {
+        description: "The Proforma Invoice has been created and is awaiting review and approval by internal stakeholders (org or project approvers).",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.APPROVE]: transitionPendingApprovalStatusApproveAction,
+            [billing_action_enum_1.BillingActionsEnum.REJECT]: transitionPendingApprovalStatusRejectAction,
+            [billing_action_enum_1.BillingActionsEnum.UPDATE]: transitionPendingApprovalStatusUpdateAction,
+            [billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES]: transitionPendingApprovalStatusRequestForChangesAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionPendingApprovalStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES]: {
+        description: "Stakeholders have reviewed the Proforma Invoice and requested modifications before it can be approved. The invoice is pending amendments by the billing team.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.UPDATE]: transitionRequestChangesStatusUpdateAction,
+            [billing_action_enum_1.BillingActionsEnum.SENT_FOR_APPROVAL]: transitionRequestChangesStatusSentForApprovalAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionRequestChangesStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED]: {
+        description: "The Proforma Invoice has been reviewed and approved by internal stakeholders. It is now ready to be forwarded to the client for review.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.SEND_FOR_CLIENT_REVIEW]: transitionInternalApprovedStatusSendForClientReviewAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionInternalApprovedStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW]: {
+        description: "The Proforma Invoice has been shared with the client and is awaiting their response. The client may either accept the invoice or request revisions.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.CLIENT_REVISION]: transitionPendingClientReviewStatusClientRevisionAction,
+            [billing_action_enum_1.BillingActionsEnum.SEND_INVOICE]: transitionPendingClientReviewStatusSendInvoiceAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionPendingClientReviewStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL]: {
+        description: "The client has requested revisions to the invoice. Internal stakeholders are reviewing whether to approve the revision request, reject it, or ask for further changes.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.APPROVAL]: transitionClientRevisionApprovalStatusApprovalAction,
+            [billing_action_enum_1.BillingActionsEnum.REJECT]: transitionClientRevisionApprovalStatusRejectAction,
+            [billing_action_enum_1.BillingActionsEnum.UPDATE]: transitionClientRevisionApprovalStatusUpdateAction,
+            [billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES]: transitionClientRevisionApprovalStatusRequestForChangesAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionClientRevisionApprovalStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION]: {
+        description: "The client's revision request has been rejected by internal stakeholders. The billing team can proceed to send the original invoice to the client.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.SEND_INVOICE]: transitionRejectClientRevisionStatusSendInvoiceAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionRejectClientRevisionStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.INVOICE_SENT]: {
+        description: "The final invoice has been issued to the client following a rejected revision request. Payment is being tracked; partial payments may be recorded until the invoice is fully settled.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.UPDATE_PAYMENT]: transitionInvoiceSentStatusUpdatePaymentAction,
+            [billing_action_enum_1.BillingActionsEnum.REJECT]: transitionInvoiceSentStatusRejectAction,
+            [billing_action_enum_1.BillingActionsEnum.UPDATE]: transitionInvoiceSentStatusUpdateAction,
+            [billing_action_enum_1.BillingActionsEnum.REGENERATE]: transitionInvoiceSentStatusRegenerateAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionInvoiceSentStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT]: {
+        description: "The final invoice has been sent to the client and payment is awaited. Partial or full payments can be recorded; the invoice remains in this state until the total amount is fully settled.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.UPDATE_PAYMENT]: transitionPendingPaymentStatusUpdatePaymentAction,
+            [billing_action_enum_1.BillingActionsEnum.REJECT]: transitionPendingPaymentStatusRejectAction,
+            [billing_action_enum_1.BillingActionsEnum.UPDATE]: transitionPendingPaymentStatusUpdateAction,
+            [billing_action_enum_1.BillingActionsEnum.REGENERATE]: transitionPendingPaymentStatusRegenerateAction,
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionPendingPaymentStatusPdfViewAction,
+        },
+    },
+    [billing_status_enum_1.BillingStatusEnum.SETTLED]: {
+        description: "The invoice has been fully settled. The total amount due has been accounted for through a combination of payments, credit notes, write-offs, TDS, and refunds. No further actions are required.",
+        actions: {
+            [billing_action_enum_1.BillingActionsEnum.PDF_VIEW]: transitionSettledStatusPdfViewAction,
+        },
+    },
+};
+function getNextStatusTotalAmount(data) {
+    var _a, _b, _c, _d, _e;
+    const { currentBilling, dto } = data;
+    if (!currentBilling) {
+        throw new exceptions_1.AppBadRequestException({
+            key: error_key_enum_1.ErrorKeyEnum.BILLING,
+            message: ["Current billing entity is required"],
+        });
+    }
+    if (!dto) {
+        throw new exceptions_1.AppBadRequestException({
+            key: error_key_enum_1.ErrorKeyEnum.BILLING,
+            message: ["Current billing entity is required"],
+        });
+    }
+    if (Number(currentBilling.totalAmount) ===
+        Number((_a = dto.totalAmountPaid) !== null && _a !== void 0 ? _a : currentBilling.totalAmountPaid) +
+            Number((_b = dto.creditNoteAmount) !== null && _b !== void 0 ? _b : currentBilling.creditNoteAmount) +
+            Number((_c = dto.writeoffAmount) !== null && _c !== void 0 ? _c : currentBilling.writeoffAmount) +
+            Number((_d = dto.tdsAmount) !== null && _d !== void 0 ? _d : currentBilling.tdsAmount) -
+            Number((_e = dto.refundAmount) !== null && _e !== void 0 ? _e : currentBilling.refundAmount)) {
+        return billing_status_enum_1.BillingStatusEnum.SETTLED;
+    }
+    else {
+        return billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT;
+    }
+}

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

@@ -0,0 +1,24 @@
+import { IBillingTransactionUpdateDto } from "../../api";
+import { BillingTransactionActionEnum } from "../enums/billing_transaction_action_enum";
+import { BillingTransactionStatusEnum } from "../enums/billing_transaction_status_enum";
+import { IBillingTransactionEntity } from "../interface/billing_transaction.entity.interface";
+import { FlowConfig } from "./flow-config.type";
+export interface IBillingTransactionContextFlowData {
+    currentBillingTransactionEntity: IBillingTransactionEntity;
+    dto: IBillingTransactionUpdateDto;
+}
+/**
+ * LW-828: this used to re-declare the flow-config shape by hand. It is now an alias of the shared
+ * `FlowConfig`, which is a strict superset of the old declaration — same `permissions` and `next`, plus
+ * the optional `description` / `isApplicable` / `validActionPastThreshold` this entity does not use.
+ * Kept as a named type so every existing consumer keeps compiling unchanged.
+ */
+export type IBillingTransactionFlowConfig = FlowConfig<BillingTransactionStatusEnum, BillingTransactionActionEnum, IBillingTransactionContextFlowData>;
+/**
+ * The ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING block was commented out in the legacy config and stays
+ * commented here, converted to the new shape so reviving it is a straight uncomment. It also needs
+ * `ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING` on BillingTransactionStatusEnum, its counterpart on
+ * BillingTransactionType, the mapping line in `decideNextStatus`, and the status added to UPDATE's
+ * `reachableStatues` in ACTION_MAP.
+ */
+export declare const billingTransactionFlowConfig: IBillingTransactionFlowConfig;

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.billingTransactionFlowConfig = void 0;
+const billing_transaction_action_enum_1 = require("../enums/billing_transaction_action_enum");
+const billing_transaction_enum_1 = require("../enums/billing_transaction_enum");
+const billing_transaction_status_enum_1 = require("../enums/billing_transaction_status_enum");
+const base_flow_config_factory_1 = require("./base-flow-config.factory");
+const BILLING_TRANSACTION_UPDATE_PERMISSION = ["BILLING_TRANSACTION_UPDATE_SELF"];
+const BILLING_TRANSACTION_APPROVER_PERMISSION = ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"];
+const ACTION_MAP = {
+    [billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE]: {
+        reachableStatues: [billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED],
+        permissions: BILLING_TRANSACTION_APPROVER_PERMISSION,
+    },
+    [billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT]: {
+        reachableStatues: [billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED],
+        permissions: BILLING_TRANSACTION_APPROVER_PERMISSION,
+    },
+    /**
+     * UPDATE delegates to `decideNextStatus`, which returns one of the two approval-pending statuses when
+     * the transaction type changes, and otherwise falls back to `currentBillingTransactionEntity.status`.
+     * That identity branch can yield any status the row already holds, so the honest reachable set is the
+     * full enum rather than just the two mapped targets.
+     */
+    [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: {
+        reachableStatues: [
+            billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED,
+            billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED,
+            billing_transaction_status_enum_1.BillingTransactionStatusEnum.WRITEOFF_APPROVAL_PENDING,
+            billing_transaction_status_enum_1.BillingTransactionStatusEnum.CREDITNOTE_APPROVAL_PENDING,
+        ],
+        permissions: BILLING_TRANSACTION_UPDATE_PERMISSION,
+    },
+};
+const { createActionConfig } = (0, base_flow_config_factory_1.createFlowConfigFactory)()(ACTION_MAP);
+// APPROVED status transitions
+const transitionApprovedStatusUpdateAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE, (data) => decideNextStatus(data));
+// WRITEOFF_APPROVAL_PENDING status transitions
+const transitionWriteoffApprovalPendingStatusApproveAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE, billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED);
+const transitionWriteoffApprovalPendingStatusRejectAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT, billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED);
+const transitionWriteoffApprovalPendingStatusUpdateAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE, (data) => decideNextStatus(data));
+// CREDITNOTE_APPROVAL_PENDING status transitions
+const transitionCreditnoteApprovalPendingStatusApproveAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE, billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED);
+const transitionCreditnoteApprovalPendingStatusRejectAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT, billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED);
+const transitionCreditnoteApprovalPendingStatusUpdateAction = createActionConfig(billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE, (data) => decideNextStatus(data));
+/**
+ * The ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING block was commented out in the legacy config and stays
+ * commented here, converted to the new shape so reviving it is a straight uncomment. It also needs
+ * `ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING` on BillingTransactionStatusEnum, its counterpart on
+ * BillingTransactionType, the mapping line in `decideNextStatus`, and the status added to UPDATE's
+ * `reachableStatues` in ACTION_MAP.
+ */
+// const transitionAdjustAgainstCreditNoteApprovalPendingStatusApproveAction = createActionConfig(
+//   BillingTransactionActionEnum.APPROVE,
+//   BillingTransactionStatusEnum.APPROVED,
+// );
+// const transitionAdjustAgainstCreditNoteApprovalPendingStatusRejectAction = createActionConfig(
+//   BillingTransactionActionEnum.REJECT,
+//   BillingTransactionStatusEnum.REJECTED,
+// );
+// const transitionAdjustAgainstCreditNoteApprovalPendingStatusUpdateAction = createActionConfig(
+//   BillingTransactionActionEnum.UPDATE,
+//   (data: IBillingTransactionContextFlowData) => decideNextStatus(data),
+// );
+exports.billingTransactionFlowConfig = {
+    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED]: {
+        actions: {
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: transitionApprovedStatusUpdateAction,
+        },
+    },
+    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.WRITEOFF_APPROVAL_PENDING]: {
+        actions: {
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE]: transitionWriteoffApprovalPendingStatusApproveAction,
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT]: transitionWriteoffApprovalPendingStatusRejectAction,
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: transitionWriteoffApprovalPendingStatusUpdateAction,
+        },
+    },
+    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.CREDITNOTE_APPROVAL_PENDING]: {
+        actions: {
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE]: transitionCreditnoteApprovalPendingStatusApproveAction,
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT]: transitionCreditnoteApprovalPendingStatusRejectAction,
+            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: transitionCreditnoteApprovalPendingStatusUpdateAction,
+        },
+    },
+    // [BillingTransactionStatusEnum.ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING]: {
+    //   actions: {
+    //     [BillingTransactionActionEnum.APPROVE]: transitionAdjustAgainstCreditNoteApprovalPendingStatusApproveAction,
+    //     [BillingTransactionActionEnum.REJECT]: transitionAdjustAgainstCreditNoteApprovalPendingStatusRejectAction,
+    //     [BillingTransactionActionEnum.UPDATE]: transitionAdjustAgainstCreditNoteApprovalPendingStatusUpdateAction,
+    //   },
+    // },
+};
+function decideNextStatus(data) {
+    var _a;
+    const { currentBillingTransactionEntity, dto } = data;
+    const typeStatusMapping = {
+        [billing_transaction_enum_1.BillingTransactionType.WRITE_OFF]: billing_transaction_status_enum_1.BillingTransactionStatusEnum.WRITEOFF_APPROVAL_PENDING,
+        [billing_transaction_enum_1.BillingTransactionType.CREDIT_NOTE]: billing_transaction_status_enum_1.BillingTransactionStatusEnum.CREDITNOTE_APPROVAL_PENDING,
+        // [BillingTransactionType.ADJUST_AGAINST_CREDIT_NOTE]: BillingTransactionStatusEnum.ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING,
+    };
+    if (currentBillingTransactionEntity.type === dto.type) {
+        return currentBillingTransactionEntity.status;
+    }
+    else {
+        if (dto.type && dto.type in typeStatusMapping) {
+            return (_a = typeStatusMapping[dto.type]) !== null && _a !== void 0 ? _a : currentBillingTransactionEntity.status;
+        }
+        // otherwise → retain current status
+        return currentBillingTransactionEntity.status;
+    }
+}

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

@@ -62,6 +62,20 @@ export interface IFlowConfigActionConfig<STATUS_ENUM_TYPE extends string, CONTEX
     permissions: string[];
     next: (data: CONTEXT_DATA_TYPE) => STATUS_ENUM_TYPE;
     description?: string;
+    /**
+     * Optional runtime guard. When present, the flow consumer evaluates it against the same
+     * context data as `next()` and refuses the action when it returns false. Distinct from
+     * `permissions`, which gate *who* may act; this gates *whether the action applies at all*
+     * to the row in its current state.
+     */
+    isApplicable?: (data: CONTEXT_DATA_TYPE) => boolean;
+    /**
+     * Optional flag read by consumers that enforce a data-entry threshold: whether this action
+     * stays available once the row is older than that threshold. Absent means "yes" — consumers
+     * read it as `validActionPastThreshold ?? true`. It is a plain boolean rather than a
+     * function so it survives serialisation to clients that receive the flow config over HTTP.
+     */
+    validActionPastThreshold?: boolean;
 }
 export type ParentChildFlowConfig<S extends string, A extends string, CS extends string = never, CA extends string = never, T extends Record<any, any> = never> = {
     parent: FlowConfig<S, A, T>;

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

@@ -12,4 +12,11 @@ export type ILeaveFlowContextData = {
     dto?: ILeaveUpdateDto;
 };
 export type ILeaveFlowConfig = FlowConfig<LeaveStatusEnum, LeaveActionEnum, never>;
+/**
+ * The commented-out entries below are kept verbatim from the legacy config, in the old inline
+ * `{ permissions, next }` shape, rather than converted. There are eight of them across five status
+ * blocks plus two whole commented status blocks (DELETED, REJECTED); rewriting all of them would add
+ * a lot of dead consts for transitions nobody has decided to revive. Reviving any of them means
+ * writing a `transition…Action` const and, for READ, giving it a real reachable set in ACTION_MAP.
+ */
 export declare const leaveFlowConfig: FlowConfig<LeaveStatusEnum, LeaveActionEnum, ILeaveFlowConfigContextData>;