@iobroker/socket-classes 1.1.5 → 1.3.1

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

@@ -65,7 +65,7 @@ class SocketCommon {
 
         this.settings.ttl = parseInt(this.settings.ttl, 10) || 3600;
 
-        // it can be used as client too for cloud
+        // it can be used as a client too for cloud
         if (socketClass) {
             if (!server.__inited) {
                 if (typeof socketClass.listen === 'function') {
@@ -88,7 +88,7 @@ class SocketCommon {
                 this.__initAuthentication(authOptions);
             }
 
-            // Enable cross domain access
+            // Enable cross-domain access
             // deprecated, because no more used in socket.io@4 only(in @2)
             if (this.settings.crossDomain && this.server.set) {
                 this.server.set('origins', '*:*');
@@ -111,9 +111,9 @@ class SocketCommon {
                 if ((error && error.message && error.message.includes('authentication failed') ||
                     (details && details.toString().includes('authentication failed')))
                 ) {
-                    this.adapter.log.debug(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ' - ' + details : ''}`);
+                    this.adapter.log.debug(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ` - ${details}` : ''}`);
                 } else {
-                    this.adapter.log.error(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ' - ' + details : ''}`);
+                    this.adapter.log.error(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ` - ${details}` : ''}`);
                 }
             }
         });
@@ -123,9 +123,9 @@ class SocketCommon {
             // ignore "failed connection" as it already shown
             if (!error || !error.message || !error.message.includes('failed connection')) {
                 if (error && error.message && error.message.includes('authentication failed')) {
-                    this.adapter.log.debug(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ' - ' + details : ''}`);
+                    this.adapter.log.debug(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ` - ${details}` : ''}`);
                 } else {
-                    this.adapter.log.error(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ' - ' + details : ''}`);
+                    this.adapter.log.error(`Error: ${(error && error.message) || JSON.stringify(error)}${details ? ` - ${details}` : ''}`);
                 }
             }
         });
@@ -201,17 +201,17 @@ class SocketCommon {
             return address;
         }
 
-        // check if address is IPv4
+        // check if the address is IPv4
         const addressParts = address.split('.');
         if (addressParts.length !== 4) {
             return null;
         }
 
-        // do we have settings for wild carded ips?
+        // do we have settings for wild-carded ips?
         const wildCardIps = Object.keys(whiteList).filter(key => key.includes('*'));
 
         if (!wildCardIps.length) {
-            // no wild carded ips => no ip configured
+            // no wild-carded ips => no ip configured
             return null;
         }
 
@@ -253,7 +253,7 @@ class SocketCommon {
                 });
 
                 if (whiteListAcl.user !== 'auth') {
-                    acl.user = 'system.user.' + whiteListAcl.user;
+                    acl.user = `system.user.${whiteListAcl.user}`;
                 }
             }
         }
@@ -391,6 +391,10 @@ class SocketCommon {
         return this.commands.publish(socket, type, id, obj);
     }
 
+    publishInstanceMessage(socket, sourceInstance, messageType, data) {
+        return this.commands.publishInstanceMessage(socket, sourceInstance, messageType, data);
+    }
+
     publishFile(socket, id, fileName, size) {
         return this.commands.publishFile(socket, id, fileName, size);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "1.1.5",
+  "version": "1.3.1",
   "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": "^3.0.3",
     "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",