law-common 11.0.0 → 11.0.1-beta.0

package/README.md

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

package/dist/src/entities/enums/billing-transaction-status.enum.d.ts

@@ -2,5 +2,6 @@ export declare enum BillingTransactionStatusEnum {
     APPROVED = "approved",
     REJECTED = "rejected",
     WRITEOFF_APPROVAL_PENDING = "writeoff_approval_pending",
-    CREDITNOTE_APPROVAL_PENDING = "creditnote_approval_pending"
+    CREDITNOTE_APPROVAL_PENDING = "creditnote_approval_pending",
+    ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING = "adjust_against_credit_note_approval_pending"
 }

package/dist/src/entities/enums/billing-transaction-status.enum.js

@@ -7,4 +7,5 @@ var BillingTransactionStatusEnum;
     BillingTransactionStatusEnum["REJECTED"] = "rejected";
     BillingTransactionStatusEnum["WRITEOFF_APPROVAL_PENDING"] = "writeoff_approval_pending";
     BillingTransactionStatusEnum["CREDITNOTE_APPROVAL_PENDING"] = "creditnote_approval_pending";
+    BillingTransactionStatusEnum["ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING"] = "adjust_against_credit_note_approval_pending";
 })(BillingTransactionStatusEnum || (exports.BillingTransactionStatusEnum = BillingTransactionStatusEnum = {}));

package/dist/src/entities/enums/billing.transaction.enum.d.ts

@@ -3,7 +3,8 @@ export declare enum BillingTransactionType {
     WRITE_OFF = "WRITE_OFF",
     CREDIT_NOTE = "CREDIT_NOTE",
     RECEIPT = "RECEIPT",
-    REFUND = "REFUND"
+    REFUND = "REFUND",
+    ADJUST_AGAINST_CREDIT_NOTE = "ADJUST_AGAINST_CREDIT_NOTE"
 }
 export declare namespace BillingTransactionType {
     function getNames(): string[];

package/dist/src/entities/enums/billing.transaction.enum.js

@@ -10,6 +10,7 @@ var BillingTransactionType;
     BillingTransactionType["CREDIT_NOTE"] = "CREDIT_NOTE";
     BillingTransactionType["RECEIPT"] = "RECEIPT";
     BillingTransactionType["REFUND"] = "REFUND";
+    BillingTransactionType["ADJUST_AGAINST_CREDIT_NOTE"] = "ADJUST_AGAINST_CREDIT_NOTE";
 })(BillingTransactionType || (exports.BillingTransactionType = BillingTransactionType = {}));
 (function (BillingTransactionType) {
     function getNames() {

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

@@ -45,6 +45,22 @@ exports.billingTransactionFlowConfig = {
             },
         },
     },
+    [billing_transaction_status_enum_1.BillingTransactionStatusEnum.ADJUST_AGAINST_CREDIT_NOTE_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.EDIT]: {
+                permissions: ["BILLING_TRANSACTION_UPDATE_SELF"],
+                next: (data) => decideNextStatus(data),
+            },
+        },
+    },
 };
 function decideNextStatus(data) {
     var _a;
@@ -52,6 +68,7 @@ function decideNextStatus(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,
+        [billing_transaction_enum_1.BillingTransactionType.ADJUST_AGAINST_CREDIT_NOTE]: billing_transaction_status_enum_1.BillingTransactionStatusEnum.ADJUST_AGAINST_CREDIT_NOTE_APPROVAL_PENDING,
     };
     if (currentBillingTransactionEntity.type === dto.type) {
         return currentBillingTransactionEntity.status;

package/dist/src/entities/interface/billing_transaction.entity.interface.d.ts

@@ -1,7 +1,7 @@
 import { BillingTransactionStatusEnum } from "../enums/billing-transaction-status.enum";
 import { BillingTransactionType } from "../enums/billing.transaction.enum";
 import { IEntityAuditColumn } from "./entity-audit-columns.interface";
-import { IEntityFilterData } from "./entity.utils.interface";
+import { IEntityFilterData, Nullable } from "./entity.utils.interface";
 export interface IBillingTransactionEntity extends IEntityAuditColumn {
     id: number;
     billingId: number;
@@ -12,7 +12,7 @@ export interface IBillingTransactionEntity extends IEntityAuditColumn {
     bankCharges?: number;
     bankId?: number;
     paymentDate?: string;
-    referenceNo?: string;
+    referenceNo?: Nullable<string>;
     supportingDocsUrls?: string;
     status: BillingTransactionStatusEnum;
 }

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

@@ -47,10 +47,10 @@ class BaseEntityModel {
                     }
                 }
                 if (foundRelatedEntities.length > 1) {
-                    throw new Error(`Expected one related entity for ${relationConfig.name} but found ${foundRelatedEntities.length}`);
+                    throw new Error(`[populateRelationsByIndex]. Entity ${this.entityName} - Expected one related entity for ${relationConfig.name} but found ${foundRelatedEntities.length}`);
                 }
                 if (foundRelatedEntities.length === 0) {
-                    console.warn(`No related entity found for ${relationConfig.name} with ${thisMappingKey}=${this[relationConfig.mapKeyConfig.foreignKey]}`);
+                    console.warn(`[populateRelationsByIndex]. Entity ${this.entityName} - No related entity found for ${relationConfig.name} with ${thisMappingKey}=${this[relationConfig.mapKeyConfig.foreignKey]}`);
                 }
                 this[thisKey] = foundRelatedEntities[0];
             }

package/dist/src/entities/model/billing-transaction.model.d.ts

@@ -1,7 +1,8 @@
+import { CurrencyEnum } from "../../enums";
 import { BillingTransactionStatusEnum } from "../enums/billing-transaction-status.enum";
 import { BillingTransactionType } from "../enums/billing.transaction.enum";
 import { IBillingTransactionEntity } from "../interface/billing_transaction.entity.interface";
-import { EntityEnum } from "../interface/entity.utils.interface";
+import { EntityEnum, Nullable } from "../interface/entity.utils.interface";
 import { RelationConfigs } from "../interface/relation-config.interface";
 import { BankEntityModel } from "./bank.entity.model";
 import { BaseEntityModel } from "./base.entity.model";
@@ -17,7 +18,7 @@ export declare class BillingTransactionEntityModel extends BaseEntityModel<Entit
     bankCharges?: number;
     bankId?: number;
     paymentDate?: string;
-    referenceNo?: string;
+    referenceNo?: Nullable<string>;
     supportingDocsUrls?: string;
     status: BillingTransactionStatusEnum;
     createdOn: number;
@@ -32,4 +33,8 @@ export declare class BillingTransactionEntityModel extends BaseEntityModel<Entit
     static relationConfigs: RelationConfigs<[EntityEnum.USER, EntityEnum.USER, EntityEnum.BANK, EntityEnum.BILLING], EntityEnum.BILLING_TRANSACTION>;
     static fromEntity(entity: IBillingTransactionEntity): BillingTransactionEntityModel;
     static sumAmounts(transactions: BillingTransactionEntityModel[]): number;
+    get isForeignCurrencyTransaction(): boolean;
+    get transactionCurrency(): CurrencyEnum;
+    getFileName(): string;
+    get isBillingSettled(): boolean;
 }

package/dist/src/entities/model/billing-transaction.model.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BillingTransactionEntityModel = void 0;
 const utils_1 = require("../../utils");
 const billing_transaction_status_enum_1 = require("../enums/billing-transaction-status.enum");
+const billing_status_enum_1 = require("../enums/billing.status.enum");
 const billing_transaction_enum_1 = require("../enums/billing.transaction.enum");
 const relation_type_enum_1 = require("../enums/relation-type.enum");
 const entity_utils_interface_1 = require("../interface/entity.utils.interface");
@@ -40,6 +41,26 @@ class BillingTransactionEntityModel extends base_entity_model_1.BaseEntityModel
             });
         }), "amount");
     }
+    get isForeignCurrencyTransaction() {
+        var _a, _b;
+        return (_b = (_a = this.billing) === null || _a === void 0 ? void 0 : _a.isForeignBilling) !== null && _b !== void 0 ? _b : false;
+    }
+    get transactionCurrency() {
+        var _a, _b;
+        return (_b = (_a = this.billing) === null || _a === void 0 ? void 0 : _a.currency) !== null && _b !== void 0 ? _b : "";
+    }
+    getFileName() {
+        var _a, _b, _c, _d, _e, _f;
+        const { dateCode, timeCode } = utils_1.DateCodeModel.getCurrentISTDateTimeCode();
+        const invoiceNo = (_b = (_a = this.billing) === null || _a === void 0 ? void 0 : _a.invoiceNumber) !== null && _b !== void 0 ? _b : "";
+        const clientName = ((_d = (_c = this.billing) === null || _c === void 0 ? void 0 : _c.clientName) !== null && _d !== void 0 ? _d : "").replace(/ /g, "_");
+        const projectName = ((_f = (_e = this.billing) === null || _e === void 0 ? void 0 : _e.projectName) !== null && _f !== void 0 ? _f : "").replace(/ /g, "_");
+        return `${this.type}_${invoiceNo}_${clientName}_${projectName}_${dateCode}_${timeCode}`;
+    }
+    get isBillingSettled() {
+        var _a;
+        return ((_a = this.billing) === null || _a === void 0 ? void 0 : _a.status) === billing_status_enum_1.BillingStatusEnum.SETTLED;
+    }
 }
 exports.BillingTransactionEntityModel = BillingTransactionEntityModel;
 BillingTransactionEntityModel.relationConfigs = [

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

@@ -8,6 +8,7 @@ import { BillingTypeEnum } from "../enums/billing-type.enum";
 import { BillingActionsEnum } from "../enums/billing.action.enum";
 import { BillingStatusEnum } from "../enums/billing.status.enum";
 import { BillingInvoiceTypeEnum } from "../enums/billing_invoice_type.enum";
+import { BillingProfileCode } from "../enums/billing_profile_code.enum";
 import { BillingInvoiceNumberPrefixEnum } from "../enums/invoice-number-prefix.enum";
 import { PaymentStatusEnum } from "../enums/payment_status.enum";
 import { IBillingEntity } from "../interface/billing.entity.interface";
@@ -156,4 +157,7 @@ export declare class BillingEntityModel extends BaseEntityModel<EntityEnum.BILLI
     get isForeignCurrencyProject(): boolean;
     get isProformaInvoice(): boolean;
     get title(): BillingTemplateTitle;
+    get billingProfileName(): string;
+    get billingProfileCode(): BillingProfileCode;
+    get poNumber(): Nullable<string>;
 }

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

@@ -12,6 +12,8 @@ const billing_type_enum_1 = require("../enums/billing-type.enum");
 const billing_status_enum_1 = require("../enums/billing.status.enum");
 const billing_transaction_enum_1 = require("../enums/billing.transaction.enum");
 const billing_invoice_type_enum_1 = require("../enums/billing_invoice_type.enum");
+const billing_profile_enum_1 = require("../enums/billing_profile.enum");
+const billing_profile_code_enum_1 = require("../enums/billing_profile_code.enum");
 const invoice_number_prefix_enum_1 = require("../enums/invoice-number-prefix.enum");
 const payment_status_enum_1 = require("../enums/payment_status.enum");
 const relation_type_enum_1 = require("../enums/relation-type.enum");
@@ -451,6 +453,15 @@ class BillingEntityModel extends base_entity_model_1.BaseEntityModel {
                 ? constants_1.BillingTemplateTitle.DRAFT_INVOICE
                 : constants_1.BillingTemplateTitle.INVOICE;
     }
+    get billingProfileName() {
+        return this.billingProfileParticulars.name;
+    }
+    get billingProfileCode() {
+        return this.billingProfileName === billing_profile_enum_1.BillingProfileName.AGRAM_LEGAL_CONSULTANTS ? billing_profile_code_enum_1.BillingProfileCode.ALC : billing_profile_code_enum_1.BillingProfileCode.ALP;
+    }
+    get poNumber() {
+        return this.billingProfileParticulars.poNumber;
+    }
 }
 exports.BillingEntityModel = BillingEntityModel;
 BillingEntityModel.BILLING_ENTITY_DOCUMENT_TYPES = ["invoice"];

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

@@ -71,4 +71,10 @@ export declare class ClientEntityModel extends BaseEntityModel<EntityEnum.CLIENT
      *          - Err with validation errors if any rule is violated
      */
     static validateDocumentNoDocumentFile(data: DocumentFields<typeof ClientEntityModel.CLIENT_ENTITY_DOCUMENT_TYPES>, deleteDetails?: DeleteDocumentDetails<typeof ClientEntityModel.CLIENT_ENTITY_DOCUMENT_TYPES>): Result<void, IDtoValidationError[]>;
+    get gstNo(): string;
+    private get parsedAddress();
+    get addressLineOne(): string;
+    get addressLineTwo(): string;
+    get city(): string;
+    get state(): string;
 }

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

@@ -74,6 +74,36 @@ class ClientEntityModel extends base_entity_model_1.BaseEntityModel {
     static validateDocumentNoDocumentFile(data, deleteDetails) {
         return (0, document_validate_util_1.validateDocumentPairs)(ClientEntityModel.CLIENT_ENTITY_DOCUMENT_TYPES, data, deleteDetails);
     }
+    get gstNo() {
+        var _a;
+        return (_a = this.gstNumber) !== null && _a !== void 0 ? _a : "";
+    }
+    get parsedAddress() {
+        if (!this.address)
+            return null;
+        try {
+            return JSON.parse(this.address);
+        }
+        catch (_a) {
+            return null;
+        }
+    }
+    get addressLineOne() {
+        var _a, _b;
+        return (_b = (_a = this.parsedAddress) === null || _a === void 0 ? void 0 : _a.addressLine1) !== null && _b !== void 0 ? _b : "";
+    }
+    get addressLineTwo() {
+        var _a, _b;
+        return (_b = (_a = this.parsedAddress) === null || _a === void 0 ? void 0 : _a.addressLine2) !== null && _b !== void 0 ? _b : "";
+    }
+    get city() {
+        var _a, _b;
+        return (_b = (_a = this.parsedAddress) === null || _a === void 0 ? void 0 : _a.city) !== null && _b !== void 0 ? _b : "";
+    }
+    get state() {
+        var _a, _b;
+        return (_b = (_a = this.parsedAddress) === null || _a === void 0 ? void 0 : _a.state) !== null && _b !== void 0 ? _b : "";
+    }
 }
 exports.ClientEntityModel = ClientEntityModel;
 ClientEntityModel.CLIENT_ENTITY_DOCUMENT_TYPES = ["pan", "tan", "gst"];

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

@@ -45,4 +45,6 @@ export declare class ProjectEntityModel extends BaseEntityModel<EntityEnum.PROJE
     isAdhocProject(): boolean;
     get partnersOwnerUsersOfProject(): UserEntityModel[];
     get clientName(): string;
+    get clientGSTNumber(): string;
+    get clientVendorCode(): string;
 }

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

@@ -112,6 +112,13 @@ class ProjectEntityModel extends base_entity_model_1.BaseEntityModel {
     get clientName() {
         return this.client.name;
     }
+    get clientGSTNumber() {
+        return this.client.gstNo;
+    }
+    get clientVendorCode() {
+        var _a;
+        return (_a = this.client.vendorCode) !== null && _a !== void 0 ? _a : "";
+    }
 }
 exports.ProjectEntityModel = ProjectEntityModel;
 ProjectEntityModel.relationConfigs = [

package/dist/src/index.js

@@ -15,23 +15,13 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-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 __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 __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): {
-    [propertyName]: any;
+    [x: string]: 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<{
-    [propertyName]: any;
+    [x: string]: any;
 }>;
 export declare function getPropertyFilterByPermissionFn<T extends EnumEntityType<EntityEnum>>(permissionFilterConfig: {
     [key: string]: () => Promise<IEntityFilterData<T>>;

package/dist/src/utils/models/date-code.model.util.d.ts

@@ -88,4 +88,8 @@ export declare class DateCodeModel {
         max: string | null;
     };
     toStringFormat(dateFormat: string): string;
+    static getCurrentISTDateTimeCode(): {
+        dateCode: string;
+        timeCode: string;
+    };
 }

package/dist/src/utils/models/date-code.model.util.js

@@ -372,5 +372,14 @@ class DateCodeModel {
     toStringFormat(dateFormat) {
         return (0, date_fns_1.format)(this.getDate(), dateFormat);
     }
+    static getCurrentISTDateTimeCode() {
+        const now = new Date();
+        const istOffsetMs = 5.5 * 60 * 60 * 1000;
+        const nowIST = new Date(now.getTime() + istOffsetMs);
+        return {
+            dateCode: (0, date_fns_1.format)(nowIST, "ddMMyyyy"),
+            timeCode: (0, date_fns_1.format)(nowIST, "HHmmss"),
+        };
+    }
 }
 exports.DateCodeModel = DateCodeModel;

package/package.json

@@ -1,42 +1,42 @@
-{
-  "name": "law-common",
-  "version": "11.0.0",
-  "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",
-    "check-version": "npm view law-common versions --json | jq -r '.[-1]'"
-  },
-  "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": "11.0.1-beta.0",
+  "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",
+    "check-version": "npm view law-common versions --json | jq -r '.[-1]'"
+  },
+  "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"
+  }
+}