@iobroker/js-controller-adapter 7.2.3 → 8.0.0-alpha.1-20260921-e5941ca8a

package/build/esm/lib/adapter/managers/MessagingManager.js

@@ -0,0 +1,267 @@
+import { AdapterContextBase } from '../../../lib/adapter/managers/AdapterContextBase.js';
+import { isMessageboxSupported } from '../../../lib/adapter/utils.js';
+/** Owns the adapter's outbound messaging and the pending-reply registry. */
+export class MessagingManager extends AdapterContextBase {
+    #pending = new Map();
+    #callbackId = 1;
+    #mboxSubscribed = false;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     */
+    constructor(ctx) {
+        super(ctx);
+    }
+    /**
+     * Sends a message to another adapter instance.
+     *
+     * When `opts.expectReply` is true and the target is a specific instance (not broadcast),
+     * the returned promise resolves with the reply message when it arrives, or rejects with
+     * `Error('Timeout exceeded')` if `opts.options.timeout` elapses.
+     *
+     * @param opts Normalized send options
+     */
+    async sendTo(opts) {
+        const { command, message, callback, options, expectReply } = opts;
+        let { instanceName } = opts;
+        if (!instanceName) {
+            throw new Error('No instanceName provided or not a string');
+        }
+        if (!instanceName.startsWith('system.adapter.')) {
+            instanceName = `system.adapter.${instanceName}`;
+        }
+        const obj = {
+            command,
+            message,
+            from: `system.adapter.${this.namespace}`,
+        };
+        const states = this.states;
+        if (typeof message !== 'object') {
+            this.logger.silly(`${this.namespaceLog} sendTo "${command}" to ${instanceName} from system.adapter.${this.namespace}: ${message}`);
+        }
+        else {
+            this.logger.silly(`${this.namespaceLog} sendTo "${command}" to ${instanceName} from system.adapter.${this.namespace}`);
+        }
+        if (!instanceName.match(/\.[0-9]+$/)) {
+            const objects = this.objects;
+            // Only the instance lookup is best-effort; per-instance push errors must surface.
+            const res = await objects
+                .getObjectView('system', 'instance', {
+                startkey: `${instanceName}.`,
+                endkey: `${instanceName}.\u9999`,
+            })
+                .catch(() => undefined);
+            if (res) {
+                for (const row of res.rows) {
+                    await states.pushMessage(row.id, obj);
+                }
+            }
+            return;
+        }
+        if (expectReply) {
+            return this.#registerReply(states, instanceName, obj, options);
+        }
+        if (callback) {
+            obj.callback = { ...callback, ack: true };
+        }
+        await states.pushMessage(instanceName, obj);
+    }
+    /**
+     * Subscribes to this instance's messagebox on demand when the adapter does not advertise
+     * messagebox support, so replies to outbound messages are received. Idempotent.
+     *
+     * @param states the connected states DB client
+     */
+    #maybeSubscribe(states) {
+        const common = this.common;
+        if (common && !isMessageboxSupported(common) && !this.#mboxSubscribed) {
+            this.#mboxSubscribed = true;
+            states
+                .subscribeMessage(`system.adapter.${this.namespace}`)
+                .catch(e => this.logger.error(`${this.namespaceLog} Cannot subscribe to messages: ${e.message}`));
+        }
+    }
+    /**
+     * Sets a reply callback header on `obj`, registers a pending-reply resolver keyed by its id,
+     * subscribes the messagebox on demand, pushes the message and returns a promise that resolves
+     * with the reply once `resolveCallback` is invoked for the matching id, or rejects with
+     * `Error('Timeout exceeded')` when `options.timeout` elapses.
+     *
+     * @param states the connected states DB client
+     * @param target the recipient id (instance or host) for `pushMessage`
+     * @param obj the message to send; its `callback` header is set here
+     * @param options additional send options (e.g. timeout)
+     */
+    async #registerReply(states, target, obj, options) {
+        this.#maybeSubscribe(states);
+        const id = this.#callbackId++;
+        if (this.#callbackId >= 0xffffffff) {
+            this.#callbackId = 1;
+        }
+        obj.callback = {
+            message: obj.message,
+            id,
+            ack: false,
+            time: Date.now(),
+        };
+        let pendingEntry;
+        const replyPromise = new Promise((resolve, reject) => {
+            let timer;
+            if (options?.timeout) {
+                timer = setTimeout(() => {
+                    if (this.#pending.has(id)) {
+                        this.#pending.delete(id);
+                        reject(new Error('Timeout exceeded'));
+                    }
+                }, options.timeout);
+            }
+            pendingEntry = { resolve, reject, timer, time: Date.now() };
+            this.#pending.set(id, pendingEntry);
+        });
+        const now = Date.now();
+        for (const [_id, entry] of this.#pending) {
+            if (now - entry.time > 3_600_000) {
+                this.#pending.delete(_id);
+            }
+        }
+        try {
+            await states.pushMessage(target, obj);
+        }
+        catch (e) {
+            if (pendingEntry.timer) {
+                clearTimeout(pendingEntry.timer);
+            }
+            this.#pending.delete(id);
+            throw e;
+        }
+        return replyPromise;
+    }
+    /**
+     * Sends a message to a host, or broadcasts to all hosts when `hostName` is `null`.
+     *
+     * When `opts.expectReply` is true and a specific host is targeted, the returned promise
+     * resolves with the reply message when it arrives, or rejects with `Error('Timeout exceeded')`
+     * if `opts.options.timeout` elapses. Broadcasts (hostName === null) resolve void.
+     *
+     * @param opts Normalized send options
+     */
+    async sendToHost(opts) {
+        const { command, message, expectReply, options, callback } = opts;
+        let { hostName } = opts;
+        const obj = {
+            command,
+            message,
+            from: `system.adapter.${this.namespace}`,
+        };
+        const states = this.states;
+        if (hostName && !hostName.startsWith('system.host.')) {
+            hostName = `system.host.${hostName}`;
+        }
+        if (!hostName) {
+            const objects = this.objects;
+            const res = await objects.getObjectList({ startkey: 'system.host.', endkey: 'system.host.\u9999' });
+            if (res?.rows.length) {
+                for (const row of res.rows) {
+                    const parts = row.id.split('.');
+                    // ignore system.host.name.alive and so on
+                    if (parts.length === 3) {
+                        await states.pushMessage(row.id, obj);
+                    }
+                }
+            }
+            return;
+        }
+        if (expectReply) {
+            return this.#registerReply(states, hostName, obj, options);
+        }
+        if (callback) {
+            obj.callback = { ...callback, ack: true };
+        }
+        await states.pushMessage(hostName, obj);
+    }
+    /**
+     * Resolves a pending reply promise for an acked messagebox message.
+     * Returns true if a pending entry was found and consumed.
+     *
+     * @param obj incoming message object from the messagebox
+     */
+    resolveCallback(obj) {
+        if (!obj.callback?.ack || !obj.callback.id) {
+            return false;
+        }
+        const entry = this.#pending.get(obj.callback.id);
+        if (!entry) {
+            return false;
+        }
+        if (entry.timer) {
+            clearTimeout(entry.timer);
+        }
+        this.#pending.delete(obj.callback.id);
+        entry.resolve(obj.message);
+        const now = Date.now();
+        for (const [id, pending] of this.#pending) {
+            if (now - pending.time > 3_600_000) {
+                this.#pending.delete(id);
+            }
+        }
+        return true;
+    }
+    /**
+     * Rejects all pending reply promises and clears their timers (used on stop).
+     */
+    clearPendingCallbacks() {
+        if (this.#pending.size) {
+            const err = new Error('Adapter stopped');
+            for (const entry of this.#pending.values()) {
+                if (entry.timer) {
+                    clearTimeout(entry.timer);
+                }
+                entry.reject(err);
+            }
+            this.#pending.clear();
+        }
+    }
+    /**
+     * Sends a message to a single UI client, or broadcasts to all connected UI clients when `clientId` is omitted.
+     *
+     * @param options clientId and data options
+     */
+    sendToUI(options) {
+        const states = this.states;
+        const { clientId, data } = options;
+        if (clientId === undefined) {
+            return this.uiMessagingController.sendToAllClients({
+                data,
+                states,
+            });
+        }
+        return this.uiMessagingController.sendToClient({
+            clientId,
+            data,
+            states,
+        });
+    }
+    /**
+     * Sends an addNotification command to the host of this adapter instance.
+     *
+     * @param scope notification scope
+     * @param category notification category, or `null` to match by scope regex
+     * @param message notification message
+     * @param options additional notification options
+     */
+    async registerNotification(scope, category, message, options) {
+        const states = this.states;
+        const obj = {
+            command: 'addNotification',
+            message: {
+                scope,
+                category,
+                message,
+                instance: this.namespace,
+                contextData: options?.contextData,
+            },
+            from: `system.adapter.${this.namespace}`,
+        };
+        await states.pushMessage(`system.host.${this.host}`, obj);
+    }
+}
+//# sourceMappingURL=MessagingManager.js.map

package/build/esm/lib/adapter/managers/MessagingManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagingManager.js","sourceRoot":"","sources":["../../../../../src/lib/adapter/managers/MessagingManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAU/D,4EAA4E;AAC5E,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IAC3C,QAAQ,GAAG,IAAI,GAAG,EAAwB,CAAC;IACpD,WAAW,GAAG,CAAC,CAAC;IAChB,eAAe,GAAG,KAAK,CAAC;IAExB;;OAEG;IACH,YAAY,GAAmB;QAC3B,KAAK,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,IAA2B;QACpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAClE,IAAI,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC9C,YAAY,GAAG,kBAAkB,YAAY,EAAE,CAAC;QACpD,CAAC;QAED,MAAM,GAAG,GAA6B;YAClC,OAAO;YACP,OAAO;YACP,IAAI,EAAE,kBAAkB,IAAI,CAAC,SAAS,EAAE;SAC3C,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,GAAG,IAAI,CAAC,YAAY,YAAY,OAAO,QAAQ,YAAY,wBAAwB,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAClH,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,GAAG,IAAI,CAAC,YAAY,YAAY,OAAO,QAAQ,YAAY,wBAAwB,IAAI,CAAC,SAAS,EAAE,CACtG,CAAC;QACN,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE7B,kFAAkF;YAClF,MAAM,GAAG,GAAG,MAAM,OAAO;iBACpB,aAAa,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACjC,QAAQ,EAAE,GAAG,YAAY,GAAG;gBAC5B,MAAM,EAAE,GAAG,YAAY,SAAS;aACnC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAE5B,IAAI,GAAG,EAAE,CAAC;gBACN,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;oBACzB,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;gBAC1C,CAAC;YACL,CAAC;YACD,OAAO;QACX,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACX,GAAG,CAAC,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QAED,MAAM,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,MAA2B;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACpE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC5B,MAAM;iBACD,gBAAgB,CAAC,kBAAkB,IAAI,CAAC,SAAS,EAAE,CAAC;iBACpD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,kCAAkC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC1G,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAChB,MAA2B,EAC3B,MAAc,EACd,GAA6B,EAC7B,OAAuB;QAEvB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7B,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,WAAW,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,GAAG,CAAC,QAAQ,GAAG;YACX,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,EAAE;YACF,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;SACnB,CAAC;QAEF,IAAI,YAA2B,CAAC;QAChC,MAAM,YAAY,GAAG,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,IAAI,KAAiC,CAAC;YACtC,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;gBACnB,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;wBACxB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;wBACzB,MAAM,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;oBAC1C,CAAC;gBACL,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YACxB,CAAC;YAED,YAAY,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YAC5D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;QAED,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;gBACrB,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC;QACZ,CAAC;QACD,OAAO,YAAY,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,IAA+B;QAC5C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAClE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,GAAG,GAA6B;YAClC,OAAO;YACP,OAAO;YACP,IAAI,EAAE,kBAAkB,IAAI,CAAC,SAAS,EAAE;SAC3C,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,QAAQ,GAAG,eAAe,QAAQ,EAAE,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE7B,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC;YAEpG,IAAI,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACnB,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;oBACzB,MAAM,KAAK,GAAa,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC1C,0CAA0C;oBAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrB,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;oBAC1C,CAAC;gBACL,CAAC;YACL,CAAC;YACD,OAAO;QACX,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACX,GAAG,CAAC,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QAED,MAAM,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,GAAqB;QACjC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACzC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACd,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACtC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxC,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC;gBACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,qBAAqB;QACjB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACzC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBACzC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;oBACd,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC;gBACD,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC1B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAAyC;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAEnC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC;gBAC/C,IAAI;gBACJ,MAAM;aACT,CAAC,CAAC;QACP,CAAC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC;YAC3C,QAAQ;YACR,IAAI;YACJ,MAAM;SACT,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACtB,KAAa,EACb,QAAuB,EACvB,OAAe,EACf,OAA6B;QAE7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,MAAM,GAAG,GAAG;YACR,OAAO,EAAE,iBAAiB;YAC1B,OAAO,EAAE;gBACL,KAAK;gBACL,QAAQ;gBACR,OAAO;gBACP,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,WAAW,EAAE,OAAO,EAAE,WAAW;aACpC;YACD,IAAI,EAAE,kBAAkB,IAAI,CAAC,SAAS,EAAE;SAC3C,CAAC;QAEF,MAAM,MAAM,CAAC,WAAW,CAAC,eAAe,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9D,CAAC;CACJ"}

package/build/esm/lib/adapter/managers/SubscriptionManager.d.ts

@@ -0,0 +1,107 @@
+import type { Pattern } from '../../_Types.js';
+import type { AdapterContext } from '../../../lib/adapter/context.js';
+import { AdapterContextBase } from '../../../lib/adapter/managers/AdapterContextBase.js';
+import type { AliasManager } from '../../../lib/adapter/managers/AliasManager.js';
+/** Prefixes an id or pattern with this adapter's namespace unless already namespaced. Bound to the adapter's Validator. */
+export type FixId = (id: string, isPattern?: boolean) => string;
+type SubOptions = {
+    user?: ioBroker.ObjectIDs.User;
+} | null | undefined;
+/** Reads the objects matching a pattern, used to discover alias objects during state subscription. */
+export interface ObjectAccess {
+    /**
+     * Objects matching `pattern`, keyed by id. Bound to the legacy `getForeignObjects(pattern, null, null, options)`
+     * call, whose `null` type/enums args clobber `options` — so no type filter and no user-ACL are applied;
+     * only `alias.*` ids in the result are consumed. Kept as-is for behavior parity.
+     */
+    getForeignStateObjects(pattern: string, options?: {
+        user?: ioBroker.ObjectIDs.User;
+    } | null): Promise<Record<string, ioBroker.AnyObject>>;
+}
+/** Owns object-, file- and state-change subscriptions plus the auto-subscribe bookkeeping. */
+export declare class SubscriptionManager extends AdapterContextBase {
+    #private;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     * @param fixId Namespace-prefixer bound to the adapter's Validator
+     * @param aliasManager Alias subscription cache and bookkeeping
+     * @param objectAccess Reader for state-typed objects matching a pattern
+     */
+    constructor(ctx: AdapterContext, fixId: FixId, aliasManager: AliasManager, objectAccess: ObjectAccess);
+    /**
+     * Subscribe to object changes within this instance's namespace.
+     *
+     * @param pattern pattern without namespace, `*` for all own objects, or an array of patterns
+     *        passed through as-is (not namespaced)
+     * @param options optional user context
+     */
+    subscribeObjects(pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Unsubscribe from object changes within this instance's namespace.
+     *
+     * @param pattern pattern without namespace, `*` for all own objects, or an array of patterns
+     *        passed through as-is (not namespaced)
+     * @param options optional user context
+     */
+    unsubscribeObjects(pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Subscribe to object changes in any instance.
+     *
+     * @param pattern pattern or array of patterns
+     * @param options optional user context
+     */
+    subscribeForeignObjects(pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Unsubscribe from object changes in any instance.
+     *
+     * @param pattern pattern or array of patterns (defaults to `*`)
+     * @param options optional user context
+     */
+    unsubscribeForeignObjects(pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Subscribe to file changes in a specific instance.
+     *
+     * @param id adapter id, e.g. `vis-2.0`
+     * @param pattern pattern or array of patterns
+     * @param options optional user context
+     */
+    subscribeForeignFiles(id: string, pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Unsubscribe from file changes in a specific instance.
+     *
+     * @param id adapter id, e.g. `vis-2.0`
+     * @param pattern pattern or array of patterns (defaults to `*`)
+     * @param options optional user context
+     */
+    unsubscribeForeignFiles(id: string, pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Register an instance as auto-subscribable (its `subscribes` counter is maintained on subscribe/unsubscribe).
+     *
+     * @param id instance id, e.g. `pushover.0`
+     */
+    addSubscribableInstance(id: string): void;
+    /**
+     * Stop treating an instance as auto-subscribable.
+     *
+     * @param id instance id, e.g. `pushover.0`
+     */
+    removeSubscribableInstance(id: string): void;
+    /** Populate the auto-subscribe instance list from the objects DB. */
+    autoSubscribeOn(): Promise<void>;
+    /**
+     * Subscribe to state changes in any instance, resolving aliases and maintaining auto-subscribe counters.
+     *
+     * @param pattern pattern, `*`, an `alias.*` id, or an array of ids/patterns
+     * @param options optional user context
+     */
+    subscribeForeignStates(pattern: Pattern, options?: SubOptions): Promise<void>;
+    /**
+     * Unsubscribe from state changes in any instance, mirroring {@link subscribeForeignStates}.
+     *
+     * @param pattern pattern, `*`, an `alias.*` id, or an array of ids/patterns
+     * @param options optional user context
+     */
+    unsubscribeForeignStates(pattern: Pattern, options?: SubOptions): Promise<void>;
+}
+export {};
+//# sourceMappingURL=SubscriptionManager.d.ts.map

package/build/esm/lib/adapter/managers/SubscriptionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionManager.d.ts","sourceRoot":"","sources":["../../../../../src/lib/adapter/managers/SubscriptionManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAG3E,2HAA2H;AAC3H,MAAM,MAAM,KAAK,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;AAEhE,KAAK,UAAU,GAAG;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAExE,sGAAsG;AACtG,MAAM,WAAW,YAAY;IACzB;;;;OAIG;IACH,sBAAsB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAA;KAAE,GAAG,IAAI,GACpD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;CAClD;AAED,8FAA8F;AAC9F,qBAAa,mBAAoB,SAAQ,kBAAkB;;IAMvD;;;;;OAKG;gBACS,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY;IAOrG;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7E;;;;;;OAMG;IACG,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/E;;;;;OAKG;IACG,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpF;;;;;OAKG;IACG,yBAAyB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF;;;;;;OAMG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9F;;;;;;OAMG;IACG,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhG;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAMzC;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAO5C,qEAAqE;IAC/D,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BtC;;;;;OAKG;IACG,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA+JnF;;;;;OAKG;IACG,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CA2FxF"}