law-common 10.72.10 → 10.72.13

package/README.md

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

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

@@ -1,4 +1,4 @@
-import { BillingActionsEnum, BillingEntityModel, BillingStatusEnum, EntityModelRelationHelper, IBillingEntity, IBillingProfileEntity, IBillingReimbursementExpenseEntity, IBillingTimesheetEntity, IDesignationEntity, IProjectEntity, IUserEntity } from "../../entities";
+import { BillingActionsEnum, BillingStatusEnum, EntityModelRelationHelper, IBillingEntity, IBillingReimbursementExpenseEntity, IBillingTimesheetEntity, IProjectEntity, IUserEntity } from "../../entities";
 import { IUpdateBillingDto } from "./billing.update.dto.interface";
 export type IBillingEntityResponse = {
     billing: IBillingEntity;
@@ -33,8 +33,5 @@ export type IBillingFlowContextData = {
 };
 export interface IBillingExportContext {
     currentUser: IUserEntity;
-    billingEntity: BillingEntityModel;
     billingEntityModelRelationHelper: EntityModelRelationHelper;
-    billingProfileEntity: IBillingProfileEntity[];
-    designationEntites: IDesignationEntity[];
 }

package/dist/src/constants/billing_constants.d.ts

@@ -1,5 +1,12 @@
+import { BillingStatusEnum } from "../entities";
 export declare const billingPrefixCompanyName = "ALC";
 export declare const billingSequenceSeperator = "-";
 export declare const billingSequenceSeperatorForCurrentFy = "/";
 export declare const currentFY = "2526";
 export declare const PROHIBITED_CHARS = "\\ / : * ? \" < > | . , ; = # % & { } $ ! ' @ ` ~ ^ [ ] ( ) +";
+export declare enum BillingTemplateTitle {
+    PROFORMA_INVOICE = "PROFORMA INVOICE",
+    INVOICE = "INVOICE",
+    DRAFT_INVOICE = "DRAFT INVOICE"
+}
+export declare const proFormaInvoiceStatuses: BillingStatusEnum[];

package/dist/src/constants/billing_constants.js

@@ -1,8 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROHIBITED_CHARS = exports.currentFY = exports.billingSequenceSeperatorForCurrentFy = exports.billingSequenceSeperator = exports.billingPrefixCompanyName = void 0;
+exports.proFormaInvoiceStatuses = exports.BillingTemplateTitle = exports.PROHIBITED_CHARS = exports.currentFY = exports.billingSequenceSeperatorForCurrentFy = exports.billingSequenceSeperator = exports.billingPrefixCompanyName = void 0;
+const entities_1 = require("../entities");
 exports.billingPrefixCompanyName = "ALC";
 exports.billingSequenceSeperator = "-";
 exports.billingSequenceSeperatorForCurrentFy = "/";
 exports.currentFY = "2526";
 exports.PROHIBITED_CHARS = `\\ / : * ? " < > | . , ; = # % & { } $ ! ' @ \` ~ ^ [ ] ( ) +`;
+var BillingTemplateTitle;
+(function (BillingTemplateTitle) {
+    BillingTemplateTitle["PROFORMA_INVOICE"] = "PROFORMA INVOICE";
+    BillingTemplateTitle["INVOICE"] = "INVOICE";
+    BillingTemplateTitle["DRAFT_INVOICE"] = "DRAFT INVOICE";
+})(BillingTemplateTitle || (exports.BillingTemplateTitle = BillingTemplateTitle = {}));
+exports.proFormaInvoiceStatuses = [
+    entities_1.BillingStatusEnum.PENDING_APPROVAL,
+    entities_1.BillingStatusEnum.REQUEST_CHANGES,
+    entities_1.BillingStatusEnum.INTERNAL_APPROVED,
+    entities_1.BillingStatusEnum.PENDING_CLIENT_REVIEW,
+    entities_1.BillingStatusEnum.CLIENT_REVISION_APPROVAL,
+    entities_1.BillingStatusEnum.REJECT_CLIENT_REVISION,
+];

package/dist/src/entities/model/billing.entity.model.d.ts

@@ -1,4 +1,5 @@
-import { IBillingFlowConfig } from "../../api";
+import { IBillingFlowConfig, IBillingParticulars } from "../../api";
+import { BillingTemplateTitle } from "../../constants";
 import { CurrencyEnum } from "../../enums";
 import { IDtoValidationError, Result } from "../../misc";
 import { DeleteDocumentDetails, DocumentFields } from "../../utils";
@@ -68,6 +69,7 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
     isProjectComplete?: boolean;
     static readonly BILLING_ENTITY_DOCUMENT_TYPES: readonly ["invoice"];
     static validateDocumentNoDocumentFile(data: DocumentFields<typeof BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES>, deleteDetails?: DeleteDocumentDetails<typeof BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES>): Result<void, IDtoValidationError[]>;
+    get bankFromBillingBankId(): BankEntityModel | undefined;
     get intermediaryBanks(): import("./intermediary-bank.entity.model").IntermediaryBankEntityModel[] | undefined;
     get reimbursements(): ReimbursementEntityModel[];
     static relationConfigs: RelationConfigs<[
@@ -109,6 +111,7 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
     validateAdvanceBillingId(adjustedBillingTransactions: IBillingTransactionEntity[]): void;
     getApprovedBillingTransactionsTotalAmount(): number;
     getCurrentBillingBillingProfile(billingProfiles: BillingProfileEntityModel[]): BillingProfileEntityModel[];
+    get billingProfileParticulars(): IBillingParticulars;
     static getLatestBillingEntityModel(billingEntityModels: BillingEntityModel[]): BillingEntityModel | void;
     static getNextInvoiceNumber(params: {
         type: BillingInvoiceNumberPrefixEnum;
@@ -147,4 +150,10 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
     get projectName(): string;
     getActiveBillingTransactions(): BillingTransactionEntityModel[] | undefined;
     hasActiveTranansactions(): boolean | undefined;
+    isClientInvoice(): boolean;
+    get clientAffiliate(): import("./client-affiliate.entity.model").ClientAffiliateEntityModel | undefined;
+    get isForeignBilling(): boolean;
+    get isForeignCurrencyProject(): boolean;
+    get isProformaInvoice(): boolean;
+    get title(): BillingTemplateTitle;
 }

package/dist/src/entities/model/billing.entity.model.js

@@ -52,6 +52,10 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
     static validateDocumentNoDocumentFile(data, deleteDetails) {
         return (0, utils_1.validateDocumentPairs)(BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES, data, deleteDetails);
     }
+    get bankFromBillingBankId() {
+        var _a;
+        return (_a = this.bank) === null || _a === void 0 ? void 0 : _a.find((b) => b.id === this.bankId);
+    }
     get intermediaryBanks() {
         const thisBank = this.bank;
         if (thisBank)
@@ -260,9 +264,12 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
         return (0, utils_1.sumNormalised)((_b = (_a = this.billingTransactions) === null || _a === void 0 ? void 0 : _a.filter((entity) => ![billing_transaction_status_enum_1.BillingTransactionStatusEnum.CREDITNOTE_APPROVAL_PENDING, billing_transaction_status_enum_1.BillingTransactionStatusEnum.WRITEOFF_APPROVAL_PENDING].includes(entity.status))) !== null && _b !== void 0 ? _b : [], "amount");
     }
     getCurrentBillingBillingProfile(billingProfiles) {
-        const billingParticularsOfCurrentBilling = JSON.parse(this.particulars);
+        const billingParticularsOfCurrentBilling = this.billingProfileParticulars;
         return billingProfiles.filter((profile) => profile.name === billingParticularsOfCurrentBilling.name);
     }
+    get billingProfileParticulars() {
+        return JSON.parse(this.particulars);
+    }
     static getLatestBillingEntityModel(billingEntityModels) {
         if (billingEntityModels.length === 0)
             return;
@@ -415,6 +422,35 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
         const billTransactions = this.getActiveBillingTransactions();
         return billTransactions && billTransactions.length > 0;
     }
+    isClientInvoice() {
+        return this.invoiceEntityType === billing_invoice_type_enum_1.BillingInvoiceTypeEnum.CLIENT;
+    }
+    get clientAffiliate() {
+        var _a, _b;
+        return (_b = (_a = this.client) === null || _a === void 0 ? void 0 : _a.clientAffiliates) === null || _b === void 0 ? void 0 : _b.find((affiliate) => affiliate.id === this.invoiceEntityId);
+    }
+    get isForeignBilling() {
+        var _a;
+        if (this.isClientInvoice()) {
+            return ((_a = this.client) === null || _a === void 0 ? void 0 : _a.country) !== undefined && this.client.country !== "India";
+        }
+        const affiliate = this.clientAffiliate;
+        return (affiliate === null || affiliate === void 0 ? void 0 : affiliate.country) !== undefined && affiliate.country !== "India";
+    }
+    get isForeignCurrencyProject() {
+        var _a, _b;
+        return (_b = (_a = this.project) === null || _a === void 0 ? void 0 : _a.isForeignCurrencyProjoect()) !== null && _b !== void 0 ? _b : false;
+    }
+    get isProformaInvoice() {
+        return this.type === billing_type_enum_1.BillingTypeEnum.ADVANCE;
+    }
+    get title() {
+        return this.type === billing_type_enum_1.BillingTypeEnum.ADVANCE
+            ? constants_1.BillingTemplateTitle.PROFORMA_INVOICE
+            : constants_1.proFormaInvoiceStatuses.includes(this.status)
+                ? constants_1.BillingTemplateTitle.DRAFT_INVOICE
+                : constants_1.BillingTemplateTitle.INVOICE;
+    }
 }
 exports.BillingEntityModel = BillingEntityModel;
 BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES = ["invoice"];

package/dist/src/entities/model/project.entity.model.d.ts

@@ -36,4 +36,5 @@ export declare class ProjectEntityModel extends BaseEntityModel<EntityEnum.PROJE
     static relationConfigs: RelationConfigs<[EntityEnum.PROJECT_USER_MAPPING, EntityEnum.CLIENT], EntityEnum.PROJECT>;
     populateUsers(users: UserEntityModel[], projectUserMapping: ProjectUserMappingEntityModel[]): void;
     getRelationConfigs(): [import("../interface/relation-config.interface").IRelationConfig<EntityEnum.PROJECT_USER_MAPPING, EntityEnum.PROJECT>, import("../interface/relation-config.interface").IRelationConfig<EntityEnum.CLIENT, EntityEnum.PROJECT>];
+    isForeignCurrencyProjoect(): boolean;
 }

package/dist/src/entities/model/project.entity.model.js

@@ -86,6 +86,9 @@ class ProjectEntityModel extends base_entity_model_1.BaseEntityModel {
     getRelationConfigs() {
         return ProjectEntityModel.relationConfigs;
     }
+    isForeignCurrencyProjoect() {
+        return this.currency !== enums_1.CurrencyEnum.INR;
+    }
 }
 exports.ProjectEntityModel = ProjectEntityModel;
 ProjectEntityModel.relationConfigs = [

package/dist/src/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };

package/dist/src/utils/helper.fn.util.d.ts

@@ -149,12 +149,12 @@ export declare function getEnumNames(enumType: object): string[];
 export declare function getFilterByPermission<T extends EnumEntityType<EntityEnum>>(permissionFilterConfig: {
     [key: string]: IEntityFilterData<T>;
 }, propertyName: keyof T, userPermission: string, filterDto: IEntityFilterData<T>, emptyValue?: any): {
-    [x: string]: any;
+    [propertyName]: any;
 };
 export declare function getFilterByPermissionFn<T extends EnumEntityType<EntityEnum>>(permissionFilterConfig: {
     [key: string]: () => Promise<IEntityFilterData<T>>;
 }, propertyName: keyof T, userPermission: string, filterDto: IEntityFilterData<T>, emptyValue?: any): Promise<{
-    [x: string]: any;
+    [propertyName]: any;
 }>;
 export declare function getPropertyFilterByPermissionFn<T extends EnumEntityType<EntityEnum>>(permissionFilterConfig: {
     [key: string]: () => Promise<IEntityFilterData<T>>;

package/dist/src/utils/string.util.d.ts

@@ -3,9 +3,10 @@ export declare function formatString(input: string): string;
  * Converts a string to Title Case.
  *
  * Examples:
- *  - "APPROVE"       => "Approve"
- *  - "PENDING_REVIEW" => "Pending Review"
- *  - "in_progress"    => "In Progress"
+ *  - "APPROVE"         => "Approve"
+ *  - "PENDING_REVIEW"  => "Pending Review"
+ *  - "in_progress"     => "In Progress"
+ *  - "DRAFT INVOICE"   => "Draft Invoice"
  *
  * @param {string} input - The string to convert.
  * @returns {string} - The string in Title Case.

package/dist/src/utils/string.util.js

@@ -20,9 +20,10 @@ function formatString(input) {
  * Converts a string to Title Case.
  *
  * Examples:
- *  - "APPROVE"       => "Approve"
- *  - "PENDING_REVIEW" => "Pending Review"
- *  - "in_progress"    => "In Progress"
+ *  - "APPROVE"         => "Approve"
+ *  - "PENDING_REVIEW"  => "Pending Review"
+ *  - "in_progress"     => "In Progress"
+ *  - "DRAFT INVOICE"   => "Draft Invoice"
  *
  * @param {string} input - The string to convert.
  * @returns {string} - The string in Title Case.
@@ -30,11 +31,11 @@ function formatString(input) {
 function toTitleCase(input) {
     if (!input)
         return "";
-    // Replace underscores or hyphens with spaces, then split into words
-    const words = input.replace(/[_-]+/g, " ").split(" ");
-    // Capitalize first letter of each word
-    const titleCased = words.map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()).join(" ");
-    return titleCased;
+    return input
+        .replace(/[_-]+/g, " ")
+        .split(/\s+/) // split by one or more spaces
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+        .join(" ");
 }
 /**
  * Converts a camelCase or PascalCase string into a human-readable

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "law-common",
-  "version": "10.72.10",
-  "description": "",
-  "main": "dist/index.js",
-  "files": [
-    "dist/**/*"
-  ],
-  "scripts": {
-    "clean": "rm -rf dist",
-    "build": "npm run clean && tsc",
-    "publish:beta": "npm version prerelease --preid beta && git push && npm run build && npm publish --tag beta && npm run link",
-    "publish:patch": "npm version patch && git push && npm run build && npm publish",
-    "publish:minor": "npm version minor && git push && npm run build && npm publish",
-    "publish:major": "npm version major && git push && npm run build && npm publish",
-    "link": "npm run build && npm link",
-    "test": "jest",
-    "format": "prettier --write .",
-    "check-format": "prettier --check .",
-    "pull:link": "git pull && npm run link"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^29.5.13",
-    "@types/lodash": "^4.17.21",
-    "@types/node": "^22.6.1",
-    "jest": "^29.7.0",
-    "prettier": "3.8.1",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.6.2"
-  },
-  "dependencies": {
-    "@types/express": "^5.0.0",
-    "@types/multer": "^1.4.12",
-    "date-fns": "^4.1.0",
-    "lodash": "4.17.21"
-  }
-}
+{
+  "name": "law-common",
+  "version": "10.72.13",
+  "description": "",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc",
+    "publish:beta": "npm version prerelease --preid beta && git push && npm run build && npm publish --tag beta && npm run link",
+    "publish:patch": "npm version patch && git push && npm run build && npm publish",
+    "publish:minor": "npm version minor && git push && npm run build && npm publish",
+    "publish:major": "npm version major && git push && npm run build && npm publish",
+    "link": "npm run build && npm link",
+    "test": "jest",
+    "format": "prettier --write .",
+    "check-format": "prettier --check .",
+    "pull:link": "git pull && npm run link"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^29.5.13",
+    "@types/lodash": "^4.17.21",
+    "@types/node": "^22.6.1",
+    "jest": "^29.7.0",
+    "prettier": "3.8.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.0",
+    "@types/multer": "^1.4.12",
+    "date-fns": "^4.1.0",
+    "lodash": "4.17.21"
+  }
+}