@iobroker/types 5.0.12-alpha.0-20230812-0eb416fc → 5.0.12

package/build/types.d.ts

@@ -12,6 +12,16 @@ export declare const Adapter: typeof AdapterClass;
  * Here we define dynamically created methods
  */
 export declare interface AdapterClass {
+    on(event: 'stateChange', listener: ioBroker.StateChangeHandler): this;
+    on(event: 'objectChange', listener: ioBroker.ObjectChangeHandler): this;
+    on(event: 'fileChange', listener: ioBroker.FileChangeHandler): this;
+    on(event: 'ready', listener: ioBroker.ReadyHandler): this;
+    on(event: 'install', listener: ioBroker.ReadyHandler): this;
+    on(event: 'unload', listener: ioBroker.UnloadHandler): this;
+    on(event: 'message', listener: ioBroker.MessageHandler): this;
+    /** 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 */
     extendObjectAsync(id: string, objPart: ioBroker.PartialObject, options?: ioBroker.ExtendObjectOptions): ioBroker.SetObjectPromise;
     /** Set capabilities of the given executable. Only works on Linux systems. */
@@ -392,6 +402,8 @@ export declare class AdapterClass extends EventEmitter {
     };
     /** Features supported by the running instance */
     private readonly SUPPORTED_FEATURES;
+    /** Controller for messaging related functionality */
+    private readonly uiMessagingController;
     constructor(options: AdapterOptions | string);
     decrypt(secretVal: string, value?: string): string;
     decrypt(value: string): string;
@@ -451,6 +463,10 @@ export declare class AdapterClass extends EventEmitter {
     disable(): ioBroker.SetObjectPromise;
     getEncryptedConfig(attribute: string, callback?: GetEncryptedConfigCallback): Promise<string | void>;
     private _getEncryptedConfig;
+    /**
+     * Get the system secret, after retrived once it will be read from cache
+     */
+    private getSystemSecret;
     setTimeout(cb: TimeoutCallback, timeout: number, ...args: any[]): ioBroker.Timeout | undefined;
     clearTimeout(timer: ioBroker.Timeout | undefined): void;
     delay(timeout: number): Promise<void>;
@@ -615,6 +631,7 @@ export declare class AdapterClass extends EventEmitter {
     sendToHost(hostName: string | null, message: any, callback?: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo): void;
     sendToHost(hostName: string | null, command: string, message: any, callback?: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo): void;
     private _sendToHost;
+    sendToUI(options: SendToUserInterfaceClientOptions): Promise<void>;
     registerNotification<Scope extends keyof ioBroker.NotificationScopes>(scope: Scope, category: ioBroker.NotificationScopes[Scope] | null, message: string): Promise<void>;
     setState<T extends ioBroker.SetStateCallback | undefined>(id: string | ioBroker.IdObject, state: ioBroker.State | ioBroker.StateValue | ioBroker.SettableState, callback?: T): T extends ioBroker.SetStateCallback ? void : ioBroker.SetStatePromise;
     setState<T extends ioBroker.SetStateCallback>(id: string | ioBroker.IdObject, state: ioBroker.State | ioBroker.StateValue | ioBroker.SettableState, ack: boolean, callback?: T): T extends ioBroker.SetStateCallback ? void : ioBroker.SetStatePromise;
@@ -716,7 +733,6 @@ export declare class AdapterClass extends EventEmitter {
     private _initAdapter;
     /**
      * Calls the ready handler, if it is an install run it calls the install handler instead
-     * @private
      */
     private _callReadyHandler;
     private _exceptionHandler;
@@ -733,7 +749,7 @@ export declare interface AdapterOptions {
     logTransporter?: boolean;
     /** if true, the date format from system.config */
     useFormatDate?: boolean;
-    /** if it is possible for other instances to retrive states of this adapter automatically */
+    /** if it is possible for other instances to retrieve states of this adapter automatically */
     subscribable?: boolean;
     /** compact group instance if running in compact mode */
     compactInstance?: number;
@@ -761,6 +777,10 @@ export declare interface AdapterOptions {
     stateChange?: ioBroker.StateChangeHandler;
     /** callback function (id, file) that will be called if file changed */
     fileChange?: ioBroker.FileChangeHandler;
+    /** callback function that will be called when a new UI client subscribes */
+    uiClientSubscribe?: UserInterfaceClientSubscribeHandler;
+    /** callback function that will be called when a new UI client unsubscribes */
+    uiClientUnsubscribe?: UserInterfaceClientUnsubscribeHandler;
     /** callback to inform about new message the adapter */
     message?: ioBroker.MessageHandler;
     /** callback to stop the adapter */
@@ -803,6 +823,10 @@ export declare interface AliasTargetEntry {
     unit?: string;
 }
 
+export declare type AllPropsUnknown<T> = {
+    [K in keyof T]: unknown;
+};
+
 export declare type CalculatePermissionsCallback = (result: ioBroker.PermissionSet) => void;
 
 declare type Callback = (...args: any[]) => void | Promise<void>;
@@ -818,6 +842,8 @@ export declare interface CheckStatesResult {
     ids: string[];
 }
 
+export declare type ClientUnsubscribeReason = MessageUnsubscribeReason | 'clientSubscribeError';
+
 export declare type CommandsPermissions = CommandsPermissionsObject | CommandsPermissionsEntry[];
 
 export declare type CommandsPermissionsEntry = {
@@ -1176,6 +1202,8 @@ export declare interface MessageCallbackObject {
     timer?: NodeJS.Timeout;
 }
 
+declare type MessageUnsubscribeReason = 'client' | 'disconnect';
+
 declare type OptionalCallback = undefined | Callback;
 
 export declare type Pattern = string | string[];
@@ -1187,6 +1215,13 @@ export declare interface SendToOptions {
     timeout?: number;
 }
 
+export declare interface SendToUserInterfaceClientOptions {
+    /** id of the UI client, if not given send to all active clients */
+    clientId?: string;
+    /** data to send to the client */
+    data: unknown;
+}
+
 export declare interface SetStateChangedResult {
     notChanged: boolean;
     id: string;
@@ -1232,6 +1267,54 @@ declare type SupportedFeature = (typeof SUPPORTED_FEATURES)[number];
 
 export declare type TimeoutCallback = (args?: any[]) => void;
 
+export declare type UserInterfaceClientRemoveMessage = (ioBroker.Message & {
+    command: 'clientUnsubscribe';
+    message: {
+        reason: MessageUnsubscribeReason;
+    };
+}) | (ioBroker.Message & {
+    command: 'clientSubscribeError';
+    message: {
+        reason: undefined;
+    };
+});
+
+export declare type UserInterfaceClientSubscribeHandler = (subscribeInfo: UserInterfaceSubscribeInfo) => UserInterfaceClientSubscribeReturnType | Promise<UserInterfaceClientSubscribeReturnType>;
+
+export declare interface UserInterfaceClientSubscribeReturnType {
+    /** If the adapter has accepted the client subscription */
+    accepted: boolean;
+    /** Optional heartbeat, if set, the client needs to re-subscribe every heartbeat interval */
+    heartbeat?: number;
+}
+
+export declare type UserInterfaceClientUnsubscribeHandler = (unsubscribeInfo: UserInterfaceUnsubscribeInfo) => void | Promise<void>;
+
+declare type UserInterfaceClientUnsubscribeReason = ClientUnsubscribeReason | 'timeout';
+
+export declare interface UserInterfaceSubscribeInfo {
+    /** The client id, which can be used to send information to clients */
+    clientId: string;
+    /** The message used for subscription */
+    message: ioBroker.Message;
+}
+
+export declare type UserInterfaceUnsubscribeInfo = UserInterfaceUnsubscribeInfoBaseObject & ({
+    /** Reason for unsubscribe */
+    reason: Exclude<UserInterfaceClientUnsubscribeReason, ClientUnsubscribeReason>;
+    message?: undefined;
+} | {
+    /** Reason for unsubscribe */
+    reason: ClientUnsubscribeReason;
+    /** Message used for unsubscribe */
+    message: ioBroker.Message;
+});
+
+declare type UserInterfaceUnsubscribeInfoBaseObject = {
+    /** The handler id, which can be used to send information to clients */
+    clientId: string;
+};
+
 declare interface ValidateIdOptions {
     /** in maintenance mode we can access ivnalid ids to delete them, only works with the admin user */
     maintenance?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/types",
-  "version": "5.0.12-alpha.0-20230812-0eb416fc",
+  "version": "5.0.12",
   "engines": {
     "node": ">=12.0.0"
   },
@@ -41,5 +41,5 @@
       ]
     }
   },
-  "gitHead": "2b08ed3acc935b0e1e9ad055b97f9bf7ea3c15fe"
+  "gitHead": "72526869156e91335caa1e1e0f0e86a6d827b423"
 }