@7365admin1/layer-common 4.0.1 → 4.0.3-staging.220

package/utils/console-tier.ts

@@ -0,0 +1,67 @@
+/**
+ * WHICH SEVEN365 TIER THE SIGNED-IN PERSON IS, MIRRORED FROM THE SERVER'S RULE.
+ *
+ * Owner decision 9 splits Seven365 staff powers in two. Ordinary staff may view
+ * clients, set up subscriptions and manage promo codes. **Only the owner may
+ * suspend a client** - an action that stops that client's staff, residents and
+ * guards signing in.
+ *
+ * ## The server is the authority. This file only decides what to DRAW.
+ *
+ * `iservice365-core` `src/utils/super-admin.util.ts` answers the same question
+ * on the server, from the session id alone:
+ *
+ *   isSuperAdmin(userId)    -> a `members` row `{ type: "admin" }` whose role
+ *                              document is also `type: "admin"`
+ *   isPlatformOwner(userId) -> the same, AND that role has `default === true`
+ *
+ * `requirePlatformOwner` (`console-authz.util.ts`) runs `isPlatformOwner`
+ * inside `PATCH /api/organizations/:id/status` before it writes anything, and
+ * it reads the session - never the request body, never a header the browser
+ * chose. So a browser that lies to itself about its tier gets a button it can
+ * press and a 401 when it does. Hiding the control is a courtesy, not a lock.
+ *
+ * ## Why `role.default`, and why nothing here invents a new marker
+ *
+ * `default` is the only property of a platform-staff role that no API caller
+ * can set: `role.controller.ts` validates create/update with Joi object schemas
+ * that do not list it (Joi rejects unknown keys), `role.repo.ts` never writes
+ * it, and `MRole` defaults it to `false`. Exactly one server path sets it on an
+ * `admin`-typed role - `user.service.ts createDefaultUser()` at API boot. Every
+ * additional staff account is invited onto a role made through the admin app,
+ * which cannot carry it.
+ *
+ * ## Fail closed
+ *
+ * Anything this function cannot positively prove is `"none"`. A missing member
+ * row, a role that failed to load, a request that threw - all of them draw the
+ * ordinary-staff console with no suspend control, which is the recoverable
+ * mistake. The other direction is not.
+ *
+ * Both fields come back from endpoints the app already calls, unprojected:
+ * `GET /api/members/user/:id/app/admin` and `GET /api/roles/id/:id`. Nothing
+ * new had to be added to the API for this.
+ */
+
+export type TConsoleTier = "owner" | "staff" | "none";
+
+/**
+ * One divergence from the server, stated rather than hidden: `isSuperAdmin`
+ * matches `status: { $ne: "deleted" }` on the member row, and the endpoint the
+ * browser uses (`member.repo.ts getByUserIdType`) matches only `{ user, type }`.
+ * So a deleted staff membership can still be handed to this function. It is
+ * excluded here too, which keeps the drawn console and the server's answer the
+ * same for that case.
+ */
+export function consoleTier(
+  member: Record<string, any> | null | undefined,
+  role: Record<string, any> | null | undefined,
+): TConsoleTier {
+  if (member?.type !== "admin") return "none";
+  if (member?.status === "deleted") return "none";
+  if (role?.type !== "admin") return "none";
+
+  // `=== true` exactly as the server writes it. A role document that omits
+  // `default` (every role the admin app can create) is staff, not owner.
+  return role?.default === true ? "owner" : "staff";
+}

package/utils/data.test.ts

@@ -93,3 +93,87 @@ test("a non-array levels value is counted as zero, not as its own length", () =>
   assert.equal(levelCount({ levels: 7 as unknown as [] }), 0);
   assert.equal(levelCount({ levels: "12" as unknown as [] }), 0);
 });
+
+import { cameraErrorConverter } from "./data.ts";
+
+/** Shape of an ofetch failure: the status and body live under `response`. */
+const apiError = (status: number, message?: string) => ({
+  response: { status, _data: message === undefined ? {} : { message } },
+});
+
+test("a duplicate reads as a duplicate", () => {
+  assert.match(
+    cameraErrorConverter(apiError(400, "ANPR already exist."), "ip"),
+    /already exists on this site/
+  );
+  assert.match(
+    cameraErrorConverter(apiError(409), "ip"),
+    /already exists on this site/
+  );
+});
+
+test("a failure that is NOT a duplicate never says duplicate", () => {
+  const notDuplicate = [
+    cameraErrorConverter(apiError(401), "ip"),
+    cameraErrorConverter(apiError(403), "ip"),
+    cameraErrorConverter(apiError(404), "ip"),
+    cameraErrorConverter(apiError(429), "ip"),
+    cameraErrorConverter(apiError(500, "Failed to create ANPR."), "ip"),
+    cameraErrorConverter(new Error("Network request failed"), "ip"),
+  ];
+
+  for (const message of notDuplicate) {
+    assert.doesNotMatch(message, /already exist/i, message);
+  }
+});
+
+test("each cause gets its own message", () => {
+  assert.match(cameraErrorConverter(apiError(401), "ip"), /session has expired/);
+  assert.match(
+    cameraErrorConverter(apiError(403), "ip"),
+    /do not have permission/
+  );
+  assert.match(cameraErrorConverter(apiError(404), "ip"), /no longer exists/);
+  assert.match(cameraErrorConverter(apiError(429), "ip"), /Too many attempts/);
+  assert.match(
+    cameraErrorConverter(apiError(500, "Failed to create ANPR."), "ip"),
+    /could not save this CCTV camera/
+  );
+});
+
+test("no response at all reads as a connection problem, not a server refusal", () => {
+  assert.match(
+    cameraErrorConverter(new Error("Failed to fetch"), "ip"),
+    /Could not reach the server/
+  );
+});
+
+test("a rejected field is named the way the form names it", () => {
+  assert.equal(
+    cameraErrorConverter(apiError(400, '"host" is required'), "ip"),
+    "URL is required."
+  );
+  assert.equal(
+    cameraErrorConverter(apiError(400, '"name" is not allowed to be empty'), "ip"),
+    "Camera Name cannot be empty."
+  );
+  // A field with no friendly label still reads as a sentence.
+  assert.equal(
+    cameraErrorConverter(apiError(400, '"guardPost" must be a number'), "ip"),
+    "guardPost must be a number."
+  );
+});
+
+test("a plain 400 sentence from the API is passed through unchanged", () => {
+  assert.equal(
+    cameraErrorConverter(apiError(400, "Invalid _id format"), "ip"),
+    "Invalid _id format"
+  );
+});
+
+test("the camera type decides the wording", () => {
+  assert.match(cameraErrorConverter(apiError(404), "anpr"), /ANPR camera/);
+  assert.match(cameraErrorConverter(apiError(404), "ip"), /CCTV camera/);
+  // Unknown/absent type falls back to CCTV, which is what the panel defaults to.
+  assert.match(cameraErrorConverter(apiError(404)), /CCTV camera/);
+});

package/utils/data.ts

@@ -30,6 +30,98 @@ export const errorConverter = (data: any): string => {
   return error;
 };
 
+/**
+ * Field names the camera API validates, in the wording the camera form uses,
+ * so a rejection reads as the label the person is looking at.
+ */
+const CAMERA_FIELD_LABELS: Record<string, string> = {
+  host: "URL",
+  name: "Camera Name",
+  username: "User",
+  password: "Password",
+  direction: "Type",
+  category: "Category",
+  site: "Site",
+};
+
+/** Joi phrasing -> everyday phrasing. Anything unmapped is passed through. */
+const CAMERA_VALIDATION_PHRASES: Array<[RegExp, string]> = [
+  [/^is required$/, "is required."],
+  [/^is not allowed to be empty$/, "cannot be empty."],
+  [/^must be a string$/, "is not valid."],
+];
+
+/**
+ * Turns a save/delete failure on a site camera into a sentence the person
+ * setting up the camera can act on.
+ *
+ * The camera panel used to report every `type: "ip"` failure as "CCTV camera
+ * already exist", whatever actually went wrong - a signed-out session, a
+ * missing permission, a rejected field and a server outage all read as a
+ * duplicate. This maps the cases the API really returns instead.
+ */
+export const cameraErrorConverter = (error: any, type?: string): string => {
+  const camera = type === "anpr" ? "ANPR camera" : "CCTV camera";
+
+  const status =
+    error?.response?.status ?? error?.statusCode ?? error?.status ?? null;
+
+  const serverMessage = String(
+    error?.response?._data?.message ?? error?.data?.message ?? ""
+  ).trim();
+
+  // No response at all: the request never reached the API.
+  if (!status) {
+    return `Could not reach the server, so this ${camera} was not saved. Check your internet connection and try again.`;
+  }
+
+  if (status === 401) {
+    return `Your session has expired. Sign in again, then save this ${camera}.`;
+  }
+
+  if (status === 403) {
+    return `You do not have permission to change cameras on this site. Ask your iService365 administrator for access.`;
+  }
+
+  if (status === 404) {
+    return `This ${camera} no longer exists. Refresh the list and try again.`;
+  }
+
+  if (status === 429) {
+    return "Too many attempts in a short time. Wait a moment and try again.";
+  }
+
+  // The API reports a clash from the unique index as "ANPR already exist.",
+  // which is the same message for a CCTV record.
+  if (status === 409 || /already exist|duplicate/i.test(serverMessage)) {
+    return `A ${camera} with this URL already exists on this site. Check the list before adding it again.`;
+  }
+
+  if (status >= 500) {
+    return `The server could not save this ${camera}. Try again, and contact support if it keeps happening.`;
+  }
+
+  if (status === 400 && serverMessage) {
+    // Joi rejections arrive as `"host" is required`.
+    const field = serverMessage.match(/^"(\w+)"\s+(.+?)\.?$/);
+
+    if (field) {
+      const label = CAMERA_FIELD_LABELS[field[1]] ?? field[1];
+      const phrase =
+        CAMERA_VALIDATION_PHRASES.find(([pattern]) =>
+          pattern.test(field[2])
+        )?.[1] ?? `${field[2]}.`;
+
+      return `${label} ${phrase}`;
+    }
+
+    return serverMessage;
+  }
+
+  return errorConverter(error);
+};
+
+
 /**
  * A service-provider account can only be shown ITS OWN work orders, feedbacks
  * and key logs, so every one of those screens scopes its request by the