homebridge-unifi-protect 6.12.0 → 6.12.2

package/homebridge-ui/public/ui.mjs

@@ -0,0 +1,144 @@
+/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * ui.mjs: HBUP webUI.
+ */
+"use strict";
+
+import { ProtectFeatureOptions } from "./protect-featureoptions.mjs";
+
+// Keep a list of all the feature options and option groups.
+const featureOptions = new ProtectFeatureOptions();
+
+// Toggle our enabled state.
+async function enablePlugin() {
+
+  // Show the beachball while we setup.
+  homebridge.showSpinner();
+
+  // Create our UI.
+  document.getElementById("disabledBanner").style.display = "none";
+  featureOptions.currentConfig[0].disablePlugin = false;
+
+  await homebridge.updatePluginConfig(featureOptions.currentConfig)
+  await homebridge.savePluginConfig()
+
+  // All done. Let the user interact with us.
+  homebridge.hideSpinner()
+}
+
+// Show a disabled interface.
+function showDisabledBanner() {
+
+  document.getElementById("disabledBanner").style.display = "block";
+}
+
+// Show an navigation bar at the top of the plugin configuration UI.
+function showIntro () {
+
+  const introLink = document.getElementById("introLink");
+
+  introLink.addEventListener("click", () => {
+
+    // Show the beachball while we setup.
+    homebridge.showSpinner();
+
+    // Create our UI.
+    document.getElementById("pageIntro").style.display = "none";
+    document.getElementById("menuWrapper").style.display = "inline-flex";
+    showSettings();
+
+    // All done. Let the user interact with us.
+    homebridge.hideSpinner();
+  });
+
+  document.getElementById("pageIntro").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());
+  disabledEnable.addEventListener("click", () => enablePlugin());
+
+  if(featureOptions.currentConfig.length) {
+
+    document.getElementById("menuWrapper").style.display = "inline-flex"
+    showSettings();
+
+    // If the plugin's disabled, inform the user.
+    if(featureOptions.currentConfig[0].disablePlugin) {
+
+      showDisabledBanner();
+    }
+  } else {
+
+    featureOptions.currentConfig.push({ name: "UniFi Protect" });
+    await homebridge.updatePluginConfig(featureOptions.currentConfig);
+    showIntro();
+  }
+}
+
+// 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

@@ -127,40 +127,6 @@ class PluginUiServer extends HomebridgePluginUiServer {
       }
     });
 
-    // Compatibility for older versions of the Homebridge UI.
-    this.onRequest("/getCachedAccessories", async () => {
-
-      try {
-
-        // Define the plugin and create the array to return.
-        const plugin = "homebridge-unifi-protect";
-        const devicesToReturn = [];
-
-        // The path and file of the cached accessories.
-        const accFile = this.homebridgeStoragePath + "/accessories/cachedAccessories";
-
-        // Check the file exists.
-        if(fs.existsSync(accFile)) {
-
-          // Read the cached accessories file
-          let cachedAccessories = await fs.promises.readFile(accFile);
-
-          // Parse the JSON
-          cachedAccessories = JSON.parse(cachedAccessories);
-
-          // We only want the accessories for this plugin
-          cachedAccessories.filter(accessory => accessory.plugin === plugin).map(accessory => devicesToReturn.push(accessory));
-        }
-
-        // Return the array
-        return devicesToReturn;
-      } catch(err) {
-
-        // Just return an empty accessory list in case of any errors.
-        return [];
-      }
-    });
-
     this.ready();
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-unifi-protect",
-  "version": "6.12.0",
+  "version": "6.12.2",
   "displayName": "Homebridge UniFi Protect",
   "description": "Homebridge UniFi Protect plugin providing complete HomeKit integration for the UniFi Protect ecosystem with full support for most features including autoconfiguration, motion detection, multiple controllers, and realtime updates.",
   "author": {
@@ -25,6 +25,9 @@
     "homebridge",
     "homebridge-plugin",
     "homebridge-unifi-protect",
+    "homekit",
+    "homekit secure video",
+    "hksv",
     "camera",
     "doorbell",
     "ubiquiti",
@@ -49,8 +52,14 @@
     "unifi nvr",
     "unifi-nvr",
     "unifios",
+    "uvc ai pro",
+    "uvc g3 bullet",
     "uvc g3 flex",
+    "uvc g3 instant",
+    "uvc g4 bullet",
     "uvc g4 doorbell",
+    "uvc g4 flex",
+    "uvc g4 instant",
     "uvc g4 pro",
     "rtsp"
   ],
@@ -58,6 +67,7 @@
     "build": "rimraf ./dist && tsc",
     "clean": "rimraf ./dist",
     "lint": "eslint src/**.ts",
+    "jlint": "eslint homebridge-ui/public/**.mjs",
     "postpublish": "npm run clean",
     "prepublishOnly": "npm run lint && npm run build",
     "test": "eslint src/**.ts",
@@ -65,22 +75,22 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@homebridge/plugin-ui-utils": "^0.0.19",
-    "ffmpeg-for-homebridge": "^0.1.4",
-    "mqtt": "5.0.2",
-    "unifi-protect": "^4.5.0",
-    "ws": "^8.13.0"
+    "@homebridge/plugin-ui-utils": "0.1.0",
+    "ffmpeg-for-homebridge": "0.1.4",
+    "mqtt": "5.0.3",
+    "unifi-protect": "4.6.1",
+    "ws": "8.13.0"
   },
   "devDependencies": {
-    "@types/node": "^20.4.8",
-    "@types/readable-stream": "^4.0.0",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
-    "eslint": "^8.46.0",
-    "homebridge": "=1.6.1",
-    "nodemon": "^3.0.1",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.1.6"
+    "@types/node": "20.5.1",
+    "@types/readable-stream": "4.0.1",
+    "@types/ws": "8.5.5",
+    "@typescript-eslint/eslint-plugin": "6.4.0",
+    "@typescript-eslint/parser": "6.4.0",
+    "eslint": "8.47.0",
+    "homebridge": "1.6.1",
+    "nodemon": "3.0.1",
+    "rimraf": "5.0.1",
+    "typescript": "5.1.6"
   }
 }