@7365admin1/layer-common 4.62.0 → 4.63.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @iservice365/layer-common
 
+## 4.63.0
+
+### Minor Changes
+
+- cd0a5aa: Worker nouns follow the account type: one term map (`utils/worker-terms.ts`, `useWorkerTerm()`), keyed by the app's `appSlug`. Cleaning says Cleaners, security Security officers, pest control Pest technicians, M&E Technicians, landscape Gardeners, pool Pool attendants, property management Staff / Service staff, anything else Staff. Applied to Inventory (tab, report, usage column, export file name and sheet headers via `appSlug` on the export), Attendance, the schedule checklists, the security dashboard and NFC patrol report. Display only - field names and API keys are unchanged. `scripts/sync-worker-terms.mjs` copies the map into the mobile apps and API-core.
+
 ## 4.62.0
 
 ### Minor Changes
@@ -1679,11 +1685,11 @@
   `utils/console-tier.ts` + `composables/useConsoleTier.ts` mirror the server's
   own rule from two endpoints the console already calls, unprojected:
 
-                                                                                                                                                                                                                                                                          GET /api/members/user/:user/app/admin    the Seven365 staff membership
-                                                                                                                                                                                                                                                                          GET /api/roles/id/:role                  that membership's role document
+                                                                                                                                                                                                                                                                            GET /api/members/user/:user/app/admin    the Seven365 staff membership
+                                                                                                                                                                                                                                                                            GET /api/roles/id/:role                  that membership's role document
 
-                                                                                                                                                                                                                                                                          owner  = member.type === "admin" && role.type === "admin" && role.default === true
-                                                                                                                                                                                                                                                                          staff  = member.type === "admin" && role.type === "admin"
+                                                                                                                                                                                                                                                                            owner  = member.type === "admin" && role.type === "admin" && role.default === true
+                                                                                                                                                                                                                                                                            staff  = member.type === "admin" && role.type === "admin"
 
   `role.default` is the marker because it is the only property of a platform
   staff role no API caller can set - `role.controller.ts` validates create and

package/components/AreaChecklistHistoryMain.vue

@@ -2,7 +2,7 @@
   <v-row no-gutters align="center" justify="center">
     <v-col cols="12" lg="12">
       <TableMain
-        :title="'Cleaner Checklist'"
+        :title="checklistTitle"
         :headers="headers"
         :items="items"
         :loading="loading"
@@ -98,6 +98,10 @@
 
 <script setup lang="ts">
 import useCleaningSchedules from "../composables/useCleaningSchedules";
+import useWorkerTerm from "../composables/useWorkerTerm";
+import { workerTitle } from "../utils/worker-terms";
+// "Cleaner Checklist" in Hygiene, "Gardener Checklist" in Landscape, ...
+const checklistTitle = workerTitle(`${useWorkerTerm().one} checklist`);
 
 const props = defineProps({
   orgId: { type: String, required: true, default: "" },

package/components/AttendanceMain.vue

@@ -62,6 +62,7 @@
 
 <script setup lang="ts">
 import useAttendance from "../composables/useAttendance";
+import useWorkerTerm from "../composables/useWorkerTerm";
 import useUtils from "../composables/useUtils";
 
 const props = defineProps({
@@ -86,7 +87,7 @@ const searchInput = ref("");
 const items = ref<Array<Record<string, any>>>([]);
 
 const headers = [
-  { title: "Cleaner", value: "userName" },
+  { title: useWorkerTerm().one, value: "userName" },
   { title: "Check In", value: "checkInTimestamp" },
   { title: "Check Out", value: "checkOutTimestamp" },
   { title: "Total Hours", value: "totalHours" },

package/components/CleaningScheduleMain.vue

@@ -3,7 +3,7 @@
     <v-col cols="12" lg="12">
       <TableMain
         v-if="canViewSchedules"
-        :title="'Cleaner Checklist'"
+        :title="checklistTitle"
         :items="items"
         :headers="headers"
         :loading="loading"
@@ -11,7 +11,7 @@
         v-model:page="page"
         :pages="pages"
         :pageRange="pageRange"
-        :no-data-text="'No Cleaner Checklist found'"
+        :no-data-text="`No ${checklistTitle} found`"
         @refresh="getCleanerChecklistRefresh"
         @row-click="onRowClick"
       >
@@ -114,6 +114,10 @@
 
 <script lang="ts" setup>
 import useCleaningSchedules from "../composables/useCleaningSchedules";
+import useWorkerTerm from "../composables/useWorkerTerm";
+import { workerTitle } from "../utils/worker-terms";
+// "Cleaner Checklist" in Hygiene, "Gardener Checklist" in Landscape, ...
+const checklistTitle = workerTitle(`${useWorkerTerm().one} checklist`);
 import useUtils from "../composables/useUtils";
 
 const props = defineProps({

package/components/DashboardMain.vue

@@ -996,7 +996,7 @@
                   <strong>{{
                     item.userName || item.personName || "Unassigned"
                   }}</strong>
-                  <p>{{ item.role || item.designation || "Officer" }}</p>
+                  <p>{{ item.role || item.designation || worker.one }}</p>
                 </div>
                 <StatusChip :status="item.status || 'On duty'" pill />
               </div>
@@ -1233,6 +1233,7 @@ import type { CookieOptions } from "#app";
 import { buildWorkOrderStatus } from "../utils/dashboard";
 import { permissionsDenied } from "../utils/module-routes";
 import { grantsPermission } from "../utils/permission-spellings";
+import { workerTerm, workerTitle } from "../utils/worker-terms";
 import {
   hiddenDashboardWidgets,
   saveHiddenDashboardWidgets,
@@ -1369,6 +1370,8 @@ const isPropertyMode = computed(
   () => props.serviceType === "property_management_agency"
 );
 const isSecurityMode = computed(() => props.serviceType === "security_agency");
+// "Security officer" on the security dashboard; each service type's own noun elsewhere.
+const worker = computed(() => workerTerm(props.serviceType));
 const isHygieneMode = computed(
   () => !isPropertyMode.value && !isSecurityMode.value
 );
@@ -2963,7 +2966,7 @@ const printTableSections = computed<PrintTableSection[]>(() => {
         columns: [
           { key: "title", label: "Patrol Route", width: "30%", strong: true },
           { key: "subtitle", label: "Location", width: "30%" },
-          { key: "person", label: "Assigned Officer", width: "25%" },
+          { key: "person", label: workerTitle(`Assigned ${worker.value.one}`), width: "25%" },
           { key: "status", label: "Status", width: "15%", status: true },
         ],
         rows: activePatrolItems.value.map((item, index) => ({
@@ -2978,7 +2981,7 @@ const printTableSections = computed<PrintTableSection[]>(() => {
         key: "staffStatus",
         title: "Staff Status",
         columns: [
-          { key: "name", label: "Officer Name", width: "40%", strong: true },
+          { key: "name", label: workerTitle(`${worker.value.one} name`), width: "40%", strong: true },
           { key: "role", label: "Role / Designation", width: "40%" },
           {
             key: "status",
@@ -2991,7 +2994,7 @@ const printTableSections = computed<PrintTableSection[]>(() => {
         rows: securityStaffItems.value.map((item, index) => ({
           id: item.id || item._id || `security-staff-${index}`,
           name: item.userName || item.personName || "Unassigned",
-          role: item.role || item.designation || "Officer",
+          role: item.role || item.designation || worker.value.one,
           status: item.status || "On duty",
         })),
       }
@@ -3927,7 +3930,7 @@ async function exportDashboard(format: "PDF" | "Word") {
       if (isSecurityMode.value) {
         wordHtml += `<div class="section-title">Active Patrol</div>`;
         wordHtml += `<table class="data-table">`;
-        wordHtml += `<thead><tr><th>Patrol Route</th><th>Location</th><th>Assigned Officer</th><th>Status</th></tr></thead><tbody>`;
+        wordHtml += `<thead><tr><th>Patrol Route</th><th>Location</th><th>${workerTitle(`Assigned ${worker.value.one}`)}</th><th>Status</th></tr></thead><tbody>`;
         if (activePatrolItems.value.length > 0) {
           activePatrolItems.value.forEach((item) => {
             wordHtml += `<tr>
@@ -3946,14 +3949,14 @@ async function exportDashboard(format: "PDF" | "Word") {
 
         wordHtml += `<div class="section-title">Staff Status</div>`;
         wordHtml += `<table class="data-table">`;
-        wordHtml += `<thead><tr><th>Officer Name</th><th>Role / Designation</th><th>Status</th></tr></thead><tbody>`;
+        wordHtml += `<thead><tr><th>${workerTitle(`${worker.value.one} name`)}</th><th>Role / Designation</th><th>Status</th></tr></thead><tbody>`;
         if (securityStaffItems.value.length > 0) {
           securityStaffItems.value.forEach((item) => {
             wordHtml += `<tr>
               <td><strong>${
                 item.userName || item.personName || "Unassigned"
               }</strong></td>
-              <td>${item.role || item.designation || "Officer"}</td>
+              <td>${item.role || item.designation || worker.value.one}</td>
               <td><span class="status-badge badge-${getStatusTone(
                 item.status
               )}">${item.status || "On duty"}</span></td>

package/components/InventoryMain.vue

@@ -112,6 +112,7 @@
 
 <script setup lang="ts">
 import useInventory from "../composables/useInventory";
+import useWorkerTerm from "../composables/useWorkerTerm";
 import useSite from "../composables/useSite";
 import useUtils from "../composables/useUtils";
 import { inventoryStoreLabel } from "../utils/inventory-store-label";
@@ -160,6 +161,9 @@ const subtitle = computed(() => {
   return inventoryStoreLabel(store.value, stores.value);
 });
 
+// Who holds this store's stock: the property manager's store lends to service providers' workers.
+const worker = useWorkerTerm({ providers: true });
+
 const tabs = computed(() => {
   const a = store.value?.access;
   if (!a) return [];
@@ -167,7 +171,7 @@ const tabs = computed(() => {
     { value: "stock", label: "Stock" },
     ...(a.canRequest && !a.canManage ? [{ value: "mine", label: "My Stock" }] : []),
     { value: "requests", label: a.canApprove ? "Requests" : "My Requests", badge: a.canApprove ? pendingCount.value : 0 },
-    ...(a.canApprove ? [{ value: "technicians", label: "Technicians" }] : []),
+    ...(a.canApprove ? [{ value: "technicians", label: worker.many }] : []),
     ...(isStaff.value ? [{ value: "reports", label: "Reports" }] : []),
     ...(a.canManage ? [{ value: "settings", label: "Settings" }] : []),
   ];

package/components/InventoryReportsTab.vue

@@ -4,7 +4,7 @@
       <v-btn-toggle v-model="report" mandatory density="comfortable" variant="outlined" divided>
         <v-btn value="movement" class="text-none">Stock Movement</v-btn>
         <v-btn value="usage" class="text-none">Usage</v-btn>
-        <v-btn value="technicians" class="text-none">Technicians</v-btn>
+        <v-btn value="technicians" class="text-none">{{ worker.many }}</v-btn>
         <v-btn value="purchases" class="text-none">Purchases</v-btn>
       </v-btn-toggle>
       <v-select
@@ -133,6 +133,7 @@
 
 <script setup lang="ts">
 import useInventory, { saveBlob } from "../composables/useInventory";
+import useWorkerTerm from "../composables/useWorkerTerm";
 import useUtils from "../composables/useUtils";
 import useFile from "../composables/useFile";
 
@@ -150,6 +151,9 @@ const usagePhotos = (row: any) => [
 ];
 const notify = inject<(text: string, color?: string) => void>("inventoryNotify", () => {});
 
+const worker = useWorkerTerm({ providers: true });
+const appSlug = useRuntimeConfig().public?.appSlug as string | undefined;
+
 const now = new Date();
 const month = ref(`${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, "0")}`);
 const report = ref<"movement" | "usage" | "technicians" | "purchases">("movement");
@@ -204,7 +208,7 @@ const headers: Record<string, any[]> = {
     { title: "Qty", key: "qty" },
     { title: "Unit price", key: "unitCost" },
     { title: "Total", key: "totalCost" },
-    { title: "Technician", key: "technician" },
+    { title: worker.one, key: "technician" },
     { title: "Photos", key: "photos", sortable: false },
     { title: "Reference", key: "reference" },
     { title: "Reported by", key: "reportedBy" },
@@ -283,8 +287,8 @@ async function setChecked(checked: boolean) {
 async function exportExcel() {
   exporting.value = true;
   try {
-    const blob = await api.exportReport(props.store._id, report.value, period());
-    saveBlob(blob, `${props.store.name} - ${report.value} - ${month.value}.xlsx`);
+    const blob = await api.exportReport(props.store._id, report.value, { ...period(), appSlug });
+    saveBlob(blob, `${props.store.name} - ${report.value === "technicians" ? worker.many : report.value} - ${month.value}.xlsx`);
   } catch {
     notify("Could not export the report.", "error");
   } finally {

package/components/ManageChecklistMain.vue

@@ -460,6 +460,8 @@
 import { readListPage } from "../utils/list-page";
 import { isPhotoRefusal, isSetFinished } from "../utils/checklist-set";
 import useCleaningSchedules from "../composables/useCleaningSchedules";
+import useWorkerTerm from "../composables/useWorkerTerm";
+import { workerTitle } from "../utils/worker-terms";
 import useCustomerSite from "../composables/useCustomerSite";
 import useFile from "../composables/useFile";
 import useUtils from "../composables/useUtils";
@@ -480,14 +482,15 @@ const { getBySiteAsServiceProvider } = useCustomerSite();
 const { back } = useUtils();
 
 const route = useRoute();
+const workerChecklist = workerTitle(`${useWorkerTerm().one} checklist`);
 const scheduleTitle = computed(() => {
   const path = route.path;
   if (path.includes("cleaning-schedule")) return "Cleaning Checklist";
-  if (path.includes("technician-schedule")) return "Technician Checklist";
+  if (path.includes("technician-schedule")) return workerChecklist;
   if (path.includes("landscape-schedule")) return "Landscape Checklist";
   if (path.includes("pool-schedule")) return "Pool Checklist";
   if (path.includes("pest-schedule")) return "Pest Checklist";
-  return "Cleaner Checklist";
+  return workerChecklist;
 });
 
 const canAddRemarks = computed(() => props.canAddRemarks);

package/components/Nfc/PatrolReport/PatrolActivityTable.vue

@@ -45,7 +45,7 @@
               <v-img
                 v-if="activity.guardSignatureFileId"
                 :src="getFileUrl(activity.guardSignatureFileId)"
-                :alt="`${activity.guardName || 'Guard'} signature`"
+                :alt="`${activity.guardName || worker.one} signature`"
                 class="guard-signature"
                 contain
               />
@@ -78,11 +78,13 @@
 </template>
 
 <script setup lang="ts">
+import useWorkerTerm from "../../../composables/useWorkerTerm";
 import type {
   NFCPatrolActivity,
   NFCPatrolActivityStatus,
 } from "../../../types/nfc-patrol-report";
 
+const worker = useWorkerTerm();
 defineProps<{
   activities: NFCPatrolActivity[];
 }>();

package/components/Nfc/PatrolReport/SummaryReportTable.vue

@@ -44,7 +44,7 @@
               <v-img
                 v-if="row.guardSignatureFileId"
                 :src="getFileUrl(row.guardSignatureFileId)"
-                :alt="`${row.guardName || 'Guard'} signature`"
+                :alt="`${row.guardName || worker.one} signature`"
                 class="guard-signature"
                 contain
               />
@@ -65,11 +65,13 @@
 </template>
 
 <script setup lang="ts">
+import useWorkerTerm from "../../../composables/useWorkerTerm";
 import type {
   NFCPatrolReportSummaryRow,
   NFCPatrolReportSummaryStatus,
 } from "../../../types/nfc-patrol-report";
 
+const worker = useWorkerTerm();
 defineProps<{
   title: string;
   rows: NFCPatrolReportSummaryRow[];

package/components/ScheduleAreaMain.vue

@@ -2,7 +2,7 @@
   <v-row no-gutters align="center" justify="center">
     <v-col cols="12" lg="12">
       <TableMain
-        :title="'Cleaner Checklist'"
+        :title="checklistTitle"
         :headers="headers"
         :items="items"
         :loading="loading"
@@ -160,6 +160,10 @@
 
 <script setup lang="ts">
 import useCleaningSchedules from "../composables/useCleaningSchedules";
+import useWorkerTerm from "../composables/useWorkerTerm";
+import { workerTitle } from "../utils/worker-terms";
+// "Cleaner Checklist" in Hygiene, "Gardener Checklist" in Landscape, ...
+const checklistTitle = workerTitle(`${useWorkerTerm().one} checklist`);
 import useUtils from "../composables/useUtils";
 
 const props = defineProps({

package/composables/useInventory.ts

@@ -57,7 +57,7 @@ export default function useInventory() {
 
     getReport: (store: string, report: "movement" | "usage" | "technicians" | "purchases", query: TInventoryPeriod & { unchecked?: boolean }) =>
       api<{ rows: any[]; totalQty?: number; totalCost?: number }>(`/stores/${store}/reports/${report}`, { query }),
-    exportReport: (store: string, report: string, query: TInventoryPeriod) =>
+    exportReport: (store: string, report: string, query: TInventoryPeriod & { appSlug?: string }) =>
       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/useWorkerTerm.ts

@@ -0,0 +1,10 @@
+import { workerTerm } from "../utils/worker-terms";
+
+/**
+ * The worker noun for the app this page runs in ("Cleaner" in Hygiene,
+ * "Security officer" in Security, ...). See utils/worker-terms.ts.
+ * Apps without `runtimeConfig.public.appSlug` get the neutral "Staff".
+ */
+export default function useWorkerTerm(opts?: { providers?: boolean }) {
+  return workerTerm(useRuntimeConfig().public?.appSlug as string | undefined, opts);
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@7365admin1/layer-common",
   "license": "MIT",
   "type": "module",
-  "version": "4.62.0",
+  "version": "4.63.0",
   "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/utils/worker-terms.ts

@@ -0,0 +1,80 @@
+/**
+ * What each kind of account calls the people who do its work.
+ *
+ * A cleaning company's workers are cleaners, not technicians. Every screen,
+ * export and mobile app takes the noun from here, keyed by the app it runs in
+ * (`appSlug`, e.g. "iservice365-web-app-hygiene" or
+ * "iservice365-hygiene-mobile-app"); a service-type code ("hygiene",
+ * "security_agency", ...) resolves the same way. Only the words change -
+ * field names and API keys (`technician`, `usedByTechnicians`,
+ * `/reports/technicians`) stay as they are.
+ *
+ * Copied into the React Native apps and API-core by
+ * `scripts/sync-worker-terms.mjs`, so it must stay free of imports.
+ */
+
+export type TWorkerTerm = {
+  /** Singular, sentence case: "Cleaner", "Security officer". */
+  one: string;
+  /** Plural, sentence case: "Cleaners", "Staff". */
+  many: string;
+};
+
+export type TWorkerKind =
+  | "hygiene"
+  | "security"
+  | "pest"
+  | "mechanical"
+  | "landscape"
+  | "pool"
+  | "property"
+  | "service"
+  | "staff";
+
+export const WORKER_TERMS: Record<TWorkerKind, TWorkerTerm> = {
+  hygiene: { one: "Cleaner", many: "Cleaners" },
+  security: { one: "Security officer", many: "Security officers" },
+  pest: { one: "Pest technician", many: "Pest technicians" },
+  mechanical: { one: "Technician", many: "Technicians" },
+  landscape: { one: "Gardener", many: "Gardeners" },
+  pool: { one: "Pool attendant", many: "Pool attendants" },
+  // The property manager's own team.
+  property: { one: "Staff member", many: "Staff" },
+  // Other companies' workers, as a property manager sees them.
+  service: { one: "Service staff member", many: "Service staff" },
+  // Anything else (organisation console, Super Admin, unknown app).
+  staff: { one: "Staff member", many: "Staff" },
+};
+
+// ponytail: keyword match covers every web slug, mobile slug and service-type code in use; add a row when a new app kind appears.
+const KINDS: [RegExp, TWorkerKind][] = [
+  [/hygiene|clean/, "hygiene"],
+  [/secur/, "security"],
+  [/pest/, "pest"],
+  [/mechanical|m-and-e/, "mechanical"],
+  [/landscap/, "landscape"],
+  [/pool/, "pool"],
+  [/property|-ma-/, "property"],
+];
+
+export function workerKind(appSlug?: string | null): TWorkerKind {
+  const slug = String(appSlug ?? "").toLowerCase();
+  for (const [pattern, kind] of KINDS) if (pattern.test(slug)) return kind;
+  return "staff";
+}
+
+/**
+ * The noun for this app. `providers: true` is for lists of people from the
+ * service providers a property manager supplies (e.g. who holds stock from
+ * the property store): the property manager's app says "Service staff";
+ * every other app keeps its own noun.
+ */
+export function workerTerm(appSlug?: string | null, opts?: { providers?: boolean }): TWorkerTerm {
+  const kind = workerKind(appSlug);
+  return WORKER_TERMS[opts?.providers && kind === "property" ? "service" : kind];
+}
+
+/** Title case for headings and column titles: "Security officer name" -> "Security Officer Name". */
+export function workerTitle(text: string): string {
+  return String(text).replace(/(^|\s)(\S)/g, (_m, space: string, first: string) => space + first.toUpperCase());
+}