@7365admin1/layer-common 4.149.2 → 4.151.0

package/components/HidReaderForm.vue

@@ -49,6 +49,60 @@
           Disabling keeps the reader in Standalone mode and uses manual log pulls instead.
         </p>
 
+        <!-- WHO THIS READER IS FOR.
+             A site with several doors rarely wants every door open to everybody:
+             a service entrance for contractors, a lobby for residents. Switching
+             an audience off stops new grants in that category - the server
+             refuses them, so this is not only a hint - and takes the matching tab
+             off the Access Permissions screen.
+             Each switch says what it DOES rather than only what it is called: a
+             row of four labels with no sentences is a guess about what they
+             control. -->
+        <InputLabel title="Who may use this reader" required class="mb-1" />
+        <div class="reader-audiences mb-1">
+          <div
+            v-for="field in audienceFields"
+            :key="field.value"
+            class="reader-audience"
+          >
+            <v-switch
+              v-model="audiences[field.value]"
+              :label="field.label"
+              :aria-label="field.label"
+              hide-details
+              inset
+              density="compact"
+              :color="audiences[field.value] ? 'success' : 'muted'"
+            />
+            <p class="reader-audience__hint">{{ field.hint }}</p>
+          </div>
+        </div>
+        <!-- WHAT THIS SAVE TAKES AWAY.
+             Switching an account type off revokes the people already granted
+             this reader - their credentials stay on the device, so they go from
+             authorised to recognised-and-refused and back again if it is switched
+             on later. Said with a number, because "removes access" and "removes
+             access for 40 people" are different decisions. -->
+        <p v-if="revocationWarning" class="reader-discovery-hint reader-audiences__revoking mb-1">
+          {{ revocationWarning }}
+        </p>
+        <!-- And whether anybody is left with a door at all. -->
+        <p v-if="strandedWarning" class="reader-discovery-hint reader-audiences__empty mb-1">
+          {{ strandedWarning }}
+        </p>
+        <p v-if="needsConfirmation && revocationConfirmed" class="reader-discovery-hint reader-audiences__revoking mb-3">
+          Press Save again to apply this.
+        </p>
+
+        <p v-if="noAudienceSelected" class="reader-discovery-hint reader-audiences__empty mb-3">
+          Nobody can be enrolled on this reader while all four are off. Existing
+          people keep the access they already have.
+        </p>
+        <p v-else class="reader-discovery-hint mt-1 mb-3">
+          Switching one off stops new people of that kind being given this reader.
+          It does not remove anybody who already has it.
+        </p>
+
         <InputLabel title="Username" required class="mb-1" />
         <v-text-field
           v-model="draft.username"
@@ -206,7 +260,7 @@
           :disabled="mode === 'add' && (!draft.deviceId || !draft.portalId || draft.cardReadingMode === 'unconfigured')"
           @click="submit"
         >
-          Submit
+          {{ submitLabel }}
         </v-btn>
       </v-card-actions>
     </v-card>
@@ -214,6 +268,18 @@
 </template>
 
 <script setup lang="ts">
+/* Mirrors core's `hid-reader-audience.util.ts`, which is what enforces this —
+   kept in a util with tests because the absent-means-all default is the part
+   that could close a door by accident. */
+import {
+  audienceRevocations,
+  audiencesLeftWithNoReader,
+  HID_READER_AUDIENCE_FIELDS,
+  readerAudiences,
+  type THidPermissionCounts,
+  type THidReaderAudiences,
+} from "../utils/hid-reader-audiences";
+
 type HidReaderFormRecord = {
   name?: string;
   baseUrl?: string;
@@ -248,6 +314,7 @@ type HidReaderFormPayload = {
   pacsFormat: "raw" | "wiegand";
   operatingMode: "standalone" | "online";
   monitorEnabled: boolean;
+  audiences: THidReaderAudiences;
 };
 
 const props = defineProps({
@@ -278,6 +345,23 @@ const props = defineProps({
     type: String,
     default: "",
   },
+  // Which organisation's permission document to read the granted counts from.
+  // The reader's audiences are the reader's, but who is granted under them is
+  // per organisation - see `getSitePermissions`.
+  org: {
+    type: String,
+    default: "",
+  },
+  /*
+   * Every reader at this site, so switching the LAST one serving an account type
+   * can be warned about. Passed in rather than fetched: the parent already holds
+   * the list it draws the table from, and a second request would be a second
+   * answer that could disagree with what is on screen.
+   */
+  siteReaders: {
+    type: Array as () => Array<Record<string, unknown>>,
+    default: () => [],
+  },
 });
 
 const emit = defineEmits<{
@@ -314,6 +398,112 @@ const draft = reactive({
   operatingMode: "standalone" as "standalone" | "online",
 });
 
+/*
+ * WHO THIS READER IS FOR. All four on by default, which is the same reading core
+ * gives an absent field - a reader being added should not quietly be closed to
+ * somebody because a switch defaulted off.
+ */
+const audiences = reactive<THidReaderAudiences>({
+  resident: true,
+  residentVisitor: true,
+  member: true,
+  serviceProvider: true,
+});
+const audienceFields = HID_READER_AUDIENCE_FIELDS;
+
+/*
+ * WHAT THE READER LOOKED LIKE WHEN THE DIALOG OPENED.
+ *
+ * Only an on-to-off change costs anybody their access, so the warnings compare
+ * against this rather than against the stored record - which the switches are
+ * already editing.
+ */
+const audiencesOnOpen = ref<THidReaderAudiences>({ ...audiences });
+
+/** Who is granted on this reader, per category. Read once per opening. */
+const grantedCounts = ref<THidPermissionCounts | null>(null);
+const { getSitePermissions } = useHidAmico();
+
+/**
+ * NEVER THROWS, and a failure means the counts are simply unknown.
+ *
+ * The warning below says how many people a switch-off costs; without the counts
+ * it says that it will remove access without a number, which is still the thing
+ * the operator needs to know. Failing the dialog over a count would be worse.
+ */
+async function loadGrantedCounts() {
+  grantedCounts.value = null;
+  const readerId = String(props.reader?._id ?? "");
+  if (!readerId || !props.site || !props.org) return;
+  try {
+    const response = await getSitePermissions(props.site, props.org, readerId);
+    grantedCounts.value = (response?.data?.counts ?? null) as THidPermissionCounts | null;
+  } catch (error: unknown) {
+    console.error("Unable to read who is granted on this reader:", error);
+  }
+}
+
+/** The account types this edit switches off, and what each costs. */
+const revocations = computed(() => audienceRevocations(
+  audiencesOnOpen.value,
+  audiences,
+  grantedCounts.value,
+));
+
+/** Account types this edit would leave with no reader anywhere at the site. */
+const strandedAudiences = computed(() => audiencesLeftWithNoReader(
+  props.reader?._id,
+  audiences,
+  props.siteReaders,
+));
+
+const revocationWarning = computed(() => {
+  if (!revocations.value.length) return "";
+  return revocations.value
+    .map((item) => {
+      if (item.audience === "residentVisitor") {
+        // Not a revocation: a visitor pass is bound through `user_access_rules`
+        // with its own expiry, so issued passes run out rather than stopping.
+        return `${item.label}: no new passes will be issued. Passes already issued run out on their own.`;
+      }
+      if (!item.people) {
+        return `${item.label}: nobody is currently granted this reader under it.`;
+      }
+      return `${item.label}: removes access for ${item.people} ${item.people === 1 ? "person" : "people"}.`;
+    })
+    .join(" ");
+});
+
+const strandedWarning = computed(() => {
+  if (!strandedAudiences.value.length) return "";
+  const labels = strandedAudiences.value.map((item) => item.label);
+  const subject = labels.length === 1 ? labels[0] : labels.join(", ");
+  return `No other reader at this site serves ${subject}.`
+    + ` Saving this leaves ${labels.length === 1 ? "that account type" : "those account types"} with no way in.`;
+});
+
+/*
+ * A SECOND PRESS when something is being taken away.
+ *
+ * Revoking forty people is not an edit to make on one click, and a dialog over
+ * a dialog for a switch is heavier than it needs to be. Save states what it is
+ * about to do and then does it.
+ */
+const revocationConfirmed = ref(false);
+const needsConfirmation = computed(
+  () => Boolean(revocations.value.length || strandedAudiences.value.length)
+);
+const submitLabel = computed(() => (
+  needsConfirmation.value && !revocationConfirmed.value
+    ? "Review and save"
+    : props.mode === "edit" ? "Save Changes" : "Add Reader"
+));
+/* Switching every audience off leaves a reader nobody can be enrolled on, which
+   is legal but almost never meant - so it is said out loud rather than refused. */
+const noAudienceSelected = computed(() =>
+  HID_READER_AUDIENCE_FIELDS.every((field) => audiences[field.value] === false)
+);
+
 const cardModeOptions = [
   { title: "PACS (facility code + card number)", value: "pacs" },
   { title: "CSN", value: "csn" },
@@ -352,6 +542,14 @@ watch(
     discoveryError.value = "";
     discoveredConnection.value = "";
     draft.location = props.reader?.location ?? "";
+    // Read through `readerAudiences`, so a reader saved before this field
+    // existed opens with all four on rather than all four off - and a save from
+    // this form therefore cannot close it by accident.
+    Object.assign(audiences, readerAudiences(props.reader as Record<string, unknown> | null));
+    // The baseline the warnings compare against, and the counts behind them.
+    audiencesOnOpen.value = { ...audiences };
+    revocationConfirmed.value = false;
+    void loadGrantedCounts();
     draft.username = props.reader?.username ?? "";
     draft.password = props.reader?.password ?? "";
     monitorEnabled.value = props.reader?.monitorStatus !== "disabled";
@@ -446,11 +644,22 @@ function submit() {
     discoveryError.value = "Select the model printed on the physical HID reader.";
     return;
   }
+  /*
+   * The first press on a save that takes access away only acknowledges it. The
+   * warnings are already on screen; this makes the operator read them.
+   */
+  if (needsConfirmation.value && !revocationConfirmed.value) {
+    revocationConfirmed.value = true;
+    return;
+  }
   const portal = portals.value.find((item) => item.id === Number(draft.portalId));
   const payload: HidReaderFormPayload = {
     ...draft,
     portalName: portal?.name || draft.portalName,
     monitorEnabled: monitorEnabled.value,
+    // Spread, not passed by reference: the payload leaves this dialog and the
+    // reactive object keeps being edited behind it.
+    audiences: { ...audiences },
   };
 
   emit("submit", payload);
@@ -462,6 +671,35 @@ function submit() {
   overflow: hidden;
 }
 
+/* Four rows rather than a row of four: each switch carries a sentence, and at
+   phone width a horizontal strip would either wrap badly or clip the hints. */
+.reader-audiences {
+  display: flex;
+  flex-direction: column;
+  gap: 2px;
+}
+
+.reader-audience__hint {
+  margin: -4px 0 0;
+  padding-left: 2px;
+  color: var(--muted);
+  font-size: 12px;
+  line-height: 1.4;
+}
+
+/* Said in the warning colour, not refused: a reader nobody may use is legal and
+   occasionally deliberate - a door being decommissioned. */
+.reader-audiences__empty {
+  color: var(--err);
+}
+
+/* A revocation is a warning rather than an error: it is a legitimate thing to
+   do, deliberately, and the colour should not imply the save is refused. */
+.reader-audiences__revoking {
+  color: var(--warn, var(--err));
+  font-weight: 600;
+}
+
 /* Type comes from `.screen-modal .v-card-title`; only the header strip's own
    padding and rule stay here. `#ececec` was a fixed near-white line, i.e.
    invisible on a light card and a bright scratch across a dark one. */

package/components/HidReaderManagement.vue

@@ -29,7 +29,10 @@
       show-header
       @refresh="loadReaders"
     >
-      <template #actions>
+      <!-- Hidden, not disabled, for a member without the right: the server
+           refuses the call anyway, and a button that cannot work is noise.
+           `hid-mgmt:manage-hid-readers` (`useHidAccessPermission`). -->
+      <template v-if="canManageHidReaders" #actions>
         <AppButton icon="mdi-plus" @click="openAdd">Add HID Reader</AppButton>
       </template>
 
@@ -85,14 +88,23 @@
             <AppButton v-bind="menuProps" variant="row" icon="mdi-dots-vertical" />
           </template>
 
+          <!-- View is the view right. Access Permissions assigns people to the
+               reader's group, so it is the users right; everything else acts on
+               the reader itself and is the readers right. -->
           <v-list density="compact" min-width="180">
             <v-list-item title="View" @click="openView(item)" />
-            <v-list-item title="Access Permissions" @click="openPermissions(item)" />
-            <v-list-item title="Identification Methods" @click="openIdentification(item)" />
-            <v-list-item title="Sync HID Reader" @click="openSyncConfirm(item)" />
-            <v-list-item title="Test Connection" @click="openTestConfirm(item)" />
-            <v-list-item title="Edit" @click="openEdit(item)" />
-            <v-list-item title="Delete" class="text-error" @click="openDeleteConfirm(item)" />
+            <v-list-item
+              v-if="canManageHidUsers"
+              title="Access Permissions"
+              @click="openPermissions(item)"
+            />
+            <template v-if="canManageHidReaders">
+              <v-list-item title="Identification Methods" @click="openIdentification(item)" />
+              <v-list-item title="Sync HID Reader" @click="openSyncConfirm(item)" />
+              <v-list-item title="Test Connection" @click="openTestConfirm(item)" />
+              <v-list-item title="Edit" @click="openEdit(item)" />
+              <v-list-item title="Delete" class="text-error" @click="openDeleteConfirm(item)" />
+            </template>
           </v-list>
         </v-menu>
       </template>
@@ -111,8 +123,10 @@
     <HidReaderForm
       v-model="formDialog"
       :site="props.site"
+      :org="props.org"
       :mode="selectedReader ? 'edit' : 'add'"
       :reader="selectedReader"
+      :site-readers="readers"
       :loading="saving"
       @submit="saveReader"
     />
@@ -134,7 +148,7 @@
             <span>Username</span><strong>{{ selectedReader?.username || "N/A" }}</strong>
           </div>
 
-          <div class="dialog-actions-inline">
+          <div v-if="canManageHidReaders" class="dialog-actions-inline">
             <AppButton variant="ghost" @click="openTestConfirm(selectedReader)">Test Connection</AppButton>
             <AppButton variant="ghost" @click="openSyncConfirm(selectedReader)">Sync Reader</AppButton>
           </div>
@@ -479,6 +493,10 @@ const props = defineProps({
   },
 });
 
+// Which buttons this member gets. The screen itself is behind `HidEnabledGate`
+// (the view right); these two decide the write actions on it.
+const { canManageHidReaders, canManageHidUsers } = useHidAccessPermission();
+
 const {
   getReaders,
   createReader,

package/components/HidReaderUserRoster.vue

@@ -68,7 +68,8 @@
         </span>
       </template>
 
-      <template #[`item.action-table`]="{ item }">
+      <!-- Setting a PIN is the users right; the roster itself is the view right. -->
+      <template v-if="canManageHidUsers" #[`item.action-table`]="{ item }">
         <AppButton
           variant="row"
           icon="mdi-form-textbox-password"
@@ -199,6 +200,7 @@ type HidReaderUser = Record<string, unknown> & {
   metadata?: HidMetadata;
 };
 
+const { canManageHidUsers } = useHidAccessPermission();
 const {
   getReaders,
   getReaderUsers,

package/components/HidServiceSettingsPanel.vue

@@ -115,7 +115,7 @@ function buildHidServices(enabled: boolean) {
 
   const service = {
     key: "hid_amico",
-    name: "HID Face Reader",
+    name: "HID Reader",
     enabled,
     status: enabled ? "active" : "inactive",
   };
@@ -154,7 +154,7 @@ async function saveHidService(value: boolean) {
     hidEnabled.value = value;
     emit("refresh");
     await refreshNuxtData(`layout-selected-site-details-${useRuntimeConfig().public.APP}`);
-    showMessage(`HID Face Reader ${value ? "enabled" : "disabled"} successfully`, "success");
+    showMessage(`HID Reader ${value ? "enabled" : "disabled"} successfully`, "success");
   } catch (error: unknown) {
     hidEnabled.value = previousValue;
     showMessage(errorConverter(error), "error");