npm - smart-home-engine - Versions diffs - 1.15.1 → 1.17.0 - Mend

smart-home-engine 1.15.1 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/dist/web/assets/index-BWK6XOv0.js +234 -0
package/dist/web/assets/{index-LTpStzqg.css → index-C-4azUYf.css} +1 -1
package/dist/web/assets/{tsMode-acXHtETC.js → tsMode-WXSFC0ZU.js} +1 -1
package/dist/web/index.html +2 -2
package/package.json +1 -1
package/src/sandbox/shedb-sandbox.js +56 -1
package/src/web/broker-api.js +144 -0
package/src/web/shedb.js +29 -2
package/dist/web/assets/index-Vw4M_nL7.js +0 -232

package/dist/web/assets/{tsMode-acXHtETC.js → tsMode-WXSFC0ZU.js} RENAMED Viewed

@@ -1,4 +1,4 @@
-import{m as O}from"./monaco-langs-Dt8a9eeo.js";import{t as I}from"./index-Vw4M_nL7.js";/*!-----------------------------------------------------------------------------
+import{m as O}from"./monaco-langs-Dt8a9eeo.js";import{t as I}from"./index-BWK6XOv0.js";/*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Version: 0.52.2(404545bded1df6ffa41ea0af4e8ddb219018c6c1)
  * Released under the MIT license

package/dist/web/index.html CHANGED Viewed

@@ -172,10 +172,10 @@
                 }
             })();
         </script>
-      <script type="module" crossorigin src="/assets/index-Vw4M_nL7.js"></script>
+      <script type="module" crossorigin src="/assets/index-BWK6XOv0.js"></script>
       <link rel="modulepreload" crossorigin href="/assets/monaco-langs-Dt8a9eeo.js">
       <link rel="stylesheet" crossorigin href="/assets/monaco-langs-DyX1CsEw.css">
-      <link rel="stylesheet" crossorigin href="/assets/index-LTpStzqg.css">
+      <link rel="stylesheet" crossorigin href="/assets/index-C-4azUYf.css">
     </head>
     <body>
         <div id="app"></div>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "smart-home-engine",
-    "version": "1.15.1",
+    "version": "1.17.0",
     "description": "Node.js based script runner for use in MQTT based Smart Home environments",
     "main": "src/index.js",
     "scripts": {

package/src/sandbox/shedb-sandbox.js CHANGED Viewed

@@ -13,9 +13,12 @@
  *   she.db.prop(id, method, prop, val)→ void  (method: 'set'|'create'|'del')
  *   she.db.sub(pattern, callback)     → void  (callback(id, doc))
  *   she.db.query(filter, mapFn, reduceFn) → Array (ad-hoc synchronous query)
+ *   she.db.getView(id)                → Array|undefined (current view result)
+ *   she.db.subView(pattern, callback) → void  (callback(id, result))
+ *   she.db.setView(id, definition)    → void  (create/update named view)
  */
-const { getCore, addListener, removeListenersByScript } = require('../web/shedb');
+const { getCore, addListener, removeListenersByScript, addViewListener, removeViewListenersByScript } = require('../web/shedb');
 module.exports = function (she, { scriptDomain, scriptName, scriptFile }) {
     const core = getCore();
@@ -80,6 +83,57 @@ module.exports = function (she, { scriptDomain, scriptName, scriptFile }) {
             if (!core) return [];
             return core.adhocQuery(filter, mapFn, reduceFn);
         },
+        /**
+         * Return the current computed result array for a named view, or undefined if
+         * the view does not exist, has not yet completed, or produced an error.
+         *
+         * @param {string} id - view name
+         * @returns {Array|undefined}
+         */
+        getView(id) {
+            if (!core) return undefined;
+            const view = core.views[id];
+            if (!view || view.error) return undefined;
+            return view.result;
+        },
+        /**
+         * Subscribe to view result changes matching an MQTT wildcard pattern.
+         * callback(id, result) fires whenever a matching view's result changes;
+         * result is undefined if the view errored.
+         * Subscriptions are automatically removed when the script is hot-reloaded.
+         *
+         * @param {string}   pattern  - MQTT wildcard, e.g. 'stats/#'
+         * @param {Function} callback - called as callback(id, result)
+         */
+        subView(pattern, callback) {
+            if (!core) return;
+            const wrapped = scriptDomain.bind(callback);
+            addViewListener(pattern, wrapped, trackingKey);
+        },
+        /**
+         * Create or update a named persistent view.
+         * Definition: { map, filter?, reduce?, publish?, retain?, description? }
+         * `publish` maps to `mqttpub` internally.
+         *
+         * @param {string} id
+         * @param {{ map: string, filter?: string, reduce?: string, publish?: boolean, retain?: boolean, description?: string }} definition
+         */
+        setView(id, definition) {
+            if (!core) return;
+            if (!definition || typeof definition !== 'object') return;
+            const { map, filter, reduce, publish, retain, description } = definition;
+            if (typeof map !== 'string' || !map.trim()) return;
+            const payload = { map };
+            if (filter) payload.filter = filter;
+            if (reduce) payload.reduce = reduce;
+            if (publish) payload.mqttpub = true;
+            if (retain) payload.retain = true;
+            if (description) payload.description = String(description).slice(0, 500);
+            core.query(id, payload);
+        },
     };
 };
@@ -89,4 +143,5 @@ module.exports = function (she, { scriptDomain, scriptName, scriptFile }) {
  */
 module.exports.cleanup = function (scriptFile) {
     removeListenersByScript(scriptFile);
+    removeViewListenersByScript(scriptFile);
 };

package/src/web/broker-api.js CHANGED Viewed

@@ -950,6 +950,150 @@ router.get('/logs', (req, res) => {
     res.json(limit >= all.length ? all : all.slice(-limit));
 });
+// ── Password file management ──────────────────────────────────────────────────
+/** POSIX shell-safe single-quote escaping for SSH commands */
+function shellArg(s) {
+    return "'" + String(s).replace(/'/g, "'\\''") + "'";
+}
+/**
+ * GET /she/broker/passwd?file=<path>
+ * List usernames from a mosquitto password file.
+ */
+router.get('/passwd', async (req, res) => {
+    try {
+        const bc = getBrokerConfig(req);
+        const file = String(req.query.file || '').trim();
+        if (!file || !file.startsWith('/')) return res.status(400).json({ error: 'absolute file path required' });
+        let text = '';
+        if (bc.ssh && bc.ssh.host) {
+            const result = await sshDeploy.runCommand(bc.ssh, `sudo cat -- ${shellArg(file)} 2>/dev/null || true`);
+            text = result.stdout;
+        } else {
+            try {
+                text = fs.readFileSync(file, 'utf8');
+            } catch (e) {
+                if (e.code !== 'ENOENT') throw e;
+            }
+        }
+        const users = text
+            .split('\n')
+            .filter((l) => l.includes(':'))
+            .map((l) => l.split(':')[0])
+            .filter(Boolean);
+        res.json({ users });
+    } catch (err) {
+        handleError(res, err);
+    }
+});
+/**
+ * POST /she/broker/passwd
+ * Add or update a user in a mosquitto password file.
+ * Body: { file, username, password }
+ */
+router.post('/passwd', async (req, res) => {
+    try {
+        const bc = getBrokerConfig(req);
+        const { file, username, password } = req.body;
+        if (!file || typeof file !== 'string' || !file.startsWith('/')) return res.status(400).json({ error: 'absolute file path required' });
+        if (!username || typeof username !== 'string') return res.status(400).json({ error: 'username required' });
+        if (!password || typeof password !== 'string') return res.status(400).json({ error: 'password required' });
+        if (/[:\n\r]/.test(username)) return res.status(400).json({ error: 'invalid username' });
+        if (bc.ssh && bc.ssh.host) {
+            const cmd = `sudo mosquitto_passwd -b ${shellArg(file)} ${shellArg(username)} ${shellArg(password)}`;
+            await sshDeploy.runCommand(bc.ssh, cmd);
+        } else {
+            await execFileAsync('mosquitto_passwd', ['-b', file, username, password]);
+        }
+        res.json({ ok: true });
+    } catch (err) {
+        handleError(res, err);
+    }
+});
+/**
+ * DELETE /she/broker/passwd/:user
+ * Delete a user from a mosquitto password file.
+ * Body: { file }
+ */
+router.delete('/passwd/:user', async (req, res) => {
+    try {
+        const bc = getBrokerConfig(req);
+        const { file } = req.body;
+        const username = req.params.user;
+        if (!file || typeof file !== 'string' || !file.startsWith('/')) return res.status(400).json({ error: 'absolute file path required' });
+        if (bc.ssh && bc.ssh.host) {
+            const cmd = `sudo mosquitto_passwd -D ${shellArg(file)} ${shellArg(username)}`;
+            await sshDeploy.runCommand(bc.ssh, cmd);
+        } else {
+            await execFileAsync('mosquitto_passwd', ['-D', file, username]);
+        }
+        res.json({ ok: true });
+    } catch (err) {
+        handleError(res, err);
+    }
+});
+// ── ACL file management ───────────────────────────────────────────────────────
+/**
+ * GET /she/broker/acl?file=<path>
+ * Read a mosquitto ACL file (static file, not dynsec).
+ */
+router.get('/acl', async (req, res) => {
+    try {
+        const bc = getBrokerConfig(req);
+        const file = String(req.query.file || '').trim();
+        if (!file || !file.startsWith('/')) return res.status(400).json({ error: 'absolute file path required' });
+        let content = '';
+        if (bc.ssh && bc.ssh.host) {
+            try {
+                content = await sshDeploy.readRemoteFile(bc.ssh, file);
+            } catch (e) {
+                if (!String(e.message).toLowerCase().includes('no such file')) throw e;
+            }
+        } else {
+            try {
+                content = fs.readFileSync(file, 'utf8');
+            } catch (e) {
+                if (e.code !== 'ENOENT') throw e;
+            }
+        }
+        res.json({ content });
+    } catch (err) {
+        handleError(res, err);
+    }
+});
+/**
+ * PUT /she/broker/acl
+ * Write a mosquitto ACL file.
+ * Body: { file, content }
+ */
+router.put('/acl', async (req, res) => {
+    try {
+        const bc = getBrokerConfig(req);
+        const { file, content } = req.body;
+        if (!file || typeof file !== 'string' || !file.startsWith('/')) return res.status(400).json({ error: 'absolute file path required' });
+        if (typeof content !== 'string') return res.status(400).json({ error: 'content must be a string' });
+        if (bc.ssh && bc.ssh.host) {
+            await sshDeploy.uploadContent(bc.ssh, content, file);
+        } else {
+            fs.writeFileSync(file, content, 'utf8');
+        }
+        res.json({ ok: true });
+    } catch (err) {
+        handleError(res, err);
+    }
+});
 module.exports = { router, setLogger, setStore };
 // ── dynsec: ACL topic inspection ──────────────────────────────────────────────

package/src/web/shedb.js CHANGED Viewed

@@ -23,6 +23,9 @@ let _broadcast = () => {};
 /** Registry for she.db.sub() sandbox subscriptions */
 const _listeners = []; // { pattern: string, callback: Function, _script: string }
+/** Registry for she.db.subView() sandbox subscriptions */
+const _viewListeners = []; // { pattern: string, callback: Function, _script: string }
 /**
  * Initialise sheDB.
  *
@@ -80,6 +83,18 @@ function init({ dbPath, dbPublish, dbRetain, dbPrefix, mqttName, mqtt, log, broa
         if (query && query.mqttpub && _mqtt && view && !view.error) {
             _mqtt.publish(_dbPrefix + 'view/' + id, JSON.stringify(view.result ?? []), { retain: query.retain === true });
         }
+        // Fire sandbox she.db.subView() listeners
+        const result = view && !view.error ? view.result : undefined;
+        for (const sub of _viewListeners) {
+            if (mqttWildcard(id, sub.pattern) !== null) {
+                try {
+                    sub.callback(id, result);
+                } catch {
+                    /* errors are caught by the script domain wrapper */
+                }
+            }
+        }
     });
     // When a view definition is saved, immediately publish the existing cached
@@ -165,16 +180,28 @@ function addListener(pattern, callback, scriptName) {
     _listeners.push({ pattern, callback, _script: scriptName });
 }
-/** Remove all listeners registered by a script (called on hot-reload / unload). */
+/** Remove all she.db.sub() listeners registered by a script (called on hot-reload / unload). */
 function removeListenersByScript(scriptName) {
     for (let i = _listeners.length - 1; i >= 0; i--) {
         if (_listeners[i]._script === scriptName) _listeners.splice(i, 1);
     }
 }
+/** Register a she.db.subView() listener. */
+function addViewListener(pattern, callback, scriptName) {
+    _viewListeners.push({ pattern, callback, _script: scriptName });
+}
+/** Remove all she.db.subView() listeners registered by a script (called on hot-reload / unload). */
+function removeViewListenersByScript(scriptName) {
+    for (let i = _viewListeners.length - 1; i >= 0; i--) {
+        if (_viewListeners[i]._script === scriptName) _viewListeners.splice(i, 1);
+    }
+}
 /** Return the live core instance (used by shedb-api.js). */
 function getCore() {
     return _core;
 }
-module.exports = { init, handleMqttMessage, addListener, removeListenersByScript, getCore };
+module.exports = { init, handleMqttMessage, addListener, removeListenersByScript, addViewListener, removeViewListenersByScript, getCore };