@switchbot/homebridge-switchbot 5.0.0 → 5.1.0-beta.1

package/dist/homebridge-ui/public/js/api.ts

@@ -1,5 +1,6 @@
 // Fetch the list of configured devices from the Homebridge UI API
 import { isValidDeviceType, normalizeDeviceType } from '../../../device-types.js'
+import { isV4Config } from '../../utils/v4-detection.js'
 import './types.js'
 import { uiLog } from './logger.js'
 import { toastError } from './toast.js'
@@ -22,6 +23,35 @@ export async function fetchDevices(): Promise<any[]> {
   }
 }
 
+/**
+ * Detect whether the current plugin config is in the legacy v4 format.
+ *
+ * v4 configs stored credentials under a `credentials` sub-object and devices
+ * under `options.devices`. v5+ flattened these to `openApiToken`,
+ * `openApiSecret`, and a root-level `devices` array.
+ *
+ * Returns true when a v4 config block is found, false otherwise.
+ */
+export async function detectV4Config(): Promise<boolean> {
+  try {
+    if (typeof homebridge.getPluginConfig !== 'function') {
+      return false
+    }
+    const configArr = await homebridge.getPluginConfig()
+    if (!Array.isArray(configArr)) {
+      return false
+    }
+    const config = configArr.find(isSwitchBotPlatformConfig)
+    if (!config || typeof config !== 'object') {
+      return false
+    }
+    return isV4Config(config)
+  } catch (e) {
+    uiLog.warn('Error detecting v4 config:', e)
+    return false
+  }
+}
+
 /**
  * Validate and auto-correct device types in the config array before saving.
  * Returns an array of errors for devices that cannot be fixed.
@@ -189,7 +219,19 @@ export async function addDevice(
   deviceId: string,
   name: string,
   type: string,
-  options?: { address?: string, model?: string, rssi?: number, encryptionKey?: string, keyId?: string },
+  options?: {
+    address?: string
+    model?: string
+    rssi?: number
+    connectionPreference?: string
+    externalPublishProtocol?: string
+    room?: string
+    encryptionKey?: string
+    keyId?: string
+    refreshRate?: number
+    blePollingEnabled?: boolean
+    blePollIntervalMs?: number
+  },
 ): Promise<any> {
   if (typeof homebridge.getPluginConfig !== 'function' || typeof homebridge.updatePluginConfig !== 'function') {
     throw new TypeError('Homebridge UI API not available')
@@ -224,6 +266,24 @@ export async function addDevice(
   if (options?.keyId) {
     newDevice.keyId = options.keyId
   }
+  if (options?.connectionPreference) {
+    newDevice.connectionPreference = options.connectionPreference
+  }
+  if (options?.externalPublishProtocol) {
+    newDevice.externalPublishProtocol = options.externalPublishProtocol
+  }
+  if (options?.room) {
+    newDevice.room = options.room
+  }
+  if (typeof options?.refreshRate === 'number' && Number.isFinite(options.refreshRate)) {
+    newDevice.refreshRate = options.refreshRate
+  }
+  if (typeof options?.blePollingEnabled === 'boolean') {
+    newDevice.blePollingEnabled = options.blePollingEnabled
+  }
+  if (typeof options?.blePollIntervalMs === 'number' && Number.isFinite(options.blePollIntervalMs)) {
+    newDevice.blePollIntervalMs = options.blePollIntervalMs
+  }
   config.devices.push(newDevice)
   await homebridge.updatePluginConfig(configArr)
   if (typeof homebridge.savePluginConfig === 'function') {

package/dist/homebridge-ui/public/js/app.js

@@ -8,111 +8,6 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 
-// src/homebridge-ui/public/js/logger.ts
-var PREFIX, uiLog;
-var init_logger = __esm({
-  "src/homebridge-ui/public/js/logger.ts"() {
-    "use strict";
-    PREFIX = "[SwitchBot UI/html]";
-    uiLog = {
-      info: (message, ...parameters) => {
-        console.log(PREFIX, message, ...parameters);
-      },
-      warn: (message, ...parameters) => {
-        console.warn(PREFIX, message, ...parameters);
-      },
-      error: (message, ...parameters) => {
-        console.error(PREFIX, message, ...parameters);
-      },
-      debug: (message, ...parameters) => {
-        console.debug(PREFIX, message, ...parameters);
-      }
-    };
-  }
-});
-
-// src/homebridge-ui/public/js/types.ts
-var init_types = __esm({
-  "src/homebridge-ui/public/js/types.ts"() {
-    "use strict";
-  }
-});
-
-// src/homebridge-ui/public/js/modal.ts
-function callUiMethod(name, ...args) {
-  try {
-    if (typeof homebridge?.[name] === "function") {
-      uiLog.info(`[callUiMethod] Invoking homebridge.${String(name)}()`);
-      const fn = homebridge?.[name];
-      if (typeof fn === "function") {
-        uiLog.info(`[callUiMethod] Invoking homebridge.${String(name)}()`);
-        fn.apply(homebridge, args);
-      } else {
-        uiLog.warn(`[callUiMethod] homebridge[${String(name)}] is not a function.`);
-      }
-    } else {
-      uiLog.warn(`[callUiMethod] homebridge[${String(name)}] is not a function.`);
-    }
-  } catch (e) {
-    uiLog.warn(`Homebridge UI method ${String(name)} failed:`, e);
-  }
-}
-function showBusyUi() {
-  callUiMethod("disableSaveButton");
-  callUiMethod("showSpinner");
-}
-function hideBusyUi() {
-  callUiMethod("hideSpinner");
-  callUiMethod("enableSaveButton");
-}
-var init_modal = __esm({
-  "src/homebridge-ui/public/js/modal.ts"() {
-    "use strict";
-    init_types();
-    init_logger();
-  }
-});
-
-// src/homebridge-ui/public/js/toast.ts
-function showToast(method, message, title = "SwitchBot") {
-  try {
-    const hb = typeof window !== "undefined" ? window.homebridge : void 0;
-    const toast = hb && typeof hb.toast === "object" ? hb.toast : void 0;
-    const fn = toast && typeof toast[method] === "function" ? toast[method] : void 0;
-    if (fn) {
-      try {
-        fn(message, title);
-        return;
-      } catch (err) {
-        uiLog.warn(`Toast ${method} threw:`, err);
-      }
-    }
-    uiLog.info(`[Toast:${method}] ${title} - ${message}`);
-  } catch (e) {
-    uiLog.warn(`Toast ${method} outer error:`, e);
-    uiLog.info(`[Toast:${method}] ${title} - ${message}`);
-  }
-}
-function toastSuccess(message, title) {
-  showToast("success", message, title);
-}
-function toastError(message, title) {
-  showToast("error", message, title);
-}
-function toastWarning(message, title) {
-  showToast("warning", message, title);
-}
-function toastInfo(message, title) {
-  showToast("info", message, title);
-}
-var init_toast = __esm({
-  "src/homebridge-ui/public/js/toast.ts"() {
-    "use strict";
-    init_types();
-    init_logger();
-  }
-});
-
 // src/device-types.js
 function getValidDeviceTypes() {
   const validTypes = /* @__PURE__ */ new Set();
@@ -354,6 +249,91 @@ var init_device_types = __esm({
   }
 });
 
+// src/homebridge-ui/utils/v4-detection.ts
+function isV4Config(platform) {
+  if (!platform || typeof platform !== "object") {
+    return false;
+  }
+  const hasCredentials = platform.credentials !== void 0 && typeof platform.credentials === "object";
+  const hasOptionsDevices = platform.options !== void 0 && typeof platform.options === "object" && Array.isArray(platform.options.devices);
+  return hasCredentials || hasOptionsDevices;
+}
+var init_v4_detection = __esm({
+  "src/homebridge-ui/utils/v4-detection.ts"() {
+    "use strict";
+  }
+});
+
+// src/homebridge-ui/public/js/types.ts
+var init_types = __esm({
+  "src/homebridge-ui/public/js/types.ts"() {
+    "use strict";
+  }
+});
+
+// src/homebridge-ui/public/js/logger.ts
+var PREFIX, uiLog;
+var init_logger = __esm({
+  "src/homebridge-ui/public/js/logger.ts"() {
+    "use strict";
+    PREFIX = "[SwitchBot UI/html]";
+    uiLog = {
+      info: (message, ...parameters) => {
+        console.log(PREFIX, message, ...parameters);
+      },
+      warn: (message, ...parameters) => {
+        console.warn(PREFIX, message, ...parameters);
+      },
+      error: (message, ...parameters) => {
+        console.error(PREFIX, message, ...parameters);
+      },
+      debug: (message, ...parameters) => {
+        console.debug(PREFIX, message, ...parameters);
+      }
+    };
+  }
+});
+
+// src/homebridge-ui/public/js/toast.ts
+function showToast(method, message, title = "SwitchBot") {
+  try {
+    const hb = typeof window !== "undefined" ? window.homebridge : void 0;
+    const toast = hb && typeof hb.toast === "object" ? hb.toast : void 0;
+    const fn = toast && typeof toast[method] === "function" ? toast[method] : void 0;
+    if (fn) {
+      try {
+        fn(message, title);
+        return;
+      } catch (err) {
+        uiLog.warn(`Toast ${method} threw:`, err);
+      }
+    }
+    uiLog.info(`[Toast:${method}] ${title} - ${message}`);
+  } catch (e) {
+    uiLog.warn(`Toast ${method} outer error:`, e);
+    uiLog.info(`[Toast:${method}] ${title} - ${message}`);
+  }
+}
+function toastSuccess(message, title) {
+  showToast("success", message, title);
+}
+function toastError(message, title) {
+  showToast("error", message, title);
+}
+function toastWarning(message, title) {
+  showToast("warning", message, title);
+}
+function toastInfo(message, title) {
+  showToast("info", message, title);
+}
+var init_toast = __esm({
+  "src/homebridge-ui/public/js/toast.ts"() {
+    "use strict";
+    init_types();
+    init_logger();
+  }
+});
+
 // src/homebridge-ui/public/js/api.ts
 var api_exports = {};
 __export(api_exports, {
@@ -361,11 +341,12 @@ __export(api_exports, {
   addDevicesInBulk: () => addDevicesInBulk,
   deleteAllDevices: () => deleteAllDevices,
   deleteDevice: () => deleteDevice,
+  detectV4Config: () => detectV4Config,
   discoverDevices: () => discoverDevices,
   fetchBluetoothStatus: () => fetchBluetoothStatus,
   fetchCredentialStatus: () => fetchCredentialStatus,
   fetchDevices: () => fetchDevices,
-  saveCredentials: () => saveCredentials2,
+  saveCredentials: () => saveCredentials,
   syncParentPluginConfigFromDisk: () => syncParentPluginConfigFromDisk,
   testDeviceConnection: () => testDeviceConnection,
   updateDevice: () => updateDevice,
@@ -388,6 +369,25 @@ async function fetchDevices() {
     return [];
   }
 }
+async function detectV4Config() {
+  try {
+    if (typeof homebridge.getPluginConfig !== "function") {
+      return false;
+    }
+    const configArr = await homebridge.getPluginConfig();
+    if (!Array.isArray(configArr)) {
+      return false;
+    }
+    const config = configArr.find(isSwitchBotPlatformConfig);
+    if (!config || typeof config !== "object") {
+      return false;
+    }
+    return isV4Config(config);
+  } catch (e) {
+    uiLog.warn("Error detecting v4 config:", e);
+    return false;
+  }
+}
 function validateAndFixDeviceTypes(devices) {
   const errors = [];
   for (const d of devices) {
@@ -457,7 +457,7 @@ async function fetchCredentialStatus() {
     return null;
   }
 }
-async function saveCredentials2(token, secret) {
+async function saveCredentials(token, secret) {
   uiLog.info("Saving credentials...");
   const resp = await homebridge.request("/credentials", { token, secret });
   uiLog.info("Save response:", resp);
@@ -532,6 +532,24 @@ async function addDevice(deviceId, name, type, options) {
   if (options?.keyId) {
     newDevice.keyId = options.keyId;
   }
+  if (options?.connectionPreference) {
+    newDevice.connectionPreference = options.connectionPreference;
+  }
+  if (options?.externalPublishProtocol) {
+    newDevice.externalPublishProtocol = options.externalPublishProtocol;
+  }
+  if (options?.room) {
+    newDevice.room = options.room;
+  }
+  if (typeof options?.refreshRate === "number" && Number.isFinite(options.refreshRate)) {
+    newDevice.refreshRate = options.refreshRate;
+  }
+  if (typeof options?.blePollingEnabled === "boolean") {
+    newDevice.blePollingEnabled = options.blePollingEnabled;
+  }
+  if (typeof options?.blePollIntervalMs === "number" && Number.isFinite(options.blePollIntervalMs)) {
+    newDevice.blePollIntervalMs = options.blePollIntervalMs;
+  }
   config.devices.push(newDevice);
   await homebridge.updatePluginConfig(configArr);
   if (typeof homebridge.savePluginConfig === "function") {
@@ -639,12 +657,48 @@ var init_api = __esm({
   "src/homebridge-ui/public/js/api.ts"() {
     "use strict";
     init_device_types();
+    init_v4_detection();
     init_types();
     init_logger();
     init_toast();
   }
 });
 
+// src/homebridge-ui/public/js/modal.ts
+function callUiMethod(name, ...args) {
+  try {
+    if (typeof homebridge?.[name] === "function") {
+      uiLog.info(`[callUiMethod] Invoking homebridge.${String(name)}()`);
+      const fn = homebridge?.[name];
+      if (typeof fn === "function") {
+        uiLog.info(`[callUiMethod] Invoking homebridge.${String(name)}()`);
+        fn.apply(homebridge, args);
+      } else {
+        uiLog.warn(`[callUiMethod] homebridge[${String(name)}] is not a function.`);
+      }
+    } else {
+      uiLog.warn(`[callUiMethod] homebridge[${String(name)}] is not a function.`);
+    }
+  } catch (e) {
+    uiLog.warn(`Homebridge UI method ${String(name)} failed:`, e);
+  }
+}
+function showBusyUi() {
+  callUiMethod("disableSaveButton");
+  callUiMethod("showSpinner");
+}
+function hideBusyUi() {
+  callUiMethod("hideSpinner");
+  callUiMethod("enableSaveButton");
+}
+var init_modal = __esm({
+  "src/homebridge-ui/public/js/modal.ts"() {
+    "use strict";
+    init_types();
+    init_logger();
+  }
+});
+
 // src/homebridge-ui/public/js/discovery.ts
 var discovery_exports = {};
 __export(discovery_exports, {
@@ -1892,6 +1946,27 @@ async function importDiscoveredDevice(device) {
       opt.selected = (device.connectionPreference || "auto") === val;
       connectionPrefSelect.appendChild(opt);
     });
+    const externalPublishLabel = document.createElement("label");
+    externalPublishLabel.textContent = "Publish as External Device";
+    externalPublishLabel.style.display = "block";
+    externalPublishLabel.style.marginBottom = "6px";
+    externalPublishLabel.style.fontWeight = "500";
+    externalPublishLabel.style.fontSize = "12px";
+    externalPublishLabel.style.color = "#6b7280";
+    const externalPublishSelect = document.createElement("select");
+    externalPublishSelect.style.width = "100%";
+    externalPublishSelect.style.marginBottom = "12px";
+    externalPublishSelect.style.padding = "8px 10px";
+    externalPublishSelect.style.borderRadius = "6px";
+    externalPublishSelect.style.fontSize = "14px";
+    externalPublishSelect.style.boxSizing = "border-box";
+    ["none", "hap", "matter"].forEach((val) => {
+      const opt = document.createElement("option");
+      opt.value = val;
+      opt.text = val === "none" ? "None" : val.toUpperCase();
+      opt.selected = (device.externalPublishProtocol || "none") === val;
+      externalPublishSelect.appendChild(opt);
+    });
     const roomLabel = document.createElement("label");
     roomLabel.textContent = "Room";
     roomLabel.style.display = "block";
@@ -2023,6 +2098,7 @@ async function importDiscoveredDevice(device) {
         configDeviceType: typeSelect.value || device.type,
         address: macInput.value || void 0,
         connectionPreference: connectionPrefSelect.value || void 0,
+        externalPublishProtocol: externalPublishSelect.value || "none",
         room: roomInput.value || void 0,
         encryptionKey: encryptionKeyInput.value || void 0,
         keyId: keyIdInput.value || void 0,
@@ -2044,6 +2120,8 @@ async function importDiscoveredDevice(device) {
     contentDiv.appendChild(typeSelect);
     contentDiv.appendChild(connectionPrefLabel);
     contentDiv.appendChild(connectionPrefSelect);
+    contentDiv.appendChild(externalPublishLabel);
+    contentDiv.appendChild(externalPublishSelect);
     contentDiv.appendChild(roomLabel);
     contentDiv.appendChild(roomInput);
     contentDiv.appendChild(macLabel);
@@ -2249,6 +2327,27 @@ async function editDevice(device) {
     opt.selected = (device.connectionPreference || "auto") === val;
     connectionPrefSelect.appendChild(opt);
   });
+  const externalPublishLabel = document.createElement("label");
+  externalPublishLabel.textContent = "Publish as External Device";
+  externalPublishLabel.style.display = "block";
+  externalPublishLabel.style.marginBottom = "6px";
+  externalPublishLabel.style.fontWeight = "500";
+  externalPublishLabel.style.fontSize = "12px";
+  externalPublishLabel.style.color = "#6b7280";
+  const externalPublishSelect = document.createElement("select");
+  externalPublishSelect.style.width = "100%";
+  externalPublishSelect.style.marginBottom = "12px";
+  externalPublishSelect.style.padding = "8px 10px";
+  externalPublishSelect.style.borderRadius = "6px";
+  externalPublishSelect.style.fontSize = "14px";
+  externalPublishSelect.style.boxSizing = "border-box";
+  ["none", "hap", "matter"].forEach((val) => {
+    const opt = document.createElement("option");
+    opt.value = val;
+    opt.text = val === "none" ? "None" : val.toUpperCase();
+    opt.selected = (device.externalPublishProtocol || "none") === val;
+    externalPublishSelect.appendChild(opt);
+  });
   const roomLabel = document.createElement("label");
   roomLabel.textContent = "Room";
   roomLabel.style.display = "block";
@@ -2337,6 +2436,7 @@ async function editDevice(device) {
         configDeviceName: nameInput.value || void 0,
         configDeviceType: typeSelect.value,
         connectionPreference: connectionPrefSelect.value,
+        externalPublishProtocol: externalPublishSelect.value,
         room: roomInput.value || void 0,
         encryptionKey: encryptionKeyInput.value || void 0,
         keyId: keyIdInput.value || void 0,
@@ -2351,6 +2451,9 @@ async function editDevice(device) {
       if (params.room !== void 0) {
         options.room = params.room;
       }
+      if (params.externalPublishProtocol !== void 0) {
+        options.externalPublishProtocol = params.externalPublishProtocol;
+      }
       if (params.encryptionKey !== void 0) {
         options.encryptionKey = params.encryptionKey;
       }
@@ -2395,6 +2498,8 @@ async function editDevice(device) {
   contentDiv.appendChild(typeSelect);
   contentDiv.appendChild(connectionPrefLabel);
   contentDiv.appendChild(connectionPrefSelect);
+  contentDiv.appendChild(externalPublishLabel);
+  contentDiv.appendChild(externalPublishSelect);
   contentDiv.appendChild(roomLabel);
   contentDiv.appendChild(roomInput);
   contentDiv.appendChild(encryptionKeyLabel);
@@ -3439,8 +3544,9 @@ function renderDeviceList(list) {
     meta.style.fontSize = "11px";
     const typeText = d.type ? `type: ${d.type}` : "";
     const connText = d.connectionPreference ? `conn: ${d.connectionPreference}` : "";
+    const extText = d.externalPublishProtocol && d.externalPublishProtocol !== "none" ? `external: ${d.externalPublishProtocol}` : "";
     const roomText = d.room ? `room: ${d.room}` : "";
-    meta.textContent = [typeText, connText, roomText].filter(Boolean).join(" | ");
+    meta.textContent = [typeText, connText, extText, roomText].filter(Boolean).join(" | ");
     info.appendChild(nameContainer);
     info.appendChild(meta);
     info.appendChild(expandedDetails);
@@ -3537,8 +3643,14 @@ async function addDeviceToConfig2(device, options = {}) {
       address: importValues.address,
       model: device.model,
       rssi: device.rssi,
+      connectionPreference: importValues.connectionPreference,
+      externalPublishProtocol: importValues.externalPublishProtocol,
+      room: importValues.room,
       encryptionKey: importValues.encryptionKey,
-      keyId: importValues.keyId
+      keyId: importValues.keyId,
+      refreshRate: importValues.refreshRate,
+      blePollingEnabled: importValues.blePollingEnabled,
+      blePollIntervalMs: importValues.blePollIntervalMs
     });
     uiLog.info("Add device response:", resp);
     const alreadyExists = !!resp?.alreadyExists;
@@ -3609,6 +3721,9 @@ var init_devices = __esm({
   }
 });
 
+// src/homebridge-ui/public/js/app.ts
+init_api();
+
 // src/homebridge-ui/public/js/credentials.ts
 init_logger();
 init_modal();
@@ -3646,7 +3761,7 @@ async function loadCredentialStatus() {
     uiLog.error("Error loading credentials:", e);
   }
 }
-async function saveCredentials() {
+async function saveCredentials2() {
   const token = document.getElementById("token")?.value;
   const secret = document.getElementById("secret")?.value;
   const saveStatus = document.getElementById("saveStatus");
@@ -3706,9 +3821,20 @@ async function saveCredentials() {
 init_devices();
 init_discovery();
 window.loadCredentialStatus = loadCredentialStatus;
-window.saveCredentials = saveCredentials;
+window.saveCredentials = saveCredentials2;
 window.discoverDevices = discoverDevices2;
+async function checkV4Config() {
+  const banner = document.getElementById("v4ConfigWarning");
+  if (!banner) {
+    return;
+  }
+  const isV4 = await detectV4Config();
+  if (isV4) {
+    banner.style.display = "block";
+  }
+}
 async function init() {
+  await checkV4Config();
   await loadCredentialStatus();
   await initializeDiscoverySettings();
   await loadConfiguredDevices();