law-common 10.26.1-beta.9 → 10.28.0

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveCountVirtualEntityModel = void 0;
+const utils_1 = require("../../utils");
+const leave_type_enum_1 = require("../enums/leave-type.enum");
+const entity_utils_interface_1 = require("../interface/entity.utils.interface");
+const base_entity_model_1 = require("./base.entity.model");
+class LeaveCountVirtualEntityModel extends base_entity_model_1.BaseEntityModel {
+    constructor() {
+        super(...arguments);
+        this.id = 0;
+        this.period = "";
+        this.count = 0;
+        this.createdBy = 0;
+        this.updatedBy = 0;
+        this.createdOn = 0;
+        this.updatedOn = 0;
+    }
+    static fromEntity(entity) {
+        const result = new LeaveCountVirtualEntityModel(entity_utils_interface_1.VirtualEntityEnum.LEAVE_COUNT);
+        Object.assign(result, entity);
+        return result;
+    }
+    getRelationConfigs() {
+        return this.constructor.prototype.constructor.relationConfigs;
+    }
+    static fromLeaveHoliday(leaveModel, holidayDateCodes) {
+        const leaveCountVirtualEntity = {
+            leaveId: leaveModel.id,
+            count: leaveModel.getLeaveDuration([utils_1.Weekday.Sunday, utils_1.Weekday.Saturday], holidayDateCodes) +
+                (leaveModel.type === leave_type_enum_1.LeaveTypeEnum.SICK &&
+                    (leaveModel.isWeekendPrecedes() ||
+                        leaveModel.isWeekendSucceeds() ||
+                        leaveModel.isHolidayPrecedes(holidayDateCodes) ||
+                        leaveModel.isHolidaySucceeds(holidayDateCodes))
+                    ? 2
+                    : 0),
+            createdBy: leaveModel.createdBy,
+            updatedBy: leaveModel.updatedBy,
+            createdOn: leaveModel.createdOn,
+            updatedOn: leaveModel.updatedOn,
+            id: leaveModel.id,
+            period: leaveModel.fromDate + leaveModel.toDate + leaveModel.durationType,
+        };
+        return LeaveCountVirtualEntityModel.fromEntity(leaveCountVirtualEntity);
+    }
+}
+exports.LeaveCountVirtualEntityModel = LeaveCountVirtualEntityModel;
+// static relationConfigs = [
+//             {
+//                 name: EntityEnum.LEAVE,
+//                 relation: RelationType.ONE,
+//                 key: 'leaveCount',
+//                 mapKeyConfig: {
+//                     relationKey: 'id',
+//                     key: 'leaveId',
+//                 },
+//             },
+//         ];
+LeaveCountVirtualEntityModel.relationConfigs = [];

package/dist/src/utils/entity.flow.util.d.ts

@@ -0,0 +1,32 @@
+import { LeaveActionEnum, LeaveStatusEnum } from "../entities";
+export type LeaveStatusActionPair = {
+    status: LeaveStatusEnum;
+    action: LeaveActionEnum;
+};
+/**
+ * Gets available actions for a leave based on current status and user permissions
+ * @param entityFlowConfig - The flow configuration for the entity
+ * @param currentStatus - The current status of the leave
+ * @param userPermissions - Array of permissions the user has
+ * @param combineActions - Array of action values to combine into a single action
+ * @param actionLabels - Object mapping actions to custom labels
+ * @param data - Optional function to provide additional visibility conditions
+ * @returns Array of available actions with labels and values
+ */
+export declare function getPermittedActions<T extends LeaveStatusActionPair, E>(entityFlowConfig: {
+    [key in T["status"]]?: {
+        actions: {
+            [key in T["action"]]?: {
+                permissions: string[];
+                next: () => T["status"];
+            };
+        };
+    };
+}, currentStatus: T["status"] | null, userPermissions: string[], combineActions?: T["action"][], actionLabels?: {
+    [key in T["action"]]?: string;
+}, data?: (a: E) => {
+    [key: string]: () => boolean;
+}): {
+    label: string;
+    value: T["action"] | string;
+}[];

package/dist/src/utils/entity.flow.util.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPermittedActions = getPermittedActions;
+/**
+ * Converts an action or combined action to a value-label pair
+ * @param action - The action or combined action key
+ * @param actionLabels - Object mapping actions to custom labels
+ * @returns Object with label and value
+ */
+function convertToValueLabel(action, actionLabels) {
+    return {
+        label: actionLabels[action] || action,
+        value: action,
+    };
+}
+/**
+ * Filters actions based on user permissions and visibility conditions
+ * @param actionConfig - The actions configuration for the current status
+ * @param userPermissions - Array of permissions the user has
+ * @param data - Optional function to provide additional visibility conditions
+ * @returns Array of permitted action keys
+ * @throws Error if multiple permissions are found for a single action
+ */
+function _getPermittedActions(actionConfig, userPermissions, data) {
+    return Object.entries(actionConfig)
+        .filter(([actionKey, config]) => {
+        var _a;
+        const actionRequiredPermissions = (_a = config === null || config === void 0 ? void 0 : config.permissions) !== null && _a !== void 0 ? _a : [];
+        const matchingPermissions = actionRequiredPermissions.filter((permission) => userPermissions.includes(permission));
+        if (matchingPermissions.length > 1) {
+            throw new Error(`Multiple permissions found for action ${actionKey}: ${matchingPermissions.join(", ")}`);
+        }
+        return (matchingPermissions.length > 0 &&
+            (!data ||
+                !data({})[matchingPermissions[0]] ||
+                data({})[matchingPermissions[0]]()));
+    })
+        .map(([actionKey, _]) => actionKey);
+}
+/**
+ * Combines specified actions into a single action if all are present
+ * @param permittedActions - Array of permitted action keys
+ * @param combineActions - Array of actions to combine
+ * @returns Array of action keys, with combined action if applicable
+ */
+function combinePermittedActions(permittedActions, combineActions) {
+    if (combineActions.length === 0) {
+        return permittedActions;
+    }
+    const isCombinedActionPresent = combineActions.every((action) => permittedActions.includes(action));
+    if (isCombinedActionPresent) {
+        const combinedValue = combineActions.join("_");
+        return [
+            ...permittedActions.filter((action) => !combineActions.includes(action)),
+            combinedValue,
+        ];
+    }
+    return permittedActions;
+}
+/**
+ * Gets available actions for a leave based on current status and user permissions
+ * @param entityFlowConfig - The flow configuration for the entity
+ * @param currentStatus - The current status of the leave
+ * @param userPermissions - Array of permissions the user has
+ * @param combineActions - Array of action values to combine into a single action
+ * @param actionLabels - Object mapping actions to custom labels
+ * @param data - Optional function to provide additional visibility conditions
+ * @returns Array of available actions with labels and values
+ */
+function getPermittedActions(entityFlowConfig, currentStatus, userPermissions, combineActions = [], actionLabels = {}, data = (_) => ({})) {
+    var _a;
+    // Handle invalid inputs
+    if (!currentStatus || !entityFlowConfig[currentStatus]) {
+        return [];
+    }
+    const actionConfig = ((_a = entityFlowConfig[currentStatus]) === null || _a === void 0 ? void 0 : _a.actions) || {};
+    // Get permitted actions
+    const permittedActions = _getPermittedActions(actionConfig, userPermissions, data);
+    // Combine actions if specified
+    const finalActions = combinePermittedActions(permittedActions, combineActions);
+    // Convert to value-label pairs
+    return finalActions.map((action) => convertToValueLabel(action, actionLabels));
+}

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

@@ -1,4 +1,4 @@
-import { EntityEnum, EnumEntityType, IBaseEntityServiceResponse, IEntityFilterData } from "../entities";
+import { EntityEnum, EnumEntityType, IBaseEntityServiceResponse, IEntityFilterData, IEntityServiceResponse } from "../entities";
 import { Modify } from "../misc";
 export declare function groupByFunction<T, K>(list: T[], keyGetter: (input: T) => K): Map<K, T[]>;
 export declare function groupByOneToOneFunction<T, K>(list: T[], keyGetter: (input: T) => K): Map<K, T>;
@@ -176,6 +176,42 @@ export declare function transformDate<T extends {
 export declare function capitalizeFirstWord(str: string): string;
 export declare function getEntitiesFromSearchV2Response<E extends EntityEnum, // Enum key like EntityEnum.USER, EntityEnum.PROJECT, etc.
 T extends EnumEntityType<E>>(searchResponseV2: IBaseEntityServiceResponse<EnumEntityType<EntityEnum>>, entityEnumKey: E, EntityClass: new () => T): T[];
+/**
+ * Recursively searches for entities of a specific type within a nested `relatedEntities` structure.
+ *
+ * This function traverses the `relatedEntities` tree, looking for a target entity key.
+ * When found, it collects all `baseEntities` for that key and instantiates them
+ * as instances of the provided `EntityClass`. The function continues to traverse
+ * all nested `relatedEntities` recursively, accumulating all matches.
+ *
+ * @template E - The enum type representing the target entity key (`EntityEnum`).
+ * @template T - The corresponding entity type for the target key (`EnumEntityType<E>`).
+ *
+ * @param relatedEntities - The nested `relatedEntities` structure, typically from a
+ *   `IBaseEntityServiceResponse`. Can be undefined, in which case an empty array is returned.
+ * @param targetKey - The entity key (`EntityEnum`) to search for in the nested structure.
+ * @param EntityClass - A constructor function for the entity type `T`. Used to
+ *   instantiate new objects from the raw base entity data.
+ *
+ * @returns An array of entities of type `T` found at any level of the nested structure.
+ *   If no entities are found, an empty array is returned.
+ *
+ * @example
+ * ```ts
+ * const billingEntities = findEntitiesAtAnyLevel(
+ *   projectUserMappingsOfCurrentUser.relatedEntities,
+ *   EntityEnum.BILLING,
+ *   BillingEntity
+ * );
+ *
+ * console.log(billingEntities); // [BillingEntity {...}, BillingEntity {...}]
+ * ```
+ *
+ * @note
+ * - This function preserves the type of entities by mapping the raw objects to the provided `EntityClass`.
+ * - It can handle deeply nested `relatedEntities` structures.
+ */
+export declare function findEntitiesFromSearchV2RelatedEntities<E extends EntityEnum, T extends EnumEntityType<E>>(relatedEntities: IEntityServiceResponse | undefined, targetKey: EntityEnum, EntityClass: new () => T): T[];
 /**
  * Checks if two decimal numbers are approximately equal within a given tolerance.
  *

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

@@ -33,6 +33,7 @@ exports.createKeyLabelMap = createKeyLabelMap;
 exports.transformDate = transformDate;
 exports.capitalizeFirstWord = capitalizeFirstWord;
 exports.getEntitiesFromSearchV2Response = getEntitiesFromSearchV2Response;
+exports.findEntitiesFromSearchV2RelatedEntities = findEntitiesFromSearchV2RelatedEntities;
 exports.areDecimalNumbersEqual = areDecimalNumbersEqual;
 exports.formatIndianNumber = formatIndianNumber;
 exports.findDuplicateIds = findDuplicateIds;
@@ -403,6 +404,58 @@ function getEntitiesFromSearchV2Response(searchResponseV2, entityEnumKey, Entity
     }
     return (((_a = searchResponseV2.relatedEntities[entityEnumKey]) === null || _a === void 0 ? void 0 : _a.baseEntities) || []).map((entity) => Object.assign(new EntityClass(), entity));
 }
+/**
+ * Recursively searches for entities of a specific type within a nested `relatedEntities` structure.
+ *
+ * This function traverses the `relatedEntities` tree, looking for a target entity key.
+ * When found, it collects all `baseEntities` for that key and instantiates them
+ * as instances of the provided `EntityClass`. The function continues to traverse
+ * all nested `relatedEntities` recursively, accumulating all matches.
+ *
+ * @template E - The enum type representing the target entity key (`EntityEnum`).
+ * @template T - The corresponding entity type for the target key (`EnumEntityType<E>`).
+ *
+ * @param relatedEntities - The nested `relatedEntities` structure, typically from a
+ *   `IBaseEntityServiceResponse`. Can be undefined, in which case an empty array is returned.
+ * @param targetKey - The entity key (`EntityEnum`) to search for in the nested structure.
+ * @param EntityClass - A constructor function for the entity type `T`. Used to
+ *   instantiate new objects from the raw base entity data.
+ *
+ * @returns An array of entities of type `T` found at any level of the nested structure.
+ *   If no entities are found, an empty array is returned.
+ *
+ * @example
+ * ```ts
+ * const billingEntities = findEntitiesAtAnyLevel(
+ *   projectUserMappingsOfCurrentUser.relatedEntities,
+ *   EntityEnum.BILLING,
+ *   BillingEntity
+ * );
+ *
+ * console.log(billingEntities); // [BillingEntity {...}, BillingEntity {...}]
+ * ```
+ *
+ * @note
+ * - This function preserves the type of entities by mapping the raw objects to the provided `EntityClass`.
+ * - It can handle deeply nested `relatedEntities` structures.
+ */
+function findEntitiesFromSearchV2RelatedEntities(relatedEntities, targetKey, EntityClass) {
+    if (!relatedEntities)
+        return [];
+    let result = [];
+    for (const key of Object.keys(relatedEntities)) {
+        const value = relatedEntities[key];
+        // If this key is the target and has baseEntities
+        if (key === targetKey && (value === null || value === void 0 ? void 0 : value.baseEntities)) {
+            result.push(...value.baseEntities.map((entity) => Object.assign(new EntityClass(), entity)));
+        }
+        // If value has relatedEntities, recurse
+        if (value === null || value === void 0 ? void 0 : value.relatedEntities) {
+            result.push(...findEntitiesFromSearchV2RelatedEntities(value.relatedEntities, targetKey, EntityClass));
+        }
+    }
+    return result;
+}
 /**
  * Checks if two decimal numbers are approximately equal within a given tolerance.
  *

package/dist/src/utils/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./date.util";
 export * from "./helper.fn.util";
 export * from "./models/date-code.model.util";
+export * from "./string.util";
+export * from "./entity.flow.util";

package/dist/src/utils/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./date.util"), exports);
 __exportStar(require("./helper.fn.util"), exports);
 __exportStar(require("./models/date-code.model.util"), exports);
+__exportStar(require("./string.util"), exports);
+__exportStar(require("./entity.flow.util"), exports);

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

@@ -0,0 +1 @@
+export declare function formatString(input: string): string;

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

@@ -1 +1,15 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatString = formatString;
+function formatString(input) {
+    if (input.includes('_')) {
+        return input
+            .split('_')
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+            .join(' ');
+    }
+    else {
+        // For single-word strings, capitalize the first letter
+        return input.charAt(0).toUpperCase() + input.slice(1).toLowerCase();
+    }
+}

package/package.json

@@ -1,35 +1,35 @@
-{
- "name": "law-common",
- "version": "10.26.1-beta.9",
- "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",
-  "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"
- },
- "keywords": [],
- "author": "",
- "license": "ISC",
- "devDependencies": {
-  "@types/jest": "^29.5.13",
-  "@types/node": "^22.6.1",
-  "jest": "^29.7.0",
-  "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"
- }
-}
+{
+ "name": "law-common",
+ "version": "10.28.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",
+  "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"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC",
+ "devDependencies": {
+  "@types/jest": "^29.5.13",
+  "@types/node": "^22.6.1",
+  "jest": "^29.7.0",
+  "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"
+ }
+}

package/dist/src/entities/func/convert-to-common-entity.func.d.ts

@@ -1,15 +0,0 @@
-import { Modify } from "../../misc/interface/modify.interface";
-export declare function ConvertToCommonEntity<T extends {
-    createdOn: Date;
-    updatedOn: Date;
-}, R extends Modify<T, {
-    createdOn: string;
-    updatedOn: string;
-}>>(obj: T): R;
-export declare function ConvertApiToEntity<T extends {
-    createdOn: string;
-    updatedOn: string;
-}, R extends Modify<T, {
-    createdOn: Date;
-    updatedOn: Date;
-}>>(obj: T): R;

package/dist/src/entities/func/convert-to-common-entity.func.js

@@ -1,24 +0,0 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConvertToCommonEntity = ConvertToCommonEntity;
-exports.ConvertApiToEntity = ConvertApiToEntity;
-function ConvertToCommonEntity(obj) {
-    var _a, _b;
-    const { createdOn: _, updatedOn: __ } = obj, objectToAssign = __rest(obj, ["createdOn", "updatedOn"]);
-    return Object.assign({ createdOn: (_a = obj.createdOn) === null || _a === void 0 ? void 0 : _a.toISOString(), updatedOn: (_b = obj.updatedOn) === null || _b === void 0 ? void 0 : _b.toISOString() }, objectToAssign);
-}
-function ConvertApiToEntity(obj) {
-    const { createdOn: _, updatedOn: __ } = obj, objectToAssign = __rest(obj, ["createdOn", "updatedOn"]);
-    return Object.assign({ createdOn: new Date(obj.createdOn), updatedOn: new Date(obj.updatedOn) }, objectToAssign);
-}