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

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

@@ -1,209 +0,0 @@
-"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");
-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]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.INTERNAL_APPROVED,
-                description: "Internal Approved state signifies that the Proforma Invoice has been reviewed and verified by internal stakeholders.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REJECT]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CANCELLED,
-                description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.UPDATE]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL,
-                description: "Allows stakeholders to edit the Proforma Invoice while keeping it in Pending Approval status.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
-                description: "Stakeholders have requested changes before approving the Proforma Invoice.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
-                description: "Allows modification of the Proforma Invoice based on stakeholder feedback.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.SENT_FOR_APPROVAL]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.PENDING_APPROVAL,
-                description: "Resubmits the updated Proforma Invoice for stakeholder approval.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.PENDING_CLIENT_REVIEW,
-                description: "Invoice has been internally approved and is sent to the client for review.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL,
-                description: "Client has requested revisions to the Proforma Invoice.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.SEND_INVOICE]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT,
-                description: "Final invoice has been shared with the client and payment is awaited.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
-                description: "Client revision has been reviewed and approved for further amendments.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REJECT]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.REJECT_CLIENT_REVISION,
-                description: "Client revision request has been rejected by stakeholders.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.UPDATE]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL,
-                description: "Allows editing while client revision approval is in progress.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REQUEST_FOR_CHANGES]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.REQUEST_CHANGES,
-                description: "Requests additional changes before approving the client revision.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: () => billing_status_enum_1.BillingStatusEnum.INVOICE_SENT,
-                description: "Invoice has been sent despite client revision rejection.",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: (data) => {
-                    return data ? getNextStatusTotalAmount(data) : billing_status_enum_1.BillingStatusEnum.INVOICE_SENT;
-                },
-                description: "Updates received payment details and recalculates outstanding amount.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REJECT]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CANCELLED,
-                description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.UPDATE]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.INVOICE_SENT,
-                description: "Allows stakeholders to edit the invoice while keeping it in Invoice Sent status.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REGENERATE]: {
-                permissions: ["BILLING_UPDATE"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CANCELLED,
-                description: "Regenerates the billing by cancelling the current one and creating a replacement",
-            },
-        },
-    },
-    [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]: {
-                permissions: ["BILLING_AMENDMENT_ORG"],
-                next: (data) => {
-                    return data ? getNextStatusTotalAmount(data) : billing_status_enum_1.BillingStatusEnum.PENDING_PAYMENT;
-                },
-                description: "Tracks partial or full payments until the invoice is completely settled.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REJECT]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CANCELLED,
-                description: "Rejected state indicates that the Proforma Invoice was not approved and has been cancelled.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.UPDATE]: {
-                permissions: ["BILLING_APPROVER_ORG", "BILLING_APPROVER_PROJECT"],
-                next: () => billing_status_enum_1.BillingStatusEnum.INVOICE_SENT,
-                description: "Allows stakeholders to edit the invoice while keeping it in Invoice Sent status.",
-            },
-            [billing_action_enum_1.BillingActionsEnum.REGENERATE]: {
-                permissions: ["BILLING_UPDATE"],
-                next: () => billing_status_enum_1.BillingStatusEnum.CANCELLED,
-                description: "Regenerates the billing by cancelling the current one and creating a replacement",
-            },
-        },
-    },
-    [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: {},
-    },
-};
-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;
-    }
-}
-exports.billingFlowConfig = addPdfViewToAllStatuses(exports.billingFlowConfig);
-function addPdfViewToAllStatuses(config) {
-    const PDF_VIEW_ACTION = billing_action_enum_1.BillingActionsEnum.PDF_VIEW;
-    const pdfViewActionConfig = {
-        permissions: ["BILLING_VIEW_PDF"],
-    };
-    for (const [status, configEntry] of Object.entries(config)) {
-        const actions = configEntry.actions;
-        if (!actions[PDF_VIEW_ACTION]) {
-            actions[PDF_VIEW_ACTION] = Object.assign(Object.assign({}, pdfViewActionConfig), { next: (data) => status, description: "" });
-        }
-    }
-    return config;
-}

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

@@ -1,19 +0,0 @@
-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";
-export interface IBillingTransactionContextFlowData {
-    currentBillingTransactionEntity: IBillingTransactionEntity;
-    dto: IBillingTransactionUpdateDto;
-}
-export type IBillingTransactionFlowConfig = {
-    [key in BillingTransactionStatusEnum]?: {
-        actions: {
-            [key in BillingTransactionActionEnum]?: {
-                permissions: string[];
-                next: (data: IBillingTransactionContextFlowData) => BillingTransactionStatusEnum;
-            };
-        };
-    };
-};
-export declare let billingTransactionFlowConfig: IBillingTransactionFlowConfig;

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

@@ -1,83 +0,0 @@
-"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");
-exports.billingTransactionFlowConfig = {
-    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED]: {
-        actions: {
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: {
-                permissions: ["BILLING_TRANSACTION_UPDATE_SELF"],
-                next: (data) => decideNextStatus(data),
-            },
-        },
-    },
-    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.WRITEOFF_APPROVAL_PENDING]: {
-        actions: {
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE]: {
-                permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-                next: () => billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED,
-            },
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT]: {
-                permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-                next: () => billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED,
-            },
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: {
-                permissions: ["BILLING_TRANSACTION_UPDATE_SELF"],
-                next: (data) => decideNextStatus(data),
-            },
-        },
-    },
-    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.CREDITNOTE_APPROVAL_PENDING]: {
-        actions: {
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.APPROVE]: {
-                permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-                next: () => billing_transaction_status_enum_1.BillingTransactionStatusEnum.APPROVED,
-            },
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.REJECT]: {
-                permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-                next: () => billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED,
-            },
-            [billing_transaction_action_enum_1.BillingTransactionActionEnum.UPDATE]: {
-                permissions: ["BILLING_TRANSACTION_UPDATE_SELF"],
-                next: (data) => decideNextStatus(data),
-            },
-        },
-    },
-    // [BillingTransactionStatusEnum.ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING]: {
-    //   actions: {
-    //     [BillingTransactionActionEnum.APPROVE]: {
-    //       permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-    //       next: () => BillingTransactionStatusEnum.APPROVED,
-    //     },
-    //     [BillingTransactionActionEnum.REJECT]: {
-    //       permissions: ["BILLING_TRANSACTION_APPROVER_PROJECT", "BILLING_TRANSACTION_APPROVER_ORG"],
-    //       next: () => BillingTransactionStatusEnum.REJECTED,
-    //     },
-    //     [BillingTransactionActionEnum.UPDATE]: {
-    //       permissions: ["BILLING_TRANSACTION_UPDATE_SELF"],
-    //       next: (data: IBillingTransactionContextFlowData) => decideNextStatus(data),
-    //     },
-    //   },
-    // },
-};
-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;
-    }
-}