@iobroker/socket-classes 2.2.21 → 2.3.1

package/README.md

@@ -100,7 +100,7 @@ adapter.on('message', obj => {
 });
 ```
 
-and after that client will receive messages from instance
+and after that the client will receive messages from instance
 
 ```js
 function sendImage(camera, data) {
@@ -135,6 +135,7 @@ function sendImage(camera, data) {
 * [`getAdapterName`](#getadaptername_w)
 * [`clientSubscribe`](#clientsubscribe_w)
 * [`clientUnsubscribe`](#clientunsubscribe_w)
+* [`getCompactSystemConfig`](#getcompactsystemconfig_w)
 * [`getAdapterInstances`](#getadapterinstances_w)
 * [`getObject`](#getobject_w)
 * [`getObjects`](#getobjects_w)
@@ -187,7 +188,7 @@ Write error into ioBroker log
 #### <a name="log_w"></a>`log(text, level)`
 Write log entry into ioBroker log
 * `text` *string*: log text
-* `level` *ioBroker.LogLevel*: one of `['silly', 'debug', 'info', 'warn', 'error']`. Default is 'debug'.
+* `level` *ioBroker.LogLevel*: one of `['silly', 'debug', 'info', 'warn', 'error']`. The default is 'debug'.
 
 #### <a name="checkfeaturesupported_w"></a>`checkFeatureSupported(feature, callback)`
 Check if the same feature is supported by the current js-controller
@@ -195,7 +196,7 @@ Check if the same feature is supported by the current js-controller
 * `callback` *(error: string | Error | null | undefined, isSupported?: boolean) => void) => void*: callback `(error: string | Error | null | undefined, isSupported: boolean) => void`
 
 #### <a name="gethistory_w"></a>`getHistory(id, options, callback)`
-Get history data from specific instance
+Get the history data from the specific instance
 * `id` *string*: object ID
 * `options` *ioBroker.GetHistoryOptions*: History options
 * `callback` *(error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void) => void*: callback `(error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void`
@@ -246,8 +247,8 @@ Get adapter name: "iobroker.ws", "iobroker.socketio", "iobroker.web", "iobroker.
 
 #### <a name="clientsubscribe_w"></a>`clientSubscribe(targetInstance, messageType, data, callback)`
 Client subscribes to specific instance's messages.
-Client informs specific instance about subscription on its messages.
-After subscription, the socket will receive "im" messages from desired instance
+Client informs a specific instance about subscription on its messages.
+After subscription, the socket will receive "im" messages from the desired instance
 The target instance MUST acknowledge the subscription and return result
 * `targetInstance` *string*: Instance name, e.g., 'cameras.0'
 * `messageType` *string*: Message type, e.g., 'startRecording/cam1'
@@ -261,9 +262,13 @@ The target instance MUST NOT acknowledge the un-subscription
 * `messageType` *string*: Message type, e.g., 'startRecording/cam1'
 * `callback` *(error: string | null | Error | undefined) => void) => void*: Callback `(error: string | null) => void`
 
+#### <a name="getcompactsystemconfig_w"></a>`getCompactSystemConfig(callback)`
+Get the system configuration in a compact form to save bandwidth.
+* `callback` *(error: string | null | Error | undefined, systemConfig?: {common: ioBroker.SystemConfigCommon; native?: {secret: string; vendor?: any}}) => void*: - Callback function `(error: string | null, systemConfig?: { common: any; native?: { secret: string } }) => void`
+
 #### <a name="getadapterinstances_w"></a>`getAdapterInstances(adapterName, callback)`
 Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
-* `adapterName` *string | undefined*: adapter name, e.g. `history`. To get all instances of all adapters just place here "".
+* `adapterName` *string | undefined*: adapter name, e.g. `history`. To get all instances of all adapters, just place here "".
 * `callback` *(error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void) => void*: callback `(error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void`
 
 ### Objects
@@ -273,8 +278,8 @@ Get one object.
 * `callback` *(error: Error | undefined | string | null, obj?: ioBroker.Object) => void) => void*: Callback `(error: string | null, obj?: ioBroker.Object) => void`
 
 #### <a name="getobjects_w"></a>`getObjects(list, callback)`
-Get all objects that are relevant for web: all states and enums with rooms.
-This is non-admin version of "all objects" and will be overloaded in admin
+Get all objects that are relevant for the web: all states and enums with rooms.
+This is a non-admin version of "all objects" and will be overloaded in admin
 * `list` *string[] | null*: Optional list of IDs
 * `callback` *(error: Error | undefined | string | null, objs?: Record<string, ioBroker.Object>) => void) => void*: Callback `(error: string | null, objs?: Record<string, ioBroker.Object>) => void`
 
@@ -394,7 +399,7 @@ This function is overloaded in admin (because admin accepts only base64)
 * `callback?` *(error: null | undefined | Error | string) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="unlink_w"></a>`unlink(adapter, name, callback)`
-Delete file in ioBroker DB
+Delete a file in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `name` *string*: file name, e.g. `main/vis-views.json`
 * `callback` *(error: null | undefined | Error | string) => void) => void*: Callback `(error: null | undefined | Error | string) => void`
@@ -432,7 +437,7 @@ Create a folder in ioBroker DB
 * `callback` *(error: null | undefined | Error | string) => void) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="readdir_w"></a>`readDir(adapter, dirName, options, callback?)`
-Read content of folder in ioBroker DB
+Read the content of the folder in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `dirName` *string*: folder name, e.g. `main`
 * `options` *object | ((error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void)*: for future use
@@ -449,7 +454,7 @@ Change a file mode in ioBroker DB
 Change file owner in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `fileName` *string*: file name, e.g. `main/vis-views.json`
-* `options` *{owner: `system.user.${string}`; ownerGroup?: `system.group.${string}`}*: options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from owner.
+* `options` *{owner: `system.user.${string}`; ownerGroup?: `system.group.${string}`}*: options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from an owner.
 * `callback?` *(error: null | undefined | Error | string) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="fileexists_w"></a>`fileExists(adapter, fileName, callback)`
@@ -492,6 +497,7 @@ Unsubscribe from file changes in ioBroker DB
 * [`getAdapterName`](#getadaptername_a)
 * [`clientSubscribe`](#clientsubscribe_a)
 * [`clientUnsubscribe`](#clientunsubscribe_a)
+* [`getCompactSystemConfig`](#getcompactsystemconfig_a)
 * [`getAdapterInstances`](#getadapterinstances_a)
 * [`getHostByIp`](#gethostbyip_a)
 * [`requireLog`](#requirelog_a)
@@ -509,7 +515,6 @@ Unsubscribe from file changes in ioBroker DB
 * [`getCompactInstances`](#getcompactinstances_a)
 * [`getCompactAdapters`](#getcompactadapters_a)
 * [`getCompactInstalled`](#getcompactinstalled_a)
-* [`getCompactSystemConfig`](#getcompactsystemconfig_a)
 * [`getCompactSystemRepositories`](#getcompactsystemrepositories_a)
 * [`getCompactRepository`](#getcompactrepository_a)
 * [`getCompactHosts`](#getcompacthosts_a)
@@ -574,7 +579,7 @@ Write error into ioBroker log
 #### <a name="log_a"></a>`log(text, level)`
 Write log entry into ioBroker log
 * `text` *string*: log text
-* `level` *ioBroker.LogLevel*: one of `['silly', 'debug', 'info', 'warn', 'error']`. Default is 'debug'.
+* `level` *ioBroker.LogLevel*: one of `['silly', 'debug', 'info', 'warn', 'error']`. The default is 'debug'.
 
 #### <a name="checkfeaturesupported_a"></a>`checkFeatureSupported(feature, callback)`
 Check if the same feature is supported by the current js-controller
@@ -582,7 +587,7 @@ Check if the same feature is supported by the current js-controller
 * `callback` *(error: string | Error | null | undefined, isSupported?: boolean) => void) => void*: callback `(error: string | Error | null | undefined, isSupported: boolean) => void`
 
 #### <a name="gethistory_a"></a>`getHistory(id, options, callback)`
-Get history data from specific instance
+Get the history data from the specific instance
 * `id` *string*: object ID
 * `options` *ioBroker.GetHistoryOptions*: History options
 * `callback` *(error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void) => void*: callback `(error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void`
@@ -633,8 +638,8 @@ Get adapter name: "iobroker.ws", "iobroker.socketio", "iobroker.web", "iobroker.
 
 #### <a name="clientsubscribe_a"></a>`clientSubscribe(targetInstance, messageType, data, callback)`
 Client subscribes to specific instance's messages.
-Client informs specific instance about subscription on its messages.
-After subscription, the socket will receive "im" messages from desired instance
+Client informs a specific instance about subscription on its messages.
+After subscription, the socket will receive "im" messages from the desired instance
 The target instance MUST acknowledge the subscription and return result
 * `targetInstance` *string*: Instance name, e.g., 'cameras.0'
 * `messageType` *string*: Message type, e.g., 'startRecording/cam1'
@@ -648,9 +653,13 @@ The target instance MUST NOT acknowledge the un-subscription
 * `messageType` *string*: Message type, e.g., 'startRecording/cam1'
 * `callback` *(error: string | null | Error | undefined) => void) => void*: Callback `(error: string | null) => void`
 
+#### <a name="getcompactsystemconfig_a"></a>`getCompactSystemConfig(callback)`
+Get the system configuration in a compact form to save bandwidth.
+* `callback` *(error: string | null | Error | undefined, systemConfig?: {common: ioBroker.SystemConfigCommon; native?: {secret: string; vendor?: any}}) => void*: - Callback function `(error: string | null, systemConfig?: { common: any; native?: { secret: string } }) => void`
+
 #### <a name="getadapterinstances_a"></a>`getAdapterInstances(adapterName, callback)`
 Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
-* `adapterName` *string | undefined*: adapter name, e.g. `history`. To get all instances of all adapters just place here "".
+* `adapterName` *string | undefined*: adapter name, e.g. `history`. To get all instances of all adapters, just place here "".
 * `callback` *(error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void) => void*: callback `(error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void`
 
 ### Admin
@@ -660,7 +669,7 @@ Read the host object by IP address.
 * `callback?` *(error: string | null | Error | undefined, hostObject?: ioBroker.HostObject | null) => void*: - Callback function `(ip: string, obj: ioBroker.HostObject | null) => void`
 
 #### <a name="requirelog_a"></a>`requireLog(isEnabled, callback?)`
-Activate or deactivate logging events. Events will be sent to the socket as `log` event. Adapter must have `common.logTransporter = true`.
+Activate or deactivate logging events. Events will be sent to the socket as `log` events. Adapter must have `common.logTransporter = true`.
 * `isEnabled` *boolean*: - Is logging enabled
 * `callback?` *(error: string | null | Error | undefined) => void*: - Callback function `(error: string | null) => void`
 
@@ -671,7 +680,7 @@ Get the log files from the given host.
 
 #### <a name="cmdexec_a"></a>`cmdExec(host, id, cmd, callback?)`
 Execute the shell command on host/controller.
-Following response commands are expected: `cmdStdout`, `cmdStderr`, `cmdExit`.
+The following response commands are expected: `cmdStdout`, `cmdStderr`, `cmdExit`.
 * `host` *string*: - Host name, e.g., `system.host.raspberrypi`
 * `id` *number*: - Session ID, e.g., `Date.now()`. This session ID will come in events `cmdStdout`, `cmdStderr`, `cmdExit`
 * `cmd` *string*: - Command to execute
@@ -732,13 +741,9 @@ Get all installed adapters in a compact form to save bandwidth.
 * `host` *string*: - Host name, e.g., `system.host.raspberrypi`
 * `callback` *(result?: Record<string, {version: string}>) => void) => void*: - Callback function `(error: string | null, results?: Record<string, { version: string }>) => void`
 
-#### <a name="getcompactsystemconfig_a"></a>`getCompactSystemConfig(callback)`
-Get the system configuration in a compact form to save bandwidth.
-* `callback` *(error: string | null | Error | undefined, systemConfig?: {common: ioBroker.SystemConfigCommon; native?: {secret: string; vendor?: any}}) => void*: - Callback function `(error: string | null, systemConfig?: { common: any; native?: { secret: string } }) => void`
-
 #### <a name="getcompactsystemrepositories_a"></a>`getCompactSystemRepositories(callback)`
 Get system repositories in a compact form to save bandwidth.
-* `callback` *(error: string | null | Error | undefined, systemRepositories?: CompactSystemRepository) => void) => void*: - Callback function `(error: string | null, systemRepositories?: { common: any; native?: { repositories: Record<string, { json: { _repoInfo: any } } } } }) => void`
+* `callback` *(error: string | null | Error | undefined, systemRepositories?: CompactSystemRepository) => void) => void*: - Callback function `(error: string | null, systemRepositories?: { common: any; native?: { repositories: Record<string, { json: { _repoInfo: any } } } }) => void`
 
 #### <a name="getcompactrepository_a"></a>`getCompactRepository(host, callback)`
 Get the repository in a compact form to save bandwidth.
@@ -847,8 +852,8 @@ Get one object.
 * `callback` *(error: Error | undefined | string | null, obj?: ioBroker.Object) => void) => void*: Callback `(error: string | null, obj?: ioBroker.Object) => void`
 
 #### <a name="getobjects_a"></a>`getObjects(list, callback)`
-Get all objects that are relevant for web: all states and enums with rooms.
-This is non-admin version of "all objects" and will be overloaded in admin
+Get all objects that are relevant for the web: all states and enums with rooms.
+This is a non-admin version of "all objects" and will be overloaded in admin
 * `list` *string[] | null*: Optional list of IDs
 * `callback` *(error: Error | undefined | string | null, objs?: Record<string, ioBroker.Object>) => void) => void*: Callback `(error: string | null, objs?: Record<string, ioBroker.Object>) => void`
 
@@ -936,7 +941,7 @@ This function is overloaded in admin (because admin accepts only base64)
 * `callback?` *(error: null | undefined | Error | string) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="unlink_a"></a>`unlink(adapter, name, callback)`
-Delete file in ioBroker DB
+Delete a file in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `name` *string*: file name, e.g. `main/vis-views.json`
 * `callback` *(error: null | undefined | Error | string) => void) => void*: Callback `(error: null | undefined | Error | string) => void`
@@ -974,7 +979,7 @@ Create a folder in ioBroker DB
 * `callback` *(error: null | undefined | Error | string) => void) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="readdir_a"></a>`readDir(adapter, dirName, options, callback?)`
-Read content of folder in ioBroker DB
+Read the content of the folder in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `dirName` *string*: folder name, e.g. `main`
 * `options` *object | ((error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void)*: for future use
@@ -991,7 +996,7 @@ Change a file mode in ioBroker DB
 Change file owner in ioBroker DB
 * `adapter` *string*: instance name, e.g. `vis.0`
 * `fileName` *string*: file name, e.g. `main/vis-views.json`
-* `options` *{owner: `system.user.${string}`; ownerGroup?: `system.group.${string}`}*: options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from owner.
+* `options` *{owner: `system.user.${string}`; ownerGroup?: `system.group.${string}`}*: options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from an owner.
 * `callback?` *(error: null | undefined | Error | string) => void*: Callback `(error: null | undefined | Error | string) => void`
 
 #### <a name="fileexists_a"></a>`fileExists(adapter, fileName, callback)`
@@ -1018,9 +1023,13 @@ Unsubscribe from file changes in ioBroker DB
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 2.3.1 (2026-04-12)
+* (@GermanBluefox) Moved `getCompactSystemConfig` to common commands. Made it available in web and admin.
+* (@Marc-Berg) Emit tokenInfo event with exp on socket connection
+
 ### 2.2.21 (2026-01-25)
 
-* (@Copilot) Added missing return statement for Bearer token auth
+* (@Copilot) Added a missing return statement for Bearer token auth
 
 ### 2.2.20 (2025-07-22)
 
@@ -1082,7 +1091,7 @@ Unsubscribe from file changes in ioBroker DB
 
 ### 2.1.12 (2025-02-26)
 
-* (@GermanBluefox) Added login with token in the query or as bearer token
+* (@GermanBluefox) Added login with a token in the query or as bearer token
 
 ### 2.1.7 (2025-02-23)
 * (@GermanBluefox) Added support for OAuth2 authentication
@@ -1133,7 +1142,7 @@ Unsubscribe from file changes in ioBroker DB
 * (foxriver76) fixed crash on invalid patterns with js-controller version 5
 
 ### 1.3.3 (2023-08-01)
-* (@GermanBluefox) Implemented subscribing of a client on messages from specific instance
+* (@GermanBluefox) Implemented subscribing of a client on messages from a specific instance
 * (@GermanBluefox) Moved checkFeatureSupported to regular connection and not only admin
 
 ### 1.2.0 (2023-07-07)
@@ -1150,7 +1159,7 @@ Unsubscribe from file changes in ioBroker DB
 * (@GermanBluefox) Allow deletion of fullcalendar objects
 
 ### 1.1.1 (2022-12-22)
-* (@GermanBluefox) Corrected error with subscribe
+* (@GermanBluefox) Corrected error with subscription
 
 ### 1.1.0 (2022-12-22)
 * (@GermanBluefox) Added user check to many commands
@@ -1187,7 +1196,7 @@ Unsubscribe from file changes in ioBroker DB
 * (@GermanBluefox) Corrected getAdapterInstances
 
 ### 0.4.9 (2022-06-20)
-* (@GermanBluefox) Do not show error with failed authentication
+* (@GermanBluefox) Do not show an error with failed authentication
 
 ### 0.4.7 (2022-06-20)
 * (@GermanBluefox) Allowed overloading system language
@@ -1199,7 +1208,7 @@ Unsubscribe from file changes in ioBroker DB
 * (@GermanBluefox) allowed running socket.io behind reverse proxy
 
 ### 0.4.4 (2022-06-09)
-* (@GermanBluefox) Do not show requireLog message
+* (@GermanBluefox) Do not show the requireLog message
 
 ### 0.4.3 (2022-06-03)
 * (@GermanBluefox) Allowed call of getAdapterInstances for non admin

package/build/lib/socketAdmin.d.ts

@@ -1,7 +1,7 @@
 /**
  *      Class Socket
  *
- *      Copyright 2014-2025 bluefox <dogafox@gmail.com>,
+ *      Copyright 2014-2026 bluefox <dogafox@gmail.com>,
  *      MIT License
  *
  */

package/build/lib/socketAdmin.js

@@ -7,7 +7,7 @@ exports.SocketAdmin = void 0;
 /**
  *      Class Socket
  *
- *      Copyright 2014-2025 bluefox <dogafox@gmail.com>,
+ *      Copyright 2014-2026 bluefox <dogafox@gmail.com>,
  *      MIT License
  *
  */

package/build/lib/socketCommands.js

@@ -422,7 +422,7 @@ class SocketCommands {
                                     .unsubscribeForeignFiles(pattern, patternFile || '*', options)
                                     .catch(e => this.adapter.log.error(`Cannot unsubscribe "${pattern}": ${e.message}`));
                             }
-                            delete this.subscribes[type][pattern];
+                            delete this.subscribes[type][key];
                         }
                     }
                     socket.subscribe[type].splice(i, 1);
@@ -565,9 +565,9 @@ class SocketCommands {
                             .catch(e => this.adapter.log.error(`Cannot unsubscribe "${pattern}": ${e.message}`));
                     }
                     else if (type === 'log') {
-                        if (this.adapter.requireLog && !this.#logEnabled) {
-                            this.#logEnabled = true;
-                            void this.adapter.requireLog(true, options);
+                        if (this.adapter.requireLog && this.#logEnabled) {
+                            this.#logEnabled = false;
+                            void this.adapter.requireLog(false, options);
                         }
                     }
                     else if (type === 'fileChange' && this.adapter.unsubscribeForeignFiles) {
@@ -674,7 +674,7 @@ class SocketCommands {
             obj.common.adminUI = { config: 'none' };
             if (obj.common.noConfig) {
                 obj.common.adminUI.config = 'none';
-                // @ts-expect-error this attribute is deprecated, but still used
+                // @ts-expect-error this attribute is deprecated but still used
             }
             else if (obj.common.jsonConfig) {
                 obj.common.adminUI.config = 'json';
@@ -685,7 +685,7 @@ class SocketCommands {
             else {
                 obj.common.adminUI.config = 'html';
             }
-            // @ts-expect-error this attribute is deprecated, but still used
+            // @ts-expect-error this attribute is deprecated but still used
             if (obj.common.jsonCustom) {
                 obj.common.adminUI.custom = 'json';
             }
@@ -772,6 +772,7 @@ class SocketCommands {
                             socket.conn.request.query.token = accessToken;
                         }
                         socket._sessionExpiresAt = token.aExp;
+                        socket.emit('tokenInfo', { expiresAt: token.aExp });
                         callback(null, true);
                     }
                 });
@@ -796,7 +797,7 @@ class SocketCommands {
          *
          * @param _socket Socket instance (not used)
          * @param text log text
-         * @param level one of `['silly', 'debug', 'info', 'warn', 'error']`. Default is 'debug'.
+         * @param level one of `['silly', 'debug', 'info', 'warn', 'error']`. The default is 'debug'.
          */
         this.commands.log = (_socket, text, level) => {
             if (level === 'error') {
@@ -833,7 +834,7 @@ class SocketCommands {
         };
         /**
          * #DOCUMENTATION commands
-         * Get history data from specific instance
+         * Get the history data from the specific instance
          *
          * @param socket Socket instance
          * @param id object ID
@@ -1261,7 +1262,7 @@ class SocketCommands {
         };
         /**
          * #DOCUMENTATION files
-         * Delete file in ioBroker DB
+         * Delete a file in ioBroker DB
          *
          * @param socket Socket instance
          * @param adapter instance name, e.g. `vis.0`
@@ -1389,7 +1390,7 @@ class SocketCommands {
         };
         /**
          * #DOCUMENTATION files
-         * Read content of folder in ioBroker DB
+         * Read the content of the folder in ioBroker DB
          *
          * @param socket Socket instance
          * @param adapter instance name, e.g. `vis.0`
@@ -1419,7 +1420,7 @@ class SocketCommands {
          * @param adapter instance name, e.g. `vis.0`
          * @param fileName file name, e.g. `main/vis-views.json`
          * @param options options `{mode: 0x644}`
-         * @param options.mode File mode in linux format 0x644. The first digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+         * @param options.mode File mode in linux format 0x644. The first digit is a user, the second is a group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
          * @param callback Callback `(error: string | Error | null | undefined) => void`
          */
         this.commands.chmodFile = (socket, adapter, fileName, options, callback) => {
@@ -1449,9 +1450,9 @@ class SocketCommands {
          * @param socket Socket instance
          * @param adapter instance name, e.g. `vis.0`
          * @param fileName file name, e.g. `main/vis-views.json`
-         * @param options options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from owner.
+         * @param options options `{owner: 'system.user.user', ownerGroup: 'system.group.administrator'}` or `system.user.user`. If ownerGroup is not defined, it will be taken from an owner.
          * @param options.owner New owner, like 'system.user.user'
-         * @param options.ownerGroup New owner group, like 'system.group.administrator' If ownerGroup is not defined, it will be taken from owner.
+         * @param options.ownerGroup New owner group, like 'system.group.administrator' If ownerGroup is not defined, it will be taken from an owner.
          * @param callback Callback `(error: null | undefined | Error | string) => void`
          */
         this.commands.chownFile = (socket, adapter, fileName, options, callback) => {
@@ -1523,7 +1524,7 @@ class SocketCommands {
          * Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
          *
          * @param socket Socket instance
-         * @param adapterName adapter name, e.g. `history`. To get all instances of all adapters just place here "".
+         * @param adapterName adapter name, e.g. `history`. To get all instances of all adapters, just place here "".
          * @param callback callback `(error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void`
          */
         this.commands.getAdapterInstances = (socket, adapterName, callback) => {
@@ -1775,8 +1776,8 @@ class SocketCommands {
         };
         /**
          * #DOCUMENTATION objects
-         * Get all objects that are relevant for web: all states and enums with rooms.
-         * This is non-admin version of "all objects" and will be overloaded in admin
+         * Get all objects that are relevant for the web: all states and enums with rooms.
+         * This is a non-admin version of "all objects" and will be overloaded in admin
          *
          * @param socket Socket instance
          * @param list Optional list of IDs
@@ -2046,8 +2047,8 @@ class SocketCommands {
         /**
          * #DOCUMENTATION commands
          * Client subscribes to specific instance's messages.
-         * Client informs specific instance about subscription on its messages.
-         * After subscription, the socket will receive "im" messages from desired instance
+         * Client informs a specific instance about subscription on its messages.
+         * After subscription, the socket will receive "im" messages from the desired instance
          * The target instance MUST acknowledge the subscription and return result
          *
          * @param socket Socket instance
@@ -2106,6 +2107,32 @@ class SocketCommands {
             }
             SocketCommands._fixCallback(callback, null, false);
         };
+        /**
+         * #DOCUMENTATION commands
+         * Get the system configuration in a compact form to save bandwidth.
+         *
+         * @param socket - WebSocket client instance
+         * @param callback - Callback function `(error: string | null, systemConfig?: { common: any; native?: { secret: string } }) => void`
+         */
+        this.commands.getCompactSystemConfig = (socket, callback) => {
+            if (this._checkPermissions(socket, 'getObject', callback)) {
+                void this.adapter.getForeignObject('system.config', { user: socket._acl?.user }, (error, obj) => {
+                    obj ||= {};
+                    const secret = obj?.native?.secret;
+                    const vendor = obj?.native?.vendor;
+                    // @ts-expect-error to save the memory
+                    delete obj.native;
+                    if (secret) {
+                        obj.native = { secret };
+                    }
+                    if (vendor) {
+                        obj.native ||= {};
+                        obj.native.vendor = vendor;
+                    }
+                    SocketCommands._fixCallback(callback, error, obj);
+                });
+            }
+        };
     }
     /** Init all commands: common, objects, states, files */
     #initCommands() {
@@ -2115,7 +2142,7 @@ class SocketCommands {
         this._initCommandsFiles();
     }
     #informAboutDisconnect(socketId) {
-        // say to all instances, that this socket was disconnected
+        // say to all instances that this socket was disconnected
         if (this.#clientSubscribes[socketId]) {
             Object.keys(this.#clientSubscribes[socketId]).forEach(targetInstance => {
                 this.adapter.sendTo(targetInstance, 'clientUnsubscribe', {