law-common 10.72.3 → 10.72.4

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, BillingStatusEnum, IBillingEntity, IBillingReimbursementExpenseEntity, IBillingTimesheetEntity, IProjectEntity, IUserEntity } from "../../entities";
+import { BillingActionsEnum, BillingEntityModel, BillingStatusEnum, EntityModelRelationHelper, IBillingEntity, IBillingProfileEntity, IBillingReimbursementExpenseEntity, IBillingTimesheetEntity, IDesignationEntity, IProjectEntity, IUserEntity } from "../../entities";
 import { IUpdateBillingDto } from "./billing.update.dto.interface";
 export type IBillingEntityResponse = {
     billing: IBillingEntity;
@@ -31,3 +31,10 @@ export type IBillingFlowContextData = {
     currentBilling?: IBillingEntity;
     dto?: IUpdateBillingDto;
 };
+export interface IBillingExportContext {
+    currentUser: IUserEntity;
+    billingEntity: BillingEntityModel;
+    billingEntityModelRelationHelper: EntityModelRelationHelper;
+    billingProfileEntity: IBillingProfileEntity[];
+    designationEntites: IDesignationEntity[];
+}

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

@@ -2,3 +2,4 @@ export declare const billingPrefixCompanyName = "ALC";
 export declare const billingSequenceSeperator = "-";
 export declare const billingSequenceSeperatorForCurrentFy = "/";
 export declare const currentFY = "2526";
+export declare const PROHIBITED_CHARS = "\\ / : * ? \" < > | . , ; = # % & { } $ ! ' @ ` ~ ^ [ ] ( ) +";

package/dist/src/constants/billing_constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.currentFY = exports.billingSequenceSeperatorForCurrentFy = exports.billingSequenceSeperator = exports.billingPrefixCompanyName = void 0;
+exports.PROHIBITED_CHARS = exports.currentFY = exports.billingSequenceSeperatorForCurrentFy = exports.billingSequenceSeperator = exports.billingPrefixCompanyName = void 0;
 exports.billingPrefixCompanyName = "ALC";
 exports.billingSequenceSeperator = "-";
 exports.billingSequenceSeperatorForCurrentFy = "/";
 exports.currentFY = "2526";
+exports.PROHIBITED_CHARS = `\\ / : * ? " < > | . , ; = # % & { } $ ! ' @ \` ~ ^ [ ] ( ) +`;

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

@@ -70,7 +70,6 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
     static validateDocumentNoDocumentFile(data: DocumentFields<typeof BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES>, deleteDetails?: DeleteDocumentDetails<typeof BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES>): Result<void, IDtoValidationError[]>;
     get intermediaryBanks(): import("./intermediary-bank.entity.model").IntermediaryBankEntityModel[] | undefined;
     get reimbursements(): ReimbursementEntityModel[];
-    get summarryFolderName(): string;
     static relationConfigs: RelationConfigs<[
         EntityEnum.PROJECT,
         EntityEnum.CLIENT,
@@ -133,7 +132,18 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
         latestBilling?: IBillingEntity;
     }): string;
     getBillingTimesheetUserIds(): number[];
-    get invoiceFileName(): "Proforma Invoice.pdf" | "Draft Invoice.pdf" | "Invoice.pdf";
-    get timesheetSummarryFileName(): string;
-    get OPESummarryFileName(): string;
+    getTimestamp(): string;
+    invoiceFileName(timestamp: string): string;
+    timesheetSummarryFileName(timestamp: string): string;
+    OPESummarryFileName(timestamp: string): string;
+    getFileNames(timestamp: string): {
+        invoiceFileName: string;
+        timesheetSummaryFileName: string;
+        opeSummaryFileName: string;
+    };
+    get billingPhase(): string;
+    get clientName(): string;
+    get projectName(): string;
+    getActiveBillingTransactions(): BillingTransactionEntityModel[] | undefined;
+    hasActiveTranansactions(): boolean | undefined;
 }

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

@@ -61,28 +61,6 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
         var _a, _b;
         return (_b = (_a = this.reimbursementExpenses) === null || _a === void 0 ? void 0 : _a.map((expense) => expense.reimbursement).filter(utils_1.isDefined)) !== null && _b !== void 0 ? _b : [];
     }
-    get summarryFolderName() {
-        //     Folder Name
-        // <Invoice | Proforma Invoice | Draft Invoice> - <InvoiceNo | ProjectName> - YYMMDD HHMM
-        // File
-        // Proforma Invoice | Invoice | Draft Invoice.pdf
-        // Timesheet.pdf
-        // OPE.pdf
-        var _a, _b, _c;
-        const timestamp = utils_1.DateCodeModel.getCurrentTimestampCode();
-        let prefix;
-        if (this.type === billing_type_enum_1.BillingTypeEnum.ADVANCE) {
-            prefix = "Proforma Invoice";
-        }
-        else if (!this.invoiceNumber) {
-            prefix = "Draft Invoice";
-        }
-        else {
-            prefix = "Invoice";
-        }
-        const identifier = (_c = (_a = this.invoiceNumber) !== null && _a !== void 0 ? _a : (_b = this.project) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : "";
-        return `${prefix} - ${identifier} - ${timestamp}`;
-    }
     static fromEntity(entity) {
         const result = new BillingEntityModel(entity_utils_interface_1.EntityEnum.BILLING);
         Object.assign(result, entity);
@@ -388,26 +366,54 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
         var _a, _b;
         return (_b = (_a = this.billingTimesheets) === null || _a === void 0 ? void 0 : _a.map((timesheet) => timesheet.userId)) !== null && _b !== void 0 ? _b : [];
     }
-    get invoiceFileName() {
-        // File
-        // Proforma Invoice | Invoice | Draft Invoice.pdf
-        // Timesheet.pdf
-        // OPE.pdf
+    getTimestamp() {
+        const now = new Date();
+        const ist = new Date(now.getTime() + 5.5 * 60 * 60 * 1000);
+        return (`${String(ist.getDate()).padStart(2, "0")}${String(ist.getMonth() + 1).padStart(2, "0")}${ist.getFullYear()}` +
+            `_${String(ist.getHours()).padStart(2, "0")}${String(ist.getMinutes()).padStart(2, "0")}${String(ist.getSeconds()).padStart(2, "0")}`);
+    }
+    // summarryFolderName(timestamp: string): string {
+    //   return `${this.billingPhase}_${this.clientName}_${this.projectName} _ ${timestamp}`;
+    // }
+    invoiceFileName(timestamp) {
+        return `${this.billingPhase}_Invoice_${this.clientName}_${this.projectName}_${timestamp}.pdf`;
+    }
+    timesheetSummarryFileName(timestamp) {
+        return `${this.billingPhase}_Timesheet_Summary_${this.clientName}_${this.projectName}_${timestamp}.pdf`;
+    }
+    OPESummarryFileName(timestamp) {
+        return `${this.billingPhase}_OPE_${this.clientName}_${this.projectName}_${timestamp}.pdf`;
+    }
+    getFileNames(timestamp) {
+        return {
+            invoiceFileName: this.invoiceFileName(timestamp),
+            timesheetSummaryFileName: this.timesheetSummarryFileName(timestamp),
+            opeSummaryFileName: this.OPESummarryFileName(timestamp),
+        };
+    }
+    get billingPhase() {
         if (this.type === billing_type_enum_1.BillingTypeEnum.ADVANCE) {
-            return "Proforma Invoice.pdf";
-        }
-        else if (!this.invoiceNumber) {
-            return "Draft Invoice.pdf";
+            return "Proforma";
         }
         else {
-            return "Invoice.pdf";
+            return this.invoiceNumber ? "Final" : "Draft";
         }
     }
-    get timesheetSummarryFileName() {
-        return "Timesheet.pdf";
+    get clientName() {
+        var _a, _b;
+        return (0, utils_1.sanitizeName)((_b = (_a = this.client) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : "");
+    }
+    get projectName() {
+        var _a, _b;
+        return (0, utils_1.sanitizeName)((_b = (_a = this.project) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : "");
+    }
+    getActiveBillingTransactions() {
+        var _a;
+        return (_a = this.billingTransactions) === null || _a === void 0 ? void 0 : _a.filter((transaction) => transaction.status !== billing_transaction_status_enum_1.BillingTransactionStatusEnum.REJECTED);
     }
-    get OPESummarryFileName() {
-        return "OPE.pdf";
+    hasActiveTranansactions() {
+        const billTransactions = this.getActiveBillingTransactions();
+        return billTransactions && billTransactions.length > 0;
     }
 }
 exports.BillingEntityModel = BillingEntityModel;

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

@@ -442,3 +442,4 @@ export declare function removeDuplicatesByKey<T, K extends keyof T>(items: T[],
  * Preserves the exact type of the key (string[] or number[]).
  */
 export declare function getUniqueValuesByKey<T, K extends keyof T>(items: T[], key: K): T[K][];
+export declare function sanitizeName(name: string): string;

package/dist/src/utils/helper.fn.util.js

@@ -48,8 +48,10 @@ exports.sumNormalised = sumNormalised;
 exports.isDefined = isDefined;
 exports.removeDuplicatesByKey = removeDuplicatesByKey;
 exports.getUniqueValuesByKey = getUniqueValuesByKey;
+exports.sanitizeName = sanitizeName;
 const date_fns_1 = require("date-fns");
 const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
 const util_constants_1 = require("../constants/util.constants");
 const error_key_enum_1 = require("../enums/error.key.enum");
 const exceptions_1 = require("../exceptions");
@@ -810,3 +812,6 @@ function removeDuplicatesByKey(items, key) {
 function getUniqueValuesByKey(items, key) {
     return [...new Set(items.map((item) => item[key]))];
 }
+function sanitizeName(name) {
+    return name.replace(constants_1.PROHIBITED_CHARS, " ").replace(/\s+/g, " ").trim();
+}

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "law-common",
-  "version": "10.72.3",
-  "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.4",
+  "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"
+  }
+}