@7365admin1/layer-common 4.125.1 → 4.126.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @iservice365/layer-common
 
+## 4.126.0
+
+### Minor Changes
+
+- 5e36856: Visitors: "Send pass by SMS" on the Visitors page (Guests tab, approved and not checked out, only when the site switch is on and the user may add visitors), and a "Send visitor pass by SMS" switch in Site Settings > Visitor registration (PM and Security). Shows the server's own words, e.g. "Sent to +65 ••••4567" or "SMS is not set up yet."
+
 ## 4.125.1
 
 ### Patch Changes
@@ -3294,11 +3300,11 @@ Monthly report: a month that had patrols opens the list of that month's patrol r
   `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/SiteSettings.vue

@@ -230,6 +230,9 @@
         <v-expansion-panel-text>
           <SiteSettingsVisitorRegistration :site-id="siteId" :site-data="siteData"
             :can-manage="canManageSiteSettings" @saved="refreshSiteData" @message="show" />
+          <v-divider class="my-4" />
+          <VisitorPassSmsSettings :site-id="siteId" :saved="(siteData as any)?.metadata?.visitorPassSms"
+            :loaded="!!siteData" :read-only="!canManageSiteSettings" @saved="refreshSiteData" />
         </v-expansion-panel-text>
       </v-expansion-panel>
 

package/components/VisitorManagement.vue

@@ -570,6 +570,24 @@
             </v-list-item>
           </v-card>
         </v-menu>
+        <!-- Walk-in pass by SMS: only when the site switched it on and this user may add visitors. -->
+        <v-menu
+          v-else-if="activeTab === 'guests' && item?.status === 'approved' && !item?.checkOut && canAddVisitor && passSmsEnabled"
+        >
+          <template #activator="{ props }">
+            <v-avatar v-bind="props" class="rounded-xl border-md" data-test="visitor-pass-sms-menu">
+              <v-icon icon="mdi-dots-vertical" />
+            </v-avatar>
+          </template>
+
+          <v-card>
+            <v-list-item data-test="visitor-pass-sms-open" @click.stop="openPassSms(item)">
+              <template #title>
+                <span class="text-caption">Send pass by SMS</span>
+              </template>
+            </v-list-item>
+          </v-card>
+        </v-menu>
       </template>
 
       <template v-slot:item.checkInRemarks="{ item }">
@@ -1560,6 +1578,35 @@
       </v-card>
     </v-dialog>
 
+    <v-dialog v-model="passSms.open" max-width="420">
+      <v-card data-test="visitor-pass-sms-dialog">
+        <v-toolbar color="transparent" density="comfortable" class="px-2">
+          <v-toolbar-title class="text-subtitle-1 font-weight-bold">Send pass by SMS</v-toolbar-title>
+          <v-btn icon="mdi-close" variant="text" title="Close" @click="passSms.open = false" />
+        </v-toolbar>
+        <v-card-text>
+          <p class="text-body-2 mb-3">
+            {{ passSms.name }} gets a text with the site name, the visit date and their pass link.
+          </p>
+          <v-text-field v-model.trim="passSms.phone" label="Mobile number" placeholder="e.g. 9123 4567"
+            density="comfortable" variant="outlined" maxlength="30" :disabled="passSms.sending"
+            data-test="visitor-pass-sms-phone" @keyup.enter="sendPassSmsNow" />
+          <p v-if="passSms.result" class="text-body-2 mt-1" :class="passSms.ok ? 'text-success' : 'text-error'"
+            data-test="visitor-pass-sms-result">
+            {{ passSms.result }}
+          </p>
+        </v-card-text>
+        <v-card-actions class="px-6 pb-4">
+          <v-spacer />
+          <v-btn variant="text" @click="passSms.open = false">Close</v-btn>
+          <v-btn class="screen-btn-primary" color="primary-button" variant="flat" :loading="passSms.sending"
+            :disabled="!passSms.phone" data-test="visitor-pass-sms-send" @click="sendPassSmsNow">
+            Send
+          </v-btn>
+        </v-card-actions>
+      </v-card>
+    </v-dialog>
+
     <Snackbar v-model="messageSnackbar" :text="message" :color="messageColor" />
   </v-row>
 </template>
@@ -1567,6 +1614,7 @@
 <script setup lang="ts">
 import moment from "moment-timezone";
 import QRCode from "qrcode";
+import { isVisitorPassSmsOn } from "../composables/useVisitor";
 import {
   VISITOR_SEARCH_DEBOUNCE_MS,
   visitorSearchEmptyText,
@@ -1637,6 +1685,7 @@ const {
   typeFieldMap,
   updateVisitor,
   visitorDataFromScannedQRCodeCheckIn,
+  sendPassSms,
 } = useVisitor();
 const { visitorCheckout } = useAccessManagement();
 const {
@@ -1673,6 +1722,37 @@ const hidQrVisitor = ref<Record<string, any> | null>(null);
 const hidQrConfig = ref({ enabled: false, readerId: "", validityMinutes: 60 });
 let hidQrTimer: ReturnType<typeof setInterval> | null = null;
 const hidQrEnabled = computed(() => hidQrConfig.value.enabled && Boolean(hidQrConfig.value.readerId));
+// Walk-in pass by SMS: read with the HID settings (same site document).
+const passSmsEnabled = ref(false);
+const passSms = reactive({ open: false, id: "", name: "", phone: "", sending: false, result: "", ok: false });
+
+function openPassSms(item: Record<string, any>) {
+  Object.assign(passSms, {
+    open: true,
+    id: String(item?._id ?? ""),
+    name: item?.name || "The visitor",
+    phone: String(item?.contact ?? ""),
+    sending: false,
+    result: "",
+    ok: false,
+  });
+}
+
+async function sendPassSmsNow() {
+  if (!passSms.id || !passSms.phone || passSms.sending) return;
+  passSms.sending = true;
+  passSms.result = "";
+  try {
+    const res: any = await sendPassSms(passSms.id, passSms.phone);
+    passSms.ok = true;
+    passSms.result = res?.message || "Sent.";
+  } catch (error: any) {
+    passSms.ok = false;
+    passSms.result = error?.data?.message || "The SMS could not be sent. Please try again in a minute.";
+  } finally {
+    passSms.sending = false;
+  }
+}
 const hidQrRemainingSeconds = computed(() => {
   const expiry = new Date(hidQrExpiresAt.value).getTime();
   return Number.isFinite(expiry) ? Math.max(0, Math.ceil((expiry - hidQrNow.value) / 1000)) : 0;
@@ -1683,6 +1763,7 @@ async function loadHidQrConfig() {
   try {
     const response: any = await getSiteById(siteId);
     const site = response?.data ?? response;
+    passSmsEnabled.value = isVisitorPassSmsOn(site);
     const config = site?.metadata?.hidQrCodePass ?? {};
     hidQrConfig.value = {
       enabled: Boolean(config.enabled && config.onlineMode !== false),
@@ -1690,6 +1771,7 @@ async function loadHidQrConfig() {
       validityMinutes: Number(config.validityMinutes) > 0 ? Number(config.validityMinutes) : 60,
     };
   } catch {
+    passSmsEnabled.value = false;
     hidQrConfig.value = { enabled: false, readerId: "", validityMinutes: 60 };
   }
 }

package/components/VisitorPassSmsSettings.vue

@@ -0,0 +1,57 @@
+<template>
+  <div data-test="visitor-pass-sms-settings">
+    <v-switch v-model="enabled" :disabled="readOnly" label="Send visitor pass by SMS" color="primary" hide-details
+      data-test="visitor-pass-sms-switch" />
+    <p class="text-caption text-medium-emphasis mt-1 mb-3">
+      Staff can text an approved visitor their pass link (the QR they show at the guardhouse). The text has the site
+      name, the visit date and the link only.
+    </p>
+    <v-btn v-if="!readOnly" class="screen-btn-primary" color="primary-button" variant="flat" text="Save"
+      :loading="saving" :disabled="!loaded" data-test="visitor-pass-sms-save" @click="save" />
+    <Snackbar v-model="toast.show" :text="toast.message" :color="toast.color" />
+  </div>
+</template>
+
+<script setup lang="ts">
+import useSiteFeatureSettings from "../composables/useSiteFeatureSettings";
+
+/**
+ * Site setting `metadata.visitorPassSms` (core site-feature-settings).
+ * Off = today: no "Send pass by SMS" action anywhere.
+ */
+const props = defineProps({
+  siteId: { type: String, required: true },
+  saved: { type: Object as PropType<{ enabled?: boolean } | null>, default: null },
+  readOnly: { type: Boolean, default: false },
+  /** The site has been read; Save stays off until then. */
+  loaded: { type: Boolean, default: false },
+});
+const emit = defineEmits(["saved"]);
+
+const enabled = ref(false);
+watch(
+  () => props.saved,
+  (v) => {
+    enabled.value = v?.enabled === true;
+  },
+  { immediate: true },
+);
+
+const { saveSiteFeature } = useSiteFeatureSettings();
+const saving = ref(false);
+const toast = reactive({ show: false, message: "", color: "" });
+
+async function save() {
+  if (!props.loaded) return;
+  saving.value = true;
+  try {
+    await saveSiteFeature(props.siteId, "visitorPassSms", { enabled: enabled.value });
+    Object.assign(toast, { show: true, message: "Saved.", color: "success" });
+    emit("saved");
+  } catch (e: any) {
+    Object.assign(toast, { show: true, message: e?.data?.message || "Could not save.", color: "error" });
+  } finally {
+    saving.value = false;
+  }
+}
+</script>

package/composables/useSiteFeatureSettings.ts

@@ -15,6 +15,7 @@ export const SITE_FEATURE_KEYS = [
   "feedbackSettings",
   "dataRetention",
   "maStaffRegistration",
+  "visitorPassSms",
 ] as const;
 
 export type TSiteFeatureKey = (typeof SITE_FEATURE_KEYS)[number];

package/composables/useVisitor.ts

@@ -173,6 +173,14 @@ export default function () {
     );
   }
 
+  /** Text the visit's pass link (walk-in pass by SMS). `phone` empty = the visit's contact. */
+  async function sendPassSms(_id: string, phone?: string) {
+    return await useNuxtApp().$api<{ message: string; to?: string }>(
+      `/api/visitor-transactions/${_id}/send-pass-sms`,
+      { method: "POST", body: phone ? { phone } : {} }
+    );
+  }
+
   async function updateVisitor(_id: string, payload: Partial<TVisitorPayload>) {
     return await useNuxtApp().$api<Record<string, any>>(
       `/api/visitor-transactions/id/${_id}`,
@@ -271,6 +279,7 @@ export default function () {
     validateVisitorQrCode,
     updateVisitorPassKey,
     visitorDataFromScannedQRCodeCheckIn,
+    sendPassSms,
   };
 }
 
@@ -293,6 +302,11 @@ export function getVisitorFieldSwitches(site: any): TVisitorFieldSwitches {
   };
 }
 
+/** "Send visitor pass by SMS" (`site.metadata.visitorPassSms`): off unless the site saved it on. */
+export function isVisitorPassSmsOn(site: any): boolean {
+  return site?.metadata?.visitorPassSms?.enabled === true;
+}
+
 /** Shown under the NRIC field on a "keep only the last 4" site. */
 export const NRIC_LAST4_HINT = "Only the last 4 characters will be kept.";
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@7365admin1/layer-common",
   "license": "MIT",
   "type": "module",
-  "version": "4.125.1",
+  "version": "4.126.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.",