@tolinax/ayoune-interfaces 2026.65.0 → 2026.66.0

package/data/index.d.ts

@@ -3,3 +3,4 @@ export * from "./modelsAndRights";
 export * from "./modules";
 export * from "./services";
 export * from "./pageConfig";
+export * from "./iotCapabilities";

package/data/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./modelsAndRights"), exports);
 __exportStar(require("./modules"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./pageConfig"), exports);
+__exportStar(require("./iotCapabilities"), exports);

package/data/iotCapabilities.d.ts

@@ -0,0 +1,27 @@
+/**
+ * IoT device taxonomy — single source of truth for `IIoTDevice.deviceType` and
+ * `IIoTDevice.capabilities[]`.
+ *
+ * Why string-literal sets instead of TS enums:
+ *  - they survive npm publish without runtime overhead
+ *  - new values can be added in a feature-branch without breaking older consumers
+ *  - easier to hand to non-TS clients (ESP32 firmware, shell scripts, admin UI lookups)
+ *
+ * Discriminator: `deviceType` (mostly fixed shape per class).
+ * Behaviour switch: `capabilities[]` (multi-value, drives action endpoints + UI tabs).
+ */
+export declare const IOT_DEVICE_TYPES: readonly ["wallboard", "control-panel", "production-terminal", "display", "ad-display", "status-light", "access-terminal", "sensor-node", "custom"];
+export type IoTDeviceType = (typeof IOT_DEVICE_TYPES)[number];
+/**
+ * Capabilities a device can advertise. Action endpoints in `api-iot` are
+ * gated on these, the admin-v2 detail view derives its tabs from them, and
+ * the notifier only routes events to subscribers whose capability set
+ * includes the matching channel.
+ */
+export declare const IOT_CAPABILITIES: readonly ["kiosk", "monitoring", "cast-receiver", "welcome-screen", "dashboard", "sensor-temp", "sensor-humidity", "sensor-power", "sensor-presence", "badge-reader", "nfc", "gpio-relay", "gpio-led", "screen-share", "remote-control", "remote-commands", "process-mgmt", "log-collection", "reload", "telemetry", "cli-runner"];
+export type IoTCapability = (typeof IOT_CAPABILITIES)[number];
+/**
+ * Convenience map: which action endpoints in `api-iot` does each capability
+ * unlock. Read by the action-router to 412 unsupported actions early.
+ */
+export declare const IOT_CAPABILITY_ACTIONS: Record<string, string[]>;

package/data/iotCapabilities.js

@@ -0,0 +1,83 @@
+"use strict";
+/**
+ * IoT device taxonomy — single source of truth for `IIoTDevice.deviceType` and
+ * `IIoTDevice.capabilities[]`.
+ *
+ * Why string-literal sets instead of TS enums:
+ *  - they survive npm publish without runtime overhead
+ *  - new values can be added in a feature-branch without breaking older consumers
+ *  - easier to hand to non-TS clients (ESP32 firmware, shell scripts, admin UI lookups)
+ *
+ * Discriminator: `deviceType` (mostly fixed shape per class).
+ * Behaviour switch: `capabilities[]` (multi-value, drives action endpoints + UI tabs).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IOT_CAPABILITY_ACTIONS = exports.IOT_CAPABILITIES = exports.IOT_DEVICE_TYPES = void 0;
+exports.IOT_DEVICE_TYPES = [
+    /** Pi-/PC-Kiosk großes Display (e.g. company-wallboard kiosks). */
+    'wallboard',
+    /** Pi/PC-Touchpanel an einem Standort (door, lobby, conference room). */
+    'control-panel',
+    /** Pi/PC am WorkCenter/Machine in der Produktion. */
+    'production-terminal',
+    /** Einfaches Anzeige-Gerät — Info-Screen, Warteschlange, Speisekarte. */
+    'display',
+    /** Werbedisplay — eigenes Inventory-/Schedule-Modell, kein Dashboard-Inhalt. */
+    'ad-display',
+    /** Status-Leuchte / Ampel — heute typischerweise ESP32 mit GPIO-LEDs. */
+    'status-light',
+    /** Badge-Reader / NFC-Terminal an einer Tür oder Zeiterfassung. */
+    'access-terminal',
+    /** Headless Sensor-Knoten (Temp/Humidity/Power/Presence). */
+    'sensor-node',
+    /** Escape-Hatch für noch-nicht-modellierte Custom-Devices. */
+    'custom',
+];
+/**
+ * Capabilities a device can advertise. Action endpoints in `api-iot` are
+ * gated on these, the admin-v2 detail view derives its tabs from them, and
+ * the notifier only routes events to subscribers whose capability set
+ * includes the matching channel.
+ */
+exports.IOT_CAPABILITIES = [
+    // Display / kiosk content
+    'kiosk',
+    'monitoring',
+    'cast-receiver',
+    'welcome-screen',
+    'dashboard',
+    // Sensors
+    'sensor-temp',
+    'sensor-humidity',
+    'sensor-power',
+    'sensor-presence',
+    // Identity / credential I/O
+    'badge-reader',
+    'nfc',
+    // GPIO actuators
+    'gpio-relay',
+    'gpio-led',
+    // Remote-control surfaces (used today by desktop-client)
+    'screen-share',
+    'remote-control',
+    'remote-commands',
+    'process-mgmt',
+    'log-collection',
+    // Generic agent capabilities
+    'reload',
+    'telemetry',
+    'cli-runner',
+];
+/**
+ * Convenience map: which action endpoints in `api-iot` does each capability
+ * unlock. Read by the action-router to 412 unsupported actions early.
+ */
+exports.IOT_CAPABILITY_ACTIONS = {
+    reload: ['reload'],
+    'cast-receiver': ['cast-start', 'cast-stop'],
+    'welcome-screen': ['welcome-on', 'welcome-off'],
+    'gpio-relay': ['relay-toggle', 'relay-on', 'relay-off'],
+    'gpio-led': ['led-set'],
+    'cli-runner': ['cli-exec'],
+    'remote-commands': ['remote-exec'],
+};

package/interfaces/IIoTDevice.d.ts

@@ -58,12 +58,18 @@ export interface IIoTDevice extends IDefaultFields {
     department?: ObjectId;
     workCenter?: ObjectId;
     machine?: ObjectId;
+    /** FK to the WallBoard this device renders, only set when `deviceType === 'wallboard'`. */
+    _wallboardID?: ObjectId;
     active?: boolean;
     hostName?: string;
     deviceID?: string;
     deviceName?: string;
+    /** One of `IOT_DEVICE_TYPES` — kept as plain string for migration tolerance. */
     deviceType?: string;
+    /** Legacy comma-separated list. Superseded by `capabilities[]` — both fields stay populated for one release. */
     deviceFunctions?: string;
+    /** New form (subset of `IOT_CAPABILITIES`). Drives action gating in `api-iot` and tab rendering in admin-v2. */
+    capabilities?: string[];
     topic?: string;
     ip?: string;
     hostname?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2026.65.0",
+  "version": "2026.66.0",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",