@iobroker/types 7.2.5 → 8.0.0-alpha.11-20261103-58da667b3

package/build/config.d.ts

@@ -6,7 +6,7 @@ interface DatabaseBackupOptions {
     /** All backups older than configured hours will be deleted. But only if the number of files is greater than of backupNumber */
     hours: number;
     '// hours': string;
-    /** By default backup every 2 hours. Time is in minutes. To disable backup set the value to 0 */
+    /** By default, backup every 2 hours. Time is in minutes. To disable backup set the value to 0 */
     period: number;
     '// period': string;
     /** Absolute path to back-up directory or empty to back-up in data directory */
@@ -46,41 +46,100 @@ interface JsonlOptions {
     };
 }
 
+interface DatabaseConnectionOptions {
+    /** Password used to authenticate against the database */
+    auth_pass: string;
+    /** Maximum delay in milliseconds between reconnection attempts */
+    retry_max_delay?: number;
+    /** Maximum number of reconnection attempts */
+    retry_max_count: number;
+    /** As soon as the tls property is defined, redis will try to connect via tls (currently only for redis) */
+    tls?: {
+        /** Needs to be false with self-signed certs */
+        rejectUnauthorized?: boolean;
+        /** The certificate content */
+        ca?: string;
+        /** The key file content */
+        key?: string;
+        /** The cert file content */
+        cert?: string;
+    };
+
+    // Redis options
+    port?: number | number[];
+    host?: string | string[];
+    /**
+     * 4 (IPv4) or 6 (IPv6), Defaults to 4.
+     */
+    family?: number;
+    /**
+     * Local domain socket path. If set the port, host and family will be ignored.
+     */
+    path?: string;
+    connectionName?: string;
+    /**
+     * If set, client will send AUTH command with the value of this option when connected.
+     */
+    password?: string;
+    /**
+     * Database index to use.
+     */
+    db?: number;
+    /**
+     * When a connection is established to the Redis server, the server might still be loading
+     * the database from disk. While loading, the server not respond to any commands.
+     * To work around this, when this option is true, ioredis will check the status of the Redis server,
+     * and when the Redis server is able to process commands, a ready event will be emitted.
+     */
+    enableReadyCheck?: boolean;
+    /**
+     * When the return value isn't a number, ioredis will stop trying to reconnect.
+     * Fixed in: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/15858
+     */
+    retryStrategy?(times: number): number | Error;
+    /**
+     * After reconnected, if the previous connection was in the subscriber mode, client will auto re-subscribe these channels.
+     * default: true.
+     */
+    autoResubscribe?: boolean;
+    /**
+     * default: null.
+     */
+    name?: string;
+    sentinels?: Array<{ host: string; port: number }>;
+}
+
+/** Configuration of a database connection (objects or states) */
 export interface DatabaseOptions {
     /** Possible values: 'file' - [port 9001], 'jsonl' - [port 9001], 'redis' - [port 6379 or 26379 for sentinel]. */
     type: 'jsonl' | 'file' | 'redis';
+    /** Name of the sentinel master to connect to */
     sentinelName?: string;
+    /** Host name(s) or IP address(es) of the database server */
     host: string | string[];
+    /** Port(s) of the database server */
     port: number | number[];
+    /** Maximum time in milliseconds to wait for a connection to be established */
     connectTimeout: number;
+    /** Interval in milliseconds between flushing the in-memory database to file */
     writeFileInterval: number;
+    /** Directory where the database files are stored, relative to the controller dir */
     dataDir?: string;
-    options: {
-        auth_pass: string;
-        retry_max_delay: number;
-        retry_max_count: number;
-        db: number;
-        family: number;
-        /** As soon as the tls property is defined, redis will try to connect via tls (currently only for redis) */
-        tls?: {
-            /** Needs to be false with self-signed certs */
-            rejectUnauthorized?: boolean;
-            /** The certificate content */
-            ca?: string;
-            /** The key file content */
-            key?: string;
-            /** The cert file content */
-            cert?: string;
-        };
-    };
+    /** Low-level connection options passed to the database driver */
+    options: DatabaseConnectionOptions;
+    /** Backup configuration for the database */
     backup: DatabaseBackupOptions;
+    /** Options specific to the JSONL database backend */
     jsonlOptions: JsonlOptions;
 }
 
+/** Configuration of the objects database connection */
 export interface ObjectsDatabaseOptions extends DatabaseOptions {
+    /** Disable the in-memory file cache for objects */
     noFileCache: boolean;
 }
 
+/** Configuration of the states database connection */
 export interface StatesDatabaseOptions extends DatabaseOptions {
     /** Limit maximum number of log entries in the list (only read by adapter.ts from the config file) */
     maxQueue: number;
@@ -90,6 +149,7 @@ export interface StatesDatabaseOptions extends DatabaseOptions {
  * The ioBroker global config
  */
 export interface IoBJson {
+    /** System-wide controller settings */
     system: {
         /** Do not use more than memory limit mb by ioB process (0 to deactivate) */
         memoryLimitMB: number;
@@ -116,14 +176,18 @@ export interface IoBJson {
         memLimitError: number;
         '// memLimitError': string;
     };
+    /** Configuration of the multihost service used to connect several ioBroker hosts */
     multihostService: {
         enabled: boolean;
         secure: boolean;
         password: string;
         persist: boolean;
     };
+    /** Configuration of the objects database */
     objects: ObjectsDatabaseOptions;
+    /** Configuration of the states database */
     states: StatesDatabaseOptions;
+    /** Logging configuration */
     log: {
         level: ioBroker.LogLevel;
         maxDays: number;
@@ -132,13 +196,16 @@ export interface IoBJson {
     };
     /** Always relative to iobroker.js-controller/ */
     dataDir: string;
+    /** Comment/hint shown next to the dataDir setting in the JSON config */
     '// dataDir': string;
+    /** Controller plugins configuration keyed by plugin name */
     plugins: {
         [pluginName: string]: {
             enabled: boolean;
             [other: string]: unknown;
         };
     };
+    /** Comment/hint shown next to the dnsResolution setting in the JSON config */
     '// dnsResolution': string;
     /** Use 'verbatim' for ipv6 first, else use 'ipv4first' */
     dnsResolution: 'verbatim' | 'ipv4first';

package/build/objects.d.ts

@@ -6,9 +6,9 @@ declare global {
         /** Defines access rights for a single file */
         interface FileACL {
             /** Full name of the user who owns this file, e.g. "system.user.admin" */
-            owner: string;
+            owner: ioBroker.ObjectIDs.User;
             /** Full name of the group who owns this file, e.g. "system.group.administrator" */
-            ownerGroup: string;
+            ownerGroup: ioBroker.ObjectIDs.Group;
             /** Linux-type permissions defining access to this file */
             permissions: number;
         }
@@ -24,9 +24,9 @@ declare global {
         /** Defines access rights for a single object */
         interface ObjectACL {
             /** Full name of the user who owns this object, e.g. "system.user.admin" */
-            owner: string;
+            owner: ioBroker.ObjectIDs.User;
             /** Full name of the group who owns this object, e.g. "system.group.administrator" */
-            ownerGroup: string;
+            ownerGroup: ioBroker.ObjectIDs.Group;
             /** Linux-type permissions defining access to this object */
             object: number;
         }
@@ -528,6 +528,12 @@ declare global {
             bundlerType?: 'module';
             /** The vis widget does not support the listed major versions of vis */
             ignoreInVersions?: number[];
+            /**
+             * Background components of the set, exposed by its module federation like the `components`. vis-2 renders each of them once
+             * in the runtime, next to the views and whichever view is shown, with the widgets of the set in all views of the project that
+             * the user may see. For what must not stop with its view, e.g. a phone that has to stay registered to ring.
+             */
+            services?: string[];
         }
 
         /**
@@ -536,6 +542,16 @@ declare global {
         export interface DevicesWidgets {
             /** Link to the file with components relatively to `admin/dm-widgets` in admin or `${adapterName}` in web. Default is customDevices.js */
             url?: string;
+            /**
+             * Link to the file (icons.json) with specific icons in form
+             * ```ts
+             *  type IconDescription = {
+             *   name: ioBroker.Translated,
+             *   icons: [{id: string, label: ioBroker.Translated, category: string, icon: 'data:image/svg+xml;base64,...'}]
+             *  };
+             *  ```
+             */
+            iconsManifest?: string;
             /** Description of the components (widgets). It could be multiple widgets in one adapter */
             components: {
                 /** Name of the class */
@@ -547,6 +563,12 @@ declare global {
                 /** Icon as a link to picture imageName.png relative to the admin folder or base64 */
                 icon: string;
             }[];
+            /**
+             * Background components, exported by the `Components` module of the plugin like the widgets. The devices app renders each of
+             * them once, next to the category and whichever category is shown, with the widgets of this adapter in all categories that the
+             * user may see. For what must not stop with its category, e.g. a phone that has to stay registered to ring.
+             */
+            services?: string[];
         }
 
         interface VisIconSet {
@@ -658,6 +680,12 @@ declare global {
                 link?: string;
                 /** If true, only one instance of this tab will be created for all instances */
                 singleton?: boolean;
+                /**
+                 * Show the tab through the proxy of admin (`/proxy/<instance>/`) instead of opening the own port of the instance directly.
+                 * The target is `native.bind`, `native.port` and `native.secure` of the instance. The tab is then reachable on the
+                 * address of admin, protected by its login, and only for members of `system.group.administrator`.
+                 */
+                proxy?: boolean;
                 /** Position in the admin menu: the built-in tabs use 1 to 120, a tab without order gets 200. 0 counts as not set. Once the user has sorted the menu, the stored order wins */
                 order?: number;
                 /**
@@ -686,13 +714,13 @@ declare global {
             blockedVersions?: string[];
             /** Whether this adapter includes custom blocks for Blockly. If true, `admin/blockly.js` must exist. */
             blockly?: boolean;
-            /** Where the adapter will get its data from. Set this together with @see dataSource */
+            /** Where the adapter will get its data from. Set this together with {@link dataSource} */
             connectionType?: ConnectionType;
             /** If true, this adapter can be started in compact mode (in the same process as other adapters) */
             compact?: boolean;
             /** The directory relative to iobroker-data where the adapter stores the data. Supports the placeholder `%INSTANCE%`. This folder will be backed up and restored automatically. */
             dataFolder?: string;
-            /** How the adapter will mainly receive its data. Set this together with @see connectionType */
+            /** How the adapter will mainly receive its data. Set this together with {@link connectionType} */
             dataSource?: 'poll' | 'push' | 'assumption';
             /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter on the same host. */
             dependencies?: Dependencies;
@@ -724,7 +752,7 @@ declare global {
             keywords?: string[];
             /** A dictionary of links to web services this adapter provides */
             localLinks?: Record<string, string | LocalLink>;
-            /** @deprecated Use @see localLinks */
+            /** @deprecated Use {@link localLinks} */
             localLink?: string;
             /** Default log level for this adapter. It can be changed for every instance separately */
             loglevel?: LogLevel;
@@ -735,9 +763,9 @@ declare global {
             /** Whether the admin tab is written in a materialized style. Required for Admin 3+ */
             materializeTab?: boolean;
             /** Whether the admin configuration dialog is written in a materialized style. Required for Admin 3+ */
-            /** @deprectaed Use adminUI with config = "materialize". But better use jsonConfig.json */
+            /** @deprecated Use adminUI with config = "materialize". But better use jsonConfig.json */
             materialize: boolean;
-            /** @deprecated Use @see supportedMessages up from controller v5 */
+            /** @deprecated Use {@link supportedMessages} up from controller v5 */
             messagebox?: true;
             /** Messages which are supported by the adapter, supportedMessages.custom: true is the equivalent to messagebox: true */
             supportedMessages?: SupportedMessages;
@@ -770,8 +798,13 @@ declare global {
             };
             /** Which OSes this adapter supports */
             os?: 'linux' | 'darwin' | 'win32' | Array<'linux' | 'darwin' | 'win32'>;
-            /** Constant */
-            platform: 'Javascript/Node.js';
+            /**
+             * Language the adapter is written in. `Javascript/Node.js` is the default and covers
+             * every existing adapter. `Python` makes the controller start the adapter from the
+             * virtual environment maintained by the `py-controller` adapter instead of with
+             * Node.js; `common.main` then points at the package's `__main__.py`.
+             */
+            platform: 'Javascript/Node.js' | 'Python';
             /** The keys of common attributes (e.g. `history`) which are not deleted in a `setObject` call even if they are not present. Deletion must be done explicitly by setting them to `null`. */
             preserveSettings?: string | string[];
             /** Url of the ReadMe file */
@@ -794,11 +827,11 @@ declare global {
             subscribable?: boolean;
             /** If `true`, this adapter provides custom per-state settings. Requires a `custom_m.html` file in the `admin` directory. */
             supportCustoms?: boolean;
-            /** @deprecated Use @see supportedMessages up from controller v5 */
+            /** @deprecated Use {@link supportedMessages} up from controller v5 */
             supportStopInstance?: boolean;
             /** The translated names of this adapter to be shown in the admin UI */
             titleLang?: StringOrTranslated;
-            /** @deprecated The name of this adapter to be shown in the admin UI. Use @see titleLang instead. */
+            /** @deprecated The name of this adapter to be shown in the admin UI. Use {@link titleLang} instead. */
             title?: string;
             /** The type of this adapter */
             type?:
@@ -832,6 +865,19 @@ declare global {
                 | 'weather';
             /** If `true`, the `npm` package must be installed with the `--unsafe-perm` flag */
             unsafePerm?: true;
+            /**
+             * If `true`, the adapter declares the exclusive resources it occupies (serial ports, TCP/UDP ports, ...)
+             * itself via `adapter.registerUsedResource(...)`. Set this when the occupied resources are not simply
+             * the configured `native.port`.
+             *
+             * If not set, js-controller maintains the registry for this adapter and derives the entries from the
+             * instance's `native.port` / `native.bind`.
+             *
+             * If `false`, the adapter does not declare any resources and js-controller does not derive any either,
+             * so its instances have no entries in the registry. Use this when `native.port` is not a port the
+             * adapter listens on, e.g. the port of the device it connects to.
+             */
+            declareUsedResources?: boolean;
             /** The available version in the ioBroker repo. */
             version: string;
             /** Definition of the vis-2 widgets */
@@ -842,7 +888,7 @@ declare global {
             webByVersion?: boolean;
             /** Whether the web server in this adapter can be extended with plugin/extensions */
             webExtendable?: boolean;
-            /** Relative path to a module that contains an extension for the web adapter. Use together with @see native.webInstance to configure which instances this affects */
+            /** Relative path to a module that contains an extension for the web adapter. Use together with {@link native.webInstance} to configure which instances this affects */
             webExtension?: string;
             /** List of parameters that must be included in info.js by webServer adapter. (Example material: `"webPreSettings": { "materialBackground": "native.loadingBackground" }`). Web adapter uses this setting to create a customized info.js file to provide some essential settings for the index.html file before the socket connection is established to provide e.g., background color of the loading screen. */
             webPreSettings?: Record<string, any>;
@@ -996,7 +1042,7 @@ declare global {
             acl?: ObjectACL;
             from?: string;
             /** The user who created or updated this object */
-            user?: string;
+            user?: ioBroker.ObjectIDs.User;
             ts?: number;
             /** These properties can only be edited if the correct password is provided */
             nonEdit?: NonEditable;
@@ -1090,7 +1136,25 @@ declare global {
             unsafePerm?: boolean;
             /** If given, the packet name differs from the adapter name, e.g. because it is a scoped package */
             packetName?: string;
-
+            /** Link to package */
+            meta: string;
+            /** List of licenses */
+            licenses?: { type: string; url: string }[];
+            /** Normally by admin is a ISO string with published date */
+            published?: string;
+
+            /** Link to adapter repo */
+            url?: string;
+            /** Adapter icon */
+            icon?: string;
+            /** Internally used flag */
+            processed?: boolean;
+            /** History */
+            news: { [version: string]: ioBroker.Translated };
+            /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter on the same host. */
+            dependencies: Dependencies;
+            /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter in the whole system. */
+            globalDependencies: Dependencies;
             /** Other Adapter related properties, not important for this implementation */
             [other: string]: unknown;
         }
@@ -1422,12 +1486,11 @@ declare global {
                                         : View extends 'schedule'
                                           ? ScheduleObject
                                           : View extends 'config'
-                                            ?
-                                                  | RepositoryObject
-                                                  | SystemConfigObject
-                                                  | (OtherObject & {
-                                                        type: 'config';
-                                                    })
+                                            ? | RepositoryObject
+                                              | SystemConfigObject
+                                              | (OtherObject & {
+                                                    type: 'config';
+                                                })
                                             : View extends 'custom'
                                               ? NonNullable<StateObject['common']['custom']>
                                               : ioBroker.Object