law-common 13.0.3-beta.7 → 13.0.3-beta.8

package/dist/src/entities/enums/project_action_enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum ProjectActionEnum {
+    CREATE = "CREATE",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE",
+    DEACTIVATE = "DEACTIVATE",
+    ACTIVATE = "ACTIVATE",
+    RESTORE = "RESTORE"
+}

package/dist/src/entities/enums/project_action_enum.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectActionEnum = void 0;
+var ProjectActionEnum;
+(function (ProjectActionEnum) {
+    ProjectActionEnum["CREATE"] = "CREATE";
+    ProjectActionEnum["UPDATE"] = "UPDATE";
+    ProjectActionEnum["DELETE"] = "DELETE";
+    ProjectActionEnum["DEACTIVATE"] = "DEACTIVATE";
+    ProjectActionEnum["ACTIVATE"] = "ACTIVATE";
+    ProjectActionEnum["RESTORE"] = "RESTORE";
+    // APPROVE = "APPROVE",
+    // REJECT = "REJECT",
+    // RECALL = "RECALL",
+    // REQUEST_CHANGES = "REQUEST_CHANGES",
+    // CHANGES_DONE = "CHANGES_DONE",
+})(ProjectActionEnum || (exports.ProjectActionEnum = ProjectActionEnum = {}));

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

@@ -0,0 +1,12 @@
+import { FlowConfig } from "./flow-config.type";
+import { ProjectActionEnum } from "../enums/project_action_enum";
+import { ProjectStatusEnum } from "../enums/project_status_enum";
+export interface IProjectFlowConfigContextData {
+}
+/**
+ * COMPLETED, ON_HOLD, SUSPENDED, CANCELLED and ARCHIVED have no block. Nothing transitions into them
+ * and nothing transitions out - they are declared on the enum but inert in this flow. Giving them
+ * transitions means designing the project lifecycle, which is out of scope for LW-827's
+ * auto-approval template and needs its own ticket.
+ */
+export declare const projectFlowConfig: FlowConfig<ProjectStatusEnum, ProjectActionEnum, IProjectFlowConfigContextData>;

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

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projectFlowConfig = void 0;
+const base_flow_config_factory_1 = require("./base-flow-config.factory");
+const project_action_enum_1 = require("../enums/project_action_enum");
+const project_status_enum_1 = require("../enums/project_status_enum");
+/**
+ * project is the one Tier 2 entity whose flow is MAPPED onto the existing status vocabulary rather
+ * than realigned to APPROVED / DEACTIVATED / DELETED. Every other Tier 2 entity was realigned; this
+ * one deliberately is not, for three reasons:
+ *
+ * 1. It already has all three canonical states, under two different names. ACTIVE is the live state
+ *    (the APPROVED role), INACTIVE is the deactivated state, and DELETED exists verbatim. The presence
+ *    of a separate DELETED is what disambiguates INACTIVE here - on the master tables that shared an
+ *    ACTIVE / DEACTIVE / INACTIVE triple, INACTIVE was the tombstone and mapped to DELETED. That
+ *    mapping does not transfer to project.
+ *
+ * 2. The other five members are domain vocabulary, not generator boilerplate. COMPLETED, ON_HOLD,
+ *    SUSPENDED, CANCELLED and ARCHIVED describe real project lifecycle states somebody chose to
+ *    declare. They are unwritten today, but discarding them to fit a six-action template would throw
+ *    away design intent rather than dead code.
+ *
+ * 3. `project.status` is a public API field. It is required on ProjectCreateDto and optional on
+ *    ProjectUpdateDto, both validated with @IsEnum, so renaming a member is an API contract change
+ *    for every client, not just a data migration.
+ *
+ * So the transitions below are the ticket's auto-approval shape with ACTIVE standing in for APPROVED
+ * and INACTIVE for DEACTIVATED. The five domain statuses are reachable targets of nothing and carry no
+ * block of their own - a project in any of them has no action available through this flow, which is
+ * honest about the fact that nothing transitions into or out of them today.
+ */
+const PROJECT_CREATE_PERMISSION = ["PROJECT_CREATE"];
+const PROJECT_UPDATE_PERMISSION = ["PROJECT_UPDATE"];
+const PROJECT_DELETE_PERMISSION = ["PROJECT_DELETE"];
+const PROJECT_DEACTIVATE_PERMISSION = ["PROJECT_DEACTIVATE"];
+const PROJECT_ACTIVATE_PERMISSION = ["PROJECT_ACTIVATE"];
+const PROJECT_RESTORE_PERMISSION = ["PROJECT_RESTORE"];
+const ACTION_MAP = {
+    [project_action_enum_1.ProjectActionEnum.CREATE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.ACTIVE],
+        permissions: PROJECT_CREATE_PERMISSION,
+    },
+    [project_action_enum_1.ProjectActionEnum.UPDATE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.ACTIVE],
+        permissions: PROJECT_UPDATE_PERMISSION,
+    },
+    [project_action_enum_1.ProjectActionEnum.DELETE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.DELETED],
+        permissions: PROJECT_DELETE_PERMISSION,
+    },
+    [project_action_enum_1.ProjectActionEnum.DEACTIVATE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.INACTIVE],
+        permissions: PROJECT_DEACTIVATE_PERMISSION,
+    },
+    [project_action_enum_1.ProjectActionEnum.ACTIVATE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.ACTIVE],
+        permissions: PROJECT_ACTIVATE_PERMISSION,
+    },
+    [project_action_enum_1.ProjectActionEnum.RESTORE]: {
+        reachableStatues: [project_status_enum_1.ProjectStatusEnum.ACTIVE],
+        permissions: PROJECT_RESTORE_PERMISSION,
+    },
+};
+const { createActionConfig } = (0, base_flow_config_factory_1.createFlowConfigFactory)()(ACTION_MAP);
+// ACTIVE status transitions - the APPROVED role
+const transitionActiveStatusUpdateAction = createActionConfig(project_action_enum_1.ProjectActionEnum.UPDATE, project_status_enum_1.ProjectStatusEnum.ACTIVE);
+const transitionActiveStatusDeleteAction = createActionConfig(project_action_enum_1.ProjectActionEnum.DELETE, project_status_enum_1.ProjectStatusEnum.DELETED);
+const transitionActiveStatusDeactivateAction = createActionConfig(project_action_enum_1.ProjectActionEnum.DEACTIVATE, project_status_enum_1.ProjectStatusEnum.INACTIVE);
+// INACTIVE status transitions - the DEACTIVATED role
+const transitionInactiveStatusDeleteAction = createActionConfig(project_action_enum_1.ProjectActionEnum.DELETE, project_status_enum_1.ProjectStatusEnum.DELETED);
+const transitionInactiveStatusActivateAction = createActionConfig(project_action_enum_1.ProjectActionEnum.ACTIVATE, project_status_enum_1.ProjectStatusEnum.ACTIVE);
+// DELETED status transitions
+const transitionDeletedStatusUpdateAction = createActionConfig(project_action_enum_1.ProjectActionEnum.UPDATE, project_status_enum_1.ProjectStatusEnum.ACTIVE);
+const transitionDeletedStatusRestoreAction = createActionConfig(project_action_enum_1.ProjectActionEnum.RESTORE, project_status_enum_1.ProjectStatusEnum.ACTIVE);
+/**
+ * COMPLETED, ON_HOLD, SUSPENDED, CANCELLED and ARCHIVED have no block. Nothing transitions into them
+ * and nothing transitions out - they are declared on the enum but inert in this flow. Giving them
+ * transitions means designing the project lifecycle, which is out of scope for LW-827's
+ * auto-approval template and needs its own ticket.
+ */
+exports.projectFlowConfig = {
+    [project_status_enum_1.ProjectStatusEnum.ACTIVE]: {
+        actions: {
+            [project_action_enum_1.ProjectActionEnum.UPDATE]: transitionActiveStatusUpdateAction,
+            [project_action_enum_1.ProjectActionEnum.DELETE]: transitionActiveStatusDeleteAction,
+            [project_action_enum_1.ProjectActionEnum.DEACTIVATE]: transitionActiveStatusDeactivateAction,
+        },
+    },
+    [project_status_enum_1.ProjectStatusEnum.INACTIVE]: {
+        actions: {
+            [project_action_enum_1.ProjectActionEnum.DELETE]: transitionInactiveStatusDeleteAction,
+            [project_action_enum_1.ProjectActionEnum.ACTIVATE]: transitionInactiveStatusActivateAction,
+        },
+    },
+    [project_status_enum_1.ProjectStatusEnum.DELETED]: {
+        actions: {
+            [project_action_enum_1.ProjectActionEnum.UPDATE]: transitionDeletedStatusUpdateAction,
+            [project_action_enum_1.ProjectActionEnum.RESTORE]: transitionDeletedStatusRestoreAction,
+        },
+    },
+};

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

@@ -305,7 +305,9 @@ export * from "./model/billing_profile.entity.model";
 export * from "./enums/project_billing_type_enum";
 export * from "./enums/project_revenue_split_enum";
 export * from "./enums/project_revenue_split_mapping_status_enum";
+export * from "./enums/project_action_enum";
 export * from "./enums/project_status_enum";
+export * from "./flow-configs/project_flow.config";
 export * from "./enums/project_usage_notification_threshold_enum";
 export * from "./interface/project_revenue_split_mapping.entity.interface";
 export * from "./interface/field-constraint/project_revenue_split_mapping_field_constraints.interface";

package/dist/src/entities/index.js

@@ -321,7 +321,9 @@ __exportStar(require("./model/billing_profile.entity.model"), exports);
 __exportStar(require("./enums/project_billing_type_enum"), exports);
 __exportStar(require("./enums/project_revenue_split_enum"), exports);
 __exportStar(require("./enums/project_revenue_split_mapping_status_enum"), exports);
+__exportStar(require("./enums/project_action_enum"), exports);
 __exportStar(require("./enums/project_status_enum"), exports);
+__exportStar(require("./flow-configs/project_flow.config"), exports);
 __exportStar(require("./enums/project_usage_notification_threshold_enum"), exports);
 __exportStar(require("./interface/project_revenue_split_mapping.entity.interface"), exports);
 __exportStar(require("./interface/field-constraint/project_revenue_split_mapping_field_constraints.interface"), exports);

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

@@ -1,3 +1,7 @@
+import { ProjectActionEnum } from "../enums/project_action_enum";
+import { IProjectFlowConfigContextData } from "../flow-configs/project_flow.config";
+import { IUserEntity } from "../interface/user.entity.interface";
+import { IRowActions } from "./interface/row-actions.interface";
 import { IProjectUserDto } from "../../api";
 import { CurrencyEnum } from "../../enums";
 import { ProjectBillingTypeEnum } from "../enums/project_billing_type_enum";
@@ -66,4 +70,15 @@ export declare class ProjectEntityModel extends BaseEntityModel<EntityEnum.PROJE
             timesheets: TimesheetEntityModel[];
         }[];
     }>;
+    getNextStatus(currentUser: IUserEntity, action: ProjectActionEnum, projectFlowConfigContextData: IProjectFlowConfigContextData): ProjectStatusEnum;
+    getAvailableActions(currentUser: UserEntityModel, config?: {
+        combinedActions?: Record<string, {
+            combineActions: ProjectActionEnum[];
+            label: string;
+        }>;
+        customLabels?: Partial<Record<ProjectActionEnum, string>>;
+    }): IRowActions<EntityEnum.PROJECT>[];
+    getUpdateActionVisibility(currentUser: UserEntityModel): {
+        [key: string]: () => boolean;
+    };
 }

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectEntityModel = void 0;
+const error_key_enum_1 = require("../../enums/error.key.enum");
+const exceptions_1 = require("../../exceptions");
+const utils_1 = require("../../utils");
+const project_flow_config_1 = require("../flow-configs/project_flow.config");
 const enums_1 = require("../../enums");
 const helper_fn_util_1 = require("../../utils/helper.fn.util");
 const project_billing_type_enum_1 = require("../enums/project_billing_type_enum");
@@ -155,6 +159,64 @@ class ProjectEntityModel extends base_entity_model_1.BaseEntityModel {
         }
         return result;
     }
+    getNextStatus(currentUser, action, projectFlowConfigContextData) {
+        if (!this.status) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.STATUS,
+                message: [`Status not found: ${this.status}`],
+            });
+        }
+        const flowForStatus = project_flow_config_1.projectFlowConfig[this.status];
+        if (!flowForStatus) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.STATUS,
+                message: [`No flow configuration found for status: ${this.status}`],
+            });
+        }
+        if (!action) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.ACTION_DATA,
+                message: ["actionData is required"],
+            });
+        }
+        const matchingPermissionConfig = flowForStatus.actions[action];
+        if (!matchingPermissionConfig) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.ACTION,
+                message: [`Action '${action}' is not valid for the current status.`],
+            });
+        }
+        if (!currentUser.permissions || currentUser.permissions.length === 0) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.PERMISSIONS,
+                message: ["Permission not available for currentUser"],
+            });
+        }
+        const hasPermission = matchingPermissionConfig.permissions.some((permission) => currentUser.permissions.includes(permission));
+        if (!hasPermission) {
+            throw new exceptions_1.AppBadRequestException({
+                key: error_key_enum_1.ErrorKeyEnum.PERMISSION,
+                message: [`Current user does not have permission to ${action} project`],
+            });
+        }
+        const nextStatus = matchingPermissionConfig.next(projectFlowConfigContextData);
+        return nextStatus;
+    }
+    getAvailableActions(currentUser, config) {
+        var _a;
+        const params = {
+            flowConfig: project_flow_config_1.projectFlowConfig,
+            currentStatus: this.status,
+            userPermissions: (_a = currentUser.permissions) !== null && _a !== void 0 ? _a : [],
+            visibilityData: this.getUpdateActionVisibility.bind(this, currentUser),
+            combinedActions: config === null || config === void 0 ? void 0 : config.combinedActions,
+            customLabels: config === null || config === void 0 ? void 0 : config.customLabels,
+        };
+        return utils_1.EntityActionFlowResolverV2.getAvailableActionsData(params);
+    }
+    getUpdateActionVisibility(currentUser) {
+        return {};
+    }
 }
 exports.ProjectEntityModel = ProjectEntityModel;
 ProjectEntityModel.relationConfigs = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "law-common",
-  "version": "13.0.3-beta.7",
+  "version": "13.0.3-beta.8",
   "description": "",
   "main": "dist/index.js",
   "files": [