@iobroker/socket-classes 0.5.4 → 1.0.2

package/README.md

@@ -85,8 +85,8 @@ io.close();
 * [unsubscribeObjects](#unsubscribeobjects_w)
 * [getObjectView](#getobjectview_w)
 * [setObject](#setobject_w)
-* [getStates](#getstates_w)
 * [delObject](#delobject_w)
+* [getStates](#getstates_w)
 * [getState](#getstate_w)
 * [setState](#setstate_w)
 * [getBinaryState](#getbinarystate_w)
@@ -210,17 +210,17 @@ Set object.
 * obj *(object)*: object itself
 * callback *(function)*: `function (error)`
 
-### <a name="getstates_w"></a>getStates(pattern, callback)
-Read states by pattern
-* pattern *(string)*: optional pattern, like `system.adapter.*` or array of state IDs
-* callback *(function)*: `function (error, states)`, where `states` is an object like `{'system.adapter.history.0': {_id: 'system.adapter.history.0', common: {name: 'history', ...}, native: {...}, 'system.adapter.history.1': {...}}}`
-
 ### <a name="delobject_w"></a>delObject(id, options, callback)
 Delete object. Only deletion of flot objects is allowed
 * id *(string)*: Object ID like, 'flot.0.myChart'
 * options *(string)*: ignored
 * callback *(function)*: `function (error)`
 
+### <a name="getstates_w"></a>getStates(pattern, callback)
+Read states by pattern
+* pattern *(string)*: optional pattern, like `system.adapter.*` or array of state IDs
+* callback *(function)*: `function (error, states)`, where `states` is an object like `{'system.adapter.history.0': {_id: 'system.adapter.history.0', common: {name: 'history', ...}, native: {...}, 'system.adapter.history.1': {...}}}`
+
 ### <a name="getstate_w"></a>getState(id, callback)
 Read one state.
 * id *(string)*: State ID like, 'system.adapter.admin.0.memRss'
@@ -424,10 +424,10 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 * [unsubscribeObjects](#unsubscribeobjects_a)
 * [getObjectView](#getobjectview_a)
 * [setObject](#setobject_a)
+* [delObject](#delobject_a)
 * [getAllObjects](#getallobjects_a)
 * [extendObject](#extendobject_a)
 * [getForeignObjects](#getforeignobjects_a)
-* [delObject](#delobject_a)
 * [delObjects](#delobjects_a)
 * [getStates](#getstates_a)
 * [getState](#getstate_a)
@@ -684,6 +684,12 @@ Set object.
 * obj *(object)*: object itself
 * callback *(function)*: `function (error)`
 
+### <a name="delobject_a"></a>delObject(id, options, callback)
+Delete 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)`
+
 ### <a name="getallobjects_a"></a>getAllObjects(callback)
 Read absolutely all objects
 * callback *(function)*: `function (error, objects)`, where `objects` is an object like `{'system.adapter.admin.0': {...}, 'system.adapter.web.0': {...}}`
@@ -700,12 +706,6 @@ Read objects by pattern
 * type *(string)*: type of objects to delete, like `state`, `channel`, `device`, `host`, `adapter`. Default - `state`
 * callback *(function)*: `function (error, objects)`, where `objects` is an object like `{'system.adapter.admin.0': {...}, 'system.adapter.web.0': {...}}`
 
-### <a name="delobject_a"></a>delObject(id, options, callback)
-Delete object. Only deletion of flot objects is allowed
-* id *(string)*: Object ID like, 'flot.0.myChart'
-* options *(string)*: ignored
-* callback *(function)*: `function (error)`
-
 ### <a name="delobjects_a"></a>delObjects(id, options, callback)
 Delete objects recursively. Objects with `dontDelete` cannot be deleted. Same as `delObject` but with `recursive: true`.
 * id *(string)*: Object ID like, 'adapterName.0.channel'
@@ -760,9 +760,8 @@ Unsubscribe from state changes by pattern. Same as `unsubscribe`.
 * callback *(function)*: `function (error)`
 
 ### <a name="getforeignstates_a"></a>getForeignStates(pattern, callback)
-Change user password
-* user *(string)*: user name, like 'benjamin`
-* pass *(string)*: new password
+Read all states (which might not belong to this adapter) which match the given pattern
+* pattern *(string)*: pattern like
 * callback *(function)*: `function (error)`
 
 ### <a name="readfile_a"></a>readFile(_adapter, fileName, callback)
@@ -883,6 +882,15 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 -->
 
 ## Changelog
+### 1.0.2 (2022-11-08)
+* (bluefox) Function `getObjects`for web was extended by devices, channels and enums
+
+### 1.0.1 (2022-10-10)
+* (bluefox) Fixed error with delObject
+
+### 0.5.5 (2022-10-09)
+* (Apollon77) Prepare for future js-controller versions
+
 ### 0.5.4 (2022-09-23)
 * (bluefox) Fixed error in `delObjects` method
 

package/lib/socketCommands.js

@@ -1,21 +1,7 @@
+const utils = require('@iobroker/adapter-core'); // Get common adapter utils
+const pattern2RegEx = utils.commonTools.pattern2RegEx;
 let axios = null;
-let zipFiles;
-
-// taken from here: https://github.com/ioBroker/ioBroker.js-controller/blob/master/packages/common/src/lib/common/tools.ts#L2386
-/**
- * Converts ioB pattern into regex.
- * @param pattern - Regex string to use it in new RegExp(pattern)
- */
-function pattern2RegEx(pattern) {
-    pattern = (pattern || '').toString();
-
-    const startsWithWildcard = pattern[0] === '*';
-    const endsWithWildcard = pattern[pattern.length - 1] === '*';
-
-    pattern = pattern.replace(/[-/\\^$+?.()|[\]{}]/g, '\\$&').replace(/\*/g, '.*');
-
-    return (startsWithWildcard ? '' : '^') + pattern + (endsWithWildcard ? '' : '$');
-}
+let zipFiles = null;
 
 class SocketCommands {
     static ERROR_PERMISSION = 'permissionError';
@@ -717,10 +703,6 @@ class SocketCommands {
             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
                 if (command === 'writeDirAsZip' && message && message.data.length > 1024 * 1024) {
-                    if (!zipFiles) {
-                        const utils = require('@iobroker/adapter-core'); // Get common adapter utils
-                        zipFiles = require(utils.controllerDir + '/lib/zipFiles.js');
-                    }
                     let buffer;
                     try {
                         buffer = Buffer.from(message.data, 'base64');
@@ -729,6 +711,8 @@ class SocketCommands {
                         return callback && callback({error: `Cannot convert data: ${error.toString()}`});
                     }
 
+                    zipFiles = zipFiles || utils.commonTools.zipFiles;
+
                     zipFiles
                         .writeDirAsZip(
                             this.adapter, // normally we have to pass here the internal "objects" object, but as
@@ -1210,27 +1194,6 @@ class SocketCommands {
             }
         };
 
-        // this function is overloaded in admin
-        this.commands['delObject'] = (socket, id, options, callback) => {
-            // Delete object. Only deletion of flot objects is allowed
-            // @param {string} id - Object ID like, 'flot.0.myChart'
-            // @param {string} options - ignored
-            // @param {function} callback - `function (error)`
-            if (id.startsWith('flot.')) {
-                if (this._checkPermissions(socket, 'delObject', callback, id)) {
-                    try {
-                        this.adapter.delForeignObject(id, {user: socket._acl.user}, (error, ...args) =>
-                            SocketCommands._fixCallback(callback, error, ...args));
-                    } catch (error) {
-                        this.adapter.log.error('[delObject] ERROR: ' + error.toString());
-                       SocketCommands._fixCallback(callback, error);
-                    }
-                }
-            } else {
-                SocketCommands._fixCallback(callback, SocketCommands.ERROR_PERMISSION);
-            }
-        };
-
         this.commands['getState'] = (socket, id, callback) => {
             // Read one state.
             // @param {string} id - State ID like, 'system.adapter.admin.0.memRss'
@@ -1356,26 +1319,28 @@ class SocketCommands {
             // @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.
             // @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['unsubscribe'] = (socket, pattern, callback) => {
             // Unsubscribe from state changes by pattern.
             // @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._unsubscribeStates(socket, pattern, callback);
-        }
+        };
+
         this.commands['unsubscribeStates'] = (socket, pattern, callback) => {
             // Unsubscribe from state changes by pattern. Same as `unsubscribe`.
             // @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._unsubscribeStates(socket, pattern, callback);
-        }
+        };
     }
 
     __initCommandsObjects() {
@@ -1400,24 +1365,35 @@ class SocketCommands {
         };
 
         // not admin version of "all objects"
+        // this function is overloaded in admin
         this.commands['getObjects'] = (socket, callback) => {
             // Get all objects that are relevant for web: all states and enums with rooms
             // @param {string} id - object ID.
             // @param {function} callback - `function (error, obj)`
             if (this._checkPermissions(socket, 'getObjects', callback)) {
                 try {
-                    this.adapter.getForeignObjects('*', 'state', 'rooms', {user: socket._acl.user}, (error, objs) => {
-                        if (typeof callback === 'function') {
+                    if (typeof callback === 'function') {
+                        this.adapter.getForeignObjects('*', 'state', 'rooms', {user: socket._acl.user}, async (error, objs) => {
+                            try {
+                                const channels = await this.adapter.getForeignObjectsAsync('*', 'channel', null, {user: socket._acl.user});
+                                const devices = await this.adapter.getForeignObjectsAsync('*', 'device', null, {user: socket._acl.user});
+                                const enums = await this.adapter.getForeignObjectsAsync('*', 'enum', null, {user: socket._acl.user});
+                                const config = await this.adapter.getForeignObjectAsync('system.config', {user: socket._acl.user});
+                                Object.assign(objs, channels, devices, enums);
+                                objs['system.config'] = config;
+                            } catch (e) {
+                                this.adapter.log.error('[getObjects] ERROR: ' + e.toString());
+                            }
                             // overload language
                             if (this.adapter._language && objs['system.config'] && objs['system.config'].common) {
                                 objs['system.config'].common.language = this.adapter._language;
                             }
 
                             SocketCommands._fixCallback(callback, error, objs);
-                        } else {
-                            this.adapter.log.warn('[getObjects] Invalid callback');
-                        }
-                    });
+                        });
+                    } else {
+                        this.adapter.log.warn('[getObjects] Invalid callback');
+                    }
                 } catch (error) {
                     this.adapter.log.error('[getObjects] ERROR: ' + error.toString());
                     SocketCommands._fixCallback(callback, error);
@@ -1508,6 +1484,27 @@ class SocketCommands {
                 }
             }
         };
+
+        // this function is overloaded in admin
+        this.commands['delObject'] = (socket, id, options, callback) => {
+            // Delete object. Only deletion of flot objects is allowed
+            // @param {string} id - Object ID like, 'flot.0.myChart'
+            // @param {string} options - ignored
+            // @param {function} callback - `function (error)`
+            if (id.startsWith('flot.')) {
+                if (this._checkPermissions(socket, 'delObject', callback, id)) {
+                    try {
+                        this.adapter.delForeignObject(id, {user: socket._acl.user}, (error, ...args) =>
+                            SocketCommands._fixCallback(callback, error, ...args));
+                    } catch (error) {
+                        this.adapter.log.error('[delObject] ERROR: ' + error.toString());
+                        SocketCommands._fixCallback(callback, error);
+                    }
+                }
+            } else {
+                SocketCommands._fixCallback(callback, SocketCommands.ERROR_PERMISSION);
+            }
+        };
     }
 
     _initCommands() {

package/lib/socketCommandsAdmin.js

@@ -1162,9 +1162,8 @@ class SocketCommandsAdmin extends SocketCommands {
         super.__initCommandsStates();
 
         this.commands['getForeignStates'] = (socket, pattern, callback) => {
-            // Change user password
-            // @param {string} user - user name, like 'benjamin`
-            // @param {string} pass - new password
+            // Read all states (which might not belong to this adapter) which match the given pattern
+            // @param {string} pattern - pattern like
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'getStates', callback)) {
                 if (typeof callback === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "0.5.4",
+  "version": "1.0.2",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",
@@ -21,6 +21,7 @@
     "url": "https://github.com/ioBroker/ioBroker.socket-classes"
   },
   "dependencies": {
+    "@iobroker/adapter-core": "^2.6.7",
     "passport": "^0.6.0",
     "cookie-parser": "^1.4.6",
     "axios": "^0.27.2"
@@ -28,9 +29,10 @@
   "devDependencies": {
     "@alcalzone/release-script": "^3.5.9",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
+    "iobroker.js-controller": "dev",
     "gulp": "^4.0.2",
-    "chai": "^4.3.6",
-    "mocha": "^10.0.0"
+    "chai": "^4.3.7",
+    "mocha": "^10.1.0"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.web/issues"