@tolinax/ayoune-interfaces 2026.64.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/data/modelNames.d.ts

@@ -384,6 +384,7 @@ export declare enum aMN {
     KPITemplates = "KPITemplates",
     Leads = "Leads",
     LinkPortalClicks = "LinkPortalClicks",
+    LinkPortals = "LinkPortals",
     LinkPortalViews = "LinkPortalViews",
     LoadingLists = "LoadingLists",
     Localizations = "Localizations",

package/data/modelNames.js

@@ -388,6 +388,7 @@ var aMN;
     aMN["KPITemplates"] = "KPITemplates";
     aMN["Leads"] = "Leads";
     aMN["LinkPortalClicks"] = "LinkPortalClicks";
+    aMN["LinkPortals"] = "LinkPortals";
     aMN["LinkPortalViews"] = "LinkPortalViews";
     aMN["LoadingLists"] = "LoadingLists";
     aMN["Localizations"] = "Localizations";

package/data/modelsAndRights.js

@@ -4699,6 +4699,30 @@ const modelsAndRights = [
         updateBy: "_id",
         availableInSDK: false,
     },
+    {
+        plural: "LinkPortals",
+        singular: "LinkPortal",
+        module: "marketing",
+        right: "marketing.linkportals",
+        readOnly: false,
+        importable: false,
+        allowDuplicate: true,
+        updateBy: "_id",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update"],
+        searchable: true,
+        searchableFields: ["slug", "title", "customDomain"],
+        labelKey: "marketing.linkportal.label",
+        labelPluralKey: "marketing.linkportals.label",
+        descriptionKey: "marketing.linkportals.description",
+        piiLevel: "none",
+        events: ["created", "updated", "deleted"],
+        entityActions: [
+            { name: "publish", verb: "POST", emits: "published", icon: "publish", labelKey: "marketing.linkportals.actions.publish" },
+            { name: "unpublish", verb: "POST", emits: "unpublished", icon: "unpublished", labelKey: "marketing.linkportals.actions.unpublish" },
+            { name: "duplicate", verb: "POST", emits: "duplicated", icon: "content_copy", labelKey: "marketing.linkportals.actions.duplicate" },
+        ],
+    },
     {
         plural: "LinkPortalViews",
         singular: "LinkPortalView",

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/interfaces/ILinkPortal.d.ts

@@ -0,0 +1,197 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Discriminator for polymorphic ILinkPortalBlock.data shape.
+ *
+ * Phase 1 (Migration-Compat) — Pflicht-Set, deckt das gesamte Legacy
+ * `Settings.linkPortal`-Universum (groups/links/persons/customArea/headers/social) ab.
+ * Phase 2 — Schema-Slots, Renderer kommt on-demand. Der link-portal-Service
+ * rendert Phase-2-Blöcke heute mit `mixin-unsupported` (silent-skip + Logger-Warn),
+ * damit ein eingestellter Block keinen Render-Crash auslöst.
+ */
+export type LinkPortalBlockType = "header" | "link" | "group" | "person" | "customHtml" | "vcard" | "qr" | "social" | "text" | "image" | "gallery" | "video" | "audio" | "pdf" | "map" | "faq" | "embed" | "newsletter" | "contactForm" | "booking" | "tipJar" | "product" | "countdown" | "divider" | "spacer";
+export interface ILinkPortalVisibility {
+    devices?: ("mobile" | "tablet" | "desktop")[];
+    geo?: {
+        include?: string[];
+        exclude?: string[];
+    };
+    schedule?: {
+        from?: Date;
+        to?: Date;
+    };
+    abTest?: {
+        variant: string;
+        weight: number;
+    };
+}
+export interface ILinkPortalGating {
+    type: "password" | "email" | "age" | "login" | "paywall";
+    config: Record<string, any>;
+}
+/**
+ * Polymorpher Page-Block. `type` ist der Discriminator, `data` die
+ * type-spezifische Payload (siehe LinkPortalBlockData* unten).
+ *
+ * `translations[lang]` shadowed Felder aus `data` für die jeweilige Sprache.
+ * Nicht übersetzte Felder fallen auf `data` zurück (Default-Locale-Pfad in
+ * `clients/link-portal/src/lib/i18nBlock.ts` → `pickLocalized`).
+ */
+export interface ILinkPortalBlock {
+    _id: ObjectId;
+    type: LinkPortalBlockType;
+    position: number;
+    visibility?: ILinkPortalVisibility;
+    gating?: ILinkPortalGating;
+    data: Record<string, any>;
+    translations?: {
+        [lang: string]: {
+            [field: string]: any;
+        };
+    };
+    metadata?: {
+        og?: {
+            title?: string;
+            description?: string;
+            image?: string;
+        };
+    };
+    isDraft?: boolean;
+}
+export interface LinkPortalBlockDataHeader {
+    title: string;
+    description?: string;
+}
+export interface LinkPortalBlockDataLink {
+    title: string;
+    tagLine?: string;
+    icon?: string;
+    link: string;
+    adult?: boolean;
+}
+export interface LinkPortalBlockDataGroup {
+    headerText?: string;
+    description?: string;
+    /** Children werden im selben Block-Array über `parentId` referenziert
+     *  (flach für DB-Indizierbarkeit). Falls echtes Nesting gewünscht wird,
+     *  kann der Adapter es in `children: ILinkPortalBlock[]` materialisieren. */
+    childIds?: ObjectId[];
+}
+export interface LinkPortalBlockDataPerson {
+    personRef: ObjectId;
+    description?: string;
+    tagLine?: string;
+    role?: string;
+}
+export interface LinkPortalBlockDataCustomHtml {
+    title?: string;
+    content: string;
+}
+export interface LinkPortalBlockDataVcard {
+    headerText?: string;
+}
+export interface LinkPortalBlockDataQr {
+    headerText?: string;
+    target?: string;
+}
+export interface LinkPortalBlockDataSocial {
+    headerText?: string;
+    links: {
+        provider: string;
+        url: string;
+    }[];
+}
+export interface ILinkPortalTheme {
+    backgroundMode: "gradient" | "image" | "video" | "solid";
+    color1: string;
+    color2: string;
+    fontColor: string;
+    backgroundImage?: string;
+    backgroundVideo?: string;
+    buttonColor1: string;
+    buttonColor2: string;
+    buttonFontColor: string;
+    buttonStyle?: "fill" | "outline" | "soft" | "gradient" | "glass";
+    buttonRadius?: number;
+    avatarShape?: "circle" | "square" | "rounded";
+    fontFamily?: string;
+    /** Premium-Slot. Wird nur bei publizierten Portals mit erlaubtem Right gerendert. */
+    customCss?: string;
+}
+export interface ILinkPortalBranding {
+    logo?: string;
+    logoLight?: string;
+    favicon?: string;
+    showLogo?: boolean;
+    showClaim?: boolean;
+    /** Sprach-Map: { de: '…', en: '…' } */
+    claimText?: {
+        [lang: string]: string;
+    };
+}
+export interface ILinkPortalMetadata {
+    /** Pro-Sprache OG-Tags. Fallback: `defaultLanguage`. */
+    og?: {
+        [lang: string]: {
+            title?: string;
+            description?: string;
+            image?: string;
+        };
+    };
+    schemaOrg?: Record<string, any>;
+    sitemap?: {
+        include: boolean;
+        priority?: number;
+    };
+}
+export interface ILinkPortalAnalyticsPixel {
+    provider: "meta" | "tiktok" | "ga4" | "google-ads" | "pinterest" | "snap";
+    id: string;
+}
+export interface ILinkPortalAnalyticsWebhook {
+    event: "view" | "click" | "gate-pass";
+    url: string;
+}
+export interface ILinkPortalAnalytics {
+    pixels?: ILinkPortalAnalyticsPixel[];
+    utmInherit?: boolean;
+    webhooks?: ILinkPortalAnalyticsWebhook[];
+}
+/**
+ * Optionale Migrations-Audit-Spur. Wird vom Renderer ignoriert, dient
+ * Stichproben + Hard-Remove-Phase G als verifizierbare Quelle.
+ */
+export interface ILinkPortalLegacyTrace {
+    sourceSettingsId?: ObjectId;
+    migratedAt?: Date;
+    /** Verbatim Backup des originalen Settings.linkPortal-Sub-Docs. NIE löschen vor Phase G. */
+    raw?: Record<string, any>;
+}
+export interface ILinkPortal extends IDefaultFields {
+    _customerID: ObjectId;
+    _clientID?: ObjectId[];
+    _subID?: ObjectId[];
+    /** Globally unique Identifier (URL-Segment unter link.sb/<slug>/...). */
+    slug: string;
+    /** Optionaler Custom-Domain (FQDN). Unique sparse. */
+    customDomain?: string;
+    /** Interner Anzeigename in der Admin-Liste (nicht öffentlich gerendert). */
+    title: string;
+    /** Beschreibung (intern). */
+    description?: string;
+    status: "draft" | "published" | "scheduled";
+    publishAt?: Date;
+    unpublishAt?: Date;
+    /** ISO 639-1 (z.B. "de"). Fallback für Block-Translations. */
+    defaultLanguage: string;
+    /** Liste aller in diesem Portal aktivierten Sprachen. */
+    supportedLanguages: string[];
+    theme: ILinkPortalTheme;
+    branding: ILinkPortalBranding;
+    metadata: ILinkPortalMetadata;
+    analytics: ILinkPortalAnalytics;
+    /** Optionales Page-Level-Gate (vor jedem Block). */
+    pageGating?: ILinkPortalGating;
+    /** Polymorpher Block-Stream. Reihenfolge ergibt sich aus block.position. */
+    blocks: ILinkPortalBlock[];
+    legacy?: ILinkPortalLegacyTrace;
+}

package/interfaces/ILinkPortal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/ILinkPortalClick.d.ts

@@ -8,4 +8,10 @@ export interface ILinkPortalClick extends IaYOUneTrackingParams, IGeoIPLocationT
     _subID?: ObjectId[];
     _linkID?: ObjectId;
     channel?: string;
+    /** Reference to the LinkPortal entity (chapter 1.72). Sparse — pre-migration clicks lack this. */
+    _linkPortalID?: ObjectId;
+    /** Reference to the specific block clicked (chapter 1.72). Replaces legacy `_linkID`. */
+    _blockID?: ObjectId;
+    /** Resolved render-language at click time (ISO 639-1). Sparse — pre-i18n clicks lack this. */
+    lang?: string;
 }

package/interfaces/ILinkPortalView.d.ts

@@ -7,4 +7,8 @@ export interface ILinkPortalView extends IaYOUneTrackingParams, IGeoIPLocationTr
     _clientID: ObjectId[];
     _subID: ObjectId[];
     channel: string;
+    /** Reference to the LinkPortal entity (chapter 1.72). Sparse — pre-migration views lack this. */
+    _linkPortalID?: ObjectId;
+    /** Resolved render-language for the visit (ISO 639-1). Sparse — pre-i18n views lack this. */
+    lang?: string;
 }

package/interfaces/ISetting.d.ts

@@ -1005,7 +1005,18 @@ interface ISupportPortal {
     roadMapProjects: ObjectId[];
     seo: SEOAttributes;
 }
-interface ILinkPortal {
+/**
+ * @deprecated Use the standalone `LinkPortals` collection (see `ILinkPortal`).
+ *
+ * Lives only as `ISetting.linkPortal` for the dual-read window described in
+ * `docs/migration/concept/migration-concept.md` chapter 1.72. The link-portal
+ * service auto-migrates customers reading this sub-doc into a fresh
+ * `LinkPortals` document on first request, then continues to serve from the
+ * new collection. Hard-removal happens in Phase G after a 30+ day cool-down.
+ *
+ * Renamed from `ILinkPortal` to free that name for the new entity interface.
+ */
+interface ILinkPortalLegacy {
     title: string;
     description: string;
     style: LinkPortalStyle;
@@ -1065,7 +1076,8 @@ export interface ISetting extends IDefaultFields {
     products: ProductsSettings;
     slides: SlidesSettings;
     customerportal: ISettingCustomerPortal;
-    linkPortal: ILinkPortal;
+    /** @deprecated Migrated to standalone `LinkPortals` collection in chapter 1.72. */
+    linkPortal: ILinkPortalLegacy;
     supportPortal: ISupportPortal;
     warehouse?: IWarehouseSettings;
     [x: string]: any;

package/interfaces/index.d.ts

@@ -404,6 +404,7 @@ export * from "./IKPINewsletterType";
 export * from "./IKPITemplate";
 export * from "./ILabel";
 export * from "./ILead";
+export * from "./ILinkPortal";
 export * from "./ILinkPortalClick";
 export * from "./ILinkPortalView";
 export * from "./ILoadingList";

package/interfaces/index.js

@@ -420,6 +420,7 @@ __exportStar(require("./IKPINewsletterType"), exports);
 __exportStar(require("./IKPITemplate"), exports);
 __exportStar(require("./ILabel"), exports);
 __exportStar(require("./ILead"), exports);
+__exportStar(require("./ILinkPortal"), exports);
 __exportStar(require("./ILinkPortalClick"), exports);
 __exportStar(require("./ILinkPortalView"), exports);
 __exportStar(require("./ILoadingList"), exports);

package/package.json

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