@7365admin1/layer-common 4.73.1-staging.455 → 4.74.0

package/components/HidProfileQrCode.vue

@@ -1,332 +0,0 @@
-<!--
-  MY HID QR CODE.
-
-  The signed-in member's own pass for one reader. Every other HID screen acts on
-  somebody else - a resident being enrolled, a visitor being issued a pass. This
-  one has no subject picker at all, because the server takes the caller from the
-  session and there is no user id to send.
-
-  Issuing a code does NOT grant access. A member's door permission comes from the
-  HID permissions screen, and minting an access rule here would let anyone who
-  can press Generate admit themselves. So the screen reports what the permissions
-  screen says (`assigned`) and warns when a code would be refused at the door,
-  rather than handing out something that silently fails.
--->
-<template>
-  <div class="hid-profile-qr">
-    <div class="hid-profile-qr__header">
-      <h2 class="hid-profile-qr__title">HID QR Code</h2>
-      <AppSelect
-        v-if="readerOptions.length"
-        v-model="selectedReaderId"
-        class="reader-select"
-        :items="readerOptions"
-        @update:model-value="loadProfile"
-      />
-    </div>
-
-    <v-card class="screen-modal hid-profile-qr__card">
-      <v-card-text class="screen-modal__body">
-        <div v-if="loading" class="hid-profile-qr__state">Loading...</div>
-
-        <div v-else-if="!readerOptions.length" class="hid-profile-qr__state">
-          No HID reader is set up for this site yet.
-        </div>
-
-        <template v-else>
-          <p class="hid-profile-qr__reader">
-            {{ profile?.readerName || "HID reader" }}
-            <span>{{ profile?.portalName || "Portal not configured" }}</span>
-          </p>
-
-          <!-- A code this reader cannot read is worse than no code, so the
-               capability is checked before anything is offered. -->
-          <v-alert
-            v-if="profile && !profile.qrEnabled"
-            type="warning"
-            variant="tonal"
-            density="compact"
-            class="mb-4"
-          >
-            This reader is not set up to read QR codes.
-          </v-alert>
-
-          <!-- The honest part: a code opens the door only for a member the
-               permissions screen already admits. `assigned` is null when the
-               lookup failed, which is not the same as "no". -->
-          <v-alert
-            v-else-if="profile && profile.assigned === false"
-            type="warning"
-            variant="tonal"
-            density="compact"
-            class="mb-4"
-          >
-            You are not assigned to this reader, so this code will be refused at
-            the door. Ask a property manager to add you on the HID permissions
-            screen.
-          </v-alert>
-
-          <div v-if="qrImage" class="hid-profile-qr__code">
-            <img :src="qrImage" alt="Your HID QR code" width="220" height="220" />
-            <p class="hid-profile-qr__issued">
-              Issued {{ formatIssuedAt(profile?.issuedAt) }}
-            </p>
-          </div>
-          <p v-else class="hid-profile-qr__state">
-            You have no QR code on this reader yet.
-          </p>
-
-          <div class="hid-profile-qr__actions">
-            <AppButton
-              :disabled="working || !profile?.qrEnabled"
-              @click="generate"
-            >
-              {{ profile?.issued ? "Regenerate" : "Generate QR Code" }}
-            </AppButton>
-            <AppButton
-              v-if="qrImage"
-              variant="ghost"
-              icon="mdi-download"
-              @click="downloadQr"
-            >
-              Download
-            </AppButton>
-            <AppButton
-              v-if="profile?.issued"
-              variant="ghost"
-              :disabled="working"
-              @click="remove"
-            >
-              Remove
-            </AppButton>
-          </div>
-
-          <p class="field-hint">
-            Regenerating replaces the previous code. The old one stops working
-            immediately.
-          </p>
-        </template>
-      </v-card-text>
-    </v-card>
-
-    <v-snackbar v-model="snackbar.show" :color="snackbar.color" timeout="4000">
-      {{ snackbar.message }}
-    </v-snackbar>
-  </div>
-</template>
-
-<script setup lang="ts">
-import QRCode from "qrcode";
-import type { HidProfileQr } from "../composables/useHidAmico";
-
-const props = defineProps<{ site: string }>();
-
-const { getReaders, getProfileQr, issueProfileQr, deleteProfileQr } = useHidAmico();
-
-type HidReaderOption = { _id: string; name?: string; portalName?: string };
-
-const readers = ref<HidReaderOption[]>([]);
-const { selectHidReader, resolveForSite } = useHidReaderSelection();
-const selectedReaderId = ref("");
-const profile = ref<HidProfileQr | null>(null);
-const qrImage = ref("");
-const loading = ref(false);
-const working = ref(false);
-const snackbar = reactive({ show: false, color: "success", message: "" });
-
-const readerOptions = computed(() => readers.value.map((reader) => ({
-  title: `${reader.name || reader._id} — ${reader.portalName || "Portal not configured"}`,
-  value: reader._id,
-})));
-
-function showToast(message: string, color: "success" | "error" = "success") {
-  snackbar.message = message;
-  snackbar.color = color;
-  snackbar.show = true;
-}
-
-function toRecord(value: unknown): Record<string, any> {
-  return value && typeof value === "object" ? (value as Record<string, any>) : {};
-}
-
-function errorMessage(error: unknown) {
-  const record = toRecord(error);
-  return String(toRecord(record.data).message || record.message || "Something went wrong.");
-}
-
-function formatIssuedAt(value?: string) {
-  if (!value) return "";
-  const date = new Date(value);
-  return Number.isNaN(date.getTime()) ? "" : date.toLocaleString();
-}
-
-/**
- * The image is drawn here, never fetched. The value is the credential itself,
- * so keeping it on this page and out of any URL is the point.
- */
-async function renderQr(value: string) {
-  if (!value) {
-    qrImage.value = "";
-    return;
-  }
-  try {
-    qrImage.value = await QRCode.toDataURL(value, { width: 440, margin: 1 });
-  } catch (error) {
-    console.error("Unable to render the HID QR code:", error);
-    qrImage.value = "";
-  }
-}
-
-/**
- * Saves the rendered code as a PNG.
- *
- * Straight off the data URL already in the page - no request, so the credential
- * never travels again to be downloaded. Same anchor-click approach `VisitorForm`
- * uses for a visitor pass, and the reader name is in the file name because a
- * member can hold one code per reader.
- */
-function downloadQr() {
-  if (!qrImage.value) return;
-  const slug = String(profile.value?.readerName || "reader")
-    .trim()
-    .replace(/[^a-z0-9]+/gi, "-")
-    .replace(/^-|-$/g, "")
-    .toLowerCase();
-  const link = document.createElement("a");
-  link.href = qrImage.value;
-  link.download = `hid-qr-${slug || "reader"}.png`;
-  link.click();
-}
-
-async function loadReaders() {
-  if (!props.site) return;
-  const response = toRecord(await getReaders({ site: props.site, page: 1, limit: 100 }));
-  const data = toRecord(response.data);
-  const items = response.items ?? data.items ?? data.readers ?? [];
-  readers.value = (Array.isArray(items) ? items : []).filter((reader) => reader?._id);
-  /* Shared with every other HID screen — see `useHidReaderSelection`. The
-     resolver refuses a remembered reader that is not this site's, so a site
-     switch or a deleted reader falls back to the first rather than querying
-     an id the site does not own. */
-  selectedReaderId.value = resolveForSite(props.site, readers.value);
-}
-
-async function loadProfile() {
-  if (!selectedReaderId.value) return;
-  loading.value = true;
-  try {
-    const response = await getProfileQr(selectedReaderId.value);
-    profile.value = response?.data ?? null;
-    await renderQr(profile.value?.qrValue || "");
-  } catch (error: unknown) {
-    profile.value = null;
-    qrImage.value = "";
-    showToast(errorMessage(error), "error");
-  } finally {
-    loading.value = false;
-  }
-}
-
-async function generate() {
-  if (!selectedReaderId.value) return;
-  working.value = true;
-  try {
-    const response = await issueProfileQr(selectedReaderId.value);
-    profile.value = response?.data ?? null;
-    await renderQr(profile.value?.qrValue || "");
-    showToast("QR code generated.");
-  } catch (error: unknown) {
-    showToast(errorMessage(error), "error");
-  } finally {
-    working.value = false;
-  }
-}
-
-async function remove() {
-  if (!selectedReaderId.value) return;
-  if (!window.confirm("Remove your QR code from this reader?")) return;
-  working.value = true;
-  try {
-    const response = await deleteProfileQr(selectedReaderId.value);
-    profile.value = response?.data ?? null;
-    await renderQr("");
-    showToast("QR code removed.");
-  } catch (error: unknown) {
-    showToast(errorMessage(error), "error");
-  } finally {
-    working.value = false;
-  }
-}
-
-watch(
-  () => props.site,
-  async () => {
-    await loadReaders();
-    await loadProfile();
-  },
-  { immediate: true },
-);
-
-/* Publish every change, including the seed above: a screen that had to fall
-   back to the first reader should leave the others agreeing with it. */
-watch(selectedReaderId, (value) => {
-  if (value) selectHidReader(props.site, value);
-});
-</script>
-
-<style scoped>
-.hid-profile-qr__header {
-  display: flex;
-  align-items: center;
-  gap: 12px;
-  flex-wrap: wrap;
-}
-
-.hid-profile-qr__title {
-  margin: 0;
-  font-size: 18px;
-  font-weight: 600;
-}
-
-.hid-profile-qr__card {
-  margin-top: 16px;
-  max-width: 460px;
-}
-
-.hid-profile-qr__reader {
-  margin: 0 0 14px;
-  font-size: 14px;
-  font-weight: 600;
-}
-
-.hid-profile-qr__reader span {
-  display: block;
-  color: var(--muted);
-  font-size: 12px;
-  font-weight: 500;
-}
-
-.hid-profile-qr__code {
-  display: grid;
-  place-items: center;
-  margin-bottom: 14px;
-}
-
-.hid-profile-qr__issued {
-  margin: 8px 0 0;
-  color: var(--muted);
-  font-size: 12px;
-}
-
-.hid-profile-qr__state {
-  color: var(--muted);
-  font-size: 13.5px;
-  padding: 8px 0 14px;
-}
-
-.hid-profile-qr__actions {
-  display: flex;
-  gap: 8px;
-  flex-wrap: wrap;
-}
-</style>

package/composables/useHidReaderSelection.ts

@@ -1,50 +0,0 @@
-import {
-  EMPTY_HID_READER_CHOICE,
-  resolveHidReaderId,
-  type HidReaderChoice,
-} from "../utils/hid-reader-selection";
-
-/**
- * ONE HID READER CHOICE, SHARED BY EVERY HID SCREEN.
- *
- * Declared at MODULE scope on purpose. Each screen held its own `ref("")`, and
- * because the HID screens are separate pages the ref was rebuilt on every
- * navigation — HID Reader Users, HID Cards, Access Logs and HID QR Code each
- * reset to the first reader no matter what had just been picked next door.
- *
- * A module-scoped ref is enough because moving between those pages is a ROUTE
- * change, not a page load: the menu's items carry a `route` and
- * `NavigationItem.vue` renders them through `:to`, so vue-router handles them
- * and this module is never re-evaluated.
- *
- * Deliberately NOT persisted. `localStorage` would carry the choice through a
- * hard refresh as well, which is a real but much smaller benefit than the
- * navigation case, and it is worth adding only once somebody has felt the
- * absence. See `utils/hid-reader-selection.ts` for the staleness rule that
- * would have to hold either way.
- *
- * Intercom keeps its own reader and is not wired to this. Its question is which
- * panel you are calling, not which door you are administering, and joining them
- * would mean switching reader on Access Logs changed who you would dial.
- */
-const choice = ref<HidReaderChoice>({ ...EMPTY_HID_READER_CHOICE });
-
-export default function useHidReaderSelection() {
-  /** Remember a choice. The site travels with it; an id alone means nothing. */
-  function selectHidReader(siteId: string, readerId: string) {
-    choice.value = { siteId: String(siteId ?? ""), readerId: String(readerId ?? "") };
-  }
-
-  /**
-   * The reader this screen should show, given the readers it just loaded.
-   *
-   * Call it after the reader list arrives, and write the answer back with
-   * `selectHidReader` so the screens agree on what "current" means even when
-   * one of them had to fall back to the first reader.
-   */
-  function resolveForSite(siteId: string, readers: readonly { _id?: unknown }[]) {
-    return resolveHidReaderId(siteId, readers, choice.value);
-  }
-
-  return { choice, selectHidReader, resolveForSite };
-}

package/composables/useSiteCategory.ts

@@ -1,45 +0,0 @@
-/**
- * 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/pages/[org]/[site]/access-mgmt/hid-qr-code/index.vue

@@ -1,23 +0,0 @@
-<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/utils/hid-permission-assignments.ts

@@ -1,190 +0,0 @@
-/**
- * WHO IS ASSIGNED TO A HID READER — the editing model behind the permissions
- * dialog.
- *
- * This is the step that actually grants access. Enrolling a person gives the
- * reader a face, a card or a PIN it can RECOGNISE; it puts nobody in the group
- * the access rule is attached to, so a recognised person is still refused at
- * the door (access log event 6). `PUT /sites/:siteId/permissions` is the only
- * call in the system that writes that group membership.
- *
- * Two contracts make this file necessary rather than inlining the logic in the
- * component:
- *
- * 1. **The PUT REPLACES the whole assignment set for the reader.** The server
- *    keeps other readers' rows and overwrites this reader's with exactly what
- *    is sent. The candidate list, however, is fetched ONE CATEGORY AT A TIME.
- *    Saving from the tab in front of you while sending only that tab's people
- *    would silently revoke every resident if you were looking at the service
- *    providers tab. So the edit state is held for the whole reader and the
- *    payload is always built from all of it.
- *
- * 2. **The body schema accepts three keys and nothing else.**
- *    `hidPermissionAssignmentSchema` is `{ subjectId, category, intercom }`,
- *    and Joi rejects unknown keys rather than stripping them. The candidate
- *    rows carry `name`, `subtitle`, `location` and friends for display, so the
- *    payload has to be narrowed deliberately — passing a candidate straight
- *    through is a 400.
- */
-
-/** The three real categories. `intercom` is a candidate FILTER, never a category. */
-export const HID_PERMISSION_CATEGORIES: THidPermissionCategory[] = [
-  "resident",
-  "property_management",
-  "service_provider",
-];
-
-export type HidAssignmentState = Map<string, { category: THidPermissionCategory; intercom: boolean }>;
-
-/** Body row for `updateSitePermissions` — exactly the keys Joi allows. */
-export type HidAssignmentPayload = {
-  subjectId: string;
-  category: THidPermissionCategory;
-  intercom: boolean;
-};
-
-function isRealCategory(value: unknown): value is THidPermissionCategory {
-  return HID_PERMISSION_CATEGORIES.includes(value as THidPermissionCategory);
-}
-
-/**
- * The reader's CURRENT assignments, as the edit state.
- *
- * Seeded from `getSitePermissions`, which returns every category at once —
- * that is what makes a whole-reader payload possible from a one-category view.
- * Rows with an unrecognised category are dropped rather than carried: sending
- * one back fails the enum check and takes the entire save with it.
- */
-export function seedAssignments(
-  assignments: readonly THidPermissionAssignment[] | undefined | null,
-): HidAssignmentState {
-  const state: HidAssignmentState = new Map();
-  if (!Array.isArray(assignments)) return state;
-  for (const assignment of assignments) {
-    const subjectId = String(assignment?.subjectId ?? "");
-    if (!subjectId || !isRealCategory(assignment?.category)) continue;
-    state.set(subjectId, {
-      category: assignment.category,
-      intercom: assignment.intercom === true,
-    });
-  }
-  return state;
-}
-
-/**
- * Add or remove one person.
- *
- * `saved` is the state the dialog opened with, and it is consulted for one
- * reason: the `intercom` flag. Nothing here edits that flag, but
- * `userHasSiteIntercomPermission` reads it off these same rows, so it must
- * survive a round trip through the checkbox.
- *
- * - **Untick then save** drops it, which is right — an unassigned person
- *   holding a dangling intercom right would keep answering the door panel
- *   after losing the door.
- * - **Untick then re-tick, without saving** must restore it. Removing from the
- *   draft forgets the flag, so re-adding recovers it from `saved`; otherwise a
- *   misclick corrected a second later would silently revoke intercom on the
- *   next save, with nothing on screen to show it had happened.
- */
-export function setAssignment(
-  state: HidAssignmentState,
-  saved: HidAssignmentState,
-  subjectId: string,
-  category: THidPermissionCategory,
-  selected: boolean,
-): HidAssignmentState {
-  const next: HidAssignmentState = new Map(state);
-  const id = String(subjectId ?? "");
-  if (!id || !isRealCategory(category)) return next;
-  if (!selected) {
-    next.delete(id);
-    return next;
-  }
-  const intercom = next.get(id)?.intercom ?? saved.get(id)?.intercom ?? false;
-  next.set(id, { category, intercom: intercom === true });
-  return next;
-}
-
-/** The whole reader's assignments, narrowed to the three keys the API accepts. */
-export function toAssignmentPayload(state: HidAssignmentState): HidAssignmentPayload[] {
-  return [...state.entries()].map(([subjectId, value]) => ({
-    subjectId,
-    category: value.category,
-    intercom: value.intercom === true,
-  }));
-}
-
-/**
- * The server sends `selected` with each candidate, describing what is SAVED.
- * Once the dialog is open the local edit state is the truth, so the flag is
- * recomputed rather than trusted — otherwise paging or searching would redraw
- * a row with the saved value and quietly discard an unsaved tick.
- */
-export function applySelection(
-  candidates: readonly THidPermissionCandidate[] | undefined | null,
-  state: HidAssignmentState,
-): THidPermissionCandidate[] {
-  if (!Array.isArray(candidates)) return [];
-  return candidates.map((candidate) => ({
-    ...candidate,
-    selected: state.has(String(candidate?.subjectId ?? "")),
-  }));
-}
-
-/** Per-category totals for the dialog header, counted over the whole reader. */
-export function countByCategory(state: HidAssignmentState): Record<THidPermissionCategory, number> {
-  const counts = { resident: 0, property_management: 0, service_provider: 0 } as Record<
-    THidPermissionCategory,
-    number
-  >;
-  for (const value of state.values()) counts[value.category] += 1;
-  return counts;
-}
-
-/** Has anything changed since the dialog opened? Drives the Save button. */
-export function hasChanges(saved: HidAssignmentState, draft: HidAssignmentState): boolean {
-  if (saved.size !== draft.size) return true;
-  for (const [subjectId, value] of draft) {
-    const before = saved.get(subjectId);
-    if (!before) return true;
-    if (before.category !== value.category) return true;
-    if (before.intercom !== value.intercom) return true;
-  }
-  return false;
-}
-
-/**
- * What a listing response tells us: the rows, and how many pages exist.
- *
- * It deliberately does NOT return the current page, and the caller must keep
- * owning that. `paginate` in `@7365admin1/node-server-utils` returns only
- * `{ items, pages, pageRange }` — it never echoes the page it was asked for. A
- * caller that read one back therefore got a default on every fetch and pinned
- * itself to page one, so the pager moved and the rows never did.
- *
- * `items` sits at the root on some of these endpoints and under `data` on
- * others, so both are read.
- */
-export function readCandidatePage(response: unknown): {
-  items: THidPermissionCandidate[];
-  pages: number;
-  pageRange: string;
-} {
-  const source = (response && typeof response === "object" ? response : {}) as Record<string, unknown>;
-  const nested = (source.data && typeof source.data === "object" ? source.data : {}) as Record<string, unknown>;
-  const items = Array.isArray(source.items)
-    ? source.items
-    : Array.isArray(nested.items)
-      ? nested.items
-      : [];
-  const pages = Number(source.pages ?? nested.pages ?? 1);
-  // `paginate` builds this ("1-10 of 37") and the table renders it verbatim.
-  // Without it the pager draws its placeholder, "-- - -- of --".
-  const pageRange = String(source.pageRange ?? nested.pageRange ?? "");
-  return {
-    items: items as THidPermissionCandidate[],
-    pages: Number.isFinite(pages) && pages > 0 ? pages : 1,
-    pageRange,
-  };
-}

package/utils/hid-reader-selection.ts

@@ -1,52 +0,0 @@
-/**
- * WHICH HID READER THE OPERATOR IS WORKING ON — the one rule behind it.
- *
- * Every HID screen used to hold its own `ref("")` and default it to
- * `readers[0]`, so picking HID 2 on HID Reader Users and clicking through to
- * HID Cards put you back on HID 1. They are separate PAGES, so the component
- * unmounted and the ref was rebuilt from scratch every time — there was no way
- * to make a choice stick. "I am working on HID 2" is a mode, not a per-screen
- * preference.
- *
- * Navigation between those pages is a route change rather than a page load
- * (`NavigationItem.vue` renders the menu's `route` through `:to`), so the
- * module-scoped ref in `useHidReaderSelection` survives it. This file holds the
- * part worth testing: deciding whether a remembered choice may still be used.
- */
-
-export type HidReaderChoice = { siteId: string; readerId: string };
-
-/** Anything with an id — the four screens all carry a different reader shape. */
-type ReaderLike = { _id?: unknown };
-
-export const EMPTY_HID_READER_CHOICE: HidReaderChoice = { siteId: "", readerId: "" };
-
-/**
- * The reader a screen should show, given what this site actually has.
- *
- * A remembered id is honoured ONLY when it belongs to this site and is still in
- * the list. That single condition covers every way it goes stale:
- *
- * - the operator switched site, so the id belongs to a site they have left
- * - the reader was deleted or deactivated since they chose it
- * - nothing has been chosen yet
- *
- * In all three the first reader is returned instead. The alternative — using
- * the id anyway — sends requests for a reader the site does not own, which come
- * back empty and read on screen as a reader with no users, no cards and no
- * logs, rather than as the mistake it is.
- */
-export function resolveHidReaderId(
-  siteId: string,
-  readers: readonly ReaderLike[] | null | undefined,
-  choice: HidReaderChoice = EMPTY_HID_READER_CHOICE,
-): string {
-  const ids = (Array.isArray(readers) ? readers : [])
-    .map((reader) => String(reader?._id ?? ""))
-    .filter(Boolean);
-
-  if (choice.siteId === String(siteId ?? "") && ids.includes(choice.readerId)) {
-    return choice.readerId;
-  }
-  return ids[0] ?? "";
-}