@switchbot/homebridge-switchbot 5.0.0-beta.11 → 5.0.0-beta.13

package/src/utils.test.ts

@@ -0,0 +1,96 @@
+import { describe, expect, it, vi } from 'vitest'
+
+import { createPlatformProxy, detectMatter } from './utils.js'
+
+describe('detectMatter', () => {
+  it('returns enabled true when api.isMatterEnabled is a function that returns true', () => {
+    const api: any = { isMatterEnabled: () => true }
+    const info = detectMatter(api)
+    expect(info.enabled).toBe(true)
+    expect(info.reason).toMatch(/isMatterEnabled\(\)/)
+  })
+
+  it('returns enabled true when api.isMatterEnabled is a truthy property', () => {
+    const api: any = { isMatterEnabled: true }
+    const info = detectMatter(api)
+    expect(info.enabled).toBe(true)
+    expect(info.reason).toMatch(/property present/)
+  })
+
+  it('uses server fallback when present', () => {
+    const api: any = { server: { isMatterEnabled: () => false } }
+    const info = detectMatter(api)
+    expect(info.enabled).toBe(false)
+    expect(info.reason).toMatch(/server.isMatterEnabled\(\)/)
+  })
+
+  it('returns enabled false with a reason when no API is present', () => {
+    const api: any = {}
+    const info = detectMatter(api)
+    expect(info.enabled).toBe(false)
+    expect(typeof info.reason).toBe('string')
+  })
+})
+
+describe('createPlatformProxy', () => {
+  it('selects HAP platform when Matter is disabled and delegates configureAccessory', () => {
+    class HapStub {
+      public static created = false
+      public configured: any = undefined
+      constructor(public log: any, public config: any, public api: any) {
+        HapStub.created = true
+      }
+
+      configureAccessory(acc: any) {
+        this.configured = acc
+      }
+    }
+
+    class MatterStub {
+      constructor() {
+        throw new Error('should not be constructed')
+      }
+    }
+
+    const ProxyCtor = createPlatformProxy(HapStub as any, MatterStub as any)
+    const log = { info: vi.fn() }
+    const api = { isMatterEnabled: false }
+    const proxy = new (ProxyCtor as any)(log, {}, api)
+
+    // delegate should be instance of HapStub
+    expect(HapStub.created).toBe(true)
+    expect(typeof proxy.delegate.configureAccessory).toBe('function')
+    proxy.configureAccessory('accessory')
+    expect(proxy.delegate.configured).toBe('accessory')
+    // log should mention HAP
+    expect((log.info as any).mock.calls[0][0]).toMatch(/HAP/)
+  })
+
+  it('selects Matter platform when isMatterEnabled is true', () => {
+    class HapStub2 {
+      constructor() {
+        throw new Error('should not be constructed')
+      }
+    }
+
+    class MatterStub2 {
+      public configured: any = undefined
+      constructor(public log: any, public config: any, public api: any) {}
+
+      configureMatterAccessory(acc: any) {
+        this.configured = acc
+      }
+    }
+
+    const ProxyCtor = createPlatformProxy(HapStub2 as any, MatterStub2 as any)
+    const log = { info: vi.fn() }
+    const api = { isMatterEnabled: () => true }
+    const proxy = new (ProxyCtor as any)(log, {}, api)
+
+    // delegate should be instance of MatterStub2
+    expect(typeof proxy.delegate.configureMatterAccessory).toBe('function')
+    ;(proxy as any).configureMatterAccessory('macc')
+    expect(proxy.delegate.configured).toBe('macc')
+    expect((log.info as any).mock.calls[0][0]).toMatch(/Matter/)
+  })
+})

package/src/utils.ts

@@ -2,6 +2,7 @@
  *
  * util.ts: @switchbot/homebridge-switchbot platform class.
  */
+import type { API } from 'homebridge'
 import type { blindTilt, curtain, curtain3, device } from 'node-switchbot'
 
 import type { devicesConfig } from './settings.js'
@@ -716,3 +717,99 @@ export function cleanDeviceConfig(deviceConfig?: Record<string, Record<string, a
   }
   return undefined
 }
+
+/**
+ * Detect whether Matter is enabled/available on the provided Homebridge API object.
+ * This encapsulates the multi-fallback detection used across the project.
+ */
+/**
+ * Detect whether Matter is enabled on the provided Homebridge API object.
+ * Returns an object with an `enabled` boolean and an optional `reason` string
+ * describing which check matched (useful for diagnostics).
+ */
+export function detectMatter(apiObj: API): { enabled: boolean, reason?: string } {
+  try {
+    const maybe = (apiObj as any).isMatterEnabled
+    if (typeof maybe === 'function') {
+      return { enabled: Boolean(maybe.call(apiObj)), reason: 'api.isMatterEnabled() returned truthy' }
+    }
+    if (typeof maybe !== 'undefined') {
+      return { enabled: Boolean(maybe), reason: 'api.isMatterEnabled property present' }
+    }
+
+    const server = (apiObj as any).server ?? (apiObj as any).homebridgeServer ?? (apiObj as any).homebridge_server
+    const serverMaybe = server?.isMatterEnabled
+    if (typeof serverMaybe === 'function') {
+      return { enabled: Boolean(serverMaybe.call(server)), reason: 'server.isMatterEnabled() returned truthy' }
+    }
+    if (typeof server?.isMatterEnabled !== 'undefined') {
+      return { enabled: Boolean(server.isMatterEnabled), reason: 'server.isMatterEnabled property present' }
+    }
+  } catch (e: any) {
+    return { enabled: false, reason: `error during detection: ${String(e?.message ?? e)}` }
+  }
+  return { enabled: false, reason: 'no isMatterEnabled API or server fallback detected' }
+}
+
+/**
+ * Backwards-compatible boolean wrapper for detectMatter.
+ */
+export function detectMatterEnabled(apiObj: API): boolean {
+  return detectMatter(apiObj).enabled
+}
+
+/**
+ * Create a Platform proxy class that selects between two platform constructors
+ * (HAP vs Matter) at runtime using `detectMatter`. Returns a class suitable
+ * for passing to `api.registerPlatform`.
+ */
+export function createPlatformProxy(HAPCtor: any, MatterCtor: any) {
+  return class PlatformProxy {
+    delegate: any
+
+    constructor(public readonly log: any, public readonly config: any, public readonly api: API) {
+      const matterInfo = detectMatter(this.api)
+      const isMatter = matterInfo.enabled
+      const reason = matterInfo.reason ? ` Reason: ${matterInfo.reason}` : ''
+      this.log.info?.(`Homebridge SwitchBot Plugin initializing in ${isMatter ? 'Matter' : 'HAP'} mode.${reason}`)
+      const PlatformCtor = isMatter ? MatterCtor : HAPCtor
+      this.delegate = new PlatformCtor(this.log, this.config, this.api)
+    }
+
+    configureAccessory(accessory: any): void {
+      try {
+        if (this.delegate && typeof this.delegate.configureAccessory === 'function') {
+          return this.delegate.configureAccessory(accessory)
+        }
+      } catch (e) {
+        // swallow — preserve previous behaviour where delegate errors don't bubble here
+      }
+    }
+
+    configureMatterAccessory?(accessory: any): void {
+      try {
+        if (this.delegate && typeof this.delegate.configureMatterAccessory === 'function') {
+          return this.delegate.configureMatterAccessory(accessory)
+        }
+      } catch (e) {
+        // swallow — delegate may not implement this or may throw
+      }
+    }
+
+    get accessories(): any {
+      try {
+        return this.delegate?.accessories
+      } catch (e) {
+        return undefined
+      }
+    }
+
+    get matterAccessories(): any {
+      try {
+        return this.delegate?.matterAccessories
+      } catch (e) {
+        return undefined
+      }
+    }
+  }
+}