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

package/build/esm/lib/adapter/asyncAdapter.d.ts

@@ -0,0 +1,124 @@
+import type { AllPropsUnknown, InternalGetCertificatesResult, NotificationOptions, SendToOptions, SendToUserInterfaceClientOptions } from '../../lib/_Types.js';
+import type { AdapterContext } from '../../lib/adapter/context.js';
+/**
+ * Clean async-only facade for the adapter's outbound messaging. Owns the {@link MessagingManager}
+ * and exposes promise-based methods without the legacy `*Async` postfix.
+ */
+export declare class AsyncAdapter {
+    #private;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     */
+    constructor(ctx: AdapterContext);
+    /**
+     * Sends a message to another adapter instance and, unless `options.expectReply` is `false`,
+     * resolves with the reply when it arrives (or rejects with `Error('Timeout exceeded')` on timeout).
+     *
+     * Broadcast targets (instance name without a trailing `.<number>`) resolve void regardless.
+     *
+     * @param instanceName name of the instance to send the message to
+     * @param command command name
+     * @param message message payload
+     * @param options send options; set `expectReply: false` for fire-and-forget, or pass a legacy
+     *        `callback` info header (mutually exclusive with `expectReply`)
+     */
+    sendTo(instanceName: string, command: string, message: any, options?: SendToOptions & {
+        expectReply?: boolean;
+        callback?: ioBroker.MessageCallbackInfo;
+    }): Promise<any>;
+    /**
+     * @internal
+     * @param instanceName name of the instance to send the message to
+     * @param command command name
+     * @param message message payload
+     * @param options send options
+     */
+    sendTo(instanceName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any>;
+    /**
+     * Sends a message to a host, or broadcasts to all hosts when `hostName` is `null`.
+     * For a specific host, resolves with the reply unless `options.expectReply` is `false`.
+     * Broadcasts resolve void.
+     *
+     * @param hostName name of the host, or `null` to broadcast to all hosts
+     * @param command command name
+     * @param message message payload
+     * @param options send options; set `expectReply: false` for fire-and-forget
+     */
+    sendToHost(hostName: string | null, command: string, message: any, options?: SendToOptions & {
+        expectReply?: boolean;
+        callback?: ioBroker.MessageCallbackInfo;
+    }): Promise<any>;
+    /**
+     * @internal
+     * @param hostName name of the host, or `null` to broadcast to all hosts
+     * @param command command name
+     * @param message message payload
+     * @param options send options
+     */
+    sendToHost(hostName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any>;
+    /**
+     * 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: AllPropsUnknown<SendToUserInterfaceClientOptions>): Promise<void>;
+    /**
+     * 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
+     */
+    registerNotification<Scope extends keyof ioBroker.NotificationScopes>(scope: Scope, category: ioBroker.NotificationScopes[Scope] | null, message: string, options?: NotificationOptions): Promise<void>;
+    /**
+     * @internal
+     * @param scope notification scope
+     * @param category notification category
+     * @param message notification message
+     * @param options additional notification options
+     */
+    registerNotification(scope: unknown, category: unknown, message: unknown, options?: unknown): Promise<void>;
+    /**
+     * Loads SSL certificates by name, falling back to the instance config defaults. File-backed
+     * certificate values are resolved to their content and their paths returned for watching.
+     *
+     * @param publicName public certificate name (defaults to `config.certPublic`)
+     * @param privateName private key name (defaults to `config.certPrivate`)
+     * @param chainedName chained certificate name (defaults to `config.certChained`)
+     */
+    getCertificates(publicName?: string, privateName?: string, chainedName?: string): Promise<InternalGetCertificatesResult>;
+    /**
+     * @internal
+     * @param publicName public certificate name
+     * @param privateName private key name
+     * @param chainedName chained certificate name
+     */
+    getCertificates(publicName?: unknown, privateName?: unknown, chainedName?: unknown): Promise<InternalGetCertificatesResult>;
+    /**
+     * Tells whether a new version of the `system.certificates` object changes one of the certificates
+     * handed out by the last {@link getCertificates} call. Returns false if certificates were never
+     * requested, so unrelated certificate edits do not concern this adapter.
+     *
+     * @param obj the new `system.certificates` object, or null/undefined if it was deleted
+     */
+    hasRelevantCertificateChange(obj: ioBroker.OtherObject | null | undefined): boolean;
+    /**
+     * Forgets the certificates handed out by the last {@link getCertificates} call, so
+     * {@link hasRelevantCertificateChange} no longer reports changes to them. Used when the adapter
+     * stops watching its certificates.
+     */
+    stopWatchingCertificates(): void;
+    /**
+     * 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
+     */
+    resolveReply(obj: ioBroker.Message): boolean;
+    /**
+     * Rejects all pending reply promises and clears their timers (used on stop).
+     */
+    clearPending(): void;
+}
+//# sourceMappingURL=asyncAdapter.d.ts.map

package/build/esm/lib/adapter/asyncAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncAdapter.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/asyncAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,eAAe,EAEf,6BAA6B,EAC7B,mBAAmB,EACnB,aAAa,EACb,gCAAgC,EACnC,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK/D;;;GAGG;AACH,qBAAa,YAAY;;IAKrB;;OAEG;gBACS,GAAG,EAAE,cAAc;IAc/B;;;;;;;;;;;OAWG;IACH,MAAM,CACF,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,aAAa,GAAG;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAA;KAAE,GAC7F,OAAO,CAAC,GAAG,CAAC;IACf;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IA4BnG;;;;;;;;;OASG;IACH,UAAU,CACN,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,aAAa,GAAG;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAA;KAAE,GAC7F,OAAO,CAAC,GAAG,CAAC;IACf;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IA+BnG;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,gCAAgC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnF;;;;;;;OAOG;IACH,oBAAoB,CAAC,KAAK,SAAS,MAAM,QAAQ,CAAC,kBAAkB,EAChE,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,EACnD,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,mBAAmB,GAC9B,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;OAMG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB3G;;;;;;;OAOG;IACH,eAAe,CACX,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,6BAA6B,CAAC;IACzC;;;;;OAKG;IACH,eAAe,CACX,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,OAAO,EACrB,WAAW,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,6BAA6B,CAAC;IA6BzC;;;;;;OAMG;IACH,4BAA4B,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO;IAInF;;;;OAIG;IACH,wBAAwB,IAAI,IAAI;IAIhC;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,GAAG,OAAO;IAI5C;;OAEG;IACH,YAAY,IAAI,IAAI;CAGvB"}

package/build/esm/lib/adapter/asyncAdapter.js

@@ -0,0 +1,157 @@
+import { CertificateManager } from '../../lib/adapter/managers/CertificateManager.js';
+import { MessagingManager } from '../../lib/adapter/managers/MessagingManager.js';
+import { Validator } from '../../lib/adapter/validator.js';
+/**
+ * Clean async-only facade for the adapter's outbound messaging. Owns the {@link MessagingManager}
+ * and exposes promise-based methods without the legacy `*Async` postfix.
+ */
+export class AsyncAdapter {
+    #ctx;
+    #messagingInstance;
+    #certificatesInstance;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     */
+    constructor(ctx) {
+        this.#ctx = ctx;
+    }
+    /** Lazily-constructed outbound messaging manager. */
+    get #messaging() {
+        return (this.#messagingInstance ??= new MessagingManager(this.#ctx));
+    }
+    /** Lazily-constructed certificate manager. */
+    get #certificates() {
+        return (this.#certificatesInstance ??= new CertificateManager(this.#ctx));
+    }
+    /**
+     * @param instanceName name of the instance to send the message to
+     * @param command command name
+     * @param message message payload
+     * @param options send options
+     */
+    async sendTo(instanceName, command, message, options) {
+        Validator.assertString(instanceName, 'instanceName');
+        Validator.assertString(command, 'command');
+        if (options !== undefined) {
+            Validator.assertObject(options, 'options');
+        }
+        const { expectReply, callback, ...sendOptions } = options ?? {};
+        return this.#messaging.sendTo({
+            instanceName,
+            command,
+            message,
+            callback,
+            options: Object.keys(sendOptions).length ? sendOptions : undefined,
+            expectReply: callback ? false : (expectReply ?? true),
+        });
+    }
+    /**
+     * @param hostName name of the host, or `null` to broadcast to all hosts
+     * @param command command name
+     * @param message message payload
+     * @param options send options
+     */
+    async sendToHost(hostName, command, message, options) {
+        if (hostName !== null) {
+            Validator.assertString(hostName, 'hostName');
+        }
+        Validator.assertString(command, 'command');
+        if (options !== undefined) {
+            Validator.assertObject(options, 'options');
+        }
+        const { expectReply, callback, ...sendOptions } = options ?? {};
+        return this.#messaging.sendToHost({
+            hostName,
+            command,
+            message,
+            callback,
+            options: Object.keys(sendOptions).length ? sendOptions : undefined,
+            // broadcast (null host) yields many responses → never wait for a reply
+            expectReply: hostName !== null && !callback && (expectReply ?? true),
+        });
+    }
+    /**
+     * 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 { clientId, data } = options;
+        if (clientId !== undefined) {
+            Validator.assertString(clientId, 'clientId');
+        }
+        return this.#messaging.sendToUI({ clientId, data });
+    }
+    /**
+     * @param scope notification scope
+     * @param category notification category
+     * @param message notification message
+     * @param options additional notification options
+     */
+    async registerNotification(scope, category, message, options) {
+        Validator.assertString(scope, 'scope');
+        if (category !== null) {
+            Validator.assertString(category, 'category');
+        }
+        Validator.assertString(message, 'message');
+        if (options !== undefined) {
+            Validator.assertObject(options, 'options');
+        }
+        return this.#messaging.registerNotification(scope, category, message, options);
+    }
+    /**
+     * @param publicName public certificate name
+     * @param privateName private key name
+     * @param chainedName chained certificate name
+     */
+    async getCertificates(publicName, privateName, chainedName) {
+        const config = this.#ctx.config;
+        publicName = publicName || config.certPublic;
+        privateName = privateName || config.certPrivate;
+        chainedName = chainedName || config.certChained;
+        if (publicName !== undefined) {
+            Validator.assertString(publicName, 'publicName');
+        }
+        if (privateName !== undefined) {
+            Validator.assertString(privateName, 'privateName');
+        }
+        if (chainedName !== undefined) {
+            Validator.assertString(chainedName, 'chainedName');
+        }
+        return this.#certificates.getCertificates({ publicName, privateName, chainedName });
+    }
+    /**
+     * Tells whether a new version of the `system.certificates` object changes one of the certificates
+     * handed out by the last {@link getCertificates} call. Returns false if certificates were never
+     * requested, so unrelated certificate edits do not concern this adapter.
+     *
+     * @param obj the new `system.certificates` object, or null/undefined if it was deleted
+     */
+    hasRelevantCertificateChange(obj) {
+        return this.#certificatesInstance?.hasRelevantChange(obj) ?? false;
+    }
+    /**
+     * Forgets the certificates handed out by the last {@link getCertificates} call, so
+     * {@link hasRelevantCertificateChange} no longer reports changes to them. Used when the adapter
+     * stops watching its certificates.
+     */
+    stopWatchingCertificates() {
+        this.#certificatesInstance?.stopWatching();
+    }
+    /**
+     * 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
+     */
+    resolveReply(obj) {
+        return this.#messagingInstance?.resolveCallback(obj) ?? false;
+    }
+    /**
+     * Rejects all pending reply promises and clears their timers (used on stop).
+     */
+    clearPending() {
+        this.#messagingInstance?.clearPendingCallbacks();
+    }
+}
+//# sourceMappingURL=asyncAdapter.js.map

package/build/esm/lib/adapter/asyncAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncAdapter.js","sourceRoot":"","sources":["../../../../src/lib/adapter/asyncAdapter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;GAGG;AACH,MAAM,OAAO,YAAY;IACZ,IAAI,CAAiB;IAC9B,kBAAkB,CAAoB;IACtC,qBAAqB,CAAsB;IAE3C;;OAEG;IACH,YAAY,GAAmB;QAC3B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,qDAAqD;IACrD,IAAI,UAAU;QACV,OAAO,CAAC,IAAI,CAAC,kBAAkB,KAAK,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,8CAA8C;IAC9C,IAAI,aAAa;QACb,OAAO,CAAC,IAAI,CAAC,qBAAqB,KAAK,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,CAAC;IA4BD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,YAAqB,EAAE,OAAgB,EAAE,OAAiB,EAAE,OAAiB;QACtF,SAAS,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrD,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS,CAAC,YAAY,CAClB,OAAO,EACP,SAAS,CACZ,CAAC;QACN,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC1B,YAAY;YACZ,OAAO;YACP,OAAO;YACP,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,IAAI,CAAC;SACxD,CAAC,CAAC;IACP,CAAC;IA0BD;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,QAAiB,EAAE,OAAgB,EAAE,OAAiB,EAAE,OAAiB;QACtF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpB,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjD,CAAC;QACD,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS,CAAC,YAAY,CAClB,OAAO,EACP,SAAS,CACZ,CAAC;QACN,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YAC9B,QAAQ;YACR,OAAO;YACP,OAAO;YACP,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;YAClE,uEAAuE;YACvE,WAAW,EAAE,QAAQ,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;SACvE,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAA0D;QAC/D,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACnC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAwBD;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CAAC,KAAc,EAAE,QAAiB,EAAE,OAAgB,EAAE,OAAiB;QAC7F,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpB,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjD,CAAC;QACD,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS,CAAC,YAAY,CAAsB,OAAO,EAAE,SAAS,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IA0BD;;;;OAIG;IACH,KAAK,CAAC,eAAe,CACjB,UAAoB,EACpB,WAAqB,EACrB,WAAqB;QAErB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAA+B,CAAC;QACzD,UAAU,GAAG,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC;QAC7C,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC;QAChD,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC;QAEhD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC3B,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B,CAAC,GAA4C;QACrE,OAAO,IAAI,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,wBAAwB;QACpB,IAAI,CAAC,qBAAqB,EAAE,YAAY,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,GAAqB;QAC9B,OAAO,IAAI,CAAC,kBAAkB,EAAE,eAAe,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,YAAY;QACR,IAAI,CAAC,kBAAkB,EAAE,qBAAqB,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/build/esm/lib/adapter/context.d.ts

@@ -0,0 +1,34 @@
+import type Winston from 'winston';
+import type { Client as StatesInRedisClient } from '@iobroker/db-states-redis';
+import type { Client as ObjectsInRedisClient } from '@iobroker/db-objects-redis';
+import type { UserInterfaceMessagingController } from '../../lib/adapter/userInterfaceMessagingController.js';
+/**
+ * Live view of the adapter's shared runtime state, passed to managers at construction time.
+ *
+ * The mutable fields are exposed as getter properties so late-bound values (DB clients,
+ * namespace, host) stay live: the adapter builds one context whose getters read its own
+ * fields, and every manager reads the same object.
+ */
+export interface AdapterContext {
+    /** Current states DB client */
+    readonly states: StatesInRedisClient | null | undefined;
+    /** Current objects DB client */
+    readonly objects: ObjectsInRedisClient | null | undefined;
+    /** Current adapter common config */
+    readonly common: ioBroker.InstanceCommon | undefined;
+    /** Current adapter instance config (native) */
+    readonly config: ioBroker.AdapterConfig;
+    /** Current host name (may be undefined before init) */
+    readonly host: string | undefined;
+    /** Current adapter namespace, e.g. `"adapter.0"` */
+    readonly namespace: `${string}.${number}`;
+    /** Current namespace string used in log messages */
+    readonly namespaceLog: string;
+    /** Logger instance */
+    readonly logger: Winston.Logger;
+    /** Controller for UI messaging */
+    readonly uiMessagingController: UserInterfaceMessagingController;
+    /** Increment the adapter's outbound-write counter. */
+    readonly countOutput: () => void;
+}
+//# sourceMappingURL=context.d.ts.map

package/build/esm/lib/adapter/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAE,MAAM,IAAI,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,KAAK,EAAE,MAAM,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,mDAAmD,CAAC;AAE1G;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC3B,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;IACxD,gCAAgC;IAChC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC1D,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,GAAG,SAAS,CAAC;IACrD,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;IACxC,uDAAuD;IACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,oDAAoD;IACpD,QAAQ,CAAC,SAAS,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC1C,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,sBAAsB;IACtB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;IAChC,kCAAkC;IAClC,QAAQ,CAAC,qBAAqB,EAAE,gCAAgC,CAAC;IACjE,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,MAAM,IAAI,CAAC;CACpC"}

package/build/esm/lib/adapter/context.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=context.js.map

package/build/esm/lib/adapter/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/lib/adapter/context.ts"],"names":[],"mappings":""}

package/build/esm/lib/adapter/defaultObjs.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Create the default `common` definitions for the well-known state roles (e.g. level.dimmer, indicator.working)
+ *
+ * @returns a map of state role to its default common properties
+ */
 export declare function createDefaults(): Record<string, Partial<ioBroker.StateCommon>>;
 //# sourceMappingURL=defaultObjs.d.ts.map

package/build/esm/lib/adapter/defaultObjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultObjs.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/defaultObjs.ts"],"names":[],"mappings":"AAAA,wBAAgB,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CA0C9E"}
+{"version":3,"file":"defaultObjs.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/defaultObjs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CA0C9E"}

package/build/esm/lib/adapter/defaultObjs.js

@@ -1,3 +1,8 @@
+/**
+ * Create the default `common` definitions for the well-known state roles (e.g. level.dimmer, indicator.working)
+ *
+ * @returns a map of state role to its default common properties
+ */
 export function createDefaults() {
     return {
         'level.dimmer': {

package/build/esm/lib/adapter/defaultObjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultObjs.js","sourceRoot":"","sources":["../../../../src/lib/adapter/defaultObjs.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,cAAc;IAC1B,OAAO;QACH,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,GAAG;SACZ;QACD,mBAAmB,EAAE;YACjB,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;SACf;QACD,uBAAuB,EAAE;YACrB,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;SACf;QACD,8BAA8B,EAAE;YAC5B,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,aAAa;SACtB;QACD,+BAA+B,EAAE;YAC7B,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,oBAAoB;SAC7B;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;SACd;KACK,CAAC;AACf,CAAC"}
+{"version":3,"file":"defaultObjs.js","sourceRoot":"","sources":["../../../../src/lib/adapter/defaultObjs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC1B,OAAO;QACH,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,GAAG;SACZ;QACD,mBAAmB,EAAE;YACjB,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;SACf;QACD,uBAAuB,EAAE;YACrB,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;SACf;QACD,8BAA8B,EAAE;YAC5B,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,aAAa;SACtB;QACD,+BAA+B,EAAE;YAC7B,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,oBAAoB;SAC7B;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;SACd;KACK,CAAC;AACf,CAAC"}

package/build/esm/lib/adapter/log.d.ts

@@ -13,10 +13,35 @@ export declare class Log implements ioBroker.Logger {
      * @param logger logger instance
      */
     constructor(namespaceLog: string, level: ioBroker.LogLevel, logger: any);
+    /**
+     * Log a message at the silly level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     silly(msg: string): void;
+    /**
+     * Log a message at the debug level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     debug(msg: string): void;
+    /**
+     * Log a message at the info level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     info(msg: string): void;
+    /**
+     * Log a message at the error level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     error(msg: string): void;
+    /**
+     * Log a message at the warn level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     warn(msg: string): void;
 }
 //# sourceMappingURL=log.d.ts.map

package/build/esm/lib/adapter/log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/log.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,qBAAa,GAAI,YAAW,QAAQ,CAAC,MAAM;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAElC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAMrB;IAEF;;;;OAIG;gBACS,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG;IAgBvE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAG1B"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/log.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,qBAAa,GAAI,YAAW,QAAQ,CAAC,MAAM;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAElC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAMrB;IAEF;;;;OAIG;gBACS,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG;IAgBvE;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvB;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAG1B"}

package/build/esm/lib/adapter/log.js

@@ -28,18 +28,43 @@ export class Log {
         this.error = this.error.bind(this);
         this.warn = this.warn.bind(this);
     }
+    /**
+     * Log a message at the silly level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     silly(msg) {
         this.logger.silly(`${this.namespaceLog} ${msg}`);
     }
+    /**
+     * Log a message at the debug level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     debug(msg) {
         this.logger.debug(`${this.namespaceLog} ${msg}`);
     }
+    /**
+     * Log a message at the info level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     info(msg) {
         this.logger.info(`${this.namespaceLog} ${msg}`);
     }
+    /**
+     * Log a message at the error level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     error(msg) {
         this.logger.error(`${this.namespaceLog} ${msg}`);
     }
+    /**
+     * Log a message at the warn level, prefixed with the adapter namespace
+     *
+     * @param msg the message to log
+     */
     warn(msg) {
         this.logger.warn(`${this.namespaceLog} ${msg}`);
     }

package/build/esm/lib/adapter/log.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../../src/lib/adapter/log.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,GAAG;IACK,YAAY,CAAS;IAC7B,KAAK,CAAoB;IAClC,2IAA2I;IAC1H,MAAM,CAMrB;IAEF;;;;OAIG;IACH,YAAY,YAAoB,EAAE,KAAwB,EAAE,MAAW;QACnE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,4EAA4E;QAC5E,uFAAuF;QACvF,8BAA8B;QAC9B,2BAA2B;QAC3B,YAAY;QACZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,GAAW;QACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,GAAW;QACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACpD,CAAC;CACJ"}
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../../src/lib/adapter/log.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,GAAG;IACK,YAAY,CAAS;IAC7B,KAAK,CAAoB;IAClC,2IAA2I;IAC1H,MAAM,CAMrB;IAEF;;;;OAIG;IACH,YAAY,YAAoB,EAAE,KAAwB,EAAE,MAAW;QACnE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,4EAA4E;QAC5E,uFAAuF;QACvF,8BAA8B;QAC9B,2BAA2B;QAC3B,YAAY;QACZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,GAAW;QACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAW;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,GAAW;QACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,GAAG,EAAE,CAAC,CAAC;IACpD,CAAC;CACJ"}

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

@@ -0,0 +1,49 @@
+import type { Client as StatesInRedisClient } from '@iobroker/db-states-redis';
+import type { Client as ObjectsInRedisClient } from '@iobroker/db-objects-redis';
+import type { AdapterContext } from '../../../lib/adapter/context.js';
+/**
+ * Base class for adapter managers that read from the shared {@link AdapterContext}.
+ *
+ * Holds the context in a private `#ctx` field so subclasses cannot bypass the connection-checked
+ * getters and reach the raw (possibly null) DB clients directly. Access to `states`/`objects` goes
+ * through the throwing getters, which raise `ERROR_DB_CLOSED` when the respective database is not
+ * connected; the other getters pass ctx values through unchanged.
+ *
+ * Getters are `protected` because `#` privates are not visible to subclasses.
+ */
+export declare abstract class AdapterContextBase {
+    #private;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     */
+    constructor(ctx: AdapterContext);
+    /**
+     * The connected states DB client.
+     *
+     * @throws {Error} `ERROR_DB_CLOSED` when the states database is not connected.
+     */
+    protected get states(): StatesInRedisClient;
+    /**
+     * The connected objects DB client.
+     *
+     * @throws {Error} `ERROR_DB_CLOSED` when the objects database is not connected.
+     */
+    protected get objects(): ObjectsInRedisClient;
+    /** Current adapter common config */
+    protected get common(): ioBroker.InstanceCommon | undefined;
+    /** Current adapter instance config (native) */
+    protected get config(): ioBroker.AdapterConfig;
+    /** Current host name (may be undefined before init) */
+    protected get host(): string | undefined;
+    /** Current adapter namespace, e.g. `"adapter.0"` */
+    protected get namespace(): `${string}.${number}`;
+    /** Current namespace string used in log messages */
+    protected get namespaceLog(): string;
+    /** Logger instance */
+    protected get logger(): AdapterContext['logger'];
+    /** Controller for UI messaging */
+    protected get uiMessagingController(): AdapterContext['uiMessagingController'];
+    /** Increment the adapter's outbound-write counter. */
+    protected countOutput(): void;
+}
+//# sourceMappingURL=AdapterContextBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AdapterContextBase.d.ts","sourceRoot":"","sources":["../../../../../src/lib/adapter/managers/AdapterContextBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,KAAK,EAAE,MAAM,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG/D;;;;;;;;;GASG;AACH,8BAAsB,kBAAkB;;IAGpC;;OAEG;gBACS,GAAG,EAAE,cAAc;IAI/B;;;;OAIG;IACH,SAAS,KAAK,MAAM,IAAI,mBAAmB,CAM1C;IAED;;;;OAIG;IACH,SAAS,KAAK,OAAO,IAAI,oBAAoB,CAM5C;IAED,oCAAoC;IACpC,SAAS,KAAK,MAAM,IAAI,QAAQ,CAAC,cAAc,GAAG,SAAS,CAE1D;IAED,+CAA+C;IAC/C,SAAS,KAAK,MAAM,IAAI,QAAQ,CAAC,aAAa,CAE7C;IAED,uDAAuD;IACvD,SAAS,KAAK,IAAI,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,oDAAoD;IACpD,SAAS,KAAK,SAAS,IAAI,GAAG,MAAM,IAAI,MAAM,EAAE,CAE/C;IAED,oDAAoD;IACpD,SAAS,KAAK,YAAY,IAAI,MAAM,CAEnC;IAED,sBAAsB;IACtB,SAAS,KAAK,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAE/C;IAED,kCAAkC;IAClC,SAAS,KAAK,qBAAqB,IAAI,cAAc,CAAC,uBAAuB,CAAC,CAE7E;IAED,sDAAsD;IACtD,SAAS,CAAC,WAAW,IAAI,IAAI;CAGhC"}

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

@@ -0,0 +1,77 @@
+import { tools } from '@iobroker/js-controller-common';
+/**
+ * Base class for adapter managers that read from the shared {@link AdapterContext}.
+ *
+ * Holds the context in a private `#ctx` field so subclasses cannot bypass the connection-checked
+ * getters and reach the raw (possibly null) DB clients directly. Access to `states`/`objects` goes
+ * through the throwing getters, which raise `ERROR_DB_CLOSED` when the respective database is not
+ * connected; the other getters pass ctx values through unchanged.
+ *
+ * Getters are `protected` because `#` privates are not visible to subclasses.
+ */
+export class AdapterContextBase {
+    #ctx;
+    /**
+     * @param ctx Shared adapter context providing live runtime state
+     */
+    constructor(ctx) {
+        this.#ctx = ctx;
+    }
+    /**
+     * The connected states DB client.
+     *
+     * @throws {Error} `ERROR_DB_CLOSED` when the states database is not connected.
+     */
+    get states() {
+        const states = this.#ctx.states;
+        if (!states) {
+            throw new Error(tools.ERRORS.ERROR_DB_CLOSED);
+        }
+        return states;
+    }
+    /**
+     * The connected objects DB client.
+     *
+     * @throws {Error} `ERROR_DB_CLOSED` when the objects database is not connected.
+     */
+    get objects() {
+        const objects = this.#ctx.objects;
+        if (!objects) {
+            throw new Error(tools.ERRORS.ERROR_DB_CLOSED);
+        }
+        return objects;
+    }
+    /** Current adapter common config */
+    get common() {
+        return this.#ctx.common;
+    }
+    /** Current adapter instance config (native) */
+    get config() {
+        return this.#ctx.config;
+    }
+    /** Current host name (may be undefined before init) */
+    get host() {
+        return this.#ctx.host;
+    }
+    /** Current adapter namespace, e.g. `"adapter.0"` */
+    get namespace() {
+        return this.#ctx.namespace;
+    }
+    /** Current namespace string used in log messages */
+    get namespaceLog() {
+        return this.#ctx.namespaceLog;
+    }
+    /** Logger instance */
+    get logger() {
+        return this.#ctx.logger;
+    }
+    /** Controller for UI messaging */
+    get uiMessagingController() {
+        return this.#ctx.uiMessagingController;
+    }
+    /** Increment the adapter's outbound-write counter. */
+    countOutput() {
+        this.#ctx.countOutput();
+    }
+}
+//# sourceMappingURL=AdapterContextBase.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AdapterContextBase.js","sourceRoot":"","sources":["../../../../../src/lib/adapter/managers/AdapterContextBase.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,OAAgB,kBAAkB;IAC3B,IAAI,CAAiB;IAE9B;;OAEG;IACH,YAAY,GAAmB;QAC3B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAc,MAAM;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAc,OAAO;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,oCAAoC;IACpC,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,+CAA+C;IAC/C,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,uDAAuD;IACvD,IAAc,IAAI;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,oDAAoD;IACpD,IAAc,SAAS;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,oDAAoD;IACpD,IAAc,YAAY;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAClC,CAAC;IAED,sBAAsB;IACtB,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,kCAAkC;IAClC,IAAc,qBAAqB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC;IAC3C,CAAC;IAED,sDAAsD;IAC5C,WAAW;QACjB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;CACJ"}