@iobroker/types 5.0.18 → 5.0.20-alpha.0-20240131-ea40ee4f

package/build/objects.d.ts

@@ -1,4 +1,4 @@
-import * as os from 'os';
+import type * as os from 'os';
 
 declare global {
     namespace ioBroker {
@@ -85,8 +85,12 @@ declare global {
             type User = `system.user.${string}`;
             // Guaranteed host objects
             type Host = `system.host.${string}`;
+            // Guaranteed repository object
+            type Repository = 'system.repositories';
             // Guaranteed config objects
-            type Config = `system.${'certificates' | 'config' | 'repositories'}`;
+            type Config = 'system.certificates';
+            // Guaranteed system config objects
+            type SystemConfig = 'system.config';
             // Guaranteed design objects
             type Design = `_design/${string}`;
 
@@ -115,35 +119,39 @@ declare global {
             T extends ObjectIDs.State
                 ? StateObject
                 : // Instance and Adapter must come before meta or `system.adapter.admin` will resolve to MetaObject
-                  T extends ObjectIDs.Instance
-                  ? InstanceObject
-                  : T extends ObjectIDs.Adapter
-                    ? AdapterObject
-                    : T extends ObjectIDs.Channel
-                      ? ChannelObject
-                      : T extends ObjectIDs.Meta
-                        ? MetaObject
-                        : T extends ObjectIDs.Misc
-                          ? AdapterScopedObject
-                          : T extends ObjectIDs.ScriptOrChannel
-                            ? ScriptObject | ChannelObject
-                            : T extends ObjectIDs.Enum
-                              ? EnumObject
-                              : T extends ObjectIDs.Group
-                                ? GroupObject
-                                : T extends ObjectIDs.User
-                                  ? UserObject
-                                  : T extends ObjectIDs.Host
-                                    ? HostObject
-                                    : T extends ObjectIDs.Design
-                                      ? DesignObject
-                                      : T extends ObjectIDs.Config
-                                        ? OtherObject & { type: 'config' }
-                                        : T extends ObjectIDs.AdapterScoped
-                                          ? AdapterScopedObject
-                                          : Read extends 'read'
-                                            ? ioBroker.Object
-                                            : AnyObject;
+                T extends ObjectIDs.Instance
+                ? InstanceObject
+                : T extends ObjectIDs.Adapter
+                ? AdapterObject
+                : T extends ObjectIDs.Channel
+                ? ChannelObject
+                : T extends ObjectIDs.Meta
+                ? MetaObject
+                : T extends ObjectIDs.Misc
+                ? AdapterScopedObject
+                : T extends ObjectIDs.ScriptOrChannel
+                ? ScriptObject | ChannelObject
+                : T extends ObjectIDs.Enum
+                ? EnumObject
+                : T extends ObjectIDs.Group
+                ? GroupObject
+                : T extends ObjectIDs.User
+                ? UserObject
+                : T extends ObjectIDs.Host
+                ? HostObject
+                : T extends ObjectIDs.Design
+                ? DesignObject
+                : T extends ObjectIDs.Repository
+                ? RepositoryObject
+                : T extends ObjectIDs.SystemConfig
+                ? SystemConfigObject
+                : T extends ObjectIDs.Config
+                ? OtherObject & { type: 'config' }
+                : T extends ObjectIDs.AdapterScoped
+                ? AdapterScopedObject
+                : Read extends 'read'
+                ? ioBroker.Object
+                : AnyObject;
 
         type Languages = 'en' | 'de' | 'ru' | 'pt' | 'nl' | 'fr' | 'it' | 'es' | 'pl' | 'uk' | 'zh-cn';
         type Translated = { en: string } & { [lang in Languages]?: string };
@@ -157,6 +165,9 @@ declare global {
             /** The name of this object as a simple string or an object with translations */
             name: StringOrTranslated;
 
+            /** Description of this object */
+            desc?: StringOrTranslated;
+
             /** When set to true, this object may not be deleted */
             dontDelete?: true;
 
@@ -182,8 +193,6 @@ declare global {
             step?: number;
             /** unit of the value */
             unit?: string;
-            /** description of this state */
-            desc?: StringOrTranslated;
 
             /** if this state is readable */
             read: boolean;
@@ -264,9 +273,6 @@ declare global {
                   });
         }
         interface ChannelCommon extends ObjectCommon {
-            /** description of this channel */
-            desc?: string;
-
             // Make it possible to narrow the object type using the custom property
             custom?: undefined;
         }
@@ -288,6 +294,10 @@ declare global {
             custom?: undefined;
         }
 
+        interface RepositoryCommon extends ObjectCommon {
+            custom?: undefined;
+        }
+
         interface ChartCommon extends ObjectCommon {
             enabled?: boolean;
             color?: string;
@@ -529,6 +539,8 @@ declare global {
                 singleton?: boolean;
             };
             allowInit?: boolean;
+            /** If the adapter should be automatically upgraded and which version ranges are supported */
+            automaticUpgrade?: AutoUpgradePolicy;
             /** Possible values for the instance mode (if more than one is possible) */
             availableModes?: InstanceMode[];
             /** Array which lists all blocked versions. Blocked versions will not be started. Use semver notation to specify the version ranges. The information is always used from the io-package.json in the GitHub repository. */
@@ -668,6 +680,49 @@ declare global {
             custom?: undefined;
         }
 
+        interface SystemConfigCommon extends ObjectCommon {
+            /** Name of all active repositories */
+            activeRepo: string[];
+            /** Current configured language */
+            language: Languages;
+            /** If floating comma is used instead of dot */
+            isFloatComma: boolean;
+            /** Configured longitude */
+            longitude: string;
+            /** Configured latitude */
+            latitude: string;
+            /** Default history instance */
+            defaultHistory: string;
+            /** Which diag data is allowed to be sent */
+            diag: 'none' | 'extended' | 'no-city';
+            /** If license has already been confirmed */
+            licenseConfirmed: boolean;
+            /** System wide default log level */
+            defaultLogLevel?: LogLevel;
+            /** Used date format for formatting */
+            dateFormat: string;
+            /** Default acl for new objects */
+            defaultNewAcl: {
+                object: number;
+                state: number;
+                file: number;
+                owner: ObjectIDs.User;
+                ownerGroup: ObjectIDs.Group;
+            };
+            /** Configured auto upgrade policy */
+            adapterAutoUpgrade?: {
+                /** Configuration for each repository */
+                repositories: {
+                    [repoName: string]: boolean;
+                };
+                /** Default policy, if none has been set explicit for the adapter */
+                defaultPolicy: AutoUpgradePolicy;
+            };
+
+            // Make it possible to narrow the object type using the custom property
+            custom?: undefined;
+        }
+
         interface OtherCommon extends ObjectCommon {
             [propName: string]: any;
 
@@ -780,6 +835,54 @@ declare global {
             common?: Partial<ScheduleCommon>;
         }
 
+        interface PartialRepositoryObject extends Partial<Omit<RepositoryObject, 'common'>> {
+            common?: Partial<RepositoryCommon>;
+        }
+
+        interface RepositoryJsonAdapterContent {
+            /** Adapter name */
+            name: string;
+            /** Newest available version */
+            version: string;
+            /** Other Adapter related properties, not important for this implementation */
+            [other: string]: unknown;
+        }
+
+        interface RepositoryJson {
+            _repoInfo: {
+                /** If it is the official stable repository */
+                stable?: boolean;
+                /** i18n name of the repository */
+                name: Required<ioBroker.Translated>;
+                /** Time of repository update */
+                repoTime: string;
+            };
+            /** Information about each adapter - Record needed for _repoInfo */
+            [adapter: string]: RepositoryJsonAdapterContent | Record<string, any>;
+        }
+
+        interface RepositoryInformation {
+            /** Url to the repository */
+            link: string;
+            json: RepositoryJson | null;
+            hash?: string;
+            time?: string;
+        }
+
+        interface RepositoryObject extends BaseObject {
+            _id: ObjectIDs.Repository;
+            type: 'config';
+            native: {
+                repositories: {
+                    [repoName: string]: RepositoryInformation;
+                };
+                oldRepositories?: {
+                    [repoName: string]: RepositoryInformation;
+                };
+            };
+            common: RepositoryCommon;
+        }
+
         interface InstanceObject extends BaseObject {
             _id: ObjectIDs.Instance;
             type: 'instance';
@@ -865,6 +968,15 @@ declare global {
             common?: Partial<ScriptCommon>;
         }
 
+        interface SystemConfigObject extends BaseObject {
+            type: 'config';
+            common: SystemConfigCommon;
+        }
+
+        interface PartialSystemConfigObject extends Partial<Omit<SystemConfigObject, 'common'>> {
+            common?: Partial<SystemConfigCommon>;
+        }
+
         interface OtherObject extends BaseObject {
             type: 'config' | 'chart';
             common: OtherCommon;
@@ -902,6 +1014,7 @@ declare global {
             | ScriptObject
             | ChartObject
             | ScheduleObject
+            | RepositoryObject
             | OtherObject
             | DesignObject;
 
@@ -920,6 +1033,8 @@ declare global {
             | PartialScriptObject
             | PartialChartObject
             | PartialScheduleObject
+            | PartialRepositoryObject
+            | PartialSystemConfigObject
             | PartialOtherObject
             | PartialDesignObject;
 
@@ -962,6 +1077,8 @@ declare global {
         type SettableScheduleObject = SettableObject<ScheduleObject>;
         type SettableChartObject = SettableObject<ChartObject>;
         type SettableDesignObject = SettableObject<DesignObject>;
+        type SettableRepositoryObject = SettableObject<RepositoryObject>;
+        type SettableSystemConfigObject = SettableObject<SystemConfigObject>;
         type SettableOtherObject = SettableObject<OtherObject>;
 
         // Used to infer the return type of GetObjectView
@@ -969,36 +1086,36 @@ declare global {
             ? View extends 'host'
                 ? HostObject
                 : View extends 'adapter'
-                  ? AdapterObject
-                  : View extends 'instance'
-                    ? InstanceObject
-                    : View extends 'meta'
-                      ? MetaObject
-                      : View extends 'device'
-                        ? DeviceObject
-                        : View extends 'channel'
-                          ? ChannelObject
-                          : View extends 'state'
-                            ? StateObject
-                            : View extends 'folder'
-                              ? FolderObject
-                              : View extends 'enum'
-                                ? EnumObject
-                                : View extends 'script'
-                                  ? ScriptObject
-                                  : View extends 'group'
-                                    ? GroupObject
-                                    : View extends 'user'
-                                      ? UserObject
-                                      : View extends 'chart'
-                                        ? ChartObject
-                                        : View extends 'schedule'
-                                          ? ScheduleObject
-                                          : View extends 'config'
-                                            ? OtherObject & { type: 'config' }
-                                            : View extends 'custom'
-                                              ? NonNullable<StateObject['common']['custom']>
-                                              : ioBroker.Object
+                ? AdapterObject
+                : View extends 'instance'
+                ? InstanceObject
+                : View extends 'meta'
+                ? MetaObject
+                : View extends 'device'
+                ? DeviceObject
+                : View extends 'channel'
+                ? ChannelObject
+                : View extends 'state'
+                ? StateObject
+                : View extends 'folder'
+                ? FolderObject
+                : View extends 'enum'
+                ? EnumObject
+                : View extends 'script'
+                ? ScriptObject
+                : View extends 'group'
+                ? GroupObject
+                : View extends 'user'
+                ? UserObject
+                : View extends 'chart'
+                ? ChartObject
+                : View extends 'schedule'
+                ? ScheduleObject
+                : View extends 'config'
+                ? RepositoryObject | SystemConfigObject | (OtherObject & { type: 'config' })
+                : View extends 'custom'
+                ? NonNullable<StateObject['common']['custom']>
+                : ioBroker.Object
             : any;
     }
 }

package/build/shared.d.ts

@@ -1,6 +1,6 @@
 // Types which are safe to share within this repository AND publicly
 
-import * as fs from 'fs';
+import type * as fs from 'fs';
 import './objects';
 import type { IoBJson, DatabaseOptions, ObjectsDatabaseOptions as ObjectsDbOptions } from './config';
 

package/build/types.d.ts

@@ -22,7 +22,10 @@ export declare interface AdapterClass {
     /** Only emitted for compact instances */
     on(event: 'exit', listener: (exitCode: number, reason: string) => Promise<void> | void): this;
     on(event: 'log', listener: (info: any) => Promise<void> | void): this;
-    /** Extend an object and create it if it might not exist */
+    /**
+     * Extend an object and create it if it might not exist
+     * @deprecated use `adapter.extendObject` without callback instead
+     */
     extendObjectAsync(id: string, objPart: ioBroker.PartialObject, options?: ioBroker.ExtendObjectOptions): ioBroker.SetObjectPromise;
     /** Set capabilities of the given executable. Only works on Linux systems. */
     setExecutableCapabilities(execPath: string, capabilities: string[], modeEffective?: boolean, modePermitted?: boolean, modeInherited?: boolean): Promise<void>;
@@ -102,7 +105,7 @@ export declare interface AdapterClass {
     /** Read all states of this adapter which match the given pattern */
     getStatesAsync(pattern: string, options?: unknown): ioBroker.GetStatesPromise;
     /** Read all states (which might not belong to this adapter) which match the given pattern */
-    getForeignStatesAsync(pattern: string, options?: unknown): ioBroker.GetStatesPromise;
+    getForeignStatesAsync(pattern: Pattern, options?: unknown): ioBroker.GetStatesPromise;
     /** Subscribe to changes of states (which might not belong to this adapter) */
     subscribeForeignStatesAsync(pattern: string | string[], options?: unknown): Promise<void>;
     /** Subscribe from changes of states (which might not belong to this adapter) */
@@ -199,9 +202,12 @@ export declare interface AdapterClass {
     delFile(adapterName: string | null, path: string, options: unknown, callback: ioBroker.ErrnoCallback): void;
     /**
      * Writes a value into the states DB.
+     * @deprecated use `adapter.setState` without callback instead
      */
     setStateAsync(id: string, state: ioBroker.State | ioBroker.StateValue | ioBroker.SettableState, ack?: boolean): ioBroker.SetStatePromise;
+    /** @deprecated use `adapter.setState` without callback instead */
     setStateAsync(id: string, state: ioBroker.State | ioBroker.StateValue | ioBroker.SettableState, options?: unknown): ioBroker.SetStatePromise;
+    /** @deprecated use `adapter.setState` without callback instead */
     setStateAsync(id: string, state: ioBroker.State | ioBroker.StateValue | ioBroker.SettableState, ack: boolean, options: unknown): ioBroker.SetStatePromise;
     /**
      * Writes a value (which might not belong to this adapter) into the states DB.
@@ -372,9 +378,9 @@ export declare class AdapterClass extends EventEmitter {
     /** configured language of system.config, only available if requested via AdapterOptions `useFormatDate` */
     language?: ioBroker.Languages;
     /** longitude configured in system.config, only available if requested via AdapterOptions `useFormatDate`*/
-    longitude?: number;
+    longitude?: string;
     /** latitude configured in system.config, only available if requested via AdapterOptions `useFormatDate`*/
-    latitude?: number;
+    latitude?: string;
     private _defaultObjs?;
     private _aliasObjectsSubscribed?;
     config: ioBroker.AdapterConfig;
@@ -491,7 +497,9 @@ export declare class AdapterClass extends EventEmitter {
     private _setObjectWithDefaultValue;
     getAdapterObjects(callback: (objects: Record<string, ioBroker.AdapterScopedObject>) => void): Promise<Record<string, ioBroker.AdapterScopedObject> | void>;
     private _getAdapterObjects;
+    extendObject(id: string, objPart: ioBroker.PartialObject): ioBroker.SetObjectPromise;
     extendObject(id: string, objPart: ioBroker.PartialObject, callback?: ioBroker.SetObjectCallback): void;
+    extendObject(id: string, objPart: ioBroker.PartialObject, options: ioBroker.ExtendObjectOptions): ioBroker.SetObjectPromise;
     extendObject(id: string, objPart: ioBroker.PartialObject, options: ioBroker.ExtendObjectOptions, callback?: ioBroker.SetObjectCallback): void;
     private _extendObject;
     setForeignObject<T extends string>(id: T, obj: ioBroker.SettableObject<ioBroker.ObjectIdToObjectType<T, 'write'>>, callback?: ioBroker.SetObjectCallback): void;

package/package.json

@@ -1,45 +1,45 @@
 {
-    "name": "@iobroker/types",
-    "version": "5.0.18",
-    "engines": {
-        "node": ">=12.0.0"
-    },
-    "keywords": [
-        "ioBroker"
-    ],
-    "author": "foxriver76 <moritz.heusinger@gmail.com>",
-    "contributors": [
-        "foxriver76 <moritz.heusinger@gmail.com>"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/ioBroker/ioBroker.js-controller/packages/types"
-    },
-    "devDependencies": {
-        "tsd": "^0.24.1"
-    },
-    "scripts": {
-        "build": "ts-node build.ts",
-        "test": "tsd"
-    },
-    "main": "index.js",
-    "types": "index.d.ts",
-    "license": "MIT",
-    "publishConfig": {
-        "access": "public"
-    },
-    "files": [
-        "build/",
-        "index.d.ts",
-        "public.d.ts",
-        "LICENSE"
-    ],
-    "tsd": {
-        "compilerOptions": {
-            "types": [
-                "@iobroker/types"
-            ]
-        }
-    },
-    "gitHead": "4609455d62438f63207b5ad869e54ea8b1325c0c"
+  "name": "@iobroker/types",
+  "version": "5.0.20-alpha.0-20240131-ea40ee4f",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "keywords": [
+    "ioBroker"
+  ],
+  "author": "foxriver76 <moritz.heusinger@gmail.com>",
+  "contributors": [
+    "foxriver76 <moritz.heusinger@gmail.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ioBroker/ioBroker.js-controller/packages/types"
+  },
+  "devDependencies": {
+    "tsd": "^0.24.1"
+  },
+  "scripts": {
+    "build": "ts-node build.ts",
+    "test": "tsd"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/",
+    "index.d.ts",
+    "public.d.ts",
+    "LICENSE"
+  ],
+  "tsd": {
+    "compilerOptions": {
+      "types": [
+        "@iobroker/types"
+      ]
+    }
+  },
+  "gitHead": "e95a41bedc1520053271e31a35d5272df6415e6e"
 }

package/public.d.ts

@@ -1,6 +1,6 @@
 // Types which are only safe to share publicly
 
-import { AdapterClass, AdapterOptions as _AdapterOptions } from './build/types';
+import type { AdapterClass, AdapterOptions as _AdapterOptions } from './build/types';
 
 declare global {
     namespace ioBroker {