@7365admin1/core 3.82.0 → 3.83.0

package/dist/index.mjs

@@ -58577,6 +58577,7 @@ var robotSchema = Joi74.object({
   // Optional, so every caller written before this field existed still validates.
   type: Joi74.string().valid(...ROBOT_TYPES).optional().allow("", null),
   robotSn: Joi74.string().optional().allow("", null),
+  brand: Joi74.string().optional().allow("", null),
   appKey: Joi74.string().required(),
   appToken: Joi74.string().required(),
   createdBy: Joi74.string().hex().required(),
@@ -58638,6 +58639,7 @@ function MRobot(value) {
      */
     type: value.type || "cleaning",
     robotSn: value.robotSn ?? "",
+    brand: value.brand || "ounitech",
     appKey: value.appKey ?? "",
     appToken: value.appToken ?? "",
     createdBy: value.createdBy ?? "",
@@ -58801,6 +58803,9 @@ function useRobotRepo() {
             // Not a secret - it is the vendor's device serial, and the apps
             // need it to address a robot. The CREDENTIALS stay out.
             robotSn: 1,
+            // Not a secret - it names which protocol the robot speaks, and a
+            // screen needs it to know which controls to draw.
+            brand: 1,
             createdByName: 1,
             createdAt: 1,
             status: 1
@@ -59194,30 +59199,30 @@ function parseRobotCommand(body) {
   if (kind !== "full" && kind !== "area" && kind !== "spot" && kind !== "return") {
     return { ok: false, message: 'kind must be one of "full", "area", "spot", "return".' };
   }
-  const has = (k) => Object.prototype.hasOwnProperty.call(b, k);
+  const has2 = (k) => Object.prototype.hasOwnProperty.call(b, k);
   const optionKeys = ["cleanTimes", "modeFlag", "subModeFlag", "levelFlag"];
   if (kind === "return") {
     for (const k of [...optionKeys, "areas", "points"]) {
-      if (has(k))
+      if (has2(k))
         return { ok: false, message: `${k} is not valid for a return command.` };
     }
     return { ok: true, command: { kind: "return" } };
   }
-  if (kind !== "area" && has("areas")) {
+  if (kind !== "area" && has2("areas")) {
     return { ok: false, message: "areas is only valid for an area command." };
   }
-  if (kind !== "spot" && has("points")) {
+  if (kind !== "spot" && has2("points")) {
     return { ok: false, message: "points is only valid for a spot command." };
   }
   const int = (k, allowed, fallback) => {
-    if (!has(k))
+    if (!has2(k))
       return fallback;
     const v = b[k];
     if (typeof v !== "number" || !Number.isInteger(v) || !allowed.includes(v))
       return null;
     return v;
   };
-  const cleanTimes = has("cleanTimes") ? typeof b.cleanTimes === "number" && Number.isInteger(b.cleanTimes) && b.cleanTimes >= 0 && b.cleanTimes <= 99 ? b.cleanTimes : null : DEFAULTS.cleanTimes;
+  const cleanTimes = has2("cleanTimes") ? typeof b.cleanTimes === "number" && Number.isInteger(b.cleanTimes) && b.cleanTimes >= 0 && b.cleanTimes <= 99 ? b.cleanTimes : null : DEFAULTS.cleanTimes;
   if (cleanTimes === null)
     return { ok: false, message: "cleanTimes must be an integer 0-99." };
   const modeFlag = int("modeFlag", [1, 2, 3], DEFAULTS.modeFlag);
@@ -59433,6 +59438,125 @@ function robotActionsFor(actor) {
   );
 }
 
+// src/utils/robot-adapter.util.ts
+var ROBOT_CAPABILITIES = [
+  /** Read the current location of the robot [x, y, yaw]. */
+  "readLocation",
+  /** Request the robot move to an [x, y, yaw] coordinate. */
+  "navigateToPoint",
+  /** Pause a robot while it is navigating, and resume it. */
+  "pauseResume",
+  /** Read the route/path taken, or the ETA to the destination. */
+  "pathAndEta",
+  /** Read the battery level. */
+  "battery",
+  /** Send the robot to its docking/charging station. */
+  "sendToDock",
+  /** Switch the on-board map and re-localise the robot. */
+  "relocalize",
+  /** Start a process — "clean zone A". */
+  "startProcess",
+  /** Pause, resume or stop a running process. */
+  "pauseProcess",
+  /** Know, rather than infer, when a process has finished. */
+  "processCompletion",
+  /** Report which floor the robot is on. */
+  "floorReporting",
+  /** Ride a lift between floors under our coordination. */
+  "multiFloor"
+];
+var TIER_REQUIREMENTS = {
+  "full-control": [
+    "readLocation",
+    "navigateToPoint",
+    "pauseResume",
+    "pathAndEta",
+    "battery",
+    "sendToDock",
+    "relocalize",
+    "startProcess",
+    "pauseProcess",
+    "processCompletion"
+  ],
+  "traffic-light": [
+    "readLocation",
+    "pauseResume",
+    "battery",
+    "sendToDock",
+    "startProcess",
+    "pauseProcess",
+    "processCompletion"
+  ],
+  "read-only": ["readLocation", "pathAndEta", "battery", "processCompletion"]
+};
+var has = (caps, c) => Object.prototype.hasOwnProperty.call(caps, c) && caps[c] === true;
+function robotTier(capabilities) {
+  const caps = capabilities ?? {};
+  for (const tier of ["full-control", "traffic-light", "read-only"]) {
+    if (TIER_REQUIREMENTS[tier].every((c) => has(caps, c)))
+      return tier;
+  }
+  return "no-interface";
+}
+function missingForTier(capabilities, tier) {
+  const caps = capabilities ?? {};
+  return TIER_REQUIREMENTS[tier].filter((c) => !has(caps, c));
+}
+function supports(capabilities, capability) {
+  return has(capabilities ?? {}, capability);
+}
+function uncontrollableFleetWarning(tiers) {
+  const count = tiers.filter(
+    (t) => t === "read-only" || t === "no-interface"
+  ).length;
+  if (count <= 1) {
+    return { ok: true, count, message: "" };
+  }
+  return {
+    ok: false,
+    count,
+    message: `This site has ${count} robot fleets that cannot be controlled (read-only or no interface). A shared space supports at most one: beyond that, robots cannot reliably be kept out of each other's way.`
+  };
+}
+var COMMAND_NEEDS = {
+  full: "startProcess",
+  area: "startProcess",
+  spot: "startProcess",
+  return: "sendToDock",
+  pause: "pauseProcess",
+  resume: "pauseProcess",
+  cancel: "pauseProcess",
+  navigate: "navigateToPoint",
+  relocalize: "relocalize"
+};
+function commandSupported(capabilities, kind) {
+  const needed = Object.prototype.hasOwnProperty.call(COMMAND_NEEDS, kind) ? COMMAND_NEEDS[kind] : void 0;
+  if (!needed)
+    return false;
+  return supports(capabilities, needed);
+}
+var adapters = /* @__PURE__ */ new Map();
+function registerRobotAdapter(adapter) {
+  if (!adapter?.brand)
+    throw new Error("A robot adapter must name its brand.");
+  adapters.set(adapter.brand, adapter);
+}
+function robotAdapterFor(brand) {
+  if (typeof brand !== "string" || !brand)
+    return null;
+  return adapters.get(brand) ?? null;
+}
+function registeredRobotBrands() {
+  return [...adapters.values()].map((a) => ({
+    brand: a.brand,
+    displayName: a.displayName,
+    tier: robotTier(a.capabilities)
+  }));
+}
+function clearRobotAdapters() {
+  adapters.clear();
+}
+
 // src/utils/lift-contract.util.ts
 var LIFT_DOOR = {
   CLOSED: 0,
@@ -59829,6 +59953,129 @@ function useRobotFleetService(deps) {
   };
 }
 
+// src/services/ounitech.adapter.ts
+var OUNITECH_BRAND = "ounitech";
+var OUNITECH_CAPABILITIES = {
+  // The tracking stream carries x, y, theta.
+  readLocation: true,
+  // `/portal/robots/return-to-base`.
+  sendToDock: true,
+  // `start-full-cleaning`, `start-area-cleaning`, `start-spot-cleaning` — RMF's
+  // "start a process (such as clean Zone_A)", and their areas are RMF's zones.
+  startProcess: true,
+  // Everything below is FALSE on purpose, and each one is a question already put
+  // to the vendor. Their app can do most of it; the API cannot.
+  navigateToPoint: false,
+  // app: "Move to Target Point in standby mode"
+  relocalize: false,
+  // app: "Set Origin"
+  pauseResume: false,
+  // handlebar + app: Pause/Resume, long-press cancel
+  pauseProcess: false,
+  // app: "End work"
+  battery: false,
+  // nothing in the API carries it
+  pathAndEta: false,
+  // nothing in the API carries it
+  processCompletion: false,
+  // no task id is returned, so completion is inferred
+  floorReporting: false,
+  // the tracking stream has no floorNo
+  multiFloor: false
+  // their app does cross-floor; the API does not expose it
+};
+function createOunitechAdapter(credentials, options) {
+  const cloud = useRobotCloudService(credentials, options);
+  function toAdapterRobot(raw) {
+    return {
+      robotSn: raw.robotSn,
+      name: raw.robotName,
+      online: raw.onlineFlag !== false,
+      mode: robotModeFromList(raw),
+      statusName: raw.statusName,
+      // Null, not 0 or a guess. A screen must be able to tell "we do not know"
+      // from "empty", and `floorKnown: false` is what stops a robot being drawn
+      // on a storey nobody confirmed.
+      batteryPercent: null,
+      floorNo: null,
+      floorKnown: false,
+      position: null
+    };
+  }
+  return {
+    brand: OUNITECH_BRAND,
+    displayName: "Ounitech (Q3-G / Q3-W)",
+    capabilities: OUNITECH_CAPABILITIES,
+    async listRobots() {
+      const fleet = await cloud.getRobots();
+      return fleet.map(toAdapterRobot);
+    },
+    async getRobot(robotSn) {
+      const fleet = await cloud.getRobots();
+      const match = fleet.find((r) => r.robotSn === robotSn);
+      if (!match) {
+        return {
+          robotSn,
+          online: false,
+          mode: "UNAVAILABLE",
+          statusName: "Not found in the robot cloud",
+          batteryPercent: null,
+          floorNo: null,
+          floorKnown: false,
+          position: null
+        };
+      }
+      return toAdapterRobot(match);
+    },
+    async sendCommand(robotSn, command) {
+      const options2 = {
+        cleanTimes: 1,
+        modeFlag: 1,
+        subModeFlag: 0,
+        levelFlag: 1
+      };
+      switch (command.kind) {
+        case "full":
+          await cloud.startFullCleaning(robotSn, options2);
+          return;
+        case "area":
+          await cloud.startAreaCleaning(robotSn, command.areas, options2);
+          return;
+        case "spot":
+          await cloud.startSpotCleaning(robotSn, command.points, options2);
+          return;
+        case "return":
+          await cloud.returnToBase(robotSn);
+          return;
+        default:
+          throw new Error(
+            `Ounitech robots do not support "${command.kind}" through the API yet.`
+          );
+      }
+    },
+    async getMaps(robotSn) {
+      return cloud.getMaps(robotSn);
+    },
+    async getPlans(robotSn) {
+      return cloud.getPlans(robotSn);
+    }
+  };
+}
+function registerOunitechBrand() {
+  const unconfigured = () => {
+    throw new Error(
+      "No Ounitech credentials for this robot. Add the app key and token on the robot's record."
+    );
+  };
+  registerRobotAdapter({
+    brand: OUNITECH_BRAND,
+    displayName: "Ounitech (Q3-G / Q3-W)",
+    capabilities: OUNITECH_CAPABILITIES,
+    listRobots: async () => unconfigured(),
+    getRobot: async () => unconfigured()
+  });
+}
+
 // src/controllers/robot-fleet.controller.ts
 import Joi76 from "joi";
 import { BadRequestError as BadRequestError135, logger as logger106 } from "@7365admin1/node-server-utils";
@@ -93881,6 +94128,8 @@ export {
   ORG_OWNER_REPAIR_CLAIM_TAKEN_REASON,
   ORG_OWNER_REPAIR_DEFAULT,
   ORG_OWNER_REPAIR_OFF_REASON,
+  OUNITECH_BRAND,
+  OUNITECH_CAPABILITIES,
   OrgNature,
   OvernightParkingRequestSort,
   OvernightParkingRequestStatus,
@@ -93908,6 +94157,7 @@ export {
   REALTIME_MAX_FANOUT,
   REGISTERED_VEHICLE_CATEGORIES,
   ROBOT_APP_SCOPES,
+  ROBOT_CAPABILITIES,
   ROBOT_CLOUD_DOC_CONFIRMATIONS,
   ROBOT_CLOUD_PATHS,
   ROBOT_MODULE,
@@ -93996,13 +94246,16 @@ export {
   chatSchema,
   claimReadsAsStale,
   clampPtzSpeed,
+  clearRobotAdapters,
   clockDriftSeconds,
+  commandSupported,
   consoleRoleAllows,
   consoleRoleAllowsAll,
   consoleSpellings,
   console_audit_namespace_collection,
   createLiftSimulator,
   createManpowerRemarksDaily,
+  createOunitechAdapter,
   createSseParser,
   customerSchema,
   customerSitePropertyFields,
@@ -94084,6 +94337,7 @@ export {
   maskNric,
   memberModulesHandlers,
   metresToPixel,
+  missingForTier,
   moduleDeniedForCaller,
   moduleGateEnforceKeys,
   moduleGateMode,
@@ -94138,6 +94392,9 @@ export {
   recordConsoleAction,
   refuseServiceProviderInviteAction,
   registerCameraTransport,
+  registerOunitechBrand,
+  registerRobotAdapter,
+  registeredRobotBrands,
   relayForRecorder,
   remarksSchema,
   renderPagePdf,
@@ -94155,6 +94412,7 @@ export {
   resolveSiteTimezone,
   resolveStaffRole,
   robotActionsFor,
+  robotAdapterFor,
   robotCloudBody,
   robotCloudSign,
   robotCloudSigningString,
@@ -94163,6 +94421,7 @@ export {
   robotModeFromList,
   robotSchema,
   robotScopeForApp,
+  robotTier,
   robotTypesVisibleTo,
   rtspUrl,
   schema,
@@ -94336,7 +94595,9 @@ export {
   stripFacialImageMetadata,
   subscriptionPlanSchema,
   summariseBulkCameraPlan,
+  supports,
   trackingBackoffMs,
+  uncontrollableFleetWarning,
   updateRemarksStatusEod,
   updateRemarksisAcknowledged,
   updateSiteSchema,