@iobroker/socket-classes 1.1.4 → 1.2.0

package/README.md

@@ -140,22 +140,22 @@ Read content of HTTP(S) page server-side (without CORS and stuff)
 * callback *(function)*: `function (error, {status, statusText}, body)`
 
 ### <a name="sendto_w"></a>sendTo(adapterInstance, command, message, callback)
-Send message to specific instance
+Send the message to specific instance
 * adapterInstance *(string)*: instance name, e.g. `history.0`
 * command *(string)*: command name
-* message *(object)*: message is instance dependent
+* message *(object)*: the message is instance dependent
 * callback *(function)*: `function (result)`
 
 ### <a name="sendtohost_w"></a>sendToHost(host, command, message, callback)
-Send message to specific host.
-Host can answer following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
+Send a message to the specific host.
+Host can answer to the following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
 * host *(string)*: instance name, e.g. `history.0`
 * command *(string)*: command name
-* message *(object)*: message is command specific
+* message *(object)*: the message is command-specific
 * callback *(function)*: `function (result)`
 
 ### <a name="authenabled_w"></a>authEnabled(callback)
-Ask server is authentication enabled and if the user authenticated
+Ask server is authentication enabled, and if the user authenticated
 * callback *(function)*: `function (isAuthenticationUsed, userName)`
 
 ### <a name="logout_w"></a>logout(callback)
@@ -171,7 +171,7 @@ Get user permissions
 * callback *(function)*: `function (error, permissions)`
 
 ### <a name="getversion_w"></a>getVersion(callback)
-Get adapter version. Not the socket-classes version!
+Get the adapter version. Not the socket-classes version!
 * callback *(function)*: `function (error, adapterVersion, adapterName)`
 
 ### <a name="getadaptername_w"></a>getAdapterName(callback)
@@ -183,18 +183,19 @@ Get one object
 * id *(string)*: object ID.
 * callback *(function)*: `function (error, obj)`
 
-### <a name="getobjects_w"></a>getObjects(callback)
+### <a name="getobjects_w"></a>getObjects(list, callback)
 Get all objects that are relevant for web: all states and enums with rooms
 * id *(string)*: object ID.
+* list *(string[])*: optional list of IDs.
 * callback *(function)*: `function (error, obj)`
 
 ### <a name="subscribeobjects_w"></a>subscribeObjects(pattern, callback)
-Subscribe on object changes by pattern. The events will come as 'objectChange' events to the socket.
+Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
 ### <a name="unsubscribeobjects_w"></a>unsubscribeObjects(pattern, callback)
-Unsubscribe on object changes by pattern.
+Unsubscribe from object changes by pattern.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
@@ -224,7 +225,7 @@ Read states by pattern
 
 ### <a name="getforeignstates_w"></a>getForeignStates(pattern, callback)
 Read all states (which might not belong to this adapter) which match the given pattern
-* pattern *(string)*: pattern like
+* pattern *(string)*: pattern like `system.adapter.*` or array of state IDs
 * callback *(function)*: `function (error)`
 
 ### <a name="getstate_w"></a>getState(id, callback)
@@ -246,16 +247,16 @@ Read one binary state.
 ### <a name="setbinarystate_w"></a>setBinaryState(id, base64, callback)
 Write one binary state.
 * id *(string)*: State ID like, 'javascript.0.binary'
-* base64 *(string)*: State value as base64 string. Binary states has no acknowledge flag.
+* base64 *(string)*: State value as base64 string. Binary states have no acknowledged flag.
 * callback *(function)*: `function (error)`
 
 ### <a name="subscribe_w"></a>subscribe(pattern, callback)
-Subscribe on state changes by pattern. The events will come as 'stateChange' events to the socket.
+Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
 ### <a name="subscribestates_w"></a>subscribeStates(pattern, callback)
-Subscribe on state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
+Subscribe to state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
@@ -346,7 +347,7 @@ Read content of folder in ioBroker DB
 Change file mode in ioBroker DB
 * _adapter *(string)*: instance name, e.g. `vis.0`
 * fileName *(string)*: file name, e.g `main/vis-views.json`
-* options *(object)*: `{mode: 0x644}` or 0x644. First digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+* options *(object)*: `{mode: 0x644}` or 0x644. The first digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
 * callback *(function)*: `function (error)`
 
 ### <a name="chownfile_w"></a>chownFile(_adapter, fileName, options, callback)
@@ -357,19 +358,19 @@ Change file owner in ioBroker DB
 * callback *(function)*: `function (error)`
 
 ### <a name="fileexists_w"></a>fileExists(_adapter, fileName, callback)
-Checks if the file or folder exists in ioBroker DB
+Check if the file or folder exists in ioBroker DB
 * _adapter *(string)*: instance name, e.g. `vis.0`
 * fileName *(string)*: file name, e.g `main/vis-views.json`
 * callback *(function)*: `function (error, isExist)`
 
 ### <a name="subscribefiles_w"></a>subscribeFiles(id, pattern, callback)
-Subscribe on file changes in ioBroker DB
+Subscribe to file changes in ioBroker DB
 * id *(string)*: instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
 * pattern *(string)*: file name pattern, e.g `main/*.json`
 * callback *(function)*: `function (error)`
 
 ### <a name="unsubscribefiles_w"></a>unsubscribeFiles(id, pattern, callback)
-Unsubscribe on file changes in ioBroker DB
+Unsubscribe from file changes in ioBroker DB
 * id *(string)*: instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
 * pattern *(string)*: file name pattern, e.g `main/*.json`
 * callback *(function)*: `function (error)`
@@ -489,22 +490,22 @@ Read content of HTTP(S) page server-side (without CORS and stuff)
 * callback *(function)*: `function (error, {status, statusText}, body)`
 
 ### <a name="sendto_a"></a>sendTo(adapterInstance, command, message, callback)
-Send message to specific instance
+Send the message to specific instance
 * adapterInstance *(string)*: instance name, e.g. `history.0`
 * command *(string)*: command name
-* message *(object)*: message is instance dependent
+* message *(object)*: the message is instance dependent
 * callback *(function)*: `function (result)`
 
 ### <a name="sendtohost_a"></a>sendToHost(host, command, message, callback)
-Send message to specific host.
-Host can answer following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
+Send a message to the specific host.
+Host can answer to the following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
 * host *(string)*: instance name, e.g. `history.0`
 * command *(string)*: command name
-* message *(object)*: message is command specific
+* message *(object)*: the message is command-specific
 * callback *(function)*: `function (result)`
 
 ### <a name="authenabled_a"></a>authEnabled(callback)
-Ask server is authentication enabled and if the user authenticated
+Ask server is authentication enabled, and if the user authenticated
 * callback *(function)*: `function (isAuthenticationUsed, userName)`
 
 ### <a name="logout_a"></a>logout(callback)
@@ -520,7 +521,7 @@ Get user permissions
 * callback *(function)*: `function (error, permissions)`
 
 ### <a name="getversion_a"></a>getVersion(callback)
-Get adapter version. Not the socket-classes version!
+Get the adapter version. Not the socket-classes version!
 * callback *(function)*: `function (error, adapterVersion, adapterName)`
 
 ### <a name="getadaptername_a"></a>getAdapterName(callback)
@@ -528,9 +529,9 @@ Get adapter name. Not the socket-classes version!
 * callback *(function)*: `function (error, adapterVersion)`
 
 ### <a name="gethostbyip_a"></a>getHostByIp(ip, callback)
-Read host object by IP address
+Read the host object by IP address
 * ip *(string)*: ip address. IPv4 or IPv6
-* callback *(function)*: `function (ip, obj)`. If host not found, obj is null
+* callback *(function)*: `function (ip, obj)`. If host is not found, obj is null
 
 ### <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`
@@ -543,19 +544,19 @@ Get logs file from given host
 * callback *(function)*: `function (error, files)`, where `files` is array of `{fileName: `log/hostname/transport/file`, size: 123}`
 
 ### <a name="delstate_a"></a>delState(id, callback)
-Delete state. Corresponding object will be deleted too.
+Delete state. The corresponding object will be deleted too.
 * id *(string)*: state ID
 * callback *(function)*: `function (error)`
 
 ### <a name="cmdexec_a"></a>cmdExec(host, id, cmd, callback)
-Execute shell command on host/controller. Following response commands are expected: ´cmdStdout, cmdStderr, cmdExit´
+Execute the shell command on host/controller. Following response commands are expected: ´cmdStdout, cmdStderr, cmdExit´
 * host *(string)*: host name, like 'system.host.raspberrypi'
 * id *(string)*: session ID, like `Date.now()´. This session ID will come in events `cmdStdout, cmdStderr, cmdExit`
 * cmd *(string)*: command
 * callback *(function)*: `function (error)`
 
 ### <a name="eventsthreshold_a"></a>eventsThreshold(isActive)
-Used only for admin to limit number of events to front-end.
+Used only for admin to the limited number of events to front-end.
 * isActive *(boolean)*: if true, then events will be limited
 
 ### <a name="getratings_a"></a>getRatings(update, callback)
@@ -568,17 +569,17 @@ Return current instance name like `admin.0`
 * callback *(function)*: `function (error, namespace)`
 
 ### <a name="checkfeaturesupported_a"></a>checkFeatureSupported(feature, callback)
-Checks if same feature is supported by current js-controller
+Checks, if the same feature is supported by the current js-controller
 * feature *(string)*: feature name like `CONTROLLER_LICENSE_MANAGER`
 * callback *(function)*: `function (error, isSupported)`
 
 ### <a name="decrypt_a"></a>decrypt(encryptedText, callback)
-Decrypts text with system secret key
+Decrypts text with the system secret key
 * encryptedText *(string)*: encrypted text
 * callback *(function)*: `function (error, decryptedText)`
 
 ### <a name="encrypt_a"></a>encrypt(plainText, callback)
-Encrypts text with system secret key
+Encrypts text with the system secret key
 * plainText *(string)*: normal text
 * callback *(function)*: `function (error, encryptedText)`
 
@@ -641,14 +642,14 @@ Delete existing user. Admin cannot be deleted.
 * callback *(function)*: `function (error)`
 
 ### <a name="addgroup_a"></a>addGroup(group, desc, acl, callback)
-Add new group.
+Add a new group.
 * group *(string)*: user name, like 'benjamin
 * desc *(string)*: optional description
 * acl *(object)*: optional access control list object, like `{"object":{"list":true,"read":true,"write":false,"delete":false},"state":{"list":true,"read":true,"write":true,"create":true,"delete":false},"users":{"list":true,"read":true,"write":false,"create":false,"delete":false},"other":{"execute":false,"http":true,"sendto":false},"file":{"list":true,"read":true,"write":false,"create":false,"delete":false}}`
 * callback *(function)*: `function (error)`
 
 ### <a name="delgroup_a"></a>delGroup(group, callback)
-Delete existing group. Administrator group cannot be deleted.
+Delete the existing group. Administrator group cannot be deleted.
 * group *(string)*: group name, like 'users`
 * callback *(function)*: `function (error)`
 
@@ -668,12 +669,12 @@ Read absolutely all objects. Same as `getAllObjects`.
 * callback *(function)*: `function (error, objects)`, where `objects` is an object like `{'system.adapter.admin.0': {...}, 'system.adapter.web.0': {...}}`
 
 ### <a name="subscribeobjects_a"></a>subscribeObjects(pattern, callback)
-Subscribe on object changes by pattern. The events will come as 'objectChange' events to the socket.
+Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
 ### <a name="unsubscribeobjects_a"></a>unsubscribeObjects(pattern, callback)
-Unsubscribe on object changes by pattern.
+Unsubscribe from object changes by pattern.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
@@ -691,7 +692,7 @@ Set object.
 * callback *(function)*: `function (error)`
 
 ### <a name="delobject_a"></a>delObject(id, options, callback)
-Delete object or objects recursively. Objects with `dontDelete` cannot be deleted.
+Delete an object or objects recursively. Objects with `dontDelete` cannot be deleted.
 * id *(string)*: Object ID like, 'adapterName.0.channel'
 * options *(string)*: `{recursive: true}`
 * callback *(function)*: `function (error)`
@@ -701,7 +702,7 @@ Read absolutely all objects
 * callback *(function)*: `function (error, objects)`, where `objects` is an object like `{'system.adapter.admin.0': {...}, 'system.adapter.web.0': {...}}`
 
 ### <a name="extendobject_a"></a>extendObject(id, obj, callback)
-Extend existing object
+Extend the existing object
 * id *(string)*: object ID
 * obj *(object)*: new parts of the object, like `{common: {name: 'new name'}}`
 * callback *(function)*: `function (error)`
@@ -725,7 +726,7 @@ Read states by pattern
 
 ### <a name="getforeignstates_a"></a>getForeignStates(pattern, callback)
 Read all states (which might not belong to this adapter) which match the given pattern
-* pattern *(string)*: pattern like
+* pattern *(string)*: pattern like `system.adapter.*` or array of state IDs
 * callback *(function)*: `function (error)`
 
 ### <a name="getstate_a"></a>getState(id, callback)
@@ -747,16 +748,16 @@ Read one binary state.
 ### <a name="setbinarystate_a"></a>setBinaryState(id, base64, callback)
 Write one binary state.
 * id *(string)*: State ID like, 'javascript.0.binary'
-* base64 *(string)*: State value as base64 string. Binary states has no acknowledge flag.
+* base64 *(string)*: State value as base64 string. Binary states have no acknowledged flag.
 * callback *(function)*: `function (error)`
 
 ### <a name="subscribe_a"></a>subscribe(pattern, callback)
-Subscribe on state changes by pattern. The events will come as 'stateChange' events to the socket.
+Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
 ### <a name="subscribestates_a"></a>subscribeStates(pattern, callback)
-Subscribe on state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
+Subscribe to state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
 * pattern *(string)*: pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
 * callback *(function)*: `function (error)`
 
@@ -847,7 +848,7 @@ Read content of folder in ioBroker DB
 Change file mode in ioBroker DB
 * _adapter *(string)*: instance name, e.g. `vis.0`
 * fileName *(string)*: file name, e.g `main/vis-views.json`
-* options *(object)*: `{mode: 0x644}` or 0x644. First digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+* options *(object)*: `{mode: 0x644}` or 0x644. The first digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
 * callback *(function)*: `function (error)`
 
 ### <a name="chownfile_a"></a>chownFile(_adapter, fileName, options, callback)
@@ -858,19 +859,19 @@ Change file owner in ioBroker DB
 * callback *(function)*: `function (error)`
 
 ### <a name="fileexists_a"></a>fileExists(_adapter, fileName, callback)
-Checks if the file or folder exists in ioBroker DB
+Check if the file or folder exists in ioBroker DB
 * _adapter *(string)*: instance name, e.g. `vis.0`
 * fileName *(string)*: file name, e.g `main/vis-views.json`
 * callback *(function)*: `function (error, isExist)`
 
 ### <a name="subscribefiles_a"></a>subscribeFiles(id, pattern, callback)
-Subscribe on file changes in ioBroker DB
+Subscribe to file changes in ioBroker DB
 * id *(string)*: instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
 * pattern *(string)*: file name pattern, e.g `main/*.json`
 * callback *(function)*: `function (error)`
 
 ### <a name="unsubscribefiles_a"></a>unsubscribeFiles(id, pattern, callback)
-Unsubscribe on file changes in ioBroker DB
+Unsubscribe from file changes in ioBroker DB
 * id *(string)*: instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
 * pattern *(string)*: file name pattern, e.g `main/*.json`
 * callback *(function)*: `function (error)`
@@ -888,7 +889,11 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 -->
 
 ## Changelog
-### 1.1.4 (2023-03-13)
+### 1.2.0 (2023-07-07)
+* (foxriver76) fixed crash on invalid patterns with js-controller version 5
+* (bluefox) extended the getObjects function with the possibility to read the list of IDs
+
+### 1.1.5 (2023-03-13)
 * (bluefox) Added command `name`
 
 ### 1.1.3 (2023-03-12)

package/lib/socketCommands.js

@@ -264,7 +264,13 @@ class SocketCommands {
             key = pattern;
         }
 
-        p = pattern2RegEx(key);
+        try {
+            p = pattern2RegEx(key);
+        } catch (e) {
+            this.adapter.log.error(`Invalid pattern on subscribe: ${e.message}`)
+            return
+        }
+
         if (p === null) {
             return this.adapter.log.warn('Empty pattern on subscribe!');
         }
@@ -293,8 +299,8 @@ class SocketCommands {
                     this.logEnabled = true;
                     this.adapter.requireLog(true, options);
                 }
-            } else if (type === 'fileChange') {
-                this.adapter.subscribeForeignFiles && this.adapter.subscribeForeignFiles(pattern, patternFile, options);
+            } else if (type === 'fileChange' && this.adapter.subscribeForeignFiles) {
+                 this.adapter.subscribeForeignFiles(pattern, patternFile, options);
             }
         } else {
             this.subscribes[type][key]++;
@@ -689,10 +695,10 @@ class SocketCommands {
 
         // commands
         this.commands['sendTo'] = (socket, adapterInstance, command, message, callback) => {
-            // Send message to specific instance
+            // Send the message to specific instance
             // @param {string} adapterInstance - instance name, e.g. `history.0`
             // @param {string} command - command name
-            // @param {object} message - message is instance dependent
+            // @param {object} message - the message is instance dependent
             // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, 'sendTo', callback, command)) {
                 try {
@@ -709,11 +715,11 @@ class SocketCommands {
         const protectedCommands = ['cmdExec', 'getLocationOnDisk', 'getDiagData', 'getDevList', 'delLogs', 'writeDirAsZip', 'writeObjectsAsZip', 'readObjectsAsZip', 'checkLogging', 'updateMultihost', 'rebuildAdapter'];
 
         this.commands['sendToHost'] = (socket, host, command, message, callback) => {
-            // Send message to specific host.
-            // Host can answer following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
+            // Send a message to the specific host.
+            // Host can answer to the following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
             // @param {string} host - instance name, e.g. `history.0`
             // @param {string} command - command name
-            // @param {object} message - message is command specific
+            // @param {object} message - the message is command-specific
             // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, protectedCommands.includes(command) ? 'cmdExec' : 'sendToHost', callback, command)) {
                 // Try to decode this file locally as redis has a limitation for files bigger than 20MB
@@ -731,7 +737,7 @@ class SocketCommands {
                     zipFiles
                         .writeDirAsZip(
                             this.adapter, // normally we have to pass here the internal "objects" object, but as
-                            // only writeFile is used, and it has the same name we can pass here the
+                            // only writeFile is used, and it has the same name, we can pass here the
                             // adapter, which has the function with the same name and arguments
                             message.id,
                             message.name,
@@ -757,7 +763,7 @@ class SocketCommands {
         };
 
         this.commands['authEnabled'] = (socket, callback) => {
-            // Ask server is authentication enabled and if the user authenticated
+            // Ask server is authentication enabled, and if the user authenticated
             // @param {function} callback - `function (isAuthenticationUsed, userName)`
             if (this._checkPermissions(socket, 'authEnabled', callback)) {
                 if (typeof callback === 'function') {
@@ -797,7 +803,7 @@ class SocketCommands {
         };
 
         this.commands['getVersion'] = (socket, callback) => {
-            // Get adapter version. Not the socket-classes version!
+            // Get the adapter version. Not the socket-classes version!
             // @param {function} callback - `function (error, adapterVersion, adapterName)`
             if (this._checkPermissions(socket, 'getVersion', callback)) {
                 if (typeof callback === 'function') {
@@ -1070,7 +1076,7 @@ class SocketCommands {
             // Change file mode in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
             // @param {string} fileName - file name, e.g `main/vis-views.json`
-            // @param {object} options - `{mode: 0x644}` or 0x644. First digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+            // @param {object} options - `{mode: 0x644}` or 0x644. The first digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
             // @param {function} callback - `function (error)`
             if (typeof options === 'function') {
                 callback = options;
@@ -1114,7 +1120,7 @@ class SocketCommands {
         };
 
         this.commands['fileExists'] = (socket, _adapter, fileName, callback) => {
-            // Checks if the file or folder exists in ioBroker DB
+            // Check if the file or folder exists in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
             // @param {string} fileName - file name, e.g `main/vis-views.json`
             // @param {function} callback - `function (error, isExist)`
@@ -1130,7 +1136,7 @@ class SocketCommands {
         };
 
         this.commands['subscribeFiles'] = (socket, id, pattern, callback) => {
-            // Subscribe on file changes in ioBroker DB
+            // Subscribe to file changes in ioBroker DB
             // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
             // @param {string} pattern - file name pattern, e.g `main/*.json`
             // @param {function} callback - `function (error)`
@@ -1138,7 +1144,7 @@ class SocketCommands {
         }
 
         this.commands['unsubscribeFiles'] = (socket, id, pattern, callback) => {
-            // Unsubscribe on file changes in ioBroker DB
+            // Unsubscribe from file changes in ioBroker DB
             // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
             // @param {string} pattern - file name pattern, e.g `main/*.json`
             // @param {function} callback - `function (error)`
@@ -1212,7 +1218,7 @@ class SocketCommands {
 
         this.commands['getForeignStates'] = (socket, pattern, callback) => {
             // Read all states (which might not belong to this adapter) which match the given pattern
-            // @param {string} pattern - pattern like
+            // @param {string} pattern - pattern like `system.adapter.*` or array of state IDs
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'getStates', callback)) {
                 if (typeof callback === 'function') {
@@ -1320,7 +1326,7 @@ class SocketCommands {
         this.commands['setBinaryState'] = (socket, id, base64, callback) => {
             // Write one binary state.
             // @param {string} id - State ID like, 'javascript.0.binary'
-            // @param {string} base64 - State value as base64 string. Binary states has no acknowledge flag.
+            // @param {string} base64 - State value as base64 string. Binary states have no acknowledged flag.
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'setState', callback, id)) {
                 if (typeof callback === 'function') {
@@ -1350,14 +1356,14 @@ class SocketCommands {
         };
 
         this.commands['subscribe'] = (socket, pattern, callback) => {
-            // Subscribe on state changes by pattern. The events will come as 'stateChange' events to the socket.
+            // Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             return this._subscribeStates(socket, pattern, callback);
         };
 
         this.commands['subscribeStates'] = (socket, pattern, callback) => {
-            // Subscribe on state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
+            // Subscribe to state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             return this._subscribeStates(socket, pattern, callback);
@@ -1401,11 +1407,30 @@ class SocketCommands {
 
         // not admin version of "all objects"
         // this function is overloaded in admin
-        this.commands['getObjects'] = (socket, callback) => {
+        this.commands['getObjects'] = (socket, list, callback) => {
             // Get all objects that are relevant for web: all states and enums with rooms
             // @param {string} id - object ID.
+            // @param {string[]} list - optional list of IDs.
             // @param {function} callback - `function (error, obj)`
-            if (this._checkPermissions(socket, 'getObjects', callback)) {
+            if (typeof list === 'function') {
+                callback = list;
+                list = null;
+            }
+            if (list && list.length) {
+                if (this._checkPermissions(socket, 'getObject', callback)) {
+                    if (typeof callback === 'function') {
+                        try {
+                            this.adapter.getForeignObjects(list, {user: socket._acl.user}, (error, objs) =>
+                                SocketCommands._fixCallback(callback, error, objs));
+                        } catch (error) {
+                            this.adapter.log.error(`[getObjects] ERROR: ${error.toString()}`);
+                            SocketCommands._fixCallback(callback, error);
+                        }
+                    } else {
+                        this.adapter.log.warn('[getObjects] Invalid callback');
+                    }
+                }
+            } else if (this._checkPermissions(socket, 'getObjects', callback)) {
                 try {
                     if (typeof callback === 'function') {
                         this.adapter.getForeignObjects('*', 'state', 'rooms', {user: socket._acl.user}, async (error, objs) => {
@@ -1437,7 +1462,7 @@ class SocketCommands {
         };
 
         this.commands['subscribeObjects'] = (socket, pattern, callback) => {
-            // Subscribe on object changes by pattern. The events will come as 'objectChange' events to the socket.
+            // Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'subscribeObjects', callback, pattern)) {
@@ -1461,7 +1486,7 @@ class SocketCommands {
         };
 
         this.commands['unsubscribeObjects'] = (socket, pattern, callback) => {
-            // Unsubscribe on object changes by pattern.
+            // Unsubscribe from object changes by pattern.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unsubscribeObjects', callback, pattern)) {

package/lib/socketCommandsAdmin.js

@@ -70,7 +70,7 @@ class SocketCommandsAdmin extends SocketCommands {
         }
 
         try {
-            const response = await axios.get('https://rating.iobroker.net/rating?uuid=' + uuid, {timeout: 15000, validateStatus: status => status < 400})
+            const response = await axios.get(`https://rating.iobroker.net/rating?uuid=${uuid}`, {timeout: 15000, validateStatus: status => status < 400})
             this.adapter._ratings = response.data;
             if (!this.adapter._ratings || typeof this.adapter._ratings !== 'object' || Array.isArray(this.adapter._ratings)) {
                 this.adapter._ratings = {};
@@ -95,7 +95,7 @@ class SocketCommandsAdmin extends SocketCommands {
 
     _readInstanceConfig(id, user, isTab, configs) {
         return new Promise(resolve =>
-            this.adapter.getForeignObject('system.adapter.' + id, {user}, (error, obj) => {
+            this.adapter.getForeignObject(`system.adapter.${id}`, {user}, (error, obj) => {
                 if (obj && obj.common) {
                     const instance = id.split('.').pop();
                     const config = {
@@ -103,7 +103,7 @@ class SocketCommandsAdmin extends SocketCommands {
                         title:       obj.common.titleLang || obj.common.title,
                         desc:        obj.common.desc,
                         color:       obj.common.color,
-                        url:         `/adapter/${obj.common.name}/${isTab ? 'tab' : 'index'}${!isTab && obj.common.materialize ? '_m' : ''}.html${instance ? '?' + instance : ''}`,
+                        url:         `/adapter/${obj.common.name}/${isTab ? 'tab' : 'index'}${!isTab && obj.common.materialize ? '_m' : ''}.html${instance ? `?${instance}` : ''}`,
                         icon:        obj.common.icon,
                         materialize: obj.common.materialize,
                         jsonConfig:  obj.common.jsonConfig,
@@ -157,7 +157,7 @@ class SocketCommandsAdmin extends SocketCommands {
                 typeof callback === 'function' && setImmediate(() => callback(res));
             });
         } catch (error) {
-            this.adapter.log.error('[sendToHost] ERROR: ' + error.toString());
+            this.adapter.log.error(`[sendToHost] ERROR: ${error.toString()}`);
             typeof callback === 'function' && setImmediate(() => callback({ error }));
         }
     }
@@ -275,7 +275,7 @@ class SocketCommandsAdmin extends SocketCommands {
             this.eventsThreshold.count = 0;
             this.eventsThreshold.active = false;
             this.eventsThreshold.timeActivated = 0;
-            this.adapter.log.info('Subscribe on all states again');
+            this.adapter.log.info('Subscribe to all states again');
 
             setTimeout(() => {
                 /*
@@ -331,12 +331,12 @@ class SocketCommandsAdmin extends SocketCommands {
         }
 
         try {
-            this.adapter.getForeignObject('system.user.' + user, options, (error, obj) => {
+            this.adapter.getForeignObject(`system.user.${user}`, options, (error, obj) => {
                 if (obj) {
                     SocketCommands._fixCallback(callback, 'User yet exists');
                 } else {
                     try {
-                        this.adapter.setForeignObject('system.user.' + user, {
+                        this.adapter.setForeignObject(`system.user.${user}`, {
                                 type: 'user',
                                 common: {
                                     name: user,
@@ -347,25 +347,25 @@ class SocketCommandsAdmin extends SocketCommands {
                                 try {
                                     this.adapter.setPassword(user, pw, options, callback);
                                 } catch (error) {
-                                    this.adapter.log.error('[_addUser] cannot set password: ' + error.toString());
+                                    this.adapter.log.error(`[_addUser] cannot set password: ${error.toString()}`);
                                     SocketCommands._fixCallback(callback, error);
                                 }
                             });
                     } catch (error) {
-                        this.adapter.log.error('[_addUser] cannot save user: ' + error.toString());
+                        this.adapter.log.error(`[_addUser] cannot save user: ${error.toString()}`);
                         SocketCommands._fixCallback(callback, error);
                     }
                 }
             });
         } catch (error) {
-            this.adapter.log.error('[_addUser] cannot read user: ' + error.toString());
+            this.adapter.log.error(`[_addUser] cannot read user: ${error.toString()}`);
             SocketCommands._fixCallback(callback, error);
         }
     }
 
     _delUser(user, options, callback) {
         try {
-            this.adapter.getForeignObject('system.user.' + user, options, (error, obj) => {
+            this.adapter.getForeignObject(`system.user.${user}`, options, (error, obj) => {
                 if (error || !obj) {
                     SocketCommands._fixCallback(callback, 'User does not exist');
                 } else {
@@ -373,18 +373,18 @@ class SocketCommandsAdmin extends SocketCommands {
                         SocketCommands._fixCallback(callback, 'Cannot delete user, while is system user');
                     } else {
                         try {
-                            this.adapter.delForeignObject('system.user.' + user, options, error =>
+                            this.adapter.delForeignObject(`system.user.${user}`, options, error =>
                                 // Remove this user from all groups in web client
                                 SocketCommands._fixCallback(callback, error));
                         } catch (error) {
-                            this.adapter.log.error('[_delUser] cannot delete user: ' + error.toString());
+                            this.adapter.log.error(`[_delUser] cannot delete user: ${error.toString()}`);
                             SocketCommands._fixCallback(callback, error);
                         }
                     }
                 }
             });
         } catch (error) {
-            this.adapter.log.error('[_delUser] cannot read user: ' + error.toString());
+            this.adapter.log.error(`[_delUser] cannot read user: ${error.toString()}`);
             SocketCommands._fixCallback(callback, error);
         }
     }
@@ -437,14 +437,14 @@ class SocketCommandsAdmin extends SocketCommands {
                 }
             });
         } catch (error) {
-            this.adapter.log.error('[_addGroup] cannot read group: ' + error.toString());
+            this.adapter.log.error(`[_addGroup] cannot read group: ${error.toString()}`);
             SocketCommands._fixCallback(callback, error);
         }
     }
 
     _delGroup(group, options, callback) {
         try {
-            this.adapter.getForeignObject('system.group.' + group, options, (error, obj) => {
+            this.adapter.getForeignObject(`system.group.${group}`, options, (error, obj) => {
                 if (error || !obj) {
                     SocketCommands._fixCallback(callback, 'Group does not exist');
                 } else {
@@ -453,7 +453,7 @@ class SocketCommandsAdmin extends SocketCommands {
                     } else {
                         try {
                             this.adapter.delForeignObject(`system.group.${group}`, options, error =>
-                                // Remove this group from all users in web client
+                                // Remove this group from all users in the web client
                                 SocketCommands._fixCallback(callback, error));
                         } catch (error) {
                             this.adapter.log.error(`[_delGroup] cannot delete group: ${error.toString()}`);
@@ -463,13 +463,13 @@ class SocketCommandsAdmin extends SocketCommands {
                 }
             });
         } catch (error) {
-            this.adapter.log.error('[_delGroup] cannot read group: ' + error.toString());
+            this.adapter.log.error(`[_delGroup] cannot read group: ${error.toString()}`);
             SocketCommands._fixCallback(callback, error);
         }
     }
 
     static _checkObject(obj, options, flag) {
-        // read rights of object
+        // read rights of the object
         if (!obj || !obj.common || !obj.acl || flag === 'list') {
             return true;
         }
@@ -572,7 +572,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['addGroup'] = (socket, group, desc, acl, callback) => {
-            // Add new group.
+            // Add a new group.
             // @param {string} group - user name, like 'benjamin
             // @param {string} desc - optional description
             // @param {object} acl - optional access control list object, like `{"object":{"list":true,"read":true,"write":false,"delete":false},"state":{"list":true,"read":true,"write":true,"create":true,"delete":false},"users":{"list":true,"read":true,"write":false,"create":false,"delete":false},"other":{"execute":false,"http":true,"sendto":false},"file":{"list":true,"read":true,"write":false,"create":false,"delete":false}}`
@@ -584,7 +584,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['delGroup'] = (socket, group, callback) => {
-            // Delete existing group. Administrator group cannot be deleted.
+            // Delete the existing group. Administrator group cannot be deleted.
             // @param {string} group - group name, like 'users`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'delGroup', callback, group)) {
@@ -603,7 +603,7 @@ class SocketCommandsAdmin extends SocketCommands {
                     this.adapter.setPassword(user, pass, {user: socket._acl.user}, (error, ...args) =>
                         SocketCommands._fixCallback(callback, error, ...args));
                 } catch (error) {
-                    this.adapter.log.error('[_changePassword] ERROR: ' + error.toString());
+                    this.adapter.log.error(`[_changePassword] ERROR: ${error.toString()}`);
                     SocketCommands._fixCallback(callback, error);
                 }
             }
@@ -612,9 +612,9 @@ class SocketCommandsAdmin extends SocketCommands {
 
     _initCommandsAdmin() {
         this.commands['getHostByIp'] = (socket, ip, callback) => {
-            // Read host object by IP address
+            // Read the host object by IP address
             // @param {string} ip - ip address. IPv4 or IPv6
-            // @param {function} callback - `function (ip, obj)`. If host not found, obj is null
+            // @param {function} callback - `function (ip, obj)`. If host is not found, obj is null
             if (typeof callback !== 'function') {
                 return this.adapter.log.warn('[getHostByIp] Invalid callback');
             }
@@ -648,7 +648,7 @@ class SocketCommandsAdmin extends SocketCommands {
                         callback(ip, null);
                     });
                 } catch (error) {
-                    this.adapter.log.error('[_changePassword] ERROR: ' + error.toString());
+                    this.adapter.log.error(`[_changePassword] ERROR: ${error.toString()}`);
                     SocketCommands._fixCallback(callback, error);
                 }
             }
@@ -680,7 +680,7 @@ class SocketCommandsAdmin extends SocketCommands {
                     if (timeout) {
                         let result = {list: []};
 
-                        // deliver file list
+                        // deliver the file list
                         try {
                             const config = this.adapter.systemConfig;
                             // detect file log
@@ -742,7 +742,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['delState'] = (socket, id, callback) => {
-            // Delete state. Corresponding object will be deleted too.
+            // Delete state. The corresponding object will be deleted too.
             // @param {string} id - state ID
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'delState', callback, id)) {
@@ -763,7 +763,7 @@ class SocketCommandsAdmin extends SocketCommands {
         // commands will be executed on host/controller
         // following response commands are expected: cmdStdout, cmdStderr, cmdExit
         this.commands['cmdExec'] = (socket, host, id, cmd, callback) => {
-            // Execute shell command on host/controller. Following response commands are expected: ´cmdStdout, cmdStderr, cmdExit´
+            // Execute the shell command on host/controller. Following response commands are expected: ´cmdStdout, cmdStderr, cmdExit´
             // @param {string} host - host name, like 'system.host.raspberrypi'
             // @param {string} id - session ID, like `Date.now()´. This session ID will come in events `cmdStdout, cmdStderr, cmdExit`
             // @param {string} cmd - command
@@ -783,7 +783,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['eventsThreshold'] = (socket, isActive) => {
-            // Used only for admin to limit number of events to front-end.
+            // Used only for admin to the limited number of events to front-end.
             // @param {boolean} isActive - if true, then events will be limited
             if (!isActive) {
                 this.disableEventThreshold(true);
@@ -811,14 +811,14 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['checkFeatureSupported'] = (socket, feature, callback) => {
-            // Checks if same feature is supported by current js-controller
+            // Checks, if the same feature is supported by the current js-controller
             // @param {string} feature - feature name like `CONTROLLER_LICENSE_MANAGER`
             // @param {function} callback - `function (error, isSupported)`
             SocketCommands._fixCallback(callback, null, this.adapter.supportsFeature && this.adapter.supportsFeature(feature));
         };
 
         this.commands['decrypt'] = (socket, encryptedText, callback) => {
-            // Decrypts text with system secret key
+            // Decrypts text with the system secret key
             // @param {string} encryptedText - encrypted text
             // @param {function} callback - `function (error, decryptedText)`
             if (this.secret) {
@@ -842,7 +842,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['encrypt'] = (socket, plainText, callback) => {
-            // Encrypts text with system secret key
+            // Encrypts text with the system secret key
             // @param {string} plainText - normal text
             // @param {function} callback - `function (error, encryptedText)`
             if (this.secret) {
@@ -922,7 +922,7 @@ class SocketCommandsAdmin extends SocketCommands {
                             .then(() =>
                                 callback(null, {
                                     strict: false,
-                                    configs
+                                    configs,
                                 })
                             );
                     });
@@ -1010,7 +1010,7 @@ class SocketCommandsAdmin extends SocketCommands {
                                         adminTab: obj.common.adminTab,
                                         name: obj.common.name,
                                         icon: obj.common.icon,
-                                        enabled: obj.common.enabled
+                                        enabled: obj.common.enabled,
                                     };
                                 });
 
@@ -1106,7 +1106,7 @@ class SocketCommandsAdmin extends SocketCommands {
             // @param {function} callback - `function (error, repository)`, where `repository` is an object like `{'javascript': {version: '1.0.1', icon}, 'admin': {version: '1.0.1', icon}}`
             if (this._checkPermissions(socket, 'sendToHost', callback)) {
                 this._sendToHost(host, 'getRepository', null, data => {
-                    // Extract only version and icon
+                    // Extract only the version and icon
                     const result = {};
                     data && Object.keys(data).forEach(name => result[name] = {
                         version: data[name].version,
@@ -1210,7 +1210,7 @@ class SocketCommandsAdmin extends SocketCommands {
         }
 
         this.commands['extendObject'] = (socket, id, obj, callback) => {
-            // Extend existing object
+            // Extend the existing object
             // @param {string} id - object ID
             // @param {object} obj - new parts of the object, like `{common: {name: 'new name'}}`
             // @param {function} callback - `function (error)`
@@ -1251,7 +1251,7 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         this.commands['delObject'] = (socket, id, options, callback) => {
-            // Delete object or objects recursively. Objects with `dontDelete` cannot be deleted.
+            // Delete an object or objects recursively. Objects with `dontDelete` cannot be deleted.
             // @param {string} id - Object ID like, 'adapterName.0.channel'
             // @param {string} options - `{recursive: true}`
             // @param {function} callback - `function (error)`

package/lib/socketCommon.js

@@ -271,11 +271,9 @@ class SocketCommon {
 
         this._updateConnectedInfo();
 
-        const commands = this.commands.getCommandHandler();
-
-        if (!commands['name']) {
+        if (!this.commands.getCommandHandler('name')) {
             // socket sends its name => update list of sockets
-            commands['name'] = (_socket, name, cb) => {
+            this.addCommandHandler('name', (_socket, name, cb) => {
                 this.adapter.log.debug(`Connection from "${name}"`);
                 if (_socket._name === undefined) {
                     _socket._name = name;
@@ -287,7 +285,7 @@ class SocketCommon {
                 }
 
                 typeof cb === 'function' && cb();
-            };
+            });
         }
 
         this.commands.applyCommands(socket);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",
@@ -21,13 +21,13 @@
     "url": "https://github.com/ioBroker/ioBroker.socket-classes"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^2.6.7",
+    "@iobroker/adapter-core": "^2.6.8",
     "passport": "^0.6.0",
     "cookie-parser": "^1.4.6",
-    "axios": "^1.3.4"
+    "axios": "^1.4.0"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.9",
+    "@alcalzone/release-script": "^3.6.0",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
     "iobroker.js-controller": "dev",
     "gulp": "^4.0.2",
@@ -51,6 +51,7 @@
     "release-patch": "release-script patch --yes",
     "release-minor": "release-script minor --yes",
     "release-major": "release-script major --yes",
+    "update-packages": "ncu --upgrade",
     "docs": "gulp"
   },
   "license": "MIT",