@iobroker/socket-classes 1.4.4 → 1.5.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-2023 bluefox <dogafox@gmail.com>
+Copyright (c) 2020-2024 bluefox <dogafox@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -740,8 +740,9 @@ Get one object
 * id *(string)*: object ID.
 * callback *(function)*: `function (error, obj)`
 
-### <a name="getobjects_a"></a>getObjects(callback)
+### <a name="getobjects_a"></a>getObjects(list, callback)
 Read absolutely all objects. Same as `getAllObjects`.
+* list *(string[])*: optional list of IDs.
 * 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)
@@ -978,6 +979,12 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 -->
 
 ## Changelog
+### 1.5.0 (2024-02-22)
+* (bluefox) Extended getObjects function with the possibility to read the list of IDs in admin
+
+### 1.4.6 (2023-10-19)
+* (bluefox) Added `publishInstanceMessageAll` command
+
 ### 1.4.4 (2023-10-11)
 * (bluefox) Caught errors by subscribe/unsubscribe
 
@@ -1113,7 +1120,7 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 ## License
 The MIT License (MIT)
 
-Copyright (c) 2020-2023 Bluefox <dogafox@gmail.com>
+Copyright (c) 2020-2024 Bluefox <dogafox@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/socketAdmin.js

@@ -140,27 +140,24 @@ class SocketAdmin extends SocketCommon {
     stateChange(id, state) {
         this.commands.stateChange(id, state);
 
-        if (this.server && this.server.sockets) {
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
+        const sockets = this.getSocketsList();
+        if (sockets) {
             sockets.forEach(socket =>
                 this.commands.publish(socket, 'stateChange', id, state));
         }
     }
 
     fileChange(id, fileName, size) {
-        if (this.server && this.server.sockets) {
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
+        const sockets = this.getSocketsList();
+        if (sockets) {
             sockets.forEach(socket =>
                 this.commands.publishFile(socket, id, fileName, size));
         }
     }
 
     repoUpdated() {
-        if (this.server && this.server.sockets) {
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
+        const sockets = this.getSocketsList();
+        if (sockets) {
             sockets.forEach(socket =>
                 this.__updateSession(socket));
 
@@ -169,9 +166,8 @@ class SocketAdmin extends SocketCommon {
     }
 
     objectChange(id, obj) {
-        if (this.server && this.server.sockets) {
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
+        const sockets = this.getSocketsList();
+        if (sockets) {
             sockets.forEach(socket =>
                 this.commands.publish(socket, 'objectChange', id, obj));
         }
@@ -186,13 +182,14 @@ class SocketAdmin extends SocketCommon {
     }
 
     sendCommand(obj) {
-        if (this.commands.sendCommand(obj) && this.server && this.server.sockets) {
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+        if (this.commands.sendCommand(obj)) {
+            const sockets = this.getSocketsList();
+            if (sockets) {
+                sockets.forEach(socket =>
+                    this.__updateSession(socket));
 
-            sockets.forEach(socket =>
-                this.__updateSession(socket));
-
-            this.server.sockets.emit(obj.command, obj.message.id, obj.message.data);
+                this.server.sockets.emit(obj.command, obj.message.id, obj.message.data);
+            }
         }
     }
 

package/lib/socketCommandsAdmin.js

@@ -203,8 +203,8 @@ class SocketCommandsAdmin extends SocketCommands {
                 if (error.response) {
                     throw new Error(
                         (error.response.data && error.response.data.error) ||
-                            error.response.data ||
-                            error.response.status
+                        error.response.data ||
+                        error.response.status
                     );
                 } else if (error.request) {
                     throw new Error('no response');
@@ -1204,16 +1204,16 @@ class SocketCommandsAdmin extends SocketCommands {
             if (this._checkPermissions(socket, 'getObject', callback)) {
                 this.adapter.getForeignObject('system.repositories', { user: socket._acl.user }, (error, obj) => {
                     obj &&
-                        obj.native &&
-                        obj.native.repositories &&
-                        Object.keys(obj.native.repositories).forEach(name => {
-                            if (obj.native.repositories[name].json) {
-                                // limit information to _repoInfo
-                                obj.native.repositories[name].json = {
-                                    _repoInfo: obj.native.repositories[name].json._repoInfo
-                                };
-                            }
-                        });
+                    obj.native &&
+                    obj.native.repositories &&
+                    Object.keys(obj.native.repositories).forEach(name => {
+                        if (obj.native.repositories[name].json) {
+                            // limit information to _repoInfo
+                            obj.native.repositories[name].json = {
+                                _repoInfo: obj.native.repositories[name].json._repoInfo
+                            };
+                        }
+                    });
                     callback(error, obj);
                 });
             }
@@ -1227,13 +1227,13 @@ class SocketCommandsAdmin extends SocketCommands {
                     // Extract only the version and icon
                     const result = {};
                     data &&
-                        Object.keys(data).forEach(
-                            name =>
-                                (result[name] = {
-                                    version: data[name].version,
-                                    icon: data[name].extIcon
-                                })
-                        );
+                    Object.keys(data).forEach(
+                        name =>
+                            (result[name] = {
+                                version: data[name].version,
+                                icon: data[name].extIcon
+                            })
+                    );
                     callback(result);
                 });
             }
@@ -1333,10 +1333,32 @@ class SocketCommandsAdmin extends SocketCommands {
         };
 
         // Identical to getAllObjects
-        this.commands['getObjects'] = (socket, callback) => {
+        this.commands['getObjects'] = (socket, list, callback) => {
             // Read absolutely all objects. Same as `getAllObjects`.
+            // @param {string[]} list - optional list of IDs.
             // @param {function} callback - `function (error, objects)`, where `objects` is an object like `{'system.adapter.admin.0': {...}, 'system.adapter.web.0': {...}}`
-            return this._getAllObjects(socket, 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 {
+                return this._getAllObjects(socket, callback);
+            }
         };
 
         this.commands['extendObject'] = (socket, id, obj, callback) => {

package/lib/socketCommon.js

@@ -198,9 +198,10 @@ class SocketCommon {
     _unsubscribeAll() {
         if (this.server && this.server.ioBroker) {
             // this could be an object or array
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
-            Object.keys(sockets).forEach(i => this.commands.unsubscribeSocket(sockets[i]));
+            const sockets = this.getSocketsList();
+            if (sockets) {
+                Object.keys(sockets).forEach(i => this.commands.unsubscribeSocket(sockets[i]));
+            }
         } else if (this.server && this.server.sockets) {
             for (const socket in this.server.sockets) {
                 if (Object.prototype.hasOwnProperty.call(this.server.sockets, socket)) {
@@ -383,10 +384,9 @@ class SocketCommon {
 
                 if (this.server) {
                     const clientsArray = [];
-                    if (this.server.sockets) {
+                    const sockets = this.getSocketsList();
+                    if (sockets) {
                         // this could be an object or array
-                        const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
                         Object.keys(sockets).forEach(i => clientsArray.push(sockets[i]._name || 'noname'));
                     }
                     const text = `[${clientsArray.length}]${clientsArray.join(', ')}`;
@@ -423,15 +423,33 @@ class SocketCommon {
         return this.commands.publishFile(socket, id, fileName, size);
     }
 
+    getSocketsList() {
+        if (this.server && this.server.sockets) {
+            // this could be an object or array
+            return this.server.sockets.sockets || this.server.sockets.connected;
+        }
+        return null;
+    }
+
+    publishInstanceMessageAll(sourceInstance, messageType, sid, data) {
+        const sockets = this.getSocketsList();
+        if (sockets) {
+            Object.keys(sockets).forEach(i => {
+                if (sockets[i].id === sid) {
+                    this.publishInstanceMessage(sockets[i], sourceInstance, messageType, data);
+                }
+            });
+        }
+    }
+
     close() {
         this._unsubscribeAll();
 
         this.commands.destroy();
 
-        if (this.server && this.server.sockets) {
+        const sockets = this.getSocketsList();
+        if (sockets) {
             // this could be an object or array
-            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
-
             Object.keys(sockets).forEach(i => {
                 const socket = sockets[i];
                 if (socket._sessionTimer) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",
@@ -21,19 +21,19 @@
     "url": "https://github.com/ioBroker/ioBroker.socket-classes"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.0.3",
-    "axios": "^1.5.1",
+    "@iobroker/adapter-core": "^3.0.4",
+    "axios": "^1.6.7",
     "cookie-parser": "^1.4.6",
-    "passport": "^0.6.0"
+    "passport": "^0.7.0"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.6.0",
-    "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@foxriver76/eslint-config": "^1.0.1",
-    "chai": "^4.3.10",
+    "@alcalzone/release-script": "^3.7.0",
+    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@foxriver76/eslint-config": "^1.0.2",
+    "chai": "^4.4.1",
     "gulp": "^4.0.2",
     "iobroker.js-controller": "dev",
-    "mocha": "^10.2.0"
+    "mocha": "^10.3.0"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.web/issues"