smart-home-engine 0.16.1 → 0.18.0

package/package.json

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

package/src/index.js

@@ -189,8 +189,8 @@ function sunScheduleEvent(obj, shift) {
                 // call the callback immediately!
                 obj.domain.bind(obj.callback)();
             } else {
-                // Schedule the event!
-                scheduler.scheduleJob(event, obj.domain.bind(obj.callback));
+                // Schedule the event and track the job so it can be cancelled on script unload
+                obj._job = scheduler.scheduleJob(event, obj.domain.bind(obj.callback));
             }
         }
     }
@@ -659,7 +659,10 @@ function runScript(script, name, origin) {
             if (options.random) {
                 _myJobs.push(
                     scheduler.scheduleJob(pattern, () => {
-                        setTimeout(scriptDomain.bind(callback), (parseFloat(options.random) || 0) * 1000 * Math.random());
+                        // Track the random-delay timer so it is cancelled on unload
+                        // if the job fires in the same tick as the script is reloaded.
+                        const id = setTimeout(scriptDomain.bind(callback), (parseFloat(options.random) || 0) * 1000 * Math.random());
+                        _myTimers.add(id);
                     }),
                 );
             } else {
@@ -935,8 +938,19 @@ function runScript(script, name, origin) {
     };
 
     const scriptName = path.basename(name, path.extname(name));
+    // she.setTimeout / she.clearTimeout — tracked versions for use by stdlib and
+    // sandbox modules that don't have direct access to the Sandbox context.
+    she.setTimeout = (fn, delay, ...args) => {
+        const id = setTimeout(fn, delay, ...args);
+        _myTimers.add(id);
+        return id;
+    };
+    she.clearTimeout = (id) => {
+        _myTimers.delete(id);
+        clearTimeout(id);
+    };
     sandboxModules.forEach((md) => {
-        md(she, { scriptDomain, scriptName });
+        md(she, { scriptDomain, scriptName, scriptFile: name });
     });
 
     log.debug(name, 'contextifying sandbox');
@@ -1010,6 +1024,10 @@ function unloadScript(file) {
         if (mqttEventCallbacks[i]._script === file) mqttEventCallbacks.splice(i, 1);
     }
 
+    // Remove HTTP routes registered by this script via she.api
+    const scriptName = path.basename(file, path.extname(file));
+    require('./web/server').unregisterRoutesByScript(scriptName);
+
     // Cancel all node-schedule jobs for this script
     const jobs = scriptJobs.get(file);
     if (jobs) {
@@ -1017,9 +1035,12 @@ function unloadScript(file) {
         scriptJobs.delete(file);
     }
 
-    // Remove sun events belonging to this script
+    // Remove sun events belonging to this script and cancel any pending scheduled job
     for (let i = sunEvents.length - 1; i >= 0; i--) {
-        if (sunEvents[i]._script === file) sunEvents.splice(i, 1);
+        if (sunEvents[i]._script === file) {
+            if (sunEvents[i]._job) sunEvents[i]._job.cancel();
+            sunEvents.splice(i, 1);
+        }
     }
 
     // Clear all tracked timers for this script

package/src/sandbox/matter-sandbox.js

@@ -26,7 +26,10 @@
 
 const controller = require('../matter/controller');
 
-module.exports = function (she, { scriptDomain, scriptName }) {
+module.exports = function (she, { scriptDomain, scriptName, scriptFile }) {
+    // Use full file path as the tracking key so cleanup() called from
+    // unloadScript() (which passes the full path) matches what was registered.
+    const trackingKey = scriptFile || scriptName;
     she.matter = {
         /**
          * Subscribe to an attribute change on a paired Matter device.
@@ -40,7 +43,7 @@ module.exports = function (she, { scriptDomain, scriptName }) {
          */
         sub(nodeId, endpointId, clusterName, attrName, callback) {
             try {
-                return controller.subscribeAttribute(scriptName, nodeId, endpointId, clusterName, attrName, callback);
+                return controller.subscribeAttribute(trackingKey, nodeId, endpointId, clusterName, attrName, callback);
             } catch (err) {
                 scriptDomain.emit('error', err);
             }
@@ -52,7 +55,7 @@ module.exports = function (she, { scriptDomain, scriptName }) {
          * @param {number} listenerId  Returned by she.matter.sub()
          */
         unsub(listenerId) {
-            controller.unsubscribe(scriptName, listenerId);
+            controller.unsubscribe(trackingKey, listenerId);
         },
 
         /**

package/src/sandbox/shedb-sandbox.js

@@ -17,8 +17,11 @@
 
 const { getCore, addListener, removeListenersByScript } = require('../web/shedb');
 
-module.exports = function (she, { scriptDomain, scriptName }) {
+module.exports = function (she, { scriptDomain, scriptName, scriptFile }) {
     const core = getCore();
+    // Use the full file path as the tracking key so cleanup() in index.js
+    // (which passes the full path) matches what was registered here.
+    const trackingKey = scriptFile || scriptName;
 
     // sheDB may not be initialised (--db-path not given or startup still in progress).
     // We expose stubs that are no-ops / return undefined so user scripts don't crash.
@@ -62,7 +65,7 @@ module.exports = function (she, { scriptDomain, scriptName }) {
             if (!core) return;
             // Wrap in script domain so errors don't crash the process
             const wrapped = scriptDomain.bind(callback);
-            addListener(pattern, wrapped, scriptName);
+            addListener(pattern, wrapped, trackingKey);
         },
 
         /**

package/src/sandbox/stdlib.js

@@ -88,11 +88,11 @@ module.exports = function (she) {
     she.timer = function (src, target, time) {
         she.mqttsub(src, { retain: false }, (topic, val) => {
             if (val) {
-                clearTimeout(timeouts[target]);
+                she.clearTimeout(timeouts[target]);
                 if (!she.getValue(target)) {
                     she.setValue(target, 1);
                 }
-                timeouts[target] = setTimeout(() => {
+                timeouts[target] = she.setTimeout(() => {
                     if (she.getValue(target)) {
                         she.setValue(target, 0);
                     }
@@ -100,7 +100,7 @@ module.exports = function (she) {
             }
         });
 
-        timeouts[target] = setTimeout(() => {
+        timeouts[target] = she.setTimeout(() => {
             if (she.getValue(target)) {
                 she.setValue(target, 0);
             }

package/src/web/prompts/db-view.md

@@ -7,14 +7,16 @@ A view has three optional parts:
    Examples: `devices/+/state` matches `devices/lamp1/state`.  `sensors/#` matches all IDs starting with `sensors/`.
    ⚠️  `*` is NOT a valid MQTT wildcard — never use it. Use `#` for "match everything".
 
-2. **Map** — a JavaScript function body. `this` is the current document. Call `emit(value)` to include a value in the result array. No `return`.
+2. **Map** — a JavaScript function body. `this` is the current document. Call `emit(this)` to include a document in the result array. No `return`.
 
 3. **Reduce** — a JavaScript function body that receives `result` (the array from map) and must `return` a transformed value.
 
+Don't suggest scripts utilizing the she.db.* api, you should only propose view parts.
+
 When proposing view parts, use these exact formats (include only the parts that change):
 
 ```filter
-devices/#
+#
 ```
 
 ```javascript

package/src/web/server.js

@@ -82,8 +82,15 @@ app.use((req, res, next) => {
 // Central route registry — key: 'METHOD /api/scriptname/path'
 const registry = new Map();
 
+// Per-script Express sub-routers for she.api routes.
+// Each script gets one Router mounted at /api/<scriptName>; the layer reference
+// is kept so it can be spliced out of the app's middleware stack on unload.
+const scriptRouters = new Map(); // scriptName → { router, layer }
+
 /**
  * Register an HTTP route. Throws if the same method+path pair is already registered.
+ * Routes under /api/<scriptName>/... are grouped into a per-script sub-router so
+ * they can all be removed at once when the script is unloaded.
  * @param {'get'|'post'|'put'|'delete'} method
  * @param {string} fullPath  - absolute Express path, e.g. '/api/myscript/foo'
  * @param {Function} handler - Express route handler (req, res)
@@ -94,7 +101,51 @@ function registerRoute(method, fullPath, handler) {
         throw new Error(`Route already registered: ${key}`);
     }
     registry.set(key, true);
-    app[method](fullPath, handler);
+
+    // Route belongs to a user script — use a per-script sub-router.
+    const m = fullPath.match(/^\/api\/([^/]+)(\/.*)?$/);
+    if (m) {
+        const scriptName = m[1];
+        const routePath = m[2] || '/';
+        let entry = scriptRouters.get(scriptName);
+        if (!entry) {
+            const router = express.Router();
+            app.use('/api/' + scriptName, router);
+            // Capture the layer Express just pushed onto its stack.
+            // Express 5 exposes the router via the public `app.router` getter.
+            const stack = app.router.stack;
+            const layer = stack[stack.length - 1];
+            entry = { router, layer };
+            scriptRouters.set(scriptName, entry);
+        }
+        entry.router[method](routePath, handler);
+    } else {
+        // Fallback for any non-/api/ paths (shouldn't occur in normal usage).
+        app[method](fullPath, handler);
+    }
+}
+
+/**
+ * Remove all HTTP routes registered by a script and allow re-registration.
+ * Called by unloadScript() in index.js on hot-reload.
+ * @param {string} scriptName - basename without extension, e.g. 'myscript'
+ */
+function unregisterRoutesByScript(scriptName) {
+    const entry = scriptRouters.get(scriptName);
+    if (entry) {
+        const stack = app.router?.stack;
+        if (stack) {
+            const idx = stack.indexOf(entry.layer);
+            if (idx !== -1) stack.splice(idx, 1);
+        }
+        scriptRouters.delete(scriptName);
+    }
+    // Clear registry entries so the routes can be re-registered on reload.
+    for (const key of [...registry.keys()]) {
+        if (key.includes('/api/' + scriptName + '/') || key.endsWith('/api/' + scriptName)) {
+            registry.delete(key);
+        }
+    }
 }
 
 let httpServer = null;
@@ -145,4 +196,4 @@ function stopServer() {
     });
 }
 
-module.exports = { app, registerRoute, setStatsProvider, startServer, stopServer };
+module.exports = { app, registerRoute, unregisterRoutesByScript, setStatsProvider, startServer, stopServer };