@switchbot/homebridge-switchbot 5.1.0-beta.0 → 5.1.0-beta.2

package/src/homebridge-ui/public/js/app.ts

@@ -1,13 +1,31 @@
+import { detectV4Config } from './api.js'
 import { loadCredentialStatus, saveCredentials } from './credentials.js'
 import { initRemoveAllButton, loadConfiguredDevices } from './devices.js'
-import { discoverDevices, initializeDiscoverySettings } from './discovery.js';
+import { discoverDevices, initializeDiscoverySettings } from './discovery.js'
 
-(window as any).loadCredentialStatus = loadCredentialStatus;
-(window as any).saveCredentials = saveCredentials;
-(window as any).discoverDevices = discoverDevices
+;
+
+(window as any).loadCredentialStatus = loadCredentialStatus
+;(window as any).saveCredentials = saveCredentials
+;(window as any).discoverDevices = discoverDevices
+
+/**
+ * Show or hide the v4 config incompatibility warning banner.
+ */
+async function checkV4Config(): Promise<void> {
+  const banner = document.getElementById('v4ConfigWarning')
+  if (!banner) {
+    return
+  }
+  const isV4 = await detectV4Config()
+  if (isV4) {
+    banner.style.display = 'block'
+  }
+}
 
 // Initialize on page load
 async function init(): Promise<void> {
+  await checkV4Config()
   await loadCredentialStatus()
   await initializeDiscoverySettings()
   await loadConfiguredDevices()

package/src/homebridge-ui/utils/config-parser.ts

@@ -57,6 +57,15 @@ export function getAllDevices(platform: any): any[] {
   })
 }
 
+/**
+ * Detect whether a platform config block 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.
+ */
+export { isV4Config } from './v4-detection.js'
+
 /**
  * Get credential from platform config
  */

package/src/homebridge-ui/utils/v4-detection.ts

@@ -0,0 +1,23 @@
+/**
+ * Detect whether a platform config block 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.
+ *
+ * This helper has no Node.js-specific dependencies so it can be imported from
+ * both the Homebridge server-side code and the browser-side plugin UI bundle.
+ */
+export function isV4Config(platform: any): boolean {
+  if (!platform || typeof platform !== 'object') {
+    return false
+  }
+  // Presence of a `credentials` sub-object is the clearest v4 signal
+  const hasCredentials = platform.credentials !== undefined && typeof platform.credentials === 'object'
+  // Presence of `options.devices` is the other v4 signal
+  const hasOptionsDevices
+    = platform.options !== undefined
+    && typeof platform.options === 'object'
+    && Array.isArray(platform.options.devices)
+  return hasCredentials || hasOptionsDevices
+}

package/test/homebridge-ui/config-parser.spec.ts

@@ -0,0 +1,61 @@
+import { describe, expect, it } from 'vitest'
+
+import { isV4Config } from '../../src/homebridge-ui/utils/v4-detection.js'
+
+describe('isV4Config', () => {
+  it('returns false for null/undefined input', () => {
+    expect(isV4Config(null)).toBe(false)
+    expect(isV4Config(undefined)).toBe(false)
+  })
+
+  it('returns false for an empty v5 config block', () => {
+    expect(isV4Config({ platform: 'SwitchBot', devices: [] })).toBe(false)
+  })
+
+  it('returns false for a v5 config with credentials omitted', () => {
+    expect(isV4Config({ platform: 'SwitchBot', openApiToken: 'tok', openApiSecret: 'sec', devices: [] })).toBe(false)
+  })
+
+  it('returns true when a credentials sub-object is present (v4 token location)', () => {
+    const v4 = {
+      platform: 'SwitchBot',
+      credentials: { token: 'tok', secret: 'sec', notice: 'Keep your token a secret!' },
+      options: { devices: [] },
+    }
+    expect(isV4Config(v4)).toBe(true)
+  })
+
+  it('returns true when options.devices array is present without credentials (partial v4)', () => {
+    const partialV4 = {
+      platform: 'SwitchBot',
+      options: {
+        devices: [{ deviceId: 'aabbcc', configDeviceName: 'Curtain', configDeviceType: 'Curtain', connectionType: 'BLE' }],
+      },
+    }
+    expect(isV4Config(partialV4)).toBe(true)
+  })
+
+  it('returns true for the exact config from the bug report', () => {
+    const bugReportConfig = {
+      name: 'SwitchBot',
+      credentials: { notice: 'Keep your token a secret!' },
+      options: {
+        devices: [
+          {
+            deviceId: 'xxxxxxxx',
+            configDeviceName: 'Curtain',
+            configDeviceType: 'Curtain',
+            connectionType: 'BLE',
+            hide_lightsensor: false,
+            set_min: 96,
+            set_max: 12,
+            maxRetry: 0,
+            logging: 'standard',
+          },
+        ],
+      },
+      platform: 'SwitchBot',
+    }
+    expect(isV4Config(bugReportConfig)).toBe(true)
+  })
+})

package/test/platform/matter-integration.spec.ts

@@ -30,4 +30,54 @@ describe('matter integration platform', () => {
     const platform = new TestMatterPlatform(logger, config, api)
     expect(platform.getDevices()).toEqual([])
   })
+
+  it('should publish per-device external Matter accessories via the Homebridge external event', async () => {
+    const pendingExternalRegistrations = new Map()
+    const apiWithMatter: any = {
+      matter: {
+        uuid: { generate: (value: string) => `m-${value}` },
+        registerPlatformAccessories: vi.fn(async () => {}),
+      },
+      hap: { uuid: { generate: (value: string) => `h-${value}` } },
+      isMatterAvailable: () => true,
+      isMatterEnabled: () => true,
+      on: vi.fn(),
+      emit: null as any,
+      _pendingExternalRegistrations: pendingExternalRegistrations,
+    }
+    const emit = vi.fn((event: string, accessories: any[], registrationId: string) => {
+      if (event === 'publishExternalMatterAccessories') {
+        const resolve = pendingExternalRegistrations.get(registrationId)
+        resolve?.()
+      }
+      return true
+    })
+    apiWithMatter.emit = emit
+    const platform = new TestMatterPlatform(logger, config, apiWithMatter)
+    const created = {
+      createAccessory: vi.fn(async () => ({
+        name: 'Curtain3',
+        manufacturer: 'SwitchBot',
+        model: 'Curtain3',
+        serialNumber: 'serial-1',
+        deviceType: { deviceType: 514 },
+        clusters: { windowCovering: { currentPositionLiftPercent100ths: 0 } },
+        handlers: {},
+      })),
+    }
+
+    await platform.registerMatterAccessories([
+      {
+        created,
+        d: { id: 'device-1', name: 'Curtain3' },
+        type: 'curtain',
+        useMatter: true,
+        matterAvailable: true,
+        externalPublishProtocol: 'matter',
+      },
+    ])
+
+    expect(emit).toHaveBeenCalledWith('publishExternalMatterAccessories', expect.any(Array), expect.any(String))
+    expect(apiWithMatter.matter.registerPlatformAccessories).not.toHaveBeenCalled()
+  })
 })