@iobroker/types 7.2.3 → 7.2.5

package/build/objects.d.ts

@@ -650,7 +650,7 @@ declare global {
             /** Settings for custom Admin Tabs */
             adminTab?: {
                 name?: StringOrTranslated;
-                /** Base 64 icon for the tab */
+                /** Icon for the tab: a file name relative to the "admin" folder, a URL or a base64 data URL. If not set, the adapter icon is shown */
                 icon?: string;
                 /** If true, the Tab is not reloaded when the configuration changes */
                 ignoreConfigUpdate?: boolean;
@@ -658,7 +658,7 @@ declare global {
                 link?: string;
                 /** If true, only one instance of this tab will be created for all instances */
                 singleton?: boolean;
-                /** Order number in admin tabs */
+                /** Position in the admin menu: the built-in tabs use 1 to 120, a tab without order gets 200. 0 counts as not set. Once the user has sorted the menu, the stored order wins */
                 order?: number;
                 /**
                  * If the page sends an 'iobLoaded' event:
@@ -951,6 +951,8 @@ declare global {
             }[];
             /** Global saved expert mode for admin */
             expertMode?: boolean;
+            /** The "Did you know ...?" tips of the admin are not shown when it is opened */
+            tipsDisabled?: boolean;
 
             // Make it possible to narrow the object type using the custom property
             custom?: undefined;

package/build/shared.d.ts

@@ -293,6 +293,22 @@ declare global {
             message: MessagePayload;
             /** The source of this message */
             from: string;
+            /**
+             * The user this message is sent on behalf of, if the sender named one (`options.user` of
+             * `sendTo`/`sendToHost`). A socket server such as `admin` or `web` puts the authenticated
+             * user of the connection here, so the receiving instance can check what that user may do
+             * instead of acting with its own rights.
+             *
+             * It is only as trustworthy as `from`: every instance can claim any user here, and all of
+             * them run with full database rights anyway. Trust it when `from` is an instance you trust
+             * to have authenticated the user, and never as a substitute for your own permission check.
+             *
+             * Set from js-controller 7.2.5 on; an older one never sets it. A message that was sent
+             * without a user does not carry the field at all, so the absence of the field means
+             * "nobody was named" - for whichever of the two reasons, and in both cases there is
+             * nothing to check against.
+             */
+            user?: ioBroker.ObjectIDs.User;
             /** Callback information. This is set when the source expects a response */
             callback?: MessageCallbackInfo;
         }

package/build/types.d.ts

@@ -166,7 +166,7 @@ export declare interface AdapterClass {
      * Sends a message to a specific host or all hosts.
      */
     sendToHostAsync(hostName: string, message: ioBroker.MessagePayload): Promise<ioBroker.Message | undefined>;
-    sendToHostAsync(hostName: string, command: string, message: ioBroker.MessagePayload): Promise<ioBroker.Message | undefined>;
+    sendToHostAsync(hostName: string, command: string, message: ioBroker.MessagePayload, options?: SendToOptions): Promise<ioBroker.Message | undefined>;
     /**
      * Sends a message to a specific instance or all instances of some specific adapter.
      */
@@ -330,6 +330,8 @@ export declare class AdapterClass extends EventEmitter {
     namespace: `${string}.${number}`;
     name: string;
     private _systemSecret?;
+    /** Attributes of `encryptedNative`: their values in `this.config` are decrypted on start */
+    private _decryptedNativeAttributes;
     /** Whether the adapter has already terminated */
     private terminated;
     /** The cache of usernames */
@@ -483,6 +485,15 @@ export declare class AdapterClass extends EventEmitter {
      *
      */
     disable(): ioBroker.SetObjectPromise;
+    /**
+     * Reads a parameter which is stored encrypted and returns its decrypted value.
+     *
+     * An attribute listed in `encryptedNative` is already decrypted in `this.config` when the adapter
+     * starts, and is returned as it is.
+     *
+     * @param attribute the config attribute to decrypt
+     * @param callback return result
+     */
     getEncryptedConfig(attribute: string, callback?: GetEncryptedConfigCallback): Promise<string | string[] | void>;
     private _getEncryptedConfig;
     /**
@@ -703,7 +714,7 @@ export declare class AdapterClass extends EventEmitter {
     sendTo(instanceName: string, command: string, message: any, callback?: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo, options?: SendToOptions): void;
     private _sendTo;
     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;
+    sendToHost(hostName: string | null, command: string, message: any, callback?: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo, options?: SendToOptions): void;
     private _sendToHost;
     sendToUI(options: SendToUserInterfaceClientOptions): Promise<void>;
     registerNotification<Scope extends keyof ioBroker.NotificationScopes>(scope: Scope, category: ioBroker.NotificationScopes[Scope] | null, message: string, options?: NotificationOptions): Promise<void>;
@@ -1246,6 +1257,7 @@ export declare interface InternalSendToHostOptions {
     command: string;
     message: any;
     callback?: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo;
+    options?: SendToOptions;
 }
 
 export declare interface InternalSendToOptions {
@@ -1367,6 +1379,8 @@ declare type Pattern_2 = string | string[];
 export declare interface SendToOptions {
     /** Method throws or calls error cb, if callback not called in time, works for single targets only */
     timeout?: number;
+    /** The user on whose behalf the message is sent */
+    user?: ioBroker.ObjectIDs.User;
 }
 
 export declare interface SendToUserInterfaceClientOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@iobroker/types",
-    "version": "7.2.3",
+    "version": "7.2.5",
     "engines": {
         "node": ">=12.0.0"
     },
@@ -41,5 +41,5 @@
             ]
         }
     },
-    "gitHead": "6dd9ccf0391f5cd0e708855f2b571c8aab378007"
+    "gitHead": "9bc56bf00b9eedf53f0028d88c1e19d6d769615a"
 }