homebridge-ratgdo 2.1.2 → 2.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-ratgdo",
   "displayName": "Homebridge Ratgdo",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "HomeKit integration for LiftMaster and Chamberlain garage door openers, without requiring myQ.",
   "license": "ISC",
   "repository": {
@@ -18,31 +18,31 @@
   },
   "main": "dist/index.js",
   "scripts": {
-    "lint": "eslint \"src/**.ts\"",
-    "watch": "npm run build && npm link && nodemon",
-    "build": "rimraf ./dist && tsc",
+    "build": "npm run clean && tsc",
+    "build-ui": "shx mkdir -p homebridge-ui/public/lib && shx cp \"node_modules/homebridge-plugin-utils/dist/ui/**/*.@(js|mjs)\" homebridge-ui/public/lib",
+    "clean": "shx rm -rf dist homebridge-ui/public/lib && npm run build-ui",
+    "lint": "eslint eslint.config.mjs src/**.ts homebridge-ui/*.js homebridge-ui/public/**/*.mjs",
+    "postpublish": "npm run clean",
     "prepublishOnly": "npm run lint && npm run build"
   },
   "keywords": [
     "homebridge-plugin"
   ],
   "devDependencies": {
-    "@stylistic/eslint-plugin": "^1.8.0",
+    "@stylistic/eslint-plugin": "^2.1.0",
     "@types/eventsource": "^1.1.15",
-    "@types/node": "^20.12.8",
-    "eslint": "^8.5.7",
-    "homebridge": "^1.8.1",
-    "nodemon": "^3.1.0",
-    "rimraf": "^5.0.5",
-    "ts-node": "^10.9.2",
+    "@types/node": "^20.12.12",
+    "eslint": "8.57.0",
+    "homebridge": "^1.8.2",
+    "shx": "^0.3.4",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.8.0"
+    "typescript-eslint": "^7.9.0"
   },
   "dependencies": {
     "@adobe/fetch": "^4.1.2",
     "@homebridge/plugin-ui-utils": "^1.0.3",
     "bonjour-service": "^1.2.1",
     "eventsource": "^2.0.2",
-    "mqtt": "^5.5.5"
+    "homebridge-plugin-utils": "^1.0.0"
   }
 }

package/dist/ratgdo-mqtt.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="node" />
-import { RatgdoAccessory } from "./ratgdo-device.js";
-import { RatgdoPlatform } from "./ratgdo-platform.js";
-export declare class RatgdoMqtt {
-    private config;
-    private isConnected;
-    private log;
-    private mqtt;
-    private platform;
-    private subscriptions;
-    constructor(platform: RatgdoPlatform);
-    private configure;
-    publish(accessory: RatgdoAccessory, topic: string, message: string): void;
-    subscribe(accessory: RatgdoAccessory, topic: string, callback: (cbBuffer: Buffer) => void): void;
-    subscribeGet(accessory: RatgdoAccessory, topic: string, type: string, getValue: () => string): void;
-    subscribeSet(accessory: RatgdoAccessory, topic: string, type: string, setValue: (value: string) => void): void;
-    unsubscribe(accessory: RatgdoAccessory, topic: string): void;
-    private expandTopic;
-}

package/dist/ratgdo-mqtt.js

@@ -1,155 +0,0 @@
-/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
- *
- * ratgdo-mqtt.ts: MQTT connectivity class for Ratgdo.
- */
-import mqtt from "mqtt";
-import { RATGDO_MQTT_RECONNECT_INTERVAL } from "./settings.js";
-export class RatgdoMqtt {
-    config;
-    isConnected;
-    log;
-    mqtt;
-    platform;
-    subscriptions;
-    constructor(platform) {
-        this.config = platform.config;
-        this.isConnected = false;
-        this.log = platform.log;
-        this.mqtt = null;
-        this.platform = platform;
-        this.subscriptions = {};
-        if (!this.config.mqttUrl) {
-            return;
-        }
-        this.configure();
-    }
-    // Connect to the MQTT broker.
-    configure() {
-        // Try to connect to the MQTT broker and make sure we catch any URL errors.
-        try {
-            this.mqtt = mqtt.connect(this.config.mqttUrl, { reconnectPeriod: RATGDO_MQTT_RECONNECT_INTERVAL * 1000, rejectUnauthorized: false });
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                switch (error.message) {
-                    case "Missing protocol":
-                        this.log.error("MQTT Broker: Invalid URL provided: %s.", this.config.mqttUrl);
-                        break;
-                    default:
-                        this.log.error("MQTT Broker: Error: %s.", error.message);
-                        break;
-                }
-            }
-        }
-        // We've been unable to even attempt to connect. It's likely we have a configuration issue - we're done here.
-        if (!this.mqtt) {
-            return;
-        }
-        // Notify the user when we connect to the broker.
-        this.mqtt.on("connect", () => {
-            this.isConnected = true;
-            // Magic incantation to redact passwords.
-            const redact = /^(?<pre>.*:\/{0,2}.*:)(?<pass>.*)(?<post>@.*)/;
-            this.log.info("Connected to MQTT broker: %s (topic: %s).", this.config.mqttUrl.replace(redact, "$<pre>REDACTED$<post>"), this.config.mqttTopic);
-        });
-        // Notify the user when we've disconnected.
-        this.mqtt.on("close", () => {
-            if (this.isConnected) {
-                this.isConnected = false;
-                // Magic incantation to redact passwords.
-                const redact = /^(?<pre>.*:\/{0,2}.*:)(?<pass>.*)(?<post>@.*)/;
-                this.log.info("Disconnected from MQTT broker: %s.", this.config.mqttUrl.replace(redact, "$<pre>REDACTED$<post>"));
-            }
-        });
-        // Process inbound messages and pass it to the right message handler.
-        this.mqtt.on("message", (topic, message) => {
-            if (this.subscriptions[topic]) {
-                this.subscriptions[topic](message);
-            }
-        });
-        // Notify the user when there's a connectivity error.
-        this.mqtt.on("error", (error) => {
-            switch (error.code) {
-                case "ECONNREFUSED":
-                    this.log.error("MQTT Broker: Connection refused (url: %s). Will retry again in %s minute%s.", this.config.mqttUrl, RATGDO_MQTT_RECONNECT_INTERVAL / 60, RATGDO_MQTT_RECONNECT_INTERVAL / 60 > 1 ? "s" : "");
-                    break;
-                case "ECONNRESET":
-                    this.log.error("MQTT Broker: Connection reset (url: %s). Will retry again in %s minute%s.", this.config.mqttUrl, RATGDO_MQTT_RECONNECT_INTERVAL / 60, RATGDO_MQTT_RECONNECT_INTERVAL / 60 > 1 ? "s" : "");
-                    break;
-                case "ENOTFOUND":
-                    this.mqtt?.end(true);
-                    this.log.error("MQTT Broker: Hostname or IP address not found. (url: %s).", this.config.mqttUrl);
-                    break;
-                default:
-                    this.log.error("MQTT Broker: %s (url: %s). Will retry again in %s minute%s.", error, this.config.mqttUrl, RATGDO_MQTT_RECONNECT_INTERVAL / 60, RATGDO_MQTT_RECONNECT_INTERVAL / 60 > 1 ? "s" : "");
-                    break;
-            }
-        });
-    }
-    // Publish an MQTT event to a broker.
-    publish(accessory, topic, message) {
-        const expandedTopic = this.expandTopic(accessory.device.mac, topic);
-        // No valid topic returned, we're done.
-        if (!expandedTopic) {
-            return;
-        }
-        accessory.log.debug("MQTT publish: %s Message: %s.", expandedTopic, message);
-        // By default, we publish as: ratgdo/mac/event/name
-        this.mqtt?.publish(expandedTopic, message);
-    }
-    // Subscribe to an MQTT topic.
-    subscribe(accessory, topic, callback) {
-        const expandedTopic = this.expandTopic(accessory.device.mac, topic);
-        // No valid topic returned, we're done.
-        if (!expandedTopic) {
-            return;
-        }
-        accessory.log.debug("MQTT subscribe: %s.", expandedTopic);
-        // Add to our callback list.
-        this.subscriptions[expandedTopic] = callback;
-        // Tell MQTT we're subscribing to this event. By default, we subscribe as: ratgdo/mac/event/name.
-        this.mqtt?.subscribe(expandedTopic);
-    }
-    // Subscribe to a specific MQTT topic and publish a value on a get request.
-    subscribeGet(accessory, topic, type, getValue) {
-        // Return the current status of a given sensor.
-        this.platform.mqtt?.subscribe(accessory, topic + "/get", (message) => {
-            const value = message.toString().toLowerCase();
-            // Only publish if we receive a true value.
-            if (value !== "true") {
-                return;
-            }
-            // Publish our value and inform the user.
-            this.platform.mqtt?.publish(accessory, topic, getValue());
-            accessory.log.info("MQTT: %s status published.", type);
-        });
-    }
-    // Subscribe to a specific MQTT topic and set a value on a set request.
-    subscribeSet(accessory, topic, type, setValue) {
-        // Return the current status of a given sensor.
-        this.platform.mqtt?.subscribe(accessory, topic + "/set", (message) => {
-            const value = message.toString().toLowerCase();
-            // Set our value and inform the user.
-            setValue(value);
-            accessory.log.info("MQTT: set message received for %s: %s.", type, value);
-        });
-    }
-    // Unsubscribe to an MQTT topic.
-    unsubscribe(accessory, topic) {
-        const expandedTopic = this.expandTopic(accessory.device.mac, topic);
-        // No valid topic returned, we're done.
-        if (!expandedTopic) {
-            return;
-        }
-        delete this.subscriptions[expandedTopic];
-    }
-    // Expand a topic to a unique, fully formed one.
-    expandTopic(mac, topic) {
-        // No accessory, we're done.
-        if (!mac) {
-            return null;
-        }
-        return this.config.mqttTopic + "/" + mac + "/" + topic;
-    }
-}
-//# sourceMappingURL=ratgdo-mqtt.js.map

package/dist/ratgdo-mqtt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ratgdo-mqtt.js","sourceRoot":"","sources":["../src/ratgdo-mqtt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,IAAoB,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,8BAA8B,EAAE,MAAM,eAAe,CAAC;AAM/D,MAAM,OAAO,UAAU;IAEb,MAAM,CAAgB;IACtB,WAAW,CAAU;IACrB,GAAG,CAAgB;IACnB,IAAI,CAAoB;IACxB,QAAQ,CAAiB;IACzB,aAAa,CAAkD;IAEvE,YAAY,QAAwB;QAElC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,IAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAExB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,8BAA8B;IACtB,SAAS;QAEf,2EAA2E;QAC3E,IAAI,CAAC;YAEH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,eAAe,EAAE,8BAA8B,GAAG,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAC,CAAC,CAAC;QAEtI,CAAC;QAAC,OAAM,KAAK,EAAE,CAAC;YAEd,IAAG,KAAK,YAAY,KAAK,EAAE,CAAC;gBAE1B,QAAO,KAAK,CAAC,OAAO,EAAE,CAAC;oBAErB,KAAK,kBAAkB;wBAErB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAC9E,MAAM;oBAER;wBAEE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;wBACzD,MAAM;gBACV,CAAC;YAEH,CAAC;QAEH,CAAC;QAED,6GAA6G;QAC7G,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAEd,OAAO;QACT,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAE3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YAExB,yCAAyC;YACzC,MAAM,MAAM,GAAG,+CAA+C,CAAC;YAE/D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClJ,CAAC,CAAC,CAAC;QAEH,2CAA2C;QAC3C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAEzB,IAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEpB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;gBAEzB,yCAAyC;gBACzC,MAAM,MAAM,GAAG,+CAA+C,CAAC;gBAE/D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC;YACpH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,qEAAqE;QACrE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAa,EAAE,OAAe,EAAE,EAAE;YAEzD,IAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAE7B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YACrC,QAAQ,KAA+B,CAAC,IAAI,EAAE,CAAC;gBAE7C,KAAK,cAAc;oBAEjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6EAA6E,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAC/G,8BAA8B,GAAG,EAAE,EAAE,8BAA8B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC1F,MAAM;gBAER,KAAK,YAAY;oBAEf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2EAA2E,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAC7G,8BAA8B,GAAG,EAAE,EAAE,8BAA8B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC1F,MAAM;gBAER,KAAK,WAAW;oBAEd,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2DAA2D,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBACjG,MAAM;gBAER;oBAEE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6DAA6D,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EACtG,8BAA8B,GAAG,EAAE,EAAE,8BAA8B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC1F,MAAM;YACV,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IAC9B,OAAO,CAAC,SAA0B,EAAE,KAAa,EAAE,OAAe;QAEvE,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAEpE,uCAAuC;QACvC,IAAG,CAAC,aAAa,EAAE,CAAC;YAElB,OAAO;QACT,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAE7E,mDAAmD;QACnD,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,8BAA8B;IACvB,SAAS,CAAC,SAA0B,EAAE,KAAa,EAAE,QAAoC;QAE9F,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAEpE,uCAAuC;QACvC,IAAG,CAAC,aAAa,EAAE,CAAC;YAElB,OAAO;QACT,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAC;QAE1D,4BAA4B;QAC5B,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QAE7C,iGAAiG;QACjG,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED,2EAA2E;IACpE,YAAY,CAAC,SAA0B,EAAE,KAAa,EAAE,IAAY,EAAE,QAAsB;QAEjG,+CAA+C;QAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,KAAK,GAAG,MAAM,EAAE,CAAC,OAAe,EAAE,EAAE;YAE3E,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;YAE/C,2CAA2C;YAC3C,IAAG,KAAK,KAAK,MAAM,EAAE,CAAC;gBAEpB,OAAO;YACT,CAAC;YAED,yCAAyC;YACzC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1D,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,uEAAuE;IAChE,YAAY,CAAC,SAA0B,EAAE,KAAa,EAAE,IAAY,EAAE,QAAiC;QAE5G,+CAA+C;QAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,KAAK,GAAG,MAAM,EAAE,CAAC,OAAe,EAAE,EAAE;YAE3E,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;YAE/C,qCAAqC;YACrC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC;IACzB,WAAW,CAAC,SAA0B,EAAE,KAAa;QAE1D,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAEpE,uCAAuC;QACvC,IAAG,CAAC,aAAa,EAAE,CAAC;YAElB,OAAO;QACT,CAAC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,gDAAgD;IACxC,WAAW,CAAC,GAAW,EAAE,KAAa;QAE5C,4BAA4B;QAC5B,IAAG,CAAC,GAAG,EAAE,CAAC;YAER,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,CAAC;IACzD,CAAC;CACF"}

package/homebridge-ui/public/lib/featureoptions.mjs

@@ -1,200 +0,0 @@
-/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
- *
- * featureoptions.mjs: Feature option webUI base class.
- */
-"use strict";
-
-export class FeatureOptions {
-
-  controller;
-
-  featureOptionGroups;
-  featureOptionList;
-  optionsList;
-
-  constructor() {
-
-    this.featureOptionGroups = {};
-    this.featureOptionList = {};
-    this.controller = null;
-    this.optionsList = [];
-  }
-
-  // Abstract method to be implemented by subclasses to render the feature option webUI.
-  async showUI() {
-  }
-
-  // Is this feature option set explicitly?
-  isOptionSet(featureOption, deviceMac) {
-
-    const optionRegex = new RegExp("^(?:Enable|Disable)\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "$", "gi");
-    return this.optionsList.filter(x => optionRegex.test(x)).length ? true : false;
-  }
-
-  // Is a feature option globally enabled?
-  isGlobalOptionEnabled(featureOption, defaultState) {
-
-    featureOption = featureOption.toUpperCase();
-
-    // Test device-specific options.
-    return this.optionsList.some(x => x === ("ENABLE." + featureOption)) ? true :
-      (this.optionsList.some(x => x === ("DISABLE." + featureOption)) ? false : defaultState
-      );
-  }
-
-  // Is a feature option enabled at the device or global level. This function does not traverse the scoping hierarchy.
-  isDeviceOptionEnabled(featureOption, mac, defaultState) {
-
-    if(!mac) {
-
-      return this.isGlobalOptionEnabled(featureOption, defaultState);
-    }
-
-    featureOption = featureOption.toUpperCase();
-    mac = mac.toUpperCase();
-
-    // Test device-specific options.
-    return this.optionsList.some(x => x === ("ENABLE." + featureOption + "." + mac)) ? true :
-      (this.optionsList.some(x => x === ("DISABLE." + featureOption + "." + mac)) ? false : defaultState
-      );
-  }
-
-  // Is a value-centric feature option enabled at the device or global level. This function does not traverse the scoping hierarchy.
-  isOptionValueSet(featureOption, deviceMac) {
-
-    const optionRegex = new RegExp("^Enable\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "\\.([^\\.]+)$", "gi");
-
-    return this.optionsList.filter(x => optionRegex.test(x)).length ? true : false;
-  }
-
-  // Get the value of a value-centric feature option.
-  getOptionValue(featureOption, deviceMac) {
-
-    const optionRegex = new RegExp("^Enable\\." + featureOption + (!deviceMac ? "" : "\\." + deviceMac) + "\\.([^\\.]+)$", "gi");
-
-    // Get the option value, if we have one.
-    for(const option of this.optionsList) {
-
-      const regexMatch = optionRegex.exec(option);
-
-      if(regexMatch) {
-
-        return regexMatch[1];
-      }
-    }
-
-    return undefined;
-  }
-
-  // Is a feature option enabled at the device or global level. It does traverse the scoping hierarchy.
-  isOptionEnabled(featureOption, deviceMac) {
-
-    const defaultState = this.featureOptionList[featureOption]?.default ?? true;
-
-    if(deviceMac) {
-
-      // Device level check.
-      if(this.isDeviceOptionEnabled(featureOption, deviceMac, defaultState) !== defaultState) {
-
-        return !defaultState;
-      }
-
-      // Controller level check.
-      if(this.isDeviceOptionEnabled(featureOption, this.controller, defaultState) !== defaultState) {
-
-        return !defaultState;
-      }
-    }
-
-    // Global check.
-    if(this.isGlobalOptionEnabled(featureOption, defaultState) !== defaultState) {
-
-      return !defaultState;
-    }
-
-    // Return the default.
-    return defaultState;
-  };
-
-  // Return the scope level of a feature option.
-  optionScope(featureOption, deviceMac, defaultState, isOptionValue = false) {
-
-    // Scope priority is always: device, controller, global.
-
-    // If we have a value-centric feature option, our lookups are a bit different.
-    if(isOptionValue) {
-
-      if(deviceMac) {
-
-        if(this.isOptionValueSet(featureOption, deviceMac)) {
-
-          return "device";
-        }
-
-        if(this.isOptionValueSet(featureOption, this.controller)) {
-
-          return "controller";
-        }
-      }
-
-      if(this.isOptionValueSet(featureOption)) {
-
-        return "global";
-      }
-
-      return "none";
-    }
-
-    if(deviceMac) {
-
-      // Let's see if we've set it at the device-level.
-      if((this.isDeviceOptionEnabled(featureOption, deviceMac, defaultState) !== defaultState) || this.isOptionSet(featureOption, deviceMac)) {
-
-        return "device";
-      }
-
-      // Now let's test the controller level.
-      if((this.isDeviceOptionEnabled(featureOption, this.controller, defaultState) !== defaultState) || this.isOptionSet(featureOption, this.controller)) {
-
-        return "controller";
-      }
-    }
-
-    // Finally, let's test the global level.
-    if((this.isGlobalOptionEnabled(featureOption, defaultState) !== defaultState) || this.isOptionSet(featureOption)) {
-
-      return "global";
-    }
-
-    // Option isn't set to a non-default value.
-    return "none";
-  };
-
-  // Return the color hinting for a given option's scope.
-  optionScopeColor(featureOption, deviceMac, defaultState, isOptionValue) {
-
-    switch(this.optionScope(featureOption, deviceMac, defaultState, isOptionValue)) {
-
-      case "device":
-
-        return "text-info";
-        break;
-
-      case "controller":
-
-        return "text-success";
-        break;
-
-      case "global":
-
-        return deviceMac ? "text-warning" : "text-info";
-        break;
-
-      default:
-
-        break;
-    }
-
-    return null;
-  };
-}

package/homebridge-ui/public/ui.mjs

@@ -1,144 +0,0 @@
-/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
- *
- * ui.mjs: Ratgdo webUI.
- */
-"use strict";
-
-import { ratgdoFeatureOptions } from "./ratgdo-featureoptions.mjs";
-
-// Keep a list of all the feature options and option groups.
-const featureOptions = new ratgdoFeatureOptions();
-
-// Show the first run user experience if we don't have valid login credentials.
-async function showFirstRun () {
-
-  const buttonFirstRun = document.getElementById("firstRun");
-  const serverPortInfo = document.getElementById("serverPortInfo");
-
-  serverPortInfo.innerHTML = (featureOptions.currentConfig[0].port ?? "18830");
-
-  // First run user experience.
-  buttonFirstRun.addEventListener("click", async () => {
-
-    // Show the beachball while we setup.
-    homebridge.showSpinner();
-
-    // Get the list of devices the plugin knows about.
-    const ratgdoDevices = await homebridge.getCachedAccessories();
-
-    // Sort it for posterity.
-    ratgdoDevices?.sort((a, b) => {
-
-      const aCase = (a.displayName ?? "").toLowerCase();
-      const bCase = (b.displayName ?? "").toLowerCase();
-
-      return aCase > bCase ? 1 : (bCase > aCase ? -1 : 0);
-    });
-
-    // Create our UI.
-    document.getElementById("pageFirstRun").style.display = "none";
-    document.getElementById("menuWrapper").style.display = "inline-flex";
-    featureOptions.showUI();
-
-    // All done. Let the user interact with us, although in practice, we shouldn't get here.
-    // homebridge.hideSpinner();
-  });
-
-  document.getElementById("pageFirstRun").style.display = "block";
-}
-
-// Show the main plugin configuration tab.
-function showSettings () {
-
-  // Show the beachball while we setup.
-  homebridge.showSpinner();
-
-  // Create our UI.
-  document.getElementById("menuHome").classList.remove("btn-elegant");
-  document.getElementById("menuHome").classList.add("btn-primary");
-  document.getElementById("menuFeatureOptions").classList.remove("btn-elegant");
-  document.getElementById("menuFeatureOptions").classList.add("btn-primary");
-  document.getElementById("menuSettings").classList.add("btn-elegant");
-  document.getElementById("menuSettings").classList.remove("btn-primary");
-
-  document.getElementById("pageSupport").style.display = "none";
-  document.getElementById("pageFeatureOptions").style.display = "none";
-
-  homebridge.showSchemaForm();
-
-  // All done. Let the user interact with us.
-  homebridge.hideSpinner();
-}
-
-// Show the support tab.
-function showSupport() {
-
-  // Show the beachball while we setup.
-  homebridge.showSpinner();
-  homebridge.hideSchemaForm();
-
-  // Create our UI.
-  document.getElementById("menuHome").classList.add("btn-elegant");
-  document.getElementById("menuHome").classList.remove("btn-primary");
-  document.getElementById("menuFeatureOptions").classList.remove("btn-elegant");
-  document.getElementById("menuFeatureOptions").classList.add("btn-primary");
-  document.getElementById("menuSettings").classList.remove("btn-elegant");
-  document.getElementById("menuSettings").classList.add("btn-primary");
-
-  document.getElementById("pageSupport").style.display = "block";
-  document.getElementById("pageFeatureOptions").style.display = "none";
-
-  // All done. Let the user interact with us.
-  homebridge.hideSpinner();
-}
-
-// Launch our webUI.
-async function launchWebUI() {
-
-  // Retrieve the current plugin configuration.
-  featureOptions.currentConfig = await homebridge.getPluginConfig();
-
-  // Add our event listeners to animate the UI.
-  menuHome.addEventListener("click", () => showSupport());
-  menuFeatureOptions.addEventListener("click", () => featureOptions.showUI());
-  menuSettings.addEventListener("click", () => showSettings());
-
-  // Get the list of devices the plugin knows about.
-  const ratgdoDevices = await homebridge.getCachedAccessories();
-
-  // If we've got Ratgdo devices detected, we launch our feature option UI. Otherwise, we launch our first run UI.
-  if(featureOptions.currentConfig.length && ratgdoDevices?.length) {
-
-    document.getElementById("menuWrapper").style.display = "inline-flex";
-    featureOptions.showUI();
-    return;
-  }
-
-  // If we have no configuration, let's create one.
-  if(!featureOptions.currentConfig.length) {
-
-    featureOptions.currentConfig.push({ name: "Ratgdo" });
-  } else if(!("name" in featureOptions.currentConfig[0])) {
-
-    // If we haven't set the name, let's do so now.
-    featureOptions.currentConfig[0].name = "Ratgdo";
-  }
-
-  // Update the plugin configuration and launch the first run UI.
-  await homebridge.updatePluginConfig(featureOptions.currentConfig);
-  showFirstRun();
-}
-
-// Fire off our UI, catching errors along the way.
-try {
-
-  launchWebUI();
-} catch(err) {
-
-  // If we had an error instantiating or updating the UI, notify the user.
-  homebridge.toast.error(err.message, "Error");
-} finally {
-
-  // Always leave the UI in a usable place for the end user.
-  homebridge.hideSpinner();
-}