@iobroker/types 7.2.3-alpha.8-20260709-8d8c9c5ed → 7.2.3

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,100 +46,41 @@ 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;
-    /** Low-level connection options passed to the database driver */
-    options: DatabaseConnectionOptions;
-    /** Backup configuration for the database */
+    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;
+        };
+    };
     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;
@@ -149,7 +90,6 @@ 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;
@@ -176,18 +116,14 @@ 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;
@@ -196,16 +132,13 @@ 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: ioBroker.ObjectIDs.User;
+            owner: string;
             /** Full name of the group who owns this file, e.g. "system.group.administrator" */
-            ownerGroup: ioBroker.ObjectIDs.Group;
+            ownerGroup: string;
             /** 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: ioBroker.ObjectIDs.User;
+            owner: string;
             /** Full name of the group who owns this object, e.g. "system.group.administrator" */
-            ownerGroup: ioBroker.ObjectIDs.Group;
+            ownerGroup: string;
             /** Linux-type permissions defining access to this object */
             object: number;
         }
@@ -536,16 +536,6 @@ 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 */
@@ -696,13 +686,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 {@link dataSource} */
+            /** Where the adapter will get its data from. Set this together with @see 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 {@link connectionType} */
+            /** How the adapter will mainly receive its data. Set this together with @see 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;
@@ -734,7 +724,7 @@ declare global {
             keywords?: string[];
             /** A dictionary of links to web services this adapter provides */
             localLinks?: Record<string, string | LocalLink>;
-            /** @deprecated Use {@link localLinks} */
+            /** @deprecated Use @see localLinks */
             localLink?: string;
             /** Default log level for this adapter. It can be changed for every instance separately */
             loglevel?: LogLevel;
@@ -745,9 +735,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+ */
-            /** @deprecated Use adminUI with config = "materialize". But better use jsonConfig.json */
+            /** @deprectaed Use adminUI with config = "materialize". But better use jsonConfig.json */
             materialize: boolean;
-            /** @deprecated Use {@link supportedMessages} up from controller v5 */
+            /** @deprecated Use @see 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;
@@ -804,11 +794,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 {@link supportedMessages} up from controller v5 */
+            /** @deprecated Use @see 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 {@link titleLang} instead. */
+            /** @deprecated The name of this adapter to be shown in the admin UI. Use @see titleLang instead. */
             title?: string;
             /** The type of this adapter */
             type?:
@@ -852,7 +842,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 {@link native.webInstance} to configure which instances this affects */
+            /** 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 */
             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>;
@@ -1004,7 +994,7 @@ declare global {
             acl?: ObjectACL;
             from?: string;
             /** The user who created or updated this object */
-            user?: ioBroker.ObjectIDs.User;
+            user?: string;
             ts?: number;
             /** These properties can only be edited if the correct password is provided */
             nonEdit?: NonEditable;
@@ -1098,25 +1088,7 @@ 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;
         }
@@ -1448,11 +1420,12 @@ 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

package/build/shared.d.ts

@@ -120,13 +120,7 @@ declare global {
             state?: string;
         }
 
-        type Session = {
-            cookie?: {
-                originalMaxAge?: number;
-                maxAge?: number;
-            };
-            [key: string]: any;
-        };
+        type Session = any; // TODO: implement
 
         /** Defines access rights for a single object type */
         interface ObjectOperationPermissions {
@@ -156,9 +150,9 @@ declare global {
         /** Defined the complete set of access rights a user has */
         interface PermissionSet extends ObjectPermissions {
             /** The name of the user this ACL is for */
-            user: ioBroker.ObjectIDs.User;
+            user: string;
             /** The name of the groups this ACL was merged from */
-            groups: ioBroker.ObjectIDs.Group[];
+            groups: string[];
             /** The access rights for certain commands */
             other: {
                 execute: boolean;
@@ -236,7 +230,7 @@ declare global {
         }
 
         /** Parameters for adapter.getObjectList */
-        type GetObjectListParams = GetObjectViewParams | undefined;
+        type GetObjectListParams = GetObjectViewParams;
 
         type LogLevel = 'silly' | 'debug' | 'info' | 'warn' | 'error';
         interface Logger {
@@ -377,13 +371,14 @@ declare global {
             /** when using aggregate method `integral` defines the interpolation method (defaults to `none`). */
             integralInterpolation?: 'none' | 'linear';
             /** If user is set, it will be checked if this user may read the variable */
-            user?: ioBroker.ObjectIDs.User;
+            user?: `system.user.${string}`;
         }
 
         interface DelObjectOptions {
             /** Whether all child objects should be deleted as well */
             recursive?: boolean;
-            user?: ioBroker.ObjectIDs.User;
+            // Allow non-documented properties
+            [other: string]: unknown;
         }
 
         interface ExtendObjectOptionsPreserve {
@@ -393,9 +388,8 @@ declare global {
         interface ExtendObjectOptions {
             /** Which properties of the original object should be preserved */
             preserve?: ExtendObjectOptionsPreserve;
-            user?: ioBroker.ObjectIDs.User;
-            owner?: ioBroker.ObjectIDs.User;
-            ownerGroup?: ioBroker.ObjectIDs.Group;
+            // Allow non-documented properties
+            [other: string]: unknown;
         }
 
         /** Predefined notification scopes and their categories */
@@ -448,7 +442,7 @@ declare global {
         type GenericCallback<T> = (err?: Error | null, result?: T) => void;
 
         /** Due to backward compatibility first param can be result or error */
-        type MessageCallback = (response?: MessagePayload) => void;
+        type MessageCallback = (response?: Message | Error) => void;
 
         type SetObjectCallback = (err?: Error | null, obj?: { id: string }) => void;
         type SetObjectPromise = Promise<NonNullCallbackReturnTypeOf<SetObjectCallback>>;
@@ -468,7 +462,7 @@ declare global {
         ) => void;
         type GetEnumsPromise = Promise<NonNullCallbackReturnTypeOf<GetEnumsCallback>>;
 
-        type GetObjectsCallback = (err?: Error | null, objects?: Record<string, ioBroker.AnyObject | null>) => void;
+        type GetObjectsCallback = (err?: Error | null, objects?: Record<string, ioBroker.Object>) => void;
         type GetObjectsPromise = Promise<NonNullCallbackReturnTypeOf<GetObjectsCallback>>;
 
         type GetObjectsCallbackTyped<T extends ObjectType> = (
@@ -522,7 +516,7 @@ declare global {
 
         type GetHistoryResult = Array<State & { id?: string }>;
         type GetHistoryCallback = (
-            err: Error | null | undefined,
+            err: Error | null,
             result?: GetHistoryResult,
             step?: number,
             sessionId?: number,
@@ -533,9 +527,7 @@ declare global {
             /** Name of the file or directory */
             file: string;
             /** File system stats */
-            stats?: {
-                size?: number;
-            };
+            stats: Partial<fs.Stats>;
             /** Whether this is a directory or a file */
             isDir: boolean;
             /** Access rights */
@@ -548,12 +540,8 @@ declare global {
         type ReadDirCallback = (err?: NodeJS.ErrnoException | null, entries?: ReadDirResult[]) => void;
         type ReadDirPromise = Promise<ReadDirResult[]>;
 
-        type ReadFileCallback = (
-            err?: NodeJS.ErrnoException | null,
-            data?: Buffer | string | null,
-            mimeType?: string,
-        ) => void;
-        type ReadFilePromise = Promise<{ file: string | Buffer | null; mimeType?: string }>;
+        type ReadFileCallback = (err?: NodeJS.ErrnoException | null, data?: Buffer | string, mimeType?: string) => void;
+        type ReadFilePromise = Promise<{ file: string | Buffer; mimeType?: string }>;
 
         /** Contains the return values of chownFile */
         interface ChownFileResult {
@@ -562,17 +550,15 @@ declare global {
             /** Name of the file or directory */
             file: string;
             /** File system stats */
-            stats?: {
-                size?: number;
-            };
+            stats: fs.Stats;
             /** Whether this is a directory or a file */
             isDir: boolean;
             /** Access rights */
-            acl: EvaluatedFileACL;
+            acl: FileACL;
             /** Date of last modification */
-            modifiedAt?: number;
+            modifiedAt: number;
             /** Date of creation */
-            createdAt?: number;
+            createdAt: number;
         }
         type ChownFileCallback = (err?: NodeJS.ErrnoException | null, processed?: ChownFileResult[]) => void;
 
@@ -604,7 +590,7 @@ declare global {
         interface GetObjectListItem<T extends ioBroker.Object> extends GetObjectViewItem<T> {
             /** A copy of the object */
             value: T;
-            /** The same as {@link value} */
+            /** The same as @link{value} */
             doc: T;
         }
         type GetObjectListCallback<T extends ioBroker.Object> = (
@@ -619,7 +605,7 @@ declare global {
             id?: string,
         ) => void;
 
-        type GetSessionCallback = (session: Session | null) => void;
+        type GetSessionCallback = (session: Session) => void;
 
         type Timeout = Branded<number, 'Timeout'> | null; // or null to not allow native clearTimeout
         type Interval = Branded<number, 'Interval'> | null; // or null to not allow native clearInterval