smart-home-engine 0.0.1 → 0.11.0

package/package.json

@@ -1,12 +1,87 @@
 {
-  "name": "smart-home-engine",
-  "version": "0.0.1",
-  "description": "",
-  "license": "ISC",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+    "name":  "smart-home-engine",
+    "version":  "0.11.0",
+    "description":  "Node.js based script runner for use in MQTT based Smart Home environments",
+    "main":  "src/index.js",
+    "scripts":  {
+                    "test":  "cross-env NODE_OPTIONS=\"--no-warnings\" jest --testPathPattern=test/unit --forceExit",
+                    "test:integration":  "cross-env NODE_OPTIONS=\"--no-warnings\" jest --testPathPattern=test/integration --forceExit",
+                    "test:all":  "cross-env NODE_OPTIONS=\"--no-warnings\" jest --forceExit",
+                    "test:coverage":  "cross-env NODE_OPTIONS=\"--no-warnings\" jest --coverage --forceExit",
+                    "test:verbose":  "cross-env NODE_OPTIONS=\"--no-warnings\" jest --verbose --forceExit",
+                    "lint":  "eslint --cache --cache-location .cache/.eslintcache .",
+                    "lint:fix":  "eslint --cache --cache-location .cache/.eslintcache --fix .",
+                    "format":  "prettier --cache --cache-location .cache/.prettiercache --write .",
+                    "format:check":  "prettier --cache --cache-location .cache/.prettiercache --check .",
+                    "build:web":  "cd web \u0026\u0026 npm install \u0026\u0026 npm run build"
+                },
+    "bin":  {
+                "she":  "src/index.js"
+            },
+    "files":  [
+                  "src/",
+                  "sandbox/",
+                  "dist/web/"
+              ],
+    "author":  "Sebastian \u0027hobbyquaker\u0027 Raff \u003chobbyquaker@gmail.com\u003e",
+    "license":  "MIT",
+    "dependencies":  {
+                         "bcryptjs":  "^2.4.3",
+                         "@elastic/elasticsearch":  "^9.4.2",
+                         "@influxdata/influxdb-client":  "^1.35.0",
+                         "@matter/main":  "^0.17.0",
+                         "chokidar":  "^4.0.0",
+                         "express":  "^5.2.1",
+                         "ioredis":  "^5.11.0",
+                         "mqtt":  "^5.0.0",
+                         "node-schedule":  "^2.0.0",
+                         "pino":  "^9.0.0",
+                         "pino-pretty":  "^13.0.0",
+                         "suncalc":  "^1.9.0",
+                         "ws":  "^8.21.0",
+                         "yargs":  "^17.0.0"
+                     },
+    "engines":  {
+                    "node":  "\u003e=20.0.0"
+                },
+    "devDependencies":  {
+                            "@eslint/js":  "^9.0.0",
+                            "@sinonjs/fake-timers":  "^11.0.0",
+                            "@types/jest":  "^29.5.0",
+                            "@types/node":  "^22.0.0",
+                            "aedes":  "^0.50.0",
+                            "cross-env":  "^7.0.3",
+                            "eslint":  "^9.0.0",
+                            "eslint-config-prettier":  "^10.1.8",
+                            "eslint-plugin-n":  "^17.0.0",
+                            "eslint-plugin-prettier":  "^5.0.0",
+                            "globals":  "^16.0.0",
+                            "jest":  "^29.7.0",
+                            "prettier":  "^3.0.0"
+                        },
+    "directories":  {
+                        "doc":  "doc"
+                    },
+    "repository":  {
+                       "type":  "git",
+                       "url":  "https://github.com/hobbyquaker/she"
+                   },
+    "keywords":  [
+                     "MQTT",
+                     "javascript",
+                     "node.js",
+                     "npm",
+                     "sandbox",
+                     "vm",
+                     "Smart",
+                     "Home",
+                     "Internet",
+                     "of",
+                     "Things",
+                     "IoT"
+                 ],
+    "bugs":  {
+                 "url":  "https://github.com/hobbyquaker/she/issues"
+             },
+    "homepage":  "https://github.com/hobbyquaker/she"
 }

package/src/config.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+// Default config file location (can be overridden with --config on the CLI)
+const configPath = path.join(os.homedir(), '.she', 'config', 'config.json');
+
+const config = require('yargs')
+    .option('dir', {
+        alias: 'd',
+        describe: 'directory to load user scripts from',
+        default: path.join(os.homedir(), '.she', 'scripts'),
+        type: 'string',
+    })
+    .option('db-path', {
+        describe: 'path to sheDB data directory (empty string to disable)',
+        default: path.join(os.homedir(), '.she', 'db'),
+        type: 'string',
+    })
+    .option('port', {
+        alias: 'p',
+        describe: 'HTTP server port (0 = OS-assigned random port)',
+        type: 'number',
+        default: 8080,
+    })
+    .config('config', 'path to JSON config file', (cfgPath) => {
+        try {
+            return JSON.parse(fs.readFileSync(cfgPath, 'utf8'));
+        } catch {
+            return {};
+        }
+    })
+    .default('config', configPath)
+    .hide('config')
+    // Sensible defaults for values not present in config.json
+    .default({
+        latitude: 48.7408,
+        longitude: 9.1778,
+        name: 'logic',
+        variablePrefix: 'var',
+        verbosity: 'info',
+        disableVariables: false,
+        disableWatch: false,
+        dbRetain: false,
+        dbPrefix: 'she/db/',
+        auth: 'none',
+        proxyHeader: 'X-Remote-User',
+        bindAddress: '0.0.0.0',
+    })
+    .version()
+    .help('help')
+    .parseSync();
+
+module.exports = config;

package/src/elastic.js

@@ -0,0 +1,19 @@
+'use strict';
+
+let _client = null;
+
+/**
+ * Initialise the Elasticsearch client.  Called from index.js when config.elastic is set.
+ * @param {{ node: string, auth?: object }} opts
+ */
+function init(opts) {
+    if (!opts || !opts.node) return;
+    const { Client } = require('@elastic/elasticsearch');
+    _client = new Client({ node: opts.node, ...(opts.auth ? { auth: opts.auth } : {}) });
+}
+
+function getClient() {
+    return _client;
+}
+
+module.exports = { init, getClient };