@7365admin1/layer-common 4.72.0 → 4.73.1-staging.452

package/composables/useInventory.ts

@@ -15,6 +15,7 @@ export default function useInventory() {
     receive: "Received",
     issue: "Issued",
     use: "Used",
+    use_draft: "Draft",
     return: "Returned",
     adjust: "Stock count",
     handover: "Hand-over",
@@ -44,6 +45,13 @@ export default function useInventory() {
     issue: (store: string, body: Record<string, any>) => api(`/stores/${store}/issue`, { method: "POST", body }),
     receiveReturn: (store: string, body: Record<string, any>) => api(`/stores/${store}/returns`, { method: "POST", body }),
     recordUsage: (store: string, body: Record<string, any>) => api(`/stores/${store}/usage`, { method: "POST", body }),
+    /** Usage drafts: before photo now, after photo and submit after the job (stock is deducted on submit). */
+    getUsageDrafts: (store: string, everyone = false) =>
+      api<{ items: TInventoryUsageDraft[]; staleAfterDays: number }>(`/stores/${store}/usage-drafts`, { query: everyone ? { everyone: true } : {} }),
+    createUsageDraft: (store: string, body: Record<string, any>) => api<TInventoryUsageDraft>(`/stores/${store}/usage-drafts`, { method: "POST", body }),
+    updateUsageDraft: (id: string, body: Record<string, any>) => api<TInventoryUsageDraft>(`/usage-drafts/${id}`, { method: "PATCH", body }),
+    discardUsageDraft: (id: string) => api(`/usage-drafts/${id}/discard`, { method: "POST" }),
+    submitUsageDraft: (id: string, body: { photosAfter?: string[]; date?: string }) => api<TInventoryTransaction>(`/usage-drafts/${id}/submit`, { method: "POST", body }),
 
     getRequests: (store: string, query: { page?: number; limit?: number; status?: string; mine?: boolean }) =>
       api<{ items: TInventoryRequest[]; total: number; pendingCount: number; page: number; pages: number }>(`/stores/${store}/requests`, { query }),
@@ -74,9 +82,9 @@ export default function useInventory() {
     getPeople: (store: string, search = "") =>
       api<{ _id: string; name: string; orgName: string; email?: string; company?: string; service?: string; serviceLabel?: string; label?: string }[]>(`/stores/${store}/people`, { query: { search } }),
 
-    getReport: (store: string, report: "movement" | "usage" | "technicians" | "purchases" | "handovers", query: TInventoryPeriod & { unchecked?: boolean }) =>
-      api<{ rows: any[]; totalQty?: number; totalCost?: number }>(`/stores/${store}/reports/${report}`, { query }),
-    exportReport: (store: string, report: string, query: TInventoryPeriod & { appSlug?: string }) =>
+    getReport: (store: string, report: "movement" | "usage" | "technicians" | "purchases" | "handovers", query: TInventoryPeriod & Record<string, any>) =>
+      api<{ rows: any[]; totalQty?: number; totalCost?: number; scope?: "all" | "own_company"; staleAfterDays?: number }>(`/stores/${store}/reports/${report}`, { query }),
+    exportReport: (store: string, report: string, query: TInventoryPeriod & Record<string, any>) =>
       api<Blob>(`/stores/${store}/reports/${report}/export`, { query, responseType: "blob" }),
     checkUsage: (store: string, ids: string[], checked: boolean) =>
       api<{ updated: number }>(`/stores/${store}/usage/check`, { method: "POST", body: { ids, checked } }),

package/composables/useMember.ts

@@ -70,6 +70,8 @@ export default function useMember() {
     status = "active",
     siteId = "",
     roleState = "",
+    /** A building unit id, or "none": members on no unit yet. */
+    unit = "",
   } = {}) {
     const query: Record<string, any> = { page, limit, type, status };
 
@@ -79,6 +81,7 @@ export default function useMember() {
     if (user) query.user = user;
     if (org) query.org = org;
     if (siteId) query.siteId = siteId;
+    if (unit) query.unit = unit;
     return useNuxtApp().$api<Record<string, any>>("/api/members", {
       method: "GET",
       query,
@@ -154,6 +157,14 @@ export default function useMember() {
     });
   }
 
+  /** Attach a member to a building unit, or detach them (`unit` ""). */
+  function updateMemberUnit(id: string, unit: string) {
+    return useNuxtApp().$api<Record<string, any>>("/api/members/unit", {
+      method: "PUT",
+      body: { id, unit },
+    });
+  }
+
   function getByUserTypeOrg(user: string, type: string, org: string) {
     return useNuxtApp().$api<TMember>(
       `/api/members/user/${user}/app/${type}/org`,
@@ -197,6 +208,7 @@ export default function useMember() {
   return {
     getSiteAccess,
     saveSiteAccess,
+    updateMemberUnit,
     members,
     member,
     page,

package/composables/usePeople.ts

@@ -115,6 +115,24 @@ export default function () {
     });
   }
 
+  /**
+   * The blocks, levels and units at a site that actually have an occupant.
+   * The other half of the unit picker: this narrows the cascade, then
+   * `getPeopleByUnit` answers "which person in this unit?".
+   */
+  async function getOccupiedStructure(
+    site: string,
+    { type = "", status = "active", block = "", level = "" } = {}
+  ) {
+    return await useNuxtApp().$api<Record<string, any>>(
+      `/api/people/site/${site}/occupied-structure`,
+      {
+        method: "GET",
+        query: { type, status, block, level },
+      }
+    );
+  }
+
   async function getPeopleByUnit(
     _id: string,
     { status = "active", type = "" } = {}
@@ -148,6 +166,7 @@ export default function () {
     findPersonByPlateNumberMultipleResult,
     findPersonByContact,
     getPeopleByUnit,
+    getOccupiedStructure,
     searchCompanyList,
     findUsersByPlateNumber,
     reviewResidentPerson,

package/composables/useSecurityPermission.ts

@@ -714,6 +714,21 @@ export default function useSecurityPermission() {
         description:
           "Allows the user to start NFC patrolling on a specific route.",
       },
+      // Copied from Property. The security web app's NFC Patrol > Routes page
+      // gates Add, Edit and Delete on these, and API-core's `nfcPatrol` gate
+      // asks for the same strings on route create and update.
+      "add-nfc-patrol": {
+        check: true,
+        description: "Allows the user to add routes.",
+      },
+      "update-nfc-patrol": {
+        check: true,
+        description: "Allows the user to edit routes.",
+      },
+      "delete-nfc-patrol": {
+        check: true,
+        description: "Allows the user to delete routes.",
+      },
     },
     // NEW. Seeing the CCTV wall, as distinct from setting cameras up
     // (`site-settings:manage-cctv-camera`).
@@ -743,6 +758,11 @@ export default function useSecurityPermission() {
         siteSettingsPermissions["manage-resident-visitors"],
       "manage-work-order-settings":
         siteSettingsPermissions["manage-work-order-settings"],
+      // The security web app's Site Settings shows the NFC Management and NFC
+      // Patrol Settings panels on these, as Property's does.
+      "manage-nfc-management": siteSettingsPermissions["manage-nfc-management"],
+      "manage-nfc-patrol-settings":
+        siteSettingsPermissions["manage-nfc-patrol-settings"],
       "manage-red-dot-settings": {
         check: true,
         description:

package/composables/useServiceProvider.ts

@@ -15,6 +15,9 @@ export type TSiteProviderMember = {
   lastLoginAt?: string | null;
   /** a subcontractor: the provider that brought its company onto the site */
   invitedVia?: string;
+  /** The building unit this person is attached to (a unit's Management tab). */
+  unit?: string | null;
+  unitName?: string;
 };
 
 export type TSiteProviderCompany = {
@@ -90,6 +93,8 @@ export default function useServiceProvider() {
     status = "",
     /** "engagements": also providers engaged through an accepted invitation. */
     include = "",
+    /** A building unit id, or "none": providers on no unit yet. */
+    unit = "",
   } = {}) {
     return useNuxtApp().$api<Record<string, any>>("/api/service-providers", {
       method: "GET",
@@ -102,6 +107,7 @@ export default function useServiceProvider() {
         siteId,
         ...(status ? { status } : {}),
         ...(include ? { include } : {}),
+        ...(unit ? { unit } : {}),
       },
     });
   }
@@ -269,6 +275,17 @@ export default function useServiceProvider() {
     );
   }
 
+  /** Attach a provider to a building unit, or detach it (`unit` ""). */
+  async function updateUnit(id: string, unit: string) {
+    return useNuxtApp().$api<Record<string, any>>(
+      `/api/service-providers/${id}/unit`,
+      {
+        method: "PATCH",
+        body: { unit },
+      }
+    );
+  }
+
    async function getByEmail({
     email = "",
     orgId = "",
@@ -293,17 +310,29 @@ export default function useServiceProvider() {
    * Members > Service Providers: the provider people with access to this
    * site, and one entry per provider company with its head count. The
    * site's own organisation only - the server refuses anyone else.
+   * `unit`: a building unit id, or "none" (people on no unit yet).
    */
-  function getSiteMembers(siteId: string): Promise<{
+  function getSiteMembers(siteId: string, unit = ""): Promise<{
     items: TSiteProviderMember[];
     companies: TSiteProviderCompany[];
   }> {
     return useNuxtApp().$api("/api/service-providers/site-members", {
       method: "GET",
-      query: { siteId },
+      query: { siteId, ...(unit ? { unit } : {}) },
     });
   }
 
+  /** Attach one of those people to a building unit, or detach them (`unit` ""). */
+  function updateSiteMemberUnit(id: string, unit: string) {
+    return useNuxtApp().$api<Record<string, any>>(
+      `/api/service-providers/site-members/${id}/unit`,
+      {
+        method: "PATCH",
+        body: { unit },
+      }
+    );
+  }
+
   /** The same list as an Excel file, under the same filters. */
   function exportSiteMembers(
     siteId: string,
@@ -320,6 +349,7 @@ export default function useServiceProvider() {
 
   return {
     getSiteMembers,
+    updateSiteMemberUnit,
     exportSiteMembers,
     serviceProviders,
     serviceProvider,
@@ -338,6 +368,7 @@ export default function useServiceProvider() {
     add,
     addViaInvite,
     updateStatus,
+    updateUnit,
     getByEmail,
   };
 }

package/composables/useSiteCategory.ts

@@ -0,0 +1,45 @@
+/**
+ * THE CATEGORY OF THE SITE THE USER IS CURRENTLY IN.
+ *
+ * One shared answer, published once by the application's layout from the site
+ * it already loaded for the switcher, and read by anything that has to behave
+ * differently on a commercial or industrial site - the business Add Tenant
+ * form, the tenant list. Publishing it rather than re-fetching it per
+ * component means no two screens can disagree about which site this is.
+ *
+ * READ FROM THE CUSTOMER-SITE RECORD, NOT THE SITE RECORD. Both carry a
+ * `category` and `customer-site.service` keeps them equal (it writes the site
+ * on create and on update), but `siteSchema` DEFAULTS the site's own copy to
+ * `commercial` - so a site created without an explicit category reads back as
+ * commercial there even when it is a residential estate. The customer-site
+ * copy has no default: it is either the category somebody chose or nothing.
+ *
+ * An empty category means "not published yet" or "never set", and every
+ * caller must behave as it did before this existed - never assume commercial
+ * from silence.
+ */
+const BUSINESS_SITE_CATEGORIES: string[] = ["commercial", "industrial"];
+
+export default function useSiteCategory() {
+  const siteCategory = useState<string>("current-site-category", () => "");
+
+  function setSiteCategory(value?: string | null) {
+    siteCategory.value = typeof value === "string" ? value : "";
+  }
+
+  /**
+   * The categories whose units are LET TO A BUSINESS rather than lived in.
+   *
+   * These are the sites where a unit has an owner, an occupier and often a
+   * person in charge who is neither, so they are the sites that ask for a
+   * tenant's standing and print it back (see `OCCUPANCY_ROLE_OPTIONS`).
+   *
+   * The category never changes what the APPLICATION is called: the rail says
+   * Property Management on every site it serves.
+   */
+  const isBusinessSite = computed(() =>
+    BUSINESS_SITE_CATEGORIES.includes(siteCategory.value),
+  );
+
+  return { siteCategory, isBusinessSite, setSiteCategory };
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@7365admin1/layer-common",
   "license": "MIT",
   "type": "module",
-  "version": "4.72.0",
+  "version": "4.73.1-staging.452",
   "author": "7365admin1",
   "main": "./nuxt.config.ts",
   "//files": "What a consumer extending this layer actually loads. Without this npm ships the whole working tree - the changesets, the CI workflows, the render harness in tools/ and any scratch directory that happened to exist at publish time. Nuxt resolves a layer by directory, so every runtime directory below has to stay listed; adding a new top-level runtime directory means adding it here too.",

package/pages/[org]/[site]/access-mgmt/administrator/index.vue

@@ -5,7 +5,7 @@
       :org="orgId"
       message="Enable HID as a service for this site before managing HID users."
     >
-      <HidUserEnrollment :site="siteId" />
+      <HidUserEnrollment :site="siteId" :org="orgId" />
     </HidEnabledGate>
   </v-container>
 </template>

package/pages/[org]/[site]/access-mgmt/hid-cards/index.vue

@@ -5,7 +5,7 @@
       :org="orgId"
       message="Enable HID as a service for this site before managing physical HID cards."
     >
-      <HidUserEnrollment :site="siteId" card-management />
+      <HidUserEnrollment :site="siteId" :org="orgId" card-management />
     </HidEnabledGate>
   </v-container>
 </template>

package/pages/[org]/[site]/access-mgmt/hid-qr-code/index.vue

@@ -0,0 +1,23 @@
+<template>
+  <v-container fluid>
+    <HidEnabledGate
+      :site="siteId"
+      :org="orgId"
+      message="Enable HID as a service for this site before generating a QR code."
+    >
+      <HidProfileQrCode :site="siteId" />
+    </HidEnabledGate>
+  </v-container>
+</template>
+
+<script setup lang="ts">
+definePageMeta({
+  layout: "default",
+  middleware: ["01-auth", "02-org"],
+  memberOnly: true,
+});
+
+const route = useRoute();
+const siteId = computed(() => String(route.params.site ?? ""));
+const orgId = computed(() => String(route.params.org ?? ""));
+</script>

package/pages/[org]/[site]/access-mgmt/hid-readers/index.vue

@@ -5,7 +5,7 @@
       :org="orgId"
       message="Enable HID as a service for this site before managing HID readers."
     >
-      <HidReaderManagement :site="siteId" />
+      <HidReaderManagement :site="siteId" :org="orgId" />
     </HidEnabledGate>
   </v-container>
 </template>

package/types/document.d.ts

@@ -3,4 +3,18 @@ declare type TDocument = {
   name: string;
   attachment: string;
   type: string;
+  /**
+   * Set at upload or renewal, absent when the document never expires.
+   *
+   * An ISO instant on the way out of the API and a `YYYY-MM-DD` string on the
+   * way back in, which is what `InputDatePicker` binds to - hence the loose
+   * type rather than `string`.
+   */
+  expiryDate?: string | Date | null;
+  remarks?: string;
+  size?: number;
+  parentId?: string | null;
+  createdAt?: string | Date;
+  updatedAt?: string | Date;
+  status?: string;
 };

package/types/facility.d.ts

@@ -73,6 +73,10 @@ declare type TFacility = {
   hourInterval?: number;
   isBookingFeeEnabled: boolean;
   isGuestEnabled: boolean;
+  /** Residents may complete this facility's checklist themselves. */
+  isResidentChecklistEnabled?: boolean;
+  /** Security may complete it. Mutually exclusive with the above. */
+  isSecurityChecklistEnabled?: boolean;
   bookingAmount: number | null;
   peakBookingFeeAmount?: number | null;
   bookingFeeGuestAmount?: number | null;

package/types/inventory.d.ts

@@ -82,6 +82,11 @@ declare type TInventoryHolding = {
   packing?: string;
   /** Used by this holder since the start of the month (Singapore time). */
   usedThisMonth?: number;
+  holderLabel?: string;
+  /** How many sit in the holder's own usage drafts (not deducted until submitted), and what is still free. */
+  inDrafts?: number;
+  draftCount?: number;
+  free?: number;
 };
 
 declare type TInventoryTransaction = {
@@ -89,7 +94,7 @@ declare type TInventoryTransaction = {
   item: string;
   itemName: string;
   unit: string;
-  type: "opening" | "receive" | "issue" | "use" | "return" | "adjust" | "handover";
+  type: "opening" | "receive" | "issue" | "use" | "return" | "adjust" | "handover" | "use_draft";
   qty: number;
   storeChange: number;
   storeBalance: number;
@@ -97,7 +102,7 @@ declare type TInventoryTransaction = {
   holderChange?: number;
   holderBalance?: number;
   site?: string;
-  location?: { type: "common_area" | "tenant_unit"; area?: string; unitName?: string; tenantName?: string };
+  location?: { type: "common_area" | "tenant_unit"; area?: string; unit?: string; unitName?: string; tenantName?: string };
   reference?: string;
   supplier?: string;
   unitCost: number;
@@ -109,8 +114,19 @@ declare type TInventoryTransaction = {
   receivedBy?: string;
   date: string;
   createdByName: string;
+  holder?: string;
+  holderLabel?: string;
+  createdByLabel?: string;
+  /** Usage saved as a draft first. */
+  draftedAt?: string;
+  photosBeforeAt?: string | null;
+  photosAfterAt?: string | null;
+  submittedAt?: string;
 };
 
+/** A usage record saved with its before photo, waiting for the after photo (no stock deducted yet). */
+declare type TInventoryUsageDraft = TInventoryTransaction & { type: "use_draft"; stale: boolean; mine: boolean; clientRef?: string };
+
 declare type TInventoryPeriod = { from: string; to: string; site?: string; locationType?: string; usedBy?: string };
 
 /** An organisation's supplier (shared by its stores). Only the name is required. */

package/types/member.d.ts

@@ -10,6 +10,10 @@ declare type TMember = {
   customerOrgId?: string;
   customerSiteId?: string;
   status?: string;
+  email?: string;
+  /** The building unit this member manages (a unit's Management tab). */
+  unit?: string | null;
+  unitName?: string;
   createdAt?: string;
   updatedAt?: string;
   deletedAt?: string;

package/types/people.d.ts

@@ -22,11 +22,38 @@ declare type TPeople = {
   email?: string;
   files?: { name: string, id: string }[];
   isOwner?: boolean;
+  /**
+   * Owner / occupant / person-in-charge, as the BUSINESS people form asks it.
+   * Absent on everyone else - `isOwner` is still the flag that decides unit
+   * ownership, and the server derives it from this when it is sent. See
+   * `OccupancyRoles` in core's `person.model.ts`.
+   */
+  occupancyRole?: TOccupancyRole;
+  // Link to this person's `users` row. Empty for the person types that carry
+  // no login, and empty for a resident whose account was never written.
+  user?: string;
+};
+
+declare type TOccupancyRole = "owner" | "occupant" | "person-in-charge";
+
+/** One standing and everything the product says about it. See `utils/occupancy-role.ts`. */
+declare type TOccupancyRoleOption = {
+  value: TOccupancyRole;
+  /** The label a stored role is printed with. */
+  title: string;
+  /** The row menu's wording. */
+  action: string;
+  /** The confirmation's heading and its sentence. */
+  prompt: string;
+  description: string;
 };
 
 declare type TPlateNumber = { plateNumber: string, recNo?: string, _id?: string, status: TVehicleStatus, type: TVehicleType, anprCameras?: TVehicleAnprCamera[] };
 
 
-declare type TPeoplePayload = Pick<TGuest, "name" | "block" | "level" | "unit" | "unitName" | "contact" | "plateNumber" | "nric" | "contact" | "remarks" | "org" | "site" | "start" | "end" | "type" | "isOwner"> & { status?: string }
+// `""` is the FORM's "nothing picked yet" - it is stripped from the payload
+// before it is sent, because absence is what the server reads as "never
+// asked". See `PeopleFormMgmt.vue`.
+declare type TPeoplePayload = Pick<TGuest, "name" | "block" | "level" | "unit" | "unitName" | "contact" | "plateNumber" | "nric" | "contact" | "remarks" | "org" | "site" | "start" | "end" | "type" | "isOwner"> & { status?: string; user?: string; occupancyRole?: TOccupancyRole | "" }
 
 declare type TPeopleType = "guest" | "resident" | "tenant"

package/types/service-provider.d.ts

@@ -7,6 +7,11 @@ declare type TServiceProvider = {
   serviceProviderOrgId: string;
   type: string;
   nature: string;
+  status?: string;
+  email?: string;
+  /** The building unit this provider serves (a unit's Management tab). */
+  unit?: string | null;
+  unitName?: string;
 };
 
 declare type TServiceProviderName = {