@7365admin1/module-hygiene 4.28.1-staging.9 → 4.28.2-staging.10

package/.changeset/hygiene-checkout-approval.md

@@ -0,0 +1,5 @@
+---
+"@7365admin1/module-hygiene": minor
+---
+
+Add approve / disapprove to hygiene check out items (repository, controller and decision util).

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @7365admin1/module-hygiene
 
+## 4.28.1
+
+### Patch Changes
+
+- 0166aeb: Hygiene dashboard metrics: report the selected period honestly instead of fabricating figures
+
+  The dashboard's metric calculations were computed inline inside
+  `hygiene-dashboard.repository.ts` and were wrong in four ways. They now live in
+  `src/utils/hygiene-dashboard-metrics.util.ts`, covered by unit tests (`yarn test`),
+  so a change to a metric fails a test rather than a screen. What a consumer of the
+  dashboard endpoints sees change:
+
+  - **Trend comparisons follow the selected period.** The "vs previous" figure was
+    always computed against yesterday, whatever range the user picked, so a
+    month-to-month comparison was really a day-to-day one. It now compares the
+    selected period against the period immediately before it.
+  - **Day boundaries are Singapore time.** Period start/end were taken from the
+    server host's midnight, so a host on UTC put work into the wrong day. All
+    boundaries are now computed in `Asia/Singapore`.
+  - **No invented percentages on an empty prior period.** When the previous period
+    had no data, the change was reported as `100%` (or `0`) as if measured. It now
+    returns `null`, so the UI can show "no comparison available" rather than a
+    number nobody can reproduce.
+  - **The supply alert percentage is no longer hard-coded.** It was emitted as a
+    fixed value regardless of stock; it is now derived, and reports its reason when
+    there is no prior period to compare against.
+
+  No API surface changes and no consumer code change is required — the same fields
+  are returned, with `null` now possible where a comparison genuinely cannot be made.
+
 ## 4.28.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -512,6 +512,36 @@ declare function useStockController(): {
     getStocksBySupplyId: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+/**
+ * The approval decision on a hygiene check out item, as data.
+ *
+ * Kept out of the repository so it can be tested without a database, the same
+ * way `hygiene-dashboard-metrics.util.ts` is. The repository wraps the ids in
+ * `ObjectId` and hands the rest of this straight to `$set`.
+ *
+ * Shape follows `hygiene-area-checklist`: an approve/reject pair plus a
+ * terminal `status: "completed"`, so the `allowedCheckOutItemStatus`
+ * vocabulary (`pending` | `completed`) gains no new value. Rows written before
+ * this feature carry no `approve`/`reject` at all, which reads as "not
+ * decided" — nothing is backfilled.
+ */
+declare const CHECKOUT_DECISIONS: readonly ["approve", "disapprove"];
+type TCheckOutDecision = (typeof CHECKOUT_DECISIONS)[number];
+declare function isCheckOutDecision(value: string): value is TCheckOutDecision;
+/**
+ * Only a `pending` row may be decided. Returning the status the update must
+ * match — rather than matching on `_id` alone — is what makes a second
+ * approval a refusal instead of a silent overwrite of the first one.
+ */
+declare const CHECKOUT_DECIDABLE_STATUS = "pending";
+declare function buildCheckOutDecision(decision: TCheckOutDecision, remarks?: string | null, now?: string): {
+    approve: boolean;
+    reject: boolean;
+    status: string;
+    remarks: string;
+    updatedAt: string;
+};
+
 declare const allowedCheckOutItemStatus: string[];
 type TCheckOutItem = {
     _id?: ObjectId;
@@ -525,6 +555,10 @@ type TCheckOutItem = {
     createdBy: string | ObjectId;
     createdByName: string;
     status?: (typeof allowedCheckOutItemStatus)[number];
+    approve?: boolean;
+    reject?: boolean;
+    remarks?: string;
+    completedBy?: string | ObjectId;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
@@ -534,12 +568,13 @@ type TCheckOutItemCreateService = Pick<TCheckOutItem, "site" | "serviceType" | "
 type TCheckOutItemCreateByBatchService = Pick<TCheckOutItem, "site" | "serviceType" | "createdBy"> & {
     items: Pick<TCheckOutItem, "supply" | "qty" | "attachment">[];
 };
+type TCheckOutItemDecision = Pick<TCheckOutItem, "approve" | "reject" | "remarks" | "completedBy">;
 type TCheckOutItemGetQuery = {
     page?: number;
     limit?: number;
     search?: string;
 } & Pick<TCheckOutItem, "site" | "serviceType">;
-type TCheckOutItemGetById = Pick<TCheckOutItem, "_id" | "site" | "serviceType" | "supply" | "supplyName" | "supplyQty" | "qty" | "status"> & {
+type TCheckOutItemGetById = Pick<TCheckOutItem, "_id" | "site" | "serviceType" | "supply" | "supplyName" | "supplyQty" | "qty" | "status" | "approve" | "reject" | "remarks"> & {
     unitOfMeasurement?: string;
 };
 declare const checkOutItemSchema: Joi.ObjectSchema<any>;
@@ -554,6 +589,10 @@ declare function MCheckOutItem(value: TCheckOutItemCreate): {
     createdBy: string | ObjectId;
     createdByName: string;
     status: string;
+    approve: boolean;
+    reject: boolean;
+    remarks: string;
+    completedBy: string;
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
@@ -566,6 +605,7 @@ declare function useCheckOutItemRepository(): {
     getCheckOutItems: ({ page, limit, search, site, serviceType, }: TCheckOutItemGetQuery) => Promise<{}>;
     getCheckOutItemById: (_id: string | ObjectId, session?: ClientSession) => Promise<TCheckOutItemGetById>;
     completeCheckOutItem: (_id: string | ObjectId, session?: ClientSession) => Promise<number>;
+    decideCheckOutItem: (_id: string | ObjectId, value: TCheckOutItemDecision, session?: ClientSession) => Promise<number>;
 };
 
 declare function useCheckOutItemService(): {
@@ -578,6 +618,7 @@ declare function useCheckOutItemController(): {
     createCheckOutItemByBatch: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getCheckOutItems: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getCheckOutItemById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    decideCheckOutItem: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 type TScheduleTask = {
@@ -664,4 +705,4 @@ declare function useQRController(): {
     generateQR: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-export { MArea, MAreaChecklist, MCheckOutItem, MParentChecklist, MScheduleTask, MStock, MSupply, MUnit, TArea, TAreaChecklist, TAreaChecklistBatchCreate, TAreaChecklistCreate, TAreaChecklistUnits, TAreaChecklistUnitsUpdate, TAreaChecklistUpdate, TAreaCreate, TAreaGetQuery, TAreaUnits, TAreaUpdate, TAreaUpdateChecklist, TCheckOutItem, TCheckOutItemCreate, TCheckOutItemCreateByBatchService, TCheckOutItemCreateService, TCheckOutItemGetById, TCheckOutItemGetQuery, TCleaningScheduleArea, TCleaningScheduleAreaGetQuery, TGetStocksQuery, TParentChecklist, TParentChecklistCreate, TParentChecklistGetQuery, TScheduleTask, TScheduleTaskCreate, TScheduleTaskGetById, TScheduleTaskGetQuery, TScheduleTaskUpdate, TStock, TStockCreate, TStockCreateService, TSupply, TSupplyCreate, TSupplyGetById, TSupplyGetQuery, TSupplyUpdate, TUnit, TUnitCreate, TUnitGetQuery, TUnitUpdate, allowedCheckOutItemStatus, allowedChecklistStatus, allowedPeriods, allowedStatus, allowedTypes, areaChecklistSchema, areaSchema, checkOutItemSchema, parentChecklistSchema, scheduleTaskSchema, stockSchema, supplySchema, unitSchema, useAreaChecklistController, useAreaChecklistRepo, useAreaChecklistService, useAreaController, useAreaExportService, useAreaRepo, useAreaService, useCheckOutItemController, useCheckOutItemRepository, useCheckOutItemService, useHygieneDashboardController, useHygieneDashboardRepository, useParentChecklistController, useParentChecklistRepo, useQRController, useQRService, useScheduleTaskController, useScheduleTaskRepository, useScheduleTaskService, useStockController, useStockRepository, useStockService, useSupplyController, useSupplyRepository, useUnitController, useUnitExportService, useUnitRepository, useUnitService };
+export { CHECKOUT_DECIDABLE_STATUS, CHECKOUT_DECISIONS, MArea, MAreaChecklist, MCheckOutItem, MParentChecklist, MScheduleTask, MStock, MSupply, MUnit, TArea, TAreaChecklist, TAreaChecklistBatchCreate, TAreaChecklistCreate, TAreaChecklistUnits, TAreaChecklistUnitsUpdate, TAreaChecklistUpdate, TAreaCreate, TAreaGetQuery, TAreaUnits, TAreaUpdate, TAreaUpdateChecklist, TCheckOutDecision, TCheckOutItem, TCheckOutItemCreate, TCheckOutItemCreateByBatchService, TCheckOutItemCreateService, TCheckOutItemDecision, TCheckOutItemGetById, TCheckOutItemGetQuery, TCleaningScheduleArea, TCleaningScheduleAreaGetQuery, TGetStocksQuery, TParentChecklist, TParentChecklistCreate, TParentChecklistGetQuery, TScheduleTask, TScheduleTaskCreate, TScheduleTaskGetById, TScheduleTaskGetQuery, TScheduleTaskUpdate, TStock, TStockCreate, TStockCreateService, TSupply, TSupplyCreate, TSupplyGetById, TSupplyGetQuery, TSupplyUpdate, TUnit, TUnitCreate, TUnitGetQuery, TUnitUpdate, allowedCheckOutItemStatus, allowedChecklistStatus, allowedPeriods, allowedStatus, allowedTypes, areaChecklistSchema, areaSchema, buildCheckOutDecision, checkOutItemSchema, isCheckOutDecision, parentChecklistSchema, scheduleTaskSchema, stockSchema, supplySchema, unitSchema, useAreaChecklistController, useAreaChecklistRepo, useAreaChecklistService, useAreaController, useAreaExportService, useAreaRepo, useAreaService, useCheckOutItemController, useCheckOutItemRepository, useCheckOutItemService, useHygieneDashboardController, useHygieneDashboardRepository, useParentChecklistController, useParentChecklistRepo, useQRController, useQRService, useScheduleTaskController, useScheduleTaskRepository, useScheduleTaskService, useStockController, useStockRepository, useStockService, useSupplyController, useSupplyRepository, useUnitController, useUnitExportService, useUnitRepository, useUnitService };

package/dist/index.js

@@ -30,6 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  CHECKOUT_DECIDABLE_STATUS: () => CHECKOUT_DECIDABLE_STATUS,
+  CHECKOUT_DECISIONS: () => CHECKOUT_DECISIONS,
   MArea: () => MArea,
   MAreaChecklist: () => MAreaChecklist,
   MCheckOutItem: () => MCheckOutItem,
@@ -45,7 +47,9 @@ __export(src_exports, {
   allowedTypes: () => allowedTypes,
   areaChecklistSchema: () => areaChecklistSchema,
   areaSchema: () => areaSchema,
+  buildCheckOutDecision: () => buildCheckOutDecision,
   checkOutItemSchema: () => checkOutItemSchema,
+  isCheckOutDecision: () => isCheckOutDecision,
   parentChecklistSchema: () => parentChecklistSchema,
   scheduleTaskSchema: () => scheduleTaskSchema,
   stockSchema: () => stockSchema,
@@ -5876,6 +5880,23 @@ function useStockController() {
   };
 }
 
+// src/utils/hygiene-checkout-decision.util.ts
+var CHECKOUT_DECISIONS = ["approve", "disapprove"];
+function isCheckOutDecision(value) {
+  return CHECKOUT_DECISIONS.includes(value);
+}
+var CHECKOUT_DECIDABLE_STATUS = "pending";
+function buildCheckOutDecision(decision, remarks, now = (/* @__PURE__ */ new Date()).toISOString()) {
+  const approve = decision === "approve";
+  return {
+    approve,
+    reject: !approve,
+    status: "completed",
+    remarks: remarks ?? "",
+    updatedAt: now
+  };
+}
+
 // src/models/hygiene-checkout-item.model.ts
 var import_joi14 = __toESM(require("joi"));
 var import_mongodb16 = require("mongodb");
@@ -5924,6 +5945,10 @@ function MCheckOutItem(value) {
     createdBy: value.createdBy,
     createdByName: value.createdByName,
     status: "pending",
+    approve: false,
+    reject: false,
+    remarks: "",
+    completedBy: "",
     createdAt: (/* @__PURE__ */ new Date()).toISOString(),
     updatedAt: "",
     deletedAt: ""
@@ -6054,7 +6079,10 @@ function useCheckOutItemRepository() {
             profile: "$createdByDoc.profile",
             checkOutQty: "$qty",
             createdAt: 1,
-            status: 1
+            status: 1,
+            approve: 1,
+            reject: 1,
+            remarks: 1
           }
         },
         { $sort: { _id: -1 } },
@@ -6120,7 +6148,10 @@ function useCheckOutItemRepository() {
               status: 1,
               unitOfMeasurement: "$supplyDetails.unitOfMeasurement",
               stockQty: "$supplyQty",
-              attachment: 1
+              attachment: 1,
+              approve: 1,
+              reject: 1,
+              remarks: 1
             }
           }
         ],
@@ -6171,13 +6202,55 @@ function useCheckOutItemRepository() {
       throw error;
     }
   }
+  async function decideCheckOutItem(_id, value, session) {
+    try {
+      _id = new import_mongodb17.ObjectId(_id);
+    } catch (error) {
+      throw new import_node_server_utils29.BadRequestError("Invalid check out item ID format.");
+    }
+    const updateValue = buildCheckOutDecision(
+      value.approve === true ? "approve" : "disapprove",
+      value.remarks
+    );
+    if (value.completedBy) {
+      try {
+        updateValue.completedBy = new import_mongodb17.ObjectId(value.completedBy);
+      } catch (error) {
+        throw new import_node_server_utils29.BadRequestError("Invalid user ID format.");
+      }
+    }
+    try {
+      const res = await collection.updateOne(
+        { _id, status: CHECKOUT_DECIDABLE_STATUS },
+        { $set: updateValue },
+        { session }
+      );
+      if (res.matchedCount === 0) {
+        throw new import_node_server_utils29.NotFoundError(
+          "Check out item not found or is no longer pending approval."
+        );
+      }
+      delNamespace().then(() => {
+        import_node_server_utils29.logger.info(`Cache cleared for namespace: ${namespace_collection}`);
+      }).catch((err) => {
+        import_node_server_utils29.logger.error(
+          `Failed to clear cache for namespace: ${namespace_collection}`,
+          err
+        );
+      });
+      return res.modifiedCount;
+    } catch (error) {
+      throw error;
+    }
+  }
   return {
     createIndex,
     createTextIndex,
     createCheckOutItem,
     getCheckOutItems,
     getCheckOutItemById,
-    completeCheckOutItem
+    completeCheckOutItem,
+    decideCheckOutItem
   };
 }
 
@@ -6292,7 +6365,8 @@ var import_core18 = require("@7365admin1/core");
 function useCheckOutItemController() {
   const {
     getCheckOutItems: _getCheckOutItems,
-    getCheckOutItemById: _getCheckOutItemById
+    getCheckOutItemById: _getCheckOutItemById,
+    decideCheckOutItem: _decideCheckOutItem
   } = useCheckOutItemRepository();
   const {
     createCheckOutItem: _createCheckOutItem,
@@ -6427,11 +6501,60 @@ function useCheckOutItemController() {
       return;
     }
   }
+  async function decideCheckOutItem(req, res, next) {
+    const cookies = req.headers.cookie ? req.headers.cookie.split(";").map((cookie) => cookie.trim().split("=")).reduce(
+      (acc, [key, value]) => ({ ...acc, [key]: value }),
+      {}
+    ) : {};
+    const completedBy = cookies["user"] || "";
+    const decisionMap = {
+      approve: { approve: true, reject: false },
+      disapprove: { approve: false, reject: true }
+    };
+    const decision = req.params.decision;
+    const decisionValues = decisionMap[decision] || {
+      approve: void 0,
+      reject: void 0
+    };
+    const payload = {
+      ...req.params,
+      ...req.body,
+      ...decisionValues,
+      completedBy
+    };
+    const validation = import_joi15.default.object({
+      id: import_joi15.default.string().hex().required(),
+      decision: import_joi15.default.string().valid("approve", "disapprove").required(),
+      approve: import_joi15.default.boolean().required(),
+      reject: import_joi15.default.boolean().required(),
+      remarks: import_joi15.default.string().optional().allow("", null),
+      completedBy: import_joi15.default.string().hex().required()
+    });
+    const { error } = validation.validate(payload);
+    if (error) {
+      import_node_server_utils31.logger.log({ level: "error", message: error.message });
+      next(new import_node_server_utils31.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const { id, decision: _d, ...value } = payload;
+      await _decideCheckOutItem(id, value);
+      res.json({
+        message: `Check out item ${decision === "approve" ? "approved" : "disapproved"} successfully.`
+      });
+      return;
+    } catch (error2) {
+      import_node_server_utils31.logger.log({ level: "error", message: error2.message });
+      next(error2);
+      return;
+    }
+  }
   return {
     createCheckOutItem,
     createCheckOutItemByBatch,
     getCheckOutItems,
-    getCheckOutItemById
+    getCheckOutItemById,
+    decideCheckOutItem
   };
 }
 
@@ -7472,6 +7595,8 @@ function useQRController() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  CHECKOUT_DECIDABLE_STATUS,
+  CHECKOUT_DECISIONS,
   MArea,
   MAreaChecklist,
   MCheckOutItem,
@@ -7487,7 +7612,9 @@ function useQRController() {
   allowedTypes,
   areaChecklistSchema,
   areaSchema,
+  buildCheckOutDecision,
   checkOutItemSchema,
+  isCheckOutDecision,
   parentChecklistSchema,
   scheduleTaskSchema,
   stockSchema,