@iobroker/adapter-react-v5 4.12.2 → 4.13.0

package/LegacyConnection.d.ts

@@ -1,196 +1,244 @@
-/** Converts ioB pattern into regex
- * @param {string} pattern
- * @returns {string}
- */
-export function pattern2RegEx(pattern: string): string;
-export namespace PROGRESS {
-    let CONNECTING: number;
-    let CONNECTED: number;
-    let OBJECTS_LOADED: number;
-    let READY: number;
+/// <reference types="node" />
+import { type HostInfo } from '@iobroker/js-controller-common/tools';
+import { type FilteredNotificationInformation } from '@iobroker/js-controller-common-db/build/lib/common/notificationHandler';
+/**
+ * Copyright 2020-2024, Denis Haev (bluefox) <dogafox@gmail.com>
+ *
+ * MIT License
+ *
+ **/
+declare global {
+    interface Window {
+        adapterName: undefined | string;
+        socketUrl: undefined | string;
+        registerSocketOnLoad: (func: () => void) => void;
+        vendorPrefix: undefined | string;
+        io: any;
+    }
 }
-export namespace ERRORS {
-    export { PERMISSION_ERROR };
-    export { NOT_CONNECTED };
+/** Possible progress states. */
+export declare const PROGRESS: {
+    /** The socket is connecting. */
+    CONNECTING: number;
+    /** The socket is successfully connected. */
+    CONNECTED: number;
+    /** All objects are loaded. */
+    OBJECTS_LOADED: number;
+    /** The socket is ready for use. */
+    READY: number;
+};
+export declare const ERRORS: {
+    PERMISSION_ERROR: string;
+    NOT_CONNECTED: string;
+};
+export type BinaryStateChangeHandler = (id: string, base64: string | null) => void;
+/** Converts ioB pattern into regex */
+export declare function pattern2RegEx(pattern: string): string;
+interface ConnectionProps {
+    /** The socket name. */
+    name?: string;
+    /** State IDs to always automatically subscribe to. */
+    autoSubscribes?: string[];
+    /** Automatically subscribe to logging. */
+    autoSubscribeLog?: boolean;
+    /** The protocol to use for the socket.io connection. */
+    protocol: string;
+    /** The host name to use for the socket.io connection. */
+    host: string;
+    /** The port to use for the socket.io connection. */
+    port?: string | number;
+    /** The socket.io connection timeout. */
+    ioTimeout?: number;
+    /** The socket.io command timeout. */
+    cmdTimeout?: number;
+    /** Flag to indicate if all objects should be loaded or not. Default true (not loaded) */
+    doNotLoadAllObjects?: boolean;
+    /** Flag to indicate if AccessControlList for current user will be loaded or not. Default true (not loaded) */
+    doNotLoadACL?: boolean;
+    /** Progress callback. */
+    onProgress?: (progress: number) => void;
+    /** Ready callback. */
+    onReady?: (objects: Record<string, ioBroker.Object>) => void;
+    /** Log callback. */
+    onLog?: (text: string) => void;
+    /** Error callback. */
+    onError?: (error: any) => void;
+    /** Object change callback. */
+    onObjectChange?: ioBroker.ObjectChangeHandler;
+    /** Gets called when the system language is determined */
+    onLanguage?: (lang: ioBroker.Languages) => void;
+    /** Forces the use of the Compact Methods, wich only exists in admin 5 UI. */
+    admin5only?: boolean;
+    /** The device UUID with which the communication must be established */
+    uuid?: string;
+    /** Authentication token (used only in cloud) */
+    token?: string;
+}
+export interface ConnectOptions {
+    path?: string;
+    query?: string;
+    name?: string;
+    timeout?: number;
+    uuid?: string;
+}
+export interface SocketClient {
+    connect(url?: string, options?: ConnectOptions): void;
+    close(): void;
+    destroy(): void;
+    readonly connected: boolean;
+    on(event: string, callback: (...args: any) => void): void;
+    off(event: string, callback: (...args: any) => void): void;
+    emit(event: string, ...args: any): boolean;
 }
-export default Connection;
-declare const PERMISSION_ERROR: "permissionError";
-declare const NOT_CONNECTED: "notConnectedError";
 declare class Connection {
+    private _socket;
+    private _authTimer;
+    private systemLang;
+    private readonly _waitForFirstConnection;
+    private _waitForFirstConnectionResolve;
+    private _promises;
+    private readonly _instanceSubscriptions;
+    private props;
+    private doNotLoadAllObjects;
+    private readonly doNotLoadACL;
+    private states;
+    private objects;
+    private scriptLoadCounter;
+    private acl;
+    private firstConnect;
+    private readonly waitForRestart;
+    private connected;
+    private readonly statesSubscribes;
+    private readonly objectsSubscribes;
+    private readonly filesSubscribes;
+    private onConnectionHandlers;
+    private onLogHandlers;
+    private readonly onProgress;
+    private readonly onError;
+    private loaded;
+    private loadTimer;
+    private loadCounter;
+    private admin5only;
+    private ignoreState;
+    private readonly simStates;
+    private autoSubscribes;
+    private readonly autoSubscribeLog;
+    private subscribed;
+    isSecure: boolean | undefined;
+    private onCmdStdoutHandler;
+    private onCmdStderrHandler;
+    private onCmdExitHandler;
+    systemConfig: ioBroker.Object | null;
+    constructor(props: ConnectionProps);
     /**
      * Checks if this connection is running in a web adapter and not in an admin.
      * @returns {boolean} True if running in a web adapter or in a socketio adapter.
      */
     static isWeb(): boolean;
-    /**
-     * @param {import('./types').ConnectionProps} props
-     */
-    constructor(props: import('./types').ConnectionProps);
-    props: import("./types").ConnectionProps;
-    autoSubscribes: string[];
-    autoSubscribeLog: boolean;
-    _instanceSubscriptions: {};
-    doNotLoadAllObjects: boolean;
-    doNotLoadACL: boolean;
-    /** @type {Record<string, ioBroker.State>} */
-    states: Record<string, ioBroker.State>;
-    objects: any;
-    acl: any;
-    firstConnect: boolean;
-    waitForRestart: boolean;
-    /** @type {ioBroker.Languages} */
-    systemLang: ioBroker.Languages;
-    connected: boolean;
-    _waitForFirstConnection: Promise<any>;
-    _waitForFirstConnectionResolve: (value: any) => void;
-    /** @type {Record<string, { reg: RegExp; cbs: ioBroker.StateChangeHandler[]}>} */
-    statesSubscribes: Record<string, {
-        reg: RegExp;
-        cbs: ioBroker.StateChangeHandler[];
-    }>;
-    /** @type {Record<string, { reg: RegExp; cbs: import('./types').ObjectChangeHandler[]}>} */
-    objectsSubscribes: Record<string, {
-        reg: RegExp;
-        cbs: import('./types').ObjectChangeHandler[];
-    }>;
-    filesSubscribes: {};
-    onProgress: (progress: number) => void;
-    onError: (err: any) => void;
-    loaded: boolean;
-    loadTimer: any;
-    loadCounter: number;
-    admin5only: any;
-    /** @type {((connected: boolean) => void)[]} */
-    onConnectionHandlers: ((connected: boolean) => void)[];
-    /** @type {((message: string) => void)[]} */
-    onLogHandlers: ((message: string) => void)[];
-    /** @type {Record<string, Promise<any>>} */
-    _promises: Record<string, Promise<any>>;
-    ignoreState: string;
-    simStates: {};
     /**
      * Starts the socket.io connection.
-     * @returns {void}
      */
     startSocket(): void;
-    scriptLoadCounter: any;
-    _socket: any;
-    _authTimer: any;
-    subscribed: boolean;
     /**
      * Called internally.
-     * @private
-     * @param {boolean} isOk
-     * @param {boolean} isSecure
      */
     private onPreConnect;
-    isSecure: boolean;
     /**
      * Checks if the socket is connected.
-     * @returns {boolean} true if connected.
      */
     isConnected(): boolean;
     /**
      * Checks if the socket is connected.
-     * @returns {Promise<void>} Promise resolves if once connected.
+     * Promise resolves if once connected.
      */
     waitForFirstConnection(): Promise<void>;
     /**
      * Called internally.
      * @private
      */
-    private _getUserPermissions;
+    _getUserPermissions(cb?: (err: string | null, acl: Record<string, any> | null) => void): void;
     /**
      * Called internally.
      * @private
      */
-    private onConnect;
-    systemConfig: any;
+    onConnect(): void;
     /**
      * Called internally.
      * @private
      */
-    private authenticate;
+    authenticate(): void;
     /**
      * Subscribe to changes of the given state.
-     * @param {string} id The ioBroker state ID.
-     * @param {ioBroker.StateChangeHandler} cb The callback.
      */
+    subscribeState(
+    /** The ioBroker state ID. */
+    id: string | string[], 
+    /** Set to true if the given state is binary and requires Base64 decoding. */
+    binary: boolean | ioBroker.StateChangeHandler | BinaryStateChangeHandler, 
+    /** The callback. */
+    cb?: ioBroker.StateChangeHandler | BinaryStateChangeHandler): void;
     /**
      * Subscribe to changes of the given state.
-     * @param {string} id The ioBroker state ID.
-     * @param {boolean} binary Set to true if the given state is binary and requires Base64 decoding.
-     * @param {ioBroker.StateChangeHandler} cb The callback.
      */
-    subscribeState(id: string, binary: boolean, cb: ioBroker.StateChangeHandler): void;
+    subscribeStateAsync(
+    /** The ioBroker state ID or array of states */
+    id: string | string[], 
+    /** The callback. */
+    cb: ioBroker.StateChangeHandler): Promise<void>;
     /**
-     * Subscribe to changes of the given state.
-     * @param {string | string[]} id The ioBroker state ID or array of states
-     * @param {ioBroker.StateChangeHandler} cb The callback.
+     * Unsubscribes all or the given callback from changes of the given state.
      */
-    subscribeStateAsync(id: string | string[], cb: ioBroker.StateChangeHandler): Promise<any>;
-    /**
-     * Unsubscribes all callbacks from changes of the given state.
-     * @param {string | string[]} id The ioBroker state ID or array of states
-     */
-    /**
-     * Unsubscribes the given callback from changes of the given state.
-     * @param {string | string[]} id The ioBroker state ID or array of states
-     * @param {ioBroker.StateChangeHandler} cb The callback.
-     */
-    unsubscribeState(id: string | string[], cb: ioBroker.StateChangeHandler): void;
+    unsubscribeState(
+    /** The ioBroker state ID or array of states */
+    id: string | string[], 
+    /** The callback. */
+    cb?: ioBroker.StateChangeHandler | BinaryStateChangeHandler): void;
     /**
      * Subscribe to changes of the given object.
-     * @param {string} id The ioBroker object ID.
-     * @param {import('./types').ObjectChangeHandler} cb The callback.
-     * @returns {Promise<void>}
-     */
-    subscribeObject(id: string, cb: import('./types').ObjectChangeHandler): Promise<void>;
-    /**
-     * Unsubscribes all callbacks from changes of the given object.
-     * @param {string} id The ioBroker object ID.
-     * @returns {Promise<void>}
      */
+    subscribeObject(
+    /** The ioBroker object ID. */
+    id: string | string[], 
+    /** The callback. */
+    cb: ioBroker.ObjectChangeHandler): void;
     /**
-     * Unsubscribes the given callback from changes of the given object.
-     * @param {string} id The ioBroker object ID.
-     * @param {import('./types').ObjectChangeHandler} cb The callback.
-     * @returns {Promise<void>}
+     * Unsubscribes all or the given callback from changes of the given object.
      */
-    unsubscribeObject(id: string, cb: import('./types').ObjectChangeHandler): Promise<void>;
+    unsubscribeObject(
+    /** The ioBroker object ID. */
+    id: string | string[], 
+    /** The callback. */
+    cb?: ioBroker.ObjectChangeHandler): Promise<void>;
     /**
      * Called internally.
-     * @param id
-     * @param fileName
-     * @param size
      */
-    fileChange(id: any, fileName: any, size: any): void;
+    private fileChange;
     /**
      * Subscribe to changes of the files.
      * @param {string} id The ioBroker state ID for meta-object. Could be a pattern
      * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
      * @param {function} cb The callback.
      */
-    subscribeFiles(id: string, filePattern: string, cb: Function): Promise<void>;
+    subscribeFiles(
+    /** The ioBroker state ID for meta-object. Could be a pattern */
+    id: string, 
+    /** Pattern or file name, like 'main/*' or 'main/visViews.json` */
+    filePattern: string | string[], 
+    /** The callback. */
+    cb: ioBroker.FileChangeHandler): Promise<void>;
     /**
      * Unsubscribes the given callback from changes of files.
      * @param {string} id The ioBroker state ID.
      * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
      * @param {function} cb The callback.
      */
-    unsubscribeFiles(id: string, filePattern: string, cb: Function): void;
+    unsubscribeFiles(id: string, filePattern: string, cb?: ioBroker.FileChangeHandler): void;
     /**
      * Called internally.
-     * @private
-     * @param {string} id
-     * @param {ioBroker.Object | null | undefined} obj
      */
     private objectChange;
     /**
      * Called internally.
-     * @private
-     * @param {string} id
-     * @param {ioBroker.State | null | undefined} state
      */
     private stateChange;
     /**
@@ -199,182 +247,158 @@ declare class Connection {
      * @param {string} sourceInstance
      * @param {object} data
      */
-    instanceMessage(messageType: string, sourceInstance: string, data: object): void;
+    instanceMessage(messageType: string, sourceInstance: string, data: Record<string, any>): void;
     /**
      * Gets all states.
-     * @param {string} pattern The pattern to filter states.
-     * @param {boolean} disableProgressUpdate don't call onProgress() when done
-     * @returns {Promise<Record<string, ioBroker.State>>}
      */
-    getStates(pattern: string, disableProgressUpdate: boolean): Promise<Record<string, ioBroker.State>>;
+    getStates(
+    /** The pattern to filter states. */
+    pattern?: string | boolean, 
+    /** don't call onProgress() when done */
+    disableProgressUpdate?: boolean): Promise<Record<string, ioBroker.State>>;
     /**
      * Gets the given state.
-     * @param {string} id The state ID.
-     * @returns {Promise<ioBroker.State | null | undefined>}
      */
-    getState(id: string): Promise<ioBroker.State | null | undefined>;
+    getState(
+    /** The state ID. */
+    id: string): Promise<ioBroker.State | null>;
     /**
      * @deprecated since js-controller 5.0. Use files instead.
-     * Gets the given binary state.
-     * @param {string} id The state ID.
-     * @returns {Promise<Buffer | undefined>}
+     * Get the given binary state.
      */
-    getBinaryState(id: string): Promise<Buffer | undefined>;
+    getBinaryState(
+    /** The state ID. */
+    id: string): Promise<string>;
     /**
      * @deprecated since js-controller 5.0. Use files instead.
-     * Sets the given binary state.
-     * @param {string} id The state ID.
-     * @param {string} base64 The Base64 encoded binary data.
-     * @returns {Promise<void>}
+     * Set the given binary state.
      */
-    setBinaryState(id: string, base64: string): Promise<void>;
+    setBinaryState(
+    /** The state ID. */
+    id: string, 
+    /** The Base64 encoded binary data. */
+    base64: string): Promise<void>;
     /**
      * Sets the given state value.
-     * @param {string} id The state ID.
-     * @param {string | number | boolean | ioBroker.State | ioBroker.SettableState | null} val The state value.
-     * @param {boolean | null} ack Acknowledge flag
-     * @returns {Promise<void>}
      */
-    setState(id: string, val: string | number | boolean | ioBroker.State | ioBroker.SettableState | null, ack: boolean | null): Promise<void>;
+    setState(
+    /** The state ID. */
+    id: string, 
+    /** The state value. */
+    val: string | number | boolean | ioBroker.SettableState | null, 
+    /** The acknowledgment flag. */
+    ack?: boolean): Promise<void>;
     /**
      * Gets all objects.
-     * @param {(objects?: Record<string, ioBroker.Object>) => void} update Callback that is executed when all objects are retrieved.
-     * @returns {void}
      */
-    /**
-     * Gets all objects.
-     * @param {boolean} update Set to true to retrieve all objects from the server (instead of using the local cache).
-     * @param {boolean} disableProgressUpdate don't call onProgress() when done
-     * @returns {Promise<Record<string, ioBroker.Object>> | undefined}
-     */
-    getObjects(update: boolean, disableProgressUpdate: boolean): Promise<Record<string, ioBroker.Object>> | undefined;
+    getObjects(
+    /** Set to true to retrieve all objects from the server (instead of using the local cache). */
+    update?: boolean, 
+    /** don't call onProgress() when done */
+    disableProgressUpdate?: boolean): Promise<Record<string, ioBroker.Object>>;
     /**
      * Gets objects by list of IDs.
-     * @param {string[]} list Array of object IDs to retrieve.
-     * @returns {void}
      */
-    getObjectsById(list: string[]): void;
+    getObjectsById(
+    /** Array of object IDs to retrieve. */
+    list: string[]): Promise<Record<string, ioBroker.Object>>;
     /**
      * Called internally.
-     * @private
-     * @param {boolean} isEnable
      */
     private _subscribe;
     /**
      * Requests log updates.
-     * @param {boolean} isEnabled Set to true to get logs.
-     * @returns {Promise<void>}
      */
-    requireLog(isEnabled: boolean): Promise<void>;
+    requireLog(
+    /**  Set to true to get logs. */
+    isEnabled: boolean): Promise<void>;
     /**
      * Deletes the given object.
-     * @param {string} id The object ID.
-     * @param {boolean} maintenance Force deletion of non conform IDs.
-     * @returns {Promise<void>}
      */
-    delObject(id: string, maintenance: boolean): Promise<void>;
+    delObject(
+    /** The object ID. */
+    id: string, 
+    /** Force deletion of non-conform IDs. */
+    maintenance?: boolean): Promise<void>;
     /**
      * Deletes the given object and all its children.
-     * @param {string} id The object ID.
-     * @param {boolean} maintenance Force deletion of non conform IDs.
-     * @returns {Promise<void>}
      */
-    delObjects(id: string, maintenance: boolean): Promise<void>;
+    delObjects(
+    /** The object ID. */
+    id: string, 
+    /** Force deletion of non-conform IDs. */
+    maintenance?: boolean): Promise<void>;
     /**
      * Sets the object.
-     * @param {string} id The object ID.
-     * @param {ioBroker.SettableObject} obj The object.
-     * @returns {Promise<void>}
      */
     setObject(id: string, obj: ioBroker.SettableObject): Promise<void>;
     /**
      * Gets the object with the given id from the server.
-     * @param {string} id The object ID.
-     * @returns {ioBroker.GetObjectPromise} The object.
-     */
-    getObject(id: string): ioBroker.GetObjectPromise<string>;
-    /**
-     * Get all adapter instances.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
      */
+    getObject(id: string): Promise<ioBroker.Object>;
     /**
-     * Get all instances of the given adapter.
-     * @param {string} adapter The name of the adapter.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
+     * Get all instances of the given adapter or all instances of all adapters.
      */
-    getAdapterInstances(adapter: string, update?: boolean): Promise<ioBroker.Object[]>;
+    getAdapterInstances(
+    /** The name of the adapter. */
+    adapter?: string | boolean, 
+    /** Force update. */
+    update?: boolean): Promise<ioBroker.InstanceObject[]>;
     /**
-     * Get all adapters.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
-     */
-    /**
-     * Get adapters with the given name.
-     * @param {string} adapter The name of the adapter.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
+     * Get adapters with the given name or all adapters.
      */
-    getAdapters(adapter: string, update?: boolean): Promise<ioBroker.Object[]>;
+    getAdapters(
+    /** The name of the adapter. */
+    adapter?: string | boolean, 
+    /** Force update. */
+    update?: boolean): Promise<ioBroker.AdapterObject[]>;
     /**
      * Called internally.
-     * @private
-     * @param {any[]} objs
-     * @param {(err?: any) => void} cb
      */
     private _renameGroups;
     /**
      * Rename a group.
-     * @param {string} id The id.
-     * @param {string} newId The new id.
+     * @param id The id.
+     * @param  newId The new id.
      * @param {string | { [lang in ioBroker.Languages]?: string; }} newName The new name.
      */
-    renameGroup(id: string, newId: string, newName: string | {
-        en?: string;
-        de?: string;
-        ru?: string;
-        pt?: string;
-        nl?: string;
-        fr?: string;
-        it?: string;
-        es?: string;
-        pl?: string;
-        uk?: string;
-        "zh-cn"?: string;
-    }): Promise<void>;
+    renameGroup(id: string, newId: string, newName: ioBroker.StringOrTranslated): Promise<void>;
     /**
      * Sends a message to a specific instance or all instances of some specific adapter.
-     * @param {string} instance The instance to send this message to.
-     * @param {string} [command] Command name of the target instance.
-     * @param {ioBroker.MessagePayload} [data] The message data to send.
      * @returns {Promise<ioBroker.Message | undefined>}
      */
-    sendTo(instance: string, command?: string, data?: ioBroker.MessagePayload): Promise<ioBroker.Message | undefined>;
+    sendTo(
+    /** The instance to send this message to. */
+    instance: string, 
+    /** Command name of the target instance. */
+    command: string, 
+    /** The message data to send. */
+    data: any): Promise<{
+        result?: any;
+        error?: string;
+    }>;
     /**
      * Extend an object and create it if it might not exist.
-     * @param {string} id The id.
-     * @param {ioBroker.PartialObject} obj The object.
      */
-    extendObject(id: string, obj: ioBroker.PartialObject): Promise<any>;
+    extendObject(
+    /** The id. */
+    id: string, 
+    /** The object. */
+    obj: ioBroker.PartialObject): Promise<void>;
     /**
      * Register a handler for log messages.
-     * @param {(message: string) => void} handler The handler.
      */
     registerLogHandler(handler: (message: string) => void): void;
     /**
      * Unregister a handler for log messages.
-     * @param {(message: string) => void} handler The handler.
      */
     unregisterLogHandler(handler: (message: string) => void): void;
     /**
      * Register a handler for the connection state.
-     * @param {(connected: boolean) => void} handler The handler.
      */
     registerConnectionHandler(handler: (connected: boolean) => void): void;
     /**
      * Unregister a handler for the connection state.
-     * @param {(connected: boolean) => void} handler The handler.
      */
     unregisterConnectionHandler(handler: (connected: boolean) => void): void;
     /**
@@ -382,10 +406,8 @@ declare class Connection {
      * @param {(id: string, text: string) => void} handler The handler.
      */
     registerCmdStdoutHandler(handler: (id: string, text: string) => void): void;
-    onCmdStdoutHandler: (id: string, text: string) => void;
     /**
      * Unset the handler for standard output of a command.
-     * @param {(id: string, text: string) => void} handler The handler.
      */
     unregisterCmdStdoutHandler(): void;
     /**
@@ -393,30 +415,26 @@ declare class Connection {
      * @param {(id: string, text: string) => void} handler The handler.
      */
     registerCmdStderrHandler(handler: (id: string, text: string) => void): void;
-    onCmdStderrHandler: (id: string, text: string) => void;
     /**
      * Unset the handler for standard error of a command.
-     * @param {(id: string, text: string) => void} handler The handler.
      */
     unregisterCmdStderrHandler(): void;
     /**
      * Set the handler for exit of a command.
-     * @param {(id: string, exitCode: number) => void} handler The handler.
      */
     registerCmdExitHandler(handler: (id: string, exitCode: number) => void): void;
-    onCmdExitHandler: (id: string, exitCode: number) => void;
     /**
      * Unset the handler for exit of a command.
-     * @param {(id: string, exitCode: number) => void} handler The handler.
      */
     unregisterCmdExitHandler(): void;
     /**
      * Get all enums with the given name.
-     * @param {string} [_enum] The name of the enum
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<Record<string, ioBroker.Object>>}
      */
-    getEnums(_enum?: string, update?: boolean): Promise<Record<string, ioBroker.Object>>;
+    getEnums(
+    /** The name of the enum. */
+    _enum?: string, 
+    /** Force update. */
+    update?: boolean): Promise<Record<string, ioBroker.EnumObject>>;
     /**
      * Query a predefined object view.
      * @param design design - 'system' or other designs like `custom`.
@@ -424,14 +442,28 @@ declare class Connection {
      * @param start The start ID.
      * @param [end] The end ID.
      */
-    getObjectViewCustom(design: any, type: any, start: any, end?: any): Promise<any>;
+    getObjectViewCustom(
+    /** The design: 'system' or other designs like `custom`. */
+    design: string, 
+    /** The type of object. */
+    type: ioBroker.ObjectType, 
+    /** The start ID. */
+    start: string, 
+    /** The end ID. */
+    end?: string): Promise<Record<string, ioBroker.Object>>;
     /**
      * Query a predefined object view.
      * @param type The type of object.
      * @param start The start ID.
      * @param [end] The end ID.
      */
-    getObjectViewSystem(type: any, start: any, end?: any): Promise<any>;
+    getObjectViewSystem(
+    /** The type of object. */
+    type: ioBroker.ObjectType, 
+    /** The start ID. */
+    start: string, 
+    /** The end ID. */
+    end?: string): Promise<Record<string, ioBroker.Object>>;
     /**
      * @deprecated since version 1.1.15, cause parameter order does not match backend
      * Query a predefined object view.
@@ -440,103 +472,106 @@ declare class Connection {
      * @param {string} type The type of object.
      * @returns {Promise<Record<string, ioBroker.Object>>}
      */
-    getObjectView(start: string, end: string, type: string): Promise<Record<string, ioBroker.Object>>;
+    getObjectView(start: string, end: string, type: ioBroker.ObjectType): Promise<Record<string, ioBroker.Object>>;
     /**
      * Get the stored certificates.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<{name: string; type: 'public' | 'private' | 'chained'}[]>}
      */
-    getCertificates(update?: boolean): Promise<{
+    getCertificates(
+    /** Force update. */
+    update?: boolean): Promise<{
         name: string;
-        type: 'public' | 'private' | 'chained';
+        type: 'public' | 'private' | 'chained' | '';
     }[]>;
     /**
      * Get the logs from a host (only for admin connection).
-     * @param {string} host
-     * @param {number} [linesNumber]
-     * @returns {Promise<string[]>}
      */
     getLogs(host: string, linesNumber?: number): Promise<string[]>;
     /**
      * Get the log files (only for admin connection).
      * @returns {Promise<string[]>}
      */
-    getLogsFiles(host: any): Promise<string[]>;
+    getLogsFiles(host: string): Promise<string[]>;
     /**
      * Delete the logs from a host (only for admin connection).
-     * @param {string} host
-     * @returns {Promise<void>}
      */
     delLogs(host: string): Promise<void>;
     /**
      * Read the meta items.
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    readMetaItems(): Promise<ioBroker.Object[]>;
+    readMetaItems(): Promise<ioBroker.MetaObject[]>;
     /**
      * Read the directory of an adapter.
-     * @param {string} adapter The adapter name.
-     * @param {string} fileName The directory name.
-     * @returns {Promise<ioBroker.ReadDirResult[]>}
      */
-    readDir(adapter: string, fileName: string): Promise<ioBroker.ReadDirResult[]>;
+    readDir(
+    /** The adapter name. */
+    adapter: string, 
+    /** The directory name. */
+    fileName: string): Promise<ioBroker.ReadDirResult[]>;
     /**
      * Read a file of an adapter.
-     * @param {string} adapter The adapter name.
-     * @param {string} fileName The file name.
-     * @param {boolean} base64 If it must be a base64 format
-     * @returns {Promise<string>}
      */
-    readFile(adapter: string, fileName: string, base64: boolean): Promise<string>;
+    readFile(
+    /** The adapter name. */
+    adapter: string, 
+    /** The file name. */
+    fileName: string, 
+    /** If it must be a base64 format */
+    base64?: boolean): Promise<string | {
+        data: string;
+        type: string;
+    }>;
     /**
      * Write a file of an adapter.
-     * @param {string} adapter The adapter name.
-     * @param {string} fileName The file name.
-     * @param {Buffer | string} data The data (if it's a Buffer, it will be converted to Base64).
-     * @returns {Promise<void>}
      */
-    writeFile64(adapter: string, fileName: string, data: Buffer | string): Promise<void>;
+    writeFile64(
+    /** The adapter name. */
+    adapter: string, 
+    /** The file name. */
+    fileName: string, 
+    /** The data (if it's a Buffer, it will be converted to Base64). */
+    data: Buffer | string): Promise<void>;
     /**
      * Delete a file of an adapter.
-     * @param {string} adapter The adapter name.
-     * @param {string} fileName The file name.
-     * @returns {Promise<void>}
      */
-    deleteFile(adapter: string, fileName: string): Promise<void>;
+    deleteFile(
+    /** The adapter name. */
+    adapter: string, 
+    /** The file name. */
+    fileName: string): Promise<void>;
     /**
      * Delete a folder of an adapter.
      * All files in folder will be deleted.
-     * @param {string} adapter The adapter name.
-     * @param {string} folderName The folder name.
-     * @returns {Promise<void>}
      */
-    deleteFolder(adapter: string, folderName: string): Promise<void>;
+    deleteFolder(
+    /** The adapter name. */
+    adapter: string, 
+    /** The file name. */
+    folderName: string): Promise<void>;
     /**
      * Get the list of all hosts.
      * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    getHosts(update?: boolean): Promise<ioBroker.Object[]>;
+    getHosts(update?: boolean): Promise<ioBroker.HostObject[]>;
     /**
      * Get the list of all users.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    getUsers(update?: boolean): Promise<ioBroker.Object[]>;
+    getUsers(
+    /** Force update. */
+    update?: boolean): Promise<ioBroker.UserObject[]>;
     /**
      * Get the list of all groups.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    getGroups(update?: boolean): Promise<ioBroker.Object[]>;
+    getGroups(
+    /** Force update. */
+    update?: boolean): Promise<ioBroker.GroupObject[]>;
     /**
      * Get the host information.
-     * @param {string} host
-     * @param {boolean} [update] Force update.
-     * @param {number} [timeoutMs] optional read timeout.
-     * @returns {Promise<any>}
      */
-    getHostInfo(host: string, update?: boolean, timeoutMs?: number): Promise<any>;
+    getHostInfo(host: string, 
+    /** Force update. */
+    update?: boolean, 
+    /** optional read timeout. */
+    timeoutMs?: number): Promise<HostInfo>;
     /**
      * Get the host information (short version).
      * @param {string} host
@@ -544,7 +579,11 @@ declare class Connection {
      * @param {number} [timeoutMs] optional read timeout.
      * @returns {Promise<any>}
      */
-    getHostInfoShort(host: string, update?: boolean, timeoutMs?: number): Promise<any>;
+    getHostInfoShort(host: string, 
+    /** Force update. */
+    update?: boolean, 
+    /** optional read timeout. */
+    timeoutMs?: number): Promise<HostInfo>;
     /**
      * Get the repository.
      * @param {string} host
@@ -553,157 +592,156 @@ declare class Connection {
      * @param {number} [timeoutMs] timeout in ms.
      * @returns {Promise<any>}
      */
-    getRepository(host: string, args?: any, update?: boolean, timeoutMs?: number): Promise<any>;
+    getRepository(host: string, options?: {
+        update: boolean;
+        repo: string;
+    } | string, 
+    /** Force update. */
+    update?: boolean, 
+    /** timeout in ms. */
+    timeoutMs?: number): Promise<Record<string, ioBroker.AdapterObject>>;
     /**
      * Get the installed.
-     * @param {string} host
-     * @param {boolean} [update] Force update.
-     * @param {number} [cmdTimeout] timeout in ms (optional)
-     * @returns {Promise<any>}
      */
-    getInstalled(host: string, update?: boolean, cmdTimeout?: number): Promise<any>;
+    getInstalled(host: string, 
+    /** Force update. */
+    update?: boolean, 
+    /** timeout in ms */
+    cmdTimeout?: number): Promise<Record<string, ioBroker.AdapterObject>>;
     /**
      * Rename file or folder in ioBroker DB
-     * @param adapter instance name
-     * @param oldName current file name, e.g main/vis-views.json
-     * @param newName new file name, e.g main/vis-views-new.json
      */
-    rename(adapter: any, oldName: any, newName: any): Promise<any>;
+    rename(
+    /** instance name */
+    adapter: string, 
+    /** current file name, e.g., main/vis-views.json */
+    oldName: string, 
+    /** new file name, e.g., main/vis-views-new.json */
+    newName: string): Promise<void>;
     /**
      * Rename file in ioBroker DB
-     * @param adapter instance name
-     * @param oldName current file name, e.g, main/vis-views.json
-     * @param newName new file name, e.g, main/vis-views-new.json
      */
-    renameFile(adapter: any, oldName: any, newName: any): Promise<any>;
+    renameFile(
+    /** instance name */
+    adapter: string, 
+    /** current file name, e.g., main/vis-views.json */
+    oldName: string, 
+    /** new file name, e.g., main/vis-views-new.json */
+    newName: string): Promise<void>;
     /**
      * Execute a command on a host.
-     * @param {string} host The host name.
-     * @param {string} cmd The command.
-     * @param {string} cmdId The command ID.
-     * @param {number} cmdTimeout Timeout of command in ms
-     * @returns {Promise<void>}
      */
-    cmdExec(host: string, cmd: string, cmdId: string, cmdTimeout: number): Promise<void>;
+    cmdExec(
+    /** The host name. */
+    host: string, 
+    /** The command. */
+    cmd: string, 
+    /** The command ID. */
+    cmdId: string, 
+    /** Timeout of command in ms */
+    cmdTimeout: number): Promise<void>;
     /**
      * Checks if a given feature is supported.
-     * @param {string} feature The feature to check.
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<any>}
      */
-    checkFeatureSupported(feature: string, update?: boolean): Promise<any>;
+    checkFeatureSupported(
+    /** The feature to check. */
+    feature: string, 
+    /** Force update. */
+    update?: boolean): Promise<boolean>;
     /**
      * Read the base settings of a given host.
-     * @param {string} host
-     * @returns {Promise<any>}
      */
-    readBaseSettings(host: string): Promise<any>;
+    readBaseSettings(host: string): Promise<Record<string, any>>;
     /**
      * Write the base settings of a given host.
      * @param {string} host
      * @param {any} config
      * @returns {Promise<any>}
      */
-    writeBaseSettings(host: string, config: any): Promise<any>;
+    writeBaseSettings(host: string, config: Record<string, any>): Promise<{
+        result?: 'ok';
+        error?: string;
+    }>;
     /**
      * Send command to restart the iobroker on host
-     * @param {string} host
-     * @returns {Promise<any>}
      */
-    restartController(host: string): Promise<any>;
+    restartController(host: string): Promise<boolean>;
     /**
      * Read statistics information from host
      * @param {string} host
      * @param {string} typeOfDiag one of none, normal, no-city, extended
      * @returns {Promise<any>}
      */
-    getDiagData(host: string, typeOfDiag: string): Promise<any>;
+    getDiagData(host: string, typeOfDiag: 'none' | 'normal' | 'no-city' | 'extended'): Promise<Record<string, any>>;
     /**
      * Read all states (which might not belong to this adapter) which match the given pattern.
-     * @param {string} pattern
-     * @returns {ioBroker.GetStatesPromise}
      */
-    getForeignStates(pattern: string): ioBroker.GetStatesPromise;
+    getForeignStates(pattern?: string): Promise<Record<string, ioBroker.State>>;
     /**
-     * Get foreign objects by pattern, by specific type and resolve their enums.
-     * @param {string} pattern
-     * @param {string} [type]
+     * Get foreign objects by pattern, by specific type and resolve their enums. (Only admin)
      * @returns {ioBroker.GetObjectsPromise}
      */
-    getForeignObjects(pattern: string, type?: string): ioBroker.GetObjectsPromise;
+    getForeignObjects(pattern: string, type?: ioBroker.ObjectType): Promise<Record<string, ioBroker.State>>;
     /**
      * Gets the system configuration.
      * @param {boolean} [update] Force update.
      * @returns {Promise<ioBroker.OtherObject>}
      */
-    getSystemConfig(update?: boolean): Promise<ioBroker.OtherObject>;
+    getSystemConfig(update?: boolean): Promise<ioBroker.Object>;
     /**
      * Sets the system configuration.
-     * @param {ioBroker.SettableObjectWorker<ioBroker.OtherObject>} obj
-     * @returns {Promise<ioBroker.SettableObjectWorker<ioBroker.OtherObject>>}
      */
-    setSystemConfig(obj: ioBroker.SettableObjectWorker<ioBroker.OtherObject>): Promise<ioBroker.SettableObjectWorker<ioBroker.OtherObject>>;
+    setSystemConfig(obj: ioBroker.SettableObjectWorker<ioBroker.Object>): Promise<ioBroker.SettableObjectWorker<ioBroker.Object>>;
     /**
      * Get the raw socket.io socket.
-     * @returns {any}
      */
-    getRawSocket(): any;
+    getRawSocket(): SocketClient;
     /**
      * Get the history of a given state.
-     * @param {string} id
-     * @param {ioBroker.GetHistoryOptions} options
-     * @returns {Promise<ioBroker.GetHistoryResult>}
      */
     getHistory(id: string, options: ioBroker.GetHistoryOptions): Promise<ioBroker.GetHistoryResult>;
     /**
      * Get the history of a given state.
-     * @param {string} id
-     * @param {ioBroker.GetHistoryOptions} options
-     * @returns {Promise<{values: ioBroker.GetHistoryResult; sesionId: string; stepIgnore: number}>}
      */
     getHistoryEx(id: string, options: ioBroker.GetHistoryOptions): Promise<{
         values: ioBroker.GetHistoryResult;
-        sesionId: string;
+        sessionId: string;
         stepIgnore: number;
     }>;
     /**
      * Change the password of the given user.
-     * @param {string} user
-     * @param {string} password
-     * @returns {Promise<void>}
      */
     changePassword(user: string, password: string): Promise<void>;
     /**
      * Get the IP addresses of the given host.
-     * @param {string} host
-     * @param {boolean} [update] Force update.
      * @returns {Promise<string[]>}
      */
-    getIpAddresses(host: string, update?: boolean): Promise<string[]>;
+    getIpAddresses(host: string, 
+    /** Force update. */
+    update?: boolean): Promise<string[]>;
     /**
      * Get the IP addresses with interface names of the given host or find host by IP.
-     * @param {string} ipOrHostName
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<any[<name, address, family>]>}
      */
-    getHostByIp(ipOrHostName: string, update?: boolean): Promise<any>;
+    getHostByIp(ipOrHostName: string, 
+    /** Force update. */
+    update?: boolean): Promise<{
+        name: string;
+        address: string;
+        family: 'ipv4' | 'ipv6';
+    }[]>;
     /**
      * Encrypt a text
-     * @param {string} text
-     * @returns {Promise<string>}
      */
     encrypt(text: string): Promise<string>;
     /**
      * Decrypt a text
-     * @param {string} encryptedText
-     * @returns {Promise<string>}
      */
     decrypt(encryptedText: string): Promise<string>;
     /**
      * Gets the version.
      * @returns {Promise<{version: string; serverName: string}>}
      */
-    getVersion(update: any): Promise<{
+    getVersion(update?: boolean): Promise<{
         version: string;
         serverName: string;
     }>;
@@ -715,7 +753,6 @@ declare class Connection {
     /**
      * Gets the admin version.
      * @deprecated use getVersion()
-     * @returns {Promise<{version: string; serverName: string}>}
      */
     getAdminVersion(): Promise<{
         version: string;
@@ -723,48 +760,57 @@ declare class Connection {
     }>;
     /**
      * Change access rights for file
-     * @param {string} [adapter] adapter name
-     * @param {string} [filename] file name with full path. it could be like vis.0/*
-     * @param {object} [options] like {mode: 0x644}
-     * @returns {Promise<{entries: array}>}
      */
-    chmodFile(adapter?: string, filename?: string, options?: object): Promise<{
-        entries: any[];
+    chmodFile(
+    /** adapter name */
+    adapter: string, 
+    /** file name with a full path. It could be like vis.0/* */
+    filename: string, 
+    /** like {mode: 0x644} */
+    options?: {
+        mode: number;
+    }): Promise<{
+        entries: ioBroker.ChownFileResult[];
+        id: string;
     }>;
     /**
-     * Change owner or/and owner group for file
-     * @param {string} [adapter] adapter name
-     * @param {string} [filename] file name with full path. it could be like vis.0/*
-     * @param {object} [options] like {owner: 'newOwner', ownerGroup: 'newGroup'}
-     * @returns {Promise<{entries: array}>}
-     */
-    chownFile(adapter?: string, filename?: string, options?: object): Promise<{
-        entries: any[];
+     * Change an owner or/and owner group for file
+     */
+    chownFile(
+    /** adapter name */
+    adapter: string, 
+    /** file name with a full path. It could be like vis.0/* */
+    fileName: string, options: {
+        owner?: string;
+        ownerGroup?: string;
+    }): Promise<{
+        entries: ioBroker.ChownFileResult[];
+        id: string;
     }>;
     /**
      * Check if the file exists
-     * @param {string} [adapter] adapter name
-     * @param {string} [filename] file name with full path. it could be like vis.0/*
-     * @returns {Promise<boolean>}
      */
-    fileExists(adapter?: string, filename?: string): Promise<boolean>;
+    fileExists(
+    /** adapter name */
+    adapter: string, 
+    /** file name with a full path. It could be like vis.0/* */
+    fileName: string): Promise<boolean>;
     /**
      * Get the alarm notifications from a host (only for admin connection).
-     * @param {string} host
-     * @param {string} [category] - optional
      * @returns {Promise<any>}
      */
-    getNotifications(host: string, category?: string): Promise<any>;
+    getNotifications(host: string, category?: string): Promise<FilteredNotificationInformation>;
     /**
      * Clear the alarm notifications on a host (only for admin connection).
      * @param {string} host
      * @param {string} [category] - optional
      * @returns {Promise<any>}
      */
-    clearNotifications(host: string, category?: string): Promise<any>;
+    clearNotifications(host: string, category?: string): Promise<{
+        result: 'ok';
+    }>;
     /**
-     * Read if only easy mode is allowed  (only for admin connection).
-     * @returns {Promise<boolean>}
+     * Read if only easy mode is allowed (only for admin connection).
      */
     getIsEasyModeStrict(): Promise<boolean>;
     /**
@@ -777,26 +823,23 @@ declare class Connection {
      * @returns {Promise<string>}
      */
     getCurrentUser(): Promise<string>;
-    getCurrentSession(cmdTimeout: any): Promise<any>;
+    getCurrentSession(cmdTimeout?: number): Promise<unknown>;
     /**
      * Read adapter ratings
      * @returns {Promise<any>}
      */
-    getRatings(update: any): Promise<any>;
+    getRatings(update?: boolean): Promise<any>;
     /**
      * Read current web, socketio or admin namespace, like admin.0
-     * @returns {Promise<string>}
      */
     getCurrentInstance(): Promise<string>;
-    getCompactAdapters(update: any): Promise<any>;
-    getAdaptersResetCache(adapter: any): void;
-    getCompactInstances(update: any): Promise<any>;
-    getAdapternInstancesResetCache(adapter: any): void;
-    getCompactInstalled(host: any, update: any, cmdTimeout: any): any;
-    getCompactSystemRepositories(update: any, cmdTimeout: any): Promise<any>;
-    getInstalledResetCache(host: any): void;
-    getInstalledResetCache(): void;
-    getCompactSystemConfig(update: any): Promise<any>;
+    getCompactAdapters(update?: boolean): Promise<Record<string, ioBroker.AdapterObject>>;
+    getAdaptersResetCache(adapter?: string): void;
+    getCompactInstances(update?: boolean): Promise<Record<string, ioBroker.InstanceObject>>;
+    getAdapternInstancesResetCache(adapter?: string): void;
+    getCompactInstalled(host: string, update?: boolean, cmdTimeout?: number): Promise<Record<string, ioBroker.AdapterObject>>;
+    getCompactSystemRepositories(update?: boolean, cmdTimeout?: number): Promise<ioBroker.Object>;
+    getCompactSystemConfig(update?: boolean): Promise<ioBroker.Object>;
     /**
      * Get the repository in compact form (only version and icon).
      * @param {string} host
@@ -804,18 +847,19 @@ declare class Connection {
      * @param {number} [timeoutMs] timeout in ms.
      * @returns {Promise<any>}
      */
-    getCompactRepository(host: string, update?: boolean, timeoutMs?: number): Promise<any>;
+    getCompactRepository(host: string, update?: boolean, timeoutMs?: number): Promise<Record<string, {
+        version: string;
+        icon: string;
+    }>>;
+    getInstalledResetCache(): void;
     /**
      * Get the list of all hosts in compact form (only _id, common.name, common.icon, common.color, native.hardware.networkInterfaces)
-     * @param {boolean} [update] Force update.
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    getCompactHosts(update?: boolean): Promise<ioBroker.Object[]>;
+    getCompactHosts(update?: boolean): Promise<ioBroker.HostObject[]>;
     /**
      * Get uuid
-     * @returns {Promise<ioBroker.Object[]>}
      */
-    getUuid(): Promise<ioBroker.Object[]>;
+    getUuid(): Promise<string | undefined>;
     /**
      * Subscribe on instance message
      * @param {string} [targetInstance] instance, like 'cameras.0'
@@ -824,39 +868,37 @@ declare class Connection {
      * @param {function} [callback] message handler
      * @returns {Promise<null>}
      */
-    subscribeOnInstance(targetInstance?: string, messageType?: string, data?: object, callback?: Function): Promise<null>;
+    subscribeOnInstance(
+    /** instance, like 'cameras.0' */
+    targetInstance: string, 
+    /** message type like 'startCamera/cam3' */
+    messageType: string, data: any, 
+    /** message handler. Could be null if all callbacks for this messageType should be unsubscribed */
+    callback: (data: Record<string, any>, sourceInstance: string, messageType: string) => void): Promise<unknown>;
     /**
      * Unsubscribe from instance message
-     * @param {string} [targetInstance] instance, like 'cameras.0'
-     * @param {string} [messageType] message type like 'startCamera/cam3'
-     * @param {function} [callback] message handler. Could be null if all callbacks for this messageType should be unsubscribed
-     * @returns {Promise<boolean>}
      */
-    unsubscribeFromInstance(targetInstance?: string, messageType?: string, callback?: Function): Promise<boolean>;
+    unsubscribeFromInstance(
+    /** instance, like 'cameras.0' */
+    targetInstance: string, 
+    /** message type like 'startCamera/cam3' */
+    messageType?: string, 
+    /** message handler. Could be null if all callbacks for this messageType should be unsubscribed */
+    callback?: (data: Record<string, any>, sourceInstance: string, messageType: string) => void): Promise<boolean>;
     /**
      * Send log to ioBroker log
-     * @param {string} [text] Log text
-     * @param {string} [level] `info`, `debug`, `warn`, `error` or `silly`
-     * @returns {void}
      */
-    log(text?: string, level?: string): void;
+    log(text: string, level?: 'info' | 'debug' | 'warn' | 'error' | 'silly'): void;
     /**
      * Logout current user
      * @returns {Promise<null>}
      */
-    logout(): Promise<null>;
+    logout(): Promise<void>;
     /**
-     * This is special method for vis.
+     * This is a special method for vis.
      * It is used to not send to server the changes about "nothing_selected" state
      * @param id The state that has to be ignored by communication
      */
-    setStateToIgnore(id: any): void;
+    setStateToIgnore(id?: string | null): void;
 }
-declare namespace Connection {
-    namespace Connection {
-        let onLog: PropTypes.Requireable<(...args: any[]) => any>;
-        let onReady: PropTypes.Requireable<(...args: any[]) => any>;
-        let onProgress: PropTypes.Requireable<(...args: any[]) => any>;
-    }
-}
-import PropTypes from 'prop-types';
+export default Connection;