@iobroker/js-controller-adapter 7.2.3 → 8.0.0-alpha.2-20260923-99da17fcc

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

@@ -0,0 +1,167 @@
+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;
+    /**
+     * Registers an exclusive resource (serial port, TCP/UDP port, USB device, ...) as used by this
+     * instance. The registration is forwarded to the host, which stores it under
+     * `system.host.<hostname>.usedResources.<type>`.
+     *
+     * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+     * @param data payload describing the resource
+     * @throws {Error} when the host refuses the registration or does not answer
+     */
+    registerUsedResource<T extends ioBroker.UsedResourceType>(type: T, data: ioBroker.UsedResourceData<T>): Promise<void>;
+    /**
+     * Asks the host whether another instance currently holds a resource, without registering it.
+     *
+     * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+     * @param data description of the resource that is about to be used
+     * @returns the entries of other instances that currently hold it
+     * @throws {Error} when the host refuses the request or does not answer
+     */
+    checkUsedResource<T extends ioBroker.UsedResourceType>(type: T, data?: Partial<ioBroker.UsedResourceData<T>>): Promise<ioBroker.RegisteredResource[]>;
+    /**
+     * Frees all exclusive resources this instance registered, across all types.
+     *
+     * @throws {Error} when the host refuses the command or does not answer
+     */
+    clearUsedResources(): Promise<void>;
+    /**
+     * Frees previously registered exclusive resources of this instance. `data` is a filter: every field it
+     * names must match. If it is omitted, all registered resources of the given `type` are freed.
+     *
+     * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+     * @param data fields identifying the resources to free; if omitted, all resources of `type` are freed
+     * @throws {Error} when the host refuses the command or does not answer
+     */
+    freeUsedResource<T extends ioBroker.UsedResourceType>(type: T, data?: Partial<ioBroker.UsedResourceData<T>>): Promise<void>;
+    /**
+     * Reads the exclusive resources of the given type registered on this instance's host, across all
+     * instances of that host.
+     *
+     * @param type resource type to read, e.g. "serialPort"
+     */
+    getHostUsedResources<T extends ioBroker.UsedResourceType>(type: T): Promise<ioBroker.RegisteredResource<T>[]>;
+    /** Reads the exclusive resources of every type registered on this instance's host. */
+    getHostUsedResources(): Promise<ioBroker.RegisteredResource[]>;
+    /**
+     * 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/cjs/lib/adapter/asyncAdapter.js

@@ -0,0 +1,252 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var asyncAdapter_exports = {};
+__export(asyncAdapter_exports, {
+  AsyncAdapter: () => AsyncAdapter
+});
+module.exports = __toCommonJS(asyncAdapter_exports);
+var import_CertificateManager = require("../../lib/adapter/managers/CertificateManager.js");
+var import_MessagingManager = require("../../lib/adapter/managers/MessagingManager.js");
+var import_ResourceManager = require("../../lib/adapter/managers/ResourceManager.js");
+var import_validator = require("../../lib/adapter/validator.js");
+class AsyncAdapter {
+  static {
+    __name(this, "AsyncAdapter");
+  }
+  #ctx;
+  #messagingInstance;
+  #certificatesInstance;
+  #resourcesInstance;
+  /**
+   * @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 import_MessagingManager.MessagingManager(this.#ctx);
+  }
+  /** Lazily-constructed certificate manager. */
+  get #certificates() {
+    return this.#certificatesInstance ??= new import_CertificateManager.CertificateManager(this.#ctx);
+  }
+  /** Lazily-constructed exclusive-resource manager. */
+  get #resources() {
+    return this.#resourcesInstance ??= new import_ResourceManager.ResourceManager(this.#ctx, () => this.#messaging);
+  }
+  /**
+   * @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) {
+    import_validator.Validator.assertString(instanceName, "instanceName");
+    import_validator.Validator.assertString(command, "command");
+    if (options !== void 0) {
+      import_validator.Validator.assertObject(options, "options");
+    }
+    const { expectReply, callback, ...sendOptions } = options ?? {};
+    return this.#messaging.sendTo({
+      instanceName,
+      command,
+      message,
+      callback,
+      options: Object.keys(sendOptions).length ? sendOptions : void 0,
+      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) {
+      import_validator.Validator.assertString(hostName, "hostName");
+    }
+    import_validator.Validator.assertString(command, "command");
+    if (options !== void 0) {
+      import_validator.Validator.assertObject(options, "options");
+    }
+    const { expectReply, callback, ...sendOptions } = options ?? {};
+    return this.#messaging.sendToHost({
+      hostName,
+      command,
+      message,
+      callback,
+      options: Object.keys(sendOptions).length ? sendOptions : void 0,
+      // 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 !== void 0) {
+      import_validator.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) {
+    import_validator.Validator.assertString(scope, "scope");
+    if (category !== null) {
+      import_validator.Validator.assertString(category, "category");
+    }
+    import_validator.Validator.assertString(message, "message");
+    if (options !== void 0) {
+      import_validator.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 !== void 0) {
+      import_validator.Validator.assertString(publicName, "publicName");
+    }
+    if (privateName !== void 0) {
+      import_validator.Validator.assertString(privateName, "privateName");
+    }
+    if (chainedName !== void 0) {
+      import_validator.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();
+  }
+  /**
+   * Registers an exclusive resource (serial port, TCP/UDP port, USB device, ...) as used by this
+   * instance. The registration is forwarded to the host, which stores it under
+   * `system.host.<hostname>.usedResources.<type>`.
+   *
+   * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+   * @param data payload describing the resource
+   * @throws {Error} when the host refuses the registration or does not answer
+   */
+  async registerUsedResource(type, data) {
+    import_validator.Validator.assertString(type, "type");
+    import_validator.Validator.assertObject(data, "data");
+    return this.#resources.registerUsedResource(type, data);
+  }
+  /**
+   * Asks the host whether another instance currently holds a resource, without registering it.
+   *
+   * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+   * @param data description of the resource that is about to be used
+   * @returns the entries of other instances that currently hold it
+   * @throws {Error} when the host refuses the request or does not answer
+   */
+  async checkUsedResource(type, data) {
+    import_validator.Validator.assertString(type, "type");
+    if (data !== void 0) {
+      import_validator.Validator.assertObject(data, "data");
+    }
+    return this.#resources.checkUsedResource(type, data);
+  }
+  /**
+   * Frees all exclusive resources this instance registered, across all types.
+   *
+   * @throws {Error} when the host refuses the command or does not answer
+   */
+  async clearUsedResources() {
+    return this.#resources.clearUsedResources();
+  }
+  /**
+   * Frees previously registered exclusive resources of this instance. `data` is a filter: every field it
+   * names must match. If it is omitted, all registered resources of the given `type` are freed.
+   *
+   * @param type the kind of resource, e.g. "serialPort" or "tcpPort"
+   * @param data fields identifying the resources to free; if omitted, all resources of `type` are freed
+   * @throws {Error} when the host refuses the command or does not answer
+   */
+  async freeUsedResource(type, data) {
+    import_validator.Validator.assertString(type, "type");
+    if (data !== void 0) {
+      import_validator.Validator.assertObject(data, "data");
+    }
+    return this.#resources.freeUsedResource(type, data);
+  }
+  /**
+   * @param type resource type to read; if omitted, the resources of every type are read
+   */
+  getHostUsedResources(type) {
+    if (type !== void 0) {
+      import_validator.Validator.assertString(type, "type");
+      return this.#resources.getHostUsedResources(type);
+    }
+    return this.#resources.getHostUsedResources();
+  }
+  /**
+   * 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();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AsyncAdapter
+});
+//# sourceMappingURL=asyncAdapter.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/lib/adapter/asyncAdapter.ts"],
+  "sourcesContent": ["import type {\n    AllPropsUnknown,\n    InternalAdapterConfig,\n    InternalGetCertificatesResult,\n    NotificationOptions,\n    SendToOptions,\n    SendToUserInterfaceClientOptions,\n} from '@/lib/_Types.js';\nimport type { AdapterContext } from '@/lib/adapter/context.js';\nimport { CertificateManager } from '@/lib/adapter/managers/CertificateManager.js';\nimport { MessagingManager } from '@/lib/adapter/managers/MessagingManager.js';\nimport { ResourceManager } from '@/lib/adapter/managers/ResourceManager.js';\nimport { Validator } from '@/lib/adapter/validator.js';\n\n/**\n * Clean async-only facade for the adapter's outbound messaging. Owns the {@link MessagingManager}\n * and exposes promise-based methods without the legacy `*Async` postfix.\n */\nexport class AsyncAdapter {\n    readonly #ctx: AdapterContext;\n    #messagingInstance?: MessagingManager;\n    #certificatesInstance?: CertificateManager;\n    #resourcesInstance?: ResourceManager;\n\n    /**\n     * @param ctx Shared adapter context providing live runtime state\n     */\n    constructor(ctx: AdapterContext) {\n        this.#ctx = ctx;\n    }\n\n    /** Lazily-constructed outbound messaging manager. */\n    get #messaging(): MessagingManager {\n        return (this.#messagingInstance ??= new MessagingManager(this.#ctx));\n    }\n\n    /** Lazily-constructed certificate manager. */\n    get #certificates(): CertificateManager {\n        return (this.#certificatesInstance ??= new CertificateManager(this.#ctx));\n    }\n\n    /** Lazily-constructed exclusive-resource manager. */\n    get #resources(): ResourceManager {\n        return (this.#resourcesInstance ??= new ResourceManager(this.#ctx, () => this.#messaging));\n    }\n\n    /**\n     * Sends a message to another adapter instance and, unless `options.expectReply` is `false`,\n     * resolves with the reply when it arrives (or rejects with `Error('Timeout exceeded')` on timeout).\n     *\n     * Broadcast targets (instance name without a trailing `.<number>`) resolve void regardless.\n     *\n     * @param instanceName name of the instance to send the message to\n     * @param command command name\n     * @param message message payload\n     * @param options send options; set `expectReply: false` for fire-and-forget, or pass a legacy\n     *        `callback` info header (mutually exclusive with `expectReply`)\n     */\n    sendTo(\n        instanceName: string,\n        command: string,\n        message: any,\n        options?: SendToOptions & { expectReply?: boolean; callback?: ioBroker.MessageCallbackInfo },\n    ): Promise<any>;\n    /**\n     * @internal\n     * @param instanceName name of the instance to send the message to\n     * @param command command name\n     * @param message message payload\n     * @param options send options\n     */\n    sendTo(instanceName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any>;\n    /**\n     * @param instanceName name of the instance to send the message to\n     * @param command command name\n     * @param message message payload\n     * @param options send options\n     */\n    async sendTo(instanceName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any> {\n        Validator.assertString(instanceName, 'instanceName');\n        Validator.assertString(command, 'command');\n        if (options !== undefined) {\n            Validator.assertObject<SendToOptions & { expectReply?: boolean; callback?: ioBroker.MessageCallbackInfo }>(\n                options,\n                'options',\n            );\n        }\n\n        const { expectReply, callback, ...sendOptions } = options ?? {};\n        return this.#messaging.sendTo({\n            instanceName,\n            command,\n            message,\n            callback,\n            options: Object.keys(sendOptions).length ? sendOptions : undefined,\n            expectReply: callback ? false : (expectReply ?? true),\n        });\n    }\n\n    /**\n     * Sends a message to a host, or broadcasts to all hosts when `hostName` is `null`.\n     * For a specific host, resolves with the reply unless `options.expectReply` is `false`.\n     * Broadcasts resolve void.\n     *\n     * @param hostName name of the host, or `null` to broadcast to all hosts\n     * @param command command name\n     * @param message message payload\n     * @param options send options; set `expectReply: false` for fire-and-forget\n     */\n    sendToHost(\n        hostName: string | null,\n        command: string,\n        message: any,\n        options?: SendToOptions & { expectReply?: boolean; callback?: ioBroker.MessageCallbackInfo },\n    ): Promise<any>;\n    /**\n     * @internal\n     * @param hostName name of the host, or `null` to broadcast to all hosts\n     * @param command command name\n     * @param message message payload\n     * @param options send options\n     */\n    sendToHost(hostName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any>;\n    /**\n     * @param hostName name of the host, or `null` to broadcast to all hosts\n     * @param command command name\n     * @param message message payload\n     * @param options send options\n     */\n    async sendToHost(hostName: unknown, command: unknown, message?: unknown, options?: unknown): Promise<any> {\n        if (hostName !== null) {\n            Validator.assertString(hostName, 'hostName');\n        }\n        Validator.assertString(command, 'command');\n        if (options !== undefined) {\n            Validator.assertObject<SendToOptions & { expectReply?: boolean; callback?: ioBroker.MessageCallbackInfo }>(\n                options,\n                'options',\n            );\n        }\n\n        const { expectReply, callback, ...sendOptions } = options ?? {};\n        return this.#messaging.sendToHost({\n            hostName,\n            command,\n            message,\n            callback,\n            options: Object.keys(sendOptions).length ? sendOptions : undefined,\n            // broadcast (null host) yields many responses \u2192 never wait for a reply\n            expectReply: hostName !== null && !callback && (expectReply ?? true),\n        });\n    }\n\n    /**\n     * Sends a message to a single UI client, or broadcasts to all connected UI clients when `clientId` is omitted.\n     *\n     * @param options clientId and data options\n     */\n    sendToUI(options: AllPropsUnknown<SendToUserInterfaceClientOptions>): Promise<void> {\n        const { clientId, data } = options;\n        if (clientId !== undefined) {\n            Validator.assertString(clientId, 'clientId');\n        }\n        return this.#messaging.sendToUI({ clientId, data });\n    }\n\n    /**\n     * Sends an addNotification command to the host of this adapter instance.\n     *\n     * @param scope notification scope\n     * @param category notification category, or `null` to match by scope regex\n     * @param message notification message\n     * @param options additional notification options\n     */\n    registerNotification<Scope extends keyof ioBroker.NotificationScopes>(\n        scope: Scope,\n        category: ioBroker.NotificationScopes[Scope] | null,\n        message: string,\n        options?: NotificationOptions,\n    ): Promise<void>;\n    /**\n     * @internal\n     * @param scope notification scope\n     * @param category notification category\n     * @param message notification message\n     * @param options additional notification options\n     */\n    registerNotification(scope: unknown, category: unknown, message: unknown, options?: unknown): Promise<void>;\n    /**\n     * @param scope notification scope\n     * @param category notification category\n     * @param message notification message\n     * @param options additional notification options\n     */\n    async registerNotification(scope: unknown, category: unknown, message: unknown, options?: unknown): Promise<void> {\n        Validator.assertString(scope, 'scope');\n        if (category !== null) {\n            Validator.assertString(category, 'category');\n        }\n        Validator.assertString(message, 'message');\n        if (options !== undefined) {\n            Validator.assertObject<NotificationOptions>(options, 'options');\n        }\n        return this.#messaging.registerNotification(scope, category, message, options);\n    }\n\n    /**\n     * Loads SSL certificates by name, falling back to the instance config defaults. File-backed\n     * certificate values are resolved to their content and their paths returned for watching.\n     *\n     * @param publicName public certificate name (defaults to `config.certPublic`)\n     * @param privateName private key name (defaults to `config.certPrivate`)\n     * @param chainedName chained certificate name (defaults to `config.certChained`)\n     */\n    getCertificates(\n        publicName?: string,\n        privateName?: string,\n        chainedName?: string,\n    ): Promise<InternalGetCertificatesResult>;\n    /**\n     * @internal\n     * @param publicName public certificate name\n     * @param privateName private key name\n     * @param chainedName chained certificate name\n     */\n    getCertificates(\n        publicName?: unknown,\n        privateName?: unknown,\n        chainedName?: unknown,\n    ): Promise<InternalGetCertificatesResult>;\n    /**\n     * @param publicName public certificate name\n     * @param privateName private key name\n     * @param chainedName chained certificate name\n     */\n    async getCertificates(\n        publicName?: unknown,\n        privateName?: unknown,\n        chainedName?: unknown,\n    ): Promise<InternalGetCertificatesResult> {\n        const config = this.#ctx.config as InternalAdapterConfig;\n        publicName = publicName || config.certPublic;\n        privateName = privateName || config.certPrivate;\n        chainedName = chainedName || config.certChained;\n\n        if (publicName !== undefined) {\n            Validator.assertString(publicName, 'publicName');\n        }\n        if (privateName !== undefined) {\n            Validator.assertString(privateName, 'privateName');\n        }\n        if (chainedName !== undefined) {\n            Validator.assertString(chainedName, 'chainedName');\n        }\n\n        return this.#certificates.getCertificates({ publicName, privateName, chainedName });\n    }\n\n    /**\n     * Tells whether a new version of the `system.certificates` object changes one of the certificates\n     * handed out by the last {@link getCertificates} call. Returns false if certificates were never\n     * requested, so unrelated certificate edits do not concern this adapter.\n     *\n     * @param obj the new `system.certificates` object, or null/undefined if it was deleted\n     */\n    hasRelevantCertificateChange(obj: ioBroker.OtherObject | null | undefined): boolean {\n        return this.#certificatesInstance?.hasRelevantChange(obj) ?? false;\n    }\n\n    /**\n     * Forgets the certificates handed out by the last {@link getCertificates} call, so\n     * {@link hasRelevantCertificateChange} no longer reports changes to them. Used when the adapter\n     * stops watching its certificates.\n     */\n    stopWatchingCertificates(): void {\n        this.#certificatesInstance?.stopWatching();\n    }\n\n    /**\n     * Registers an exclusive resource (serial port, TCP/UDP port, USB device, ...) as used by this\n     * instance. The registration is forwarded to the host, which stores it under\n     * `system.host.<hostname>.usedResources.<type>`.\n     *\n     * @param type the kind of resource, e.g. \"serialPort\" or \"tcpPort\"\n     * @param data payload describing the resource\n     * @throws {Error} when the host refuses the registration or does not answer\n     */\n    async registerUsedResource<T extends ioBroker.UsedResourceType>(\n        type: T,\n        data: ioBroker.UsedResourceData<T>,\n    ): Promise<void> {\n        Validator.assertString(type, 'type');\n        Validator.assertObject(data, 'data');\n        return this.#resources.registerUsedResource(type, data);\n    }\n\n    /**\n     * Asks the host whether another instance currently holds a resource, without registering it.\n     *\n     * @param type the kind of resource, e.g. \"serialPort\" or \"tcpPort\"\n     * @param data description of the resource that is about to be used\n     * @returns the entries of other instances that currently hold it\n     * @throws {Error} when the host refuses the request or does not answer\n     */\n    async checkUsedResource<T extends ioBroker.UsedResourceType>(\n        type: T,\n        data?: Partial<ioBroker.UsedResourceData<T>>,\n    ): Promise<ioBroker.RegisteredResource[]> {\n        Validator.assertString(type, 'type');\n        if (data !== undefined) {\n            Validator.assertObject(data, 'data');\n        }\n        return this.#resources.checkUsedResource(type, data);\n    }\n\n    /**\n     * Frees all exclusive resources this instance registered, across all types.\n     *\n     * @throws {Error} when the host refuses the command or does not answer\n     */\n    async clearUsedResources(): Promise<void> {\n        return this.#resources.clearUsedResources();\n    }\n\n    /**\n     * Frees previously registered exclusive resources of this instance. `data` is a filter: every field it\n     * names must match. If it is omitted, all registered resources of the given `type` are freed.\n     *\n     * @param type the kind of resource, e.g. \"serialPort\" or \"tcpPort\"\n     * @param data fields identifying the resources to free; if omitted, all resources of `type` are freed\n     * @throws {Error} when the host refuses the command or does not answer\n     */\n    async freeUsedResource<T extends ioBroker.UsedResourceType>(\n        type: T,\n        data?: Partial<ioBroker.UsedResourceData<T>>,\n    ): Promise<void> {\n        Validator.assertString(type, 'type');\n        if (data !== undefined) {\n            Validator.assertObject(data, 'data');\n        }\n        return this.#resources.freeUsedResource(type, data);\n    }\n\n    /**\n     * Reads the exclusive resources of the given type registered on this instance's host, across all\n     * instances of that host.\n     *\n     * @param type resource type to read, e.g. \"serialPort\"\n     */\n    getHostUsedResources<T extends ioBroker.UsedResourceType>(type: T): Promise<ioBroker.RegisteredResource<T>[]>;\n    /** Reads the exclusive resources of every type registered on this instance's host. */\n    getHostUsedResources(): Promise<ioBroker.RegisteredResource[]>;\n\n    /**\n     * @param type resource type to read; if omitted, the resources of every type are read\n     */\n    getHostUsedResources(type?: ioBroker.UsedResourceType): Promise<ioBroker.RegisteredResource[]> {\n        if (type !== undefined) {\n            Validator.assertString(type, 'type');\n            return this.#resources.getHostUsedResources(type);\n        }\n        return this.#resources.getHostUsedResources();\n    }\n\n    /**\n     * Resolves a pending reply promise for an acked messagebox message.\n     * Returns true if a pending entry was found and consumed.\n     *\n     * @param obj incoming message object from the messagebox\n     */\n    resolveReply(obj: ioBroker.Message): boolean {\n        return this.#messagingInstance?.resolveCallback(obj) ?? false;\n    }\n\n    /**\n     * Rejects all pending reply promises and clears their timers (used on stop).\n     */\n    clearPending(): void {\n        this.#messagingInstance?.clearPendingCallbacks();\n    }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AASA;;;;;AAAA,gCAAmC;AACnC,8BAAiC;AACjC,6BAAgC;AAChC,uBAA0B;AAMpB,MAAO,aAAY;EATzB,OASyB;;;EACZ;EACT;EACA;EACA;;;;EAKA,YAAY,KAAmB;AAC3B,SAAK,OAAO;EAChB;;EAGA,IAAI,aAAU;AACV,WAAQ,KAAK,uBAAuB,IAAI,yCAAiB,KAAK,IAAI;EACtE;;EAGA,IAAI,gBAAa;AACb,WAAQ,KAAK,0BAA0B,IAAI,6CAAmB,KAAK,IAAI;EAC3E;;EAGA,IAAI,aAAU;AACV,WAAQ,KAAK,uBAAuB,IAAI,uCAAgB,KAAK,MAAM,MAAM,KAAK,UAAU;EAC5F;;;;;;;EAkCA,MAAM,OAAO,cAAuB,SAAkB,SAAmB,SAAiB;AACtF,+BAAU,aAAa,cAAc,cAAc;AACnD,+BAAU,aAAa,SAAS,SAAS;AACzC,QAAI,YAAY,QAAW;AACvB,iCAAU,aACN,SACA,SAAS;IAEjB;AAEA,UAAM,EAAE,aAAa,UAAU,GAAG,YAAW,IAAK,WAAW,CAAA;AAC7D,WAAO,KAAK,WAAW,OAAO;MAC1B;MACA;MACA;MACA;MACA,SAAS,OAAO,KAAK,WAAW,EAAE,SAAS,cAAc;MACzD,aAAa,WAAW,QAAS,eAAe;KACnD;EACL;;;;;;;EAgCA,MAAM,WAAW,UAAmB,SAAkB,SAAmB,SAAiB;AACtF,QAAI,aAAa,MAAM;AACnB,iCAAU,aAAa,UAAU,UAAU;IAC/C;AACA,+BAAU,aAAa,SAAS,SAAS;AACzC,QAAI,YAAY,QAAW;AACvB,iCAAU,aACN,SACA,SAAS;IAEjB;AAEA,UAAM,EAAE,aAAa,UAAU,GAAG,YAAW,IAAK,WAAW,CAAA;AAC7D,WAAO,KAAK,WAAW,WAAW;MAC9B;MACA;MACA;MACA;MACA,SAAS,OAAO,KAAK,WAAW,EAAE,SAAS,cAAc;;MAEzD,aAAa,aAAa,QAAQ,CAAC,aAAa,eAAe;KAClE;EACL;;;;;;EAOA,SAAS,SAA0D;AAC/D,UAAM,EAAE,UAAU,KAAI,IAAK;AAC3B,QAAI,aAAa,QAAW;AACxB,iCAAU,aAAa,UAAU,UAAU;IAC/C;AACA,WAAO,KAAK,WAAW,SAAS,EAAE,UAAU,KAAI,CAAE;EACtD;;;;;;;EA8BA,MAAM,qBAAqB,OAAgB,UAAmB,SAAkB,SAAiB;AAC7F,+BAAU,aAAa,OAAO,OAAO;AACrC,QAAI,aAAa,MAAM;AACnB,iCAAU,aAAa,UAAU,UAAU;IAC/C;AACA,+BAAU,aAAa,SAAS,SAAS;AACzC,QAAI,YAAY,QAAW;AACvB,iCAAU,aAAkC,SAAS,SAAS;IAClE;AACA,WAAO,KAAK,WAAW,qBAAqB,OAAO,UAAU,SAAS,OAAO;EACjF;;;;;;EA+BA,MAAM,gBACF,YACA,aACA,aAAqB;AAErB,UAAM,SAAS,KAAK,KAAK;AACzB,iBAAa,cAAc,OAAO;AAClC,kBAAc,eAAe,OAAO;AACpC,kBAAc,eAAe,OAAO;AAEpC,QAAI,eAAe,QAAW;AAC1B,iCAAU,aAAa,YAAY,YAAY;IACnD;AACA,QAAI,gBAAgB,QAAW;AAC3B,iCAAU,aAAa,aAAa,aAAa;IACrD;AACA,QAAI,gBAAgB,QAAW;AAC3B,iCAAU,aAAa,aAAa,aAAa;IACrD;AAEA,WAAO,KAAK,cAAc,gBAAgB,EAAE,YAAY,aAAa,YAAW,CAAE;EACtF;;;;;;;;EASA,6BAA6B,KAA4C;AACrE,WAAO,KAAK,uBAAuB,kBAAkB,GAAG,KAAK;EACjE;;;;;;EAOA,2BAAwB;AACpB,SAAK,uBAAuB,aAAY;EAC5C;;;;;;;;;;EAWA,MAAM,qBACF,MACA,MAAkC;AAElC,+BAAU,aAAa,MAAM,MAAM;AACnC,+BAAU,aAAa,MAAM,MAAM;AACnC,WAAO,KAAK,WAAW,qBAAqB,MAAM,IAAI;EAC1D;;;;;;;;;EAUA,MAAM,kBACF,MACA,MAA4C;AAE5C,+BAAU,aAAa,MAAM,MAAM;AACnC,QAAI,SAAS,QAAW;AACpB,iCAAU,aAAa,MAAM,MAAM;IACvC;AACA,WAAO,KAAK,WAAW,kBAAkB,MAAM,IAAI;EACvD;;;;;;EAOA,MAAM,qBAAkB;AACpB,WAAO,KAAK,WAAW,mBAAkB;EAC7C;;;;;;;;;EAUA,MAAM,iBACF,MACA,MAA4C;AAE5C,+BAAU,aAAa,MAAM,MAAM;AACnC,QAAI,SAAS,QAAW;AACpB,iCAAU,aAAa,MAAM,MAAM;IACvC;AACA,WAAO,KAAK,WAAW,iBAAiB,MAAM,IAAI;EACtD;;;;EAeA,qBAAqB,MAAgC;AACjD,QAAI,SAAS,QAAW;AACpB,iCAAU,aAAa,MAAM,MAAM;AACnC,aAAO,KAAK,WAAW,qBAAqB,IAAI;IACpD;AACA,WAAO,KAAK,WAAW,qBAAoB;EAC/C;;;;;;;EAQA,aAAa,KAAqB;AAC9B,WAAO,KAAK,oBAAoB,gBAAgB,GAAG,KAAK;EAC5D;;;;EAKA,eAAY;AACR,SAAK,oBAAoB,sBAAqB;EAClD;;",
+  "names": []
+}

package/build/cjs/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/cjs/lib/adapter/context.js

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var context_exports = {};
+module.exports = __toCommonJS(context_exports);
+//# sourceMappingURL=context.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../esm/lib/adapter/context.js"],
+  "sourcesContent": ["export {};\n//# sourceMappingURL=context.js.map"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;",
+  "names": []
+}

package/build/cjs/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/cjs/lib/adapter/defaultObjs.js

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -64,6 +65,7 @@ function createDefaults() {
     }
   };
 }
+__name(createDefaults, "createDefaults");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createDefaults

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/lib/adapter/defaultObjs.ts"],
-  "sourcesContent": ["export function createDefaults(): Record<string, Partial<ioBroker.StateCommon>> {\n    return {\n        'level.dimmer': {\n            type: 'number',\n            read: true,\n            write: true,\n            min: 0,\n            max: 100,\n            unit: '%',\n        },\n        'indicator.working': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n        },\n        'indicator.maintenance': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n        },\n        'indicator.maintenance.lowbat': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n            desc: 'Low battery',\n        },\n        'indicator.maintenance.unreach': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n            desc: 'Device unreachable',\n        },\n        switch: {\n            type: 'boolean',\n            read: true,\n            write: true,\n        },\n    } as const;\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;AAAM,SAAU,iBAAc;AAC1B,SAAO;IACH,gBAAgB;MACZ,MAAM;MACN,MAAM;MACN,OAAO;MACP,KAAK;MACL,KAAK;MACL,MAAM;;IAEV,qBAAqB;MACjB,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;;IAEX,yBAAyB;MACrB,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;;IAEX,gCAAgC;MAC5B,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;MACP,MAAM;;IAEV,iCAAiC;MAC7B,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;MACP,MAAM;;IAEV,QAAQ;MACJ,MAAM;MACN,MAAM;MACN,OAAO;;;AAGnB;",
+  "sourcesContent": ["/**\n * Create the default `common` definitions for the well-known state roles (e.g. level.dimmer, indicator.working)\n *\n * @returns a map of state role to its default common properties\n */\nexport function createDefaults(): Record<string, Partial<ioBroker.StateCommon>> {\n    return {\n        'level.dimmer': {\n            type: 'number',\n            read: true,\n            write: true,\n            min: 0,\n            max: 100,\n            unit: '%',\n        },\n        'indicator.working': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n        },\n        'indicator.maintenance': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n        },\n        'indicator.maintenance.lowbat': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n            desc: 'Low battery',\n        },\n        'indicator.maintenance.unreach': {\n            def: false,\n            type: 'boolean',\n            read: true,\n            write: false,\n            desc: 'Device unreachable',\n        },\n        switch: {\n            type: 'boolean',\n            read: true,\n            write: true,\n        },\n    } as const;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;;;;;AAKM,SAAU,iBAAc;AAC1B,SAAO;IACH,gBAAgB;MACZ,MAAM;MACN,MAAM;MACN,OAAO;MACP,KAAK;MACL,KAAK;MACL,MAAM;;IAEV,qBAAqB;MACjB,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;;IAEX,yBAAyB;MACrB,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;;IAEX,gCAAgC;MAC5B,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;MACP,MAAM;;IAEV,iCAAiC;MAC7B,KAAK;MACL,MAAM;MACN,MAAM;MACN,OAAO;MACP,MAAM;;IAEV,QAAQ;MACJ,MAAM;MACN,MAAM;MACN,OAAO;;;AAGnB;AA1CgB;",
   "names": []
 }

package/build/cjs/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