homebridge-ratgdo 0.1.0 → 1.0.0

package/homebridge-ui/public/ui.mjs

@@ -0,0 +1,144 @@
+/* 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();
+}

package/homebridge-ui/server.js

@@ -0,0 +1,58 @@
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * server.js: homebridge-ratgdo webUI server API.
+ *
+ * This module is heavily inspired by the homebridge-config-ui-x source code and borrows from both.
+ * Thank you oznu for your contributions to the HomeKit world.
+ */
+"use strict";
+
+import { featureOptionCategories, featureOptions, isOptionEnabled } from "../dist/ratgdo-options.js";
+import { HomebridgePluginUiServer } from "@homebridge/plugin-ui-utils";
+import util from "node:util";
+
+class PluginUiServer extends HomebridgePluginUiServer {
+
+  constructor () {
+    super();
+
+    // Register getOptions() with the Homebridge server API.
+    this.#registerGetOptions();
+
+    this.ready();
+  }
+
+  // Register the getOptions() webUI server API endpoint.
+  #registerGetOptions() {
+
+    // Return the list of options configured for a given Ratgdo device.
+    this.onRequest("/getOptions", async(request) => {
+
+      try {
+
+        const optionSet = {};
+
+        // Loop through all the feature option categories.
+        for(const category of featureOptionCategories) {
+
+          optionSet[category.name] = [];
+
+          for(const options of featureOptions[category.name]) {
+
+            options.value = isOptionEnabled(request.configOptions, request.ratgdoDevice, category.name + "." + options.name, options.default);
+            optionSet[category.name].push(options);
+          }
+        }
+
+        return { categories: featureOptionCategories, options: optionSet };
+
+      } catch(err) {
+
+        // Return nothing if we error out for some reason.
+        return {};
+      }
+    });
+  }
+}
+
+(() => new PluginUiServer())();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-ratgdo",
   "displayName": "Homebridge Ratgdo",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "HomeKit integration for LiftMaster and Chamberlain garage door openers, without requiring myQ.",
   "license": "ISC",
   "repository": {
@@ -11,6 +11,7 @@
   "bugs": {
     "url": "https://github.com/hjdhjd/homebridge-ratgdo/issues"
   },
+  "type": "module",
   "engines": {
     "node": ">=18.0",
     "homebridge": ">1.2.0"
@@ -26,17 +27,20 @@
     "homebridge-plugin"
   ],
   "devDependencies": {
-    "@types/node": "^20.10.0",
-    "@typescript-eslint/eslint-plugin": "^6.12.0",
-    "@typescript-eslint/parser": "^6.12.0",
-    "eslint": "^8.54.0",
+    "@stylistic/eslint-plugin": "^1.6.2",
+    "@types/node": "^20.11.21",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "eslint": "^8.57.0",
     "homebridge": "^1.7.0",
-    "nodemon": "^3.0.1",
+    "nodemon": "^3.1.0",
     "rimraf": "^5.0.5",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.3.2"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "aedes": "^0.49.0"
+    "@homebridge/plugin-ui-utils": "^1.0.1",
+    "aedes": "^0.51.0",
+    "mqtt": "^5.3.6"
   }
 }