Merge pull request #1549 from PeterVoronov/selector_to_array

This PR is implementing the another "result" function for the `$` (`selector`) function .
ioBroker · May 3, 2024 · 5bd97ac · 5bd97ac
2 parents 25bcb85 + 973646e
commit 5bd97ac
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 1 deletion.
diff --git a/docs/en/javascript.md b/docs/en/javascript.md
@@ -1352,6 +1352,7 @@ Sends to an adapter the message `unsubscribe` to inform adapter to not poll the
 ### $ - Selector
 ```js
 $(selector).on(function(obj) {});
+$(selector).toArray();
 $(selector).each(function(id, i) {});
 $(selector).setState(value, ack);
 $(selector).getState();
@@ -1396,7 +1397,7 @@ Find all channels with `common.role="switch"` and belongs to `enum.rooms.Wohnzim
 Take all their states, where id ends with `".STATE"` and make subscription on all these states.
 If some of these states change, the callback will be called like for "on" function.
 
-Following functions are possible, setState, getState (only from first), on, each
+Following functions are possible, setState, getState (only from first), on, each, toArray
 
 ```js
 // Switch on all switches in "Wohnzimmer"
@@ -1413,6 +1414,11 @@ $('channel[role=switch][state.id=*.STATE](rooms=Wohnzimmer)').each((id, i) => {
     }
 });
 ```
+Or you can get a an usual array of ids and process it your own way:
+```js
+// get some state and filter only which has an `true` value
+const enabled = $('channel[role=switch][state.id=*.STATE](rooms=Wohnzimmer)').toArray().filter((id) => getState(id)?.val === true);
+```
 
 ### readFile
 ```js

diff --git a/lib/javascript.d.ts b/lib/javascript.d.ts
@@ -1043,6 +1043,11 @@ declare global {
 			/** Contains the error if one happened */
 			error?: string;
 
+			/**
+			 * Return the result as an array of state ids
+			 */
+			toArray(): Array<string>;
+
 			/**
 			 * Executes a function for each state id in the result array
 			 * The execution is canceled if a callback returns false

diff --git a/lib/sandbox.js b/lib/sandbox.js
@@ -647,6 +647,9 @@ function sandBox(script, name, verbose, debug, context) {
             // If some error in the selector
             if (selectorHasInvalidType || isInsideEnumString || isInsideCommonString || isInsideNativeString) {
                 result.length = 0;
+                result.toArray = function () {
+                    return [];
+                };
                 result.each = function () {
                     return this;
                 };
@@ -936,6 +939,9 @@ function sandBox(script, name, verbose, debug, context) {
                     yield result[i];
                 }
             };
+            result.toArray = function () {
+                return [...resUnique];
+            };
             result.each = function (callback) {
                 if (typeof callback === 'function') {
                     let r;

diff --git a/test/testFunctions.js b/test/testFunctions.js
@@ -1,4 +1,5 @@
 const expect = require('chai').expect;
+const { log } = require('node:console');
 const setup  = require('./lib/setup');
 
 let objects  = null;
@@ -927,6 +928,46 @@ describe.only('Test JS', function () {
         objects.setObject(script._id, script);
     });
 
+    it('Test JS: test $().toArray()', function (done) {
+        this.timeout(1000);
+        // add script
+        const script = {
+            _id:                'script.js.selectorToArray',
+            type:               'script',
+            common: {
+                name:           'selectorToArray',
+                enabled:        true,
+                verbose:        true,
+                engine:         'system.adapter.javascript.0',
+                engineType:     'Javascript/js',
+                source:         `createState('selector.test_1.state', true, () => {\n` +
+                                `    createState('selector.test_2.state', false, () => {\n` +
+                                `        createState('selector.test_3.state', true, () => {\n` +
+                                `            $(createState('selector.test_4.id', true, () => {\n` +
+                                `                const states = $('state[id=javascript.0.selector.test_*.state]')` +
+                                `                   .toArray().filter((id) => getState(id)?.val === true);\n` +
+                                `                if (Array.isArray(states)) {\n` +
+                                `                    createState('selector.result', states.length, true);\n` +
+                                `                }\n` +
+                                `            }));\n` +
+                                `        });\n` +
+                                `    });\n` +
+                                `});`,
+            },
+            native: {}
+        };
+
+        const onStateChanged = function (id, state){
+            if (id !== 'javascript.0.selector.result') return;
+            removeStateChangedHandler(onStateChanged);
+            expect(state.val).to.be.equal(2);
+            done();
+        };
+        addStateChangedHandler(onStateChanged);
+        objects.setObject(script._id, script);
+    });
+
+
     it('Test JS: test stopScript', function (done) {
         this.timeout(5000);
         // add script