@switchbot/homebridge-switchbot 5.0.0-beta.98 → 5.0.0

package/test/platform/platform-edge.spec.ts

@@ -0,0 +1,73 @@
+import { describe, expect, it } from 'vitest'
+
+import SwitchBotHAPPlatform from '../../src/SwitchBotHAPPlatform.js'
+import { SwitchBotMatterPlatform } from '../../src/SwitchBotMatterPlatform.js'
+
+const mockLogger = {
+  info: () => {},
+  warn: () => {},
+  error: () => {},
+  debug: () => {},
+  success: () => {},
+  log: () => {},
+}
+const mockApi = { isMatterAvailable: () => false, isMatterEnabled: () => false } as any
+
+describe('platform edge cases', () => {
+  const platforms = [
+    { name: 'SwitchBotHAPPlatform', Platform: SwitchBotHAPPlatform },
+    { name: 'SwitchBotMatterPlatform', Platform: SwitchBotMatterPlatform },
+  ]
+
+  for (const { name, Platform } of platforms) {
+    describe(`${name}`, () => {
+      it('should handle missing config', () => {
+        expect(() => new Platform(mockLogger, { platform: 'SwitchBot' }, mockApi as any)).not.toThrow()
+      })
+
+      it('should handle undefined config', () => {
+        expect(() => new Platform(mockLogger, undefined as any, mockApi)).not.toThrow()
+      })
+
+      it('should handle null config', () => {
+        expect(() => new Platform(mockLogger, null as any, mockApi)).not.toThrow()
+      })
+
+      it('should handle missing api', () => {
+        expect(() => new Platform(mockLogger, { platform: 'SwitchBot' }, undefined as any)).not.toThrow()
+      })
+
+      it('should handle null api', () => {
+        expect(() => new Platform(mockLogger, { platform: 'SwitchBot' }, null as any)).not.toThrow()
+      })
+
+      it('should handle missing logger', () => {
+        expect(() => new Platform(undefined as any, { platform: 'SwitchBot' }, mockApi)).toThrow()
+      })
+
+      it('should handle null logger', () => {
+        expect(() => new Platform(null as any, { platform: 'SwitchBot' }, mockApi)).toThrow()
+      })
+
+      it('should not throw with minimal valid config', () => {
+        const config = { name: 'SwitchBot', platform: 'SwitchBot' }
+        expect(() => new Platform(mockLogger, config, mockApi)).not.toThrow()
+      })
+
+      it('should fallback gracefully if isMatterAvailable returns true but isMatterEnabled returns false', () => {
+        const api = { ...mockApi, isMatterAvailable: () => true, isMatterEnabled: () => false }
+        expect(() => new Platform(mockLogger, { platform: 'SwitchBot' }, api)).not.toThrow()
+      })
+
+      it('should fallback gracefully if isMatterAvailable returns false', () => {
+        const api = { ...mockApi, isMatterAvailable: () => false }
+        expect(() => new Platform(mockLogger, { platform: 'SwitchBot' }, api)).not.toThrow()
+      })
+
+      it('should not throw if config has extra unknown properties', () => {
+        const config = { name: 'SwitchBot', platform: 'SwitchBot', extra: 123 }
+        expect(() => new Platform(mockLogger, config, mockApi)).not.toThrow()
+      })
+    })
+  }
+})

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

@@ -0,0 +1,34 @@
+import { describe, expect, it, vi } from 'vitest'
+
+import { SwitchBotHAPPlatform } from '../../src/SwitchBotHAPPlatform.js'
+
+describe('hAP platform integration', () => {
+  class TestHAPPlatform extends SwitchBotHAPPlatform {
+    constructor(logger: any, config: any, api: any) { super(logger, config, api) }
+    setCache(cache: any[]) { (this as any)._accessoryCache = cache }
+    getRestored() { return (this as any)._accessoryCache }
+    registerAccessory(acc: any) { (this as any)._accessoryCache.push(acc) }
+  }
+
+  const logger = { info: vi.fn(), warn: vi.fn(), error: vi.fn(), debug: vi.fn() }
+  const config = {}
+  const api = {}
+
+  it('should restore accessories from cache', () => {
+    const platform = new TestHAPPlatform(logger, config, api)
+    platform.setCache([{ uuid: 'hap-acc-1', context: { type: 'Bot' } }])
+    const restored = platform.getRestored()
+    expect(restored).toHaveLength(1)
+    expect(restored[0].uuid).toBe('hap-acc-1')
+  })
+
+  it('should register a new accessory', () => {
+    const platform = new TestHAPPlatform(logger, config, api)
+    platform.setCache([])
+    const newAcc = { uuid: 'hap-acc-2', context: { type: 'Curtain' } }
+    platform.registerAccessory(newAcc)
+    const restored = platform.getRestored()
+    expect(restored).toHaveLength(1)
+    expect(restored[0].uuid).toBe('hap-acc-2')
+  })
+})

package/test/utils/utils-extra.spec.ts

@@ -0,0 +1,10 @@
+import { describe, expect, it } from 'vitest'
+
+import * as utils from '../../src/utils'
+
+describe('extra utils', () => {
+  it('normalizeConfig returns empty object for undefined', () => {
+    expect(utils.normalizeConfig(undefined)).toEqual({})
+  })
+  // Add more utility tests as needed
+})

package/test/utils/utils.spec.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, vi } from 'vitest'
+
+import {
+  createPlatformProxy,
+  MATTER_ATTRIBUTE_IDS,
+  MATTER_CLUSTER_IDS,
+  normalizeConfig,
+} from '../../src/utils'
+
+describe('utils', () => {
+  it('should expose correct MATTER_CLUSTER_IDS', () => {
+    expect(MATTER_CLUSTER_IDS.OnOff).toBe(0x0006)
+    expect(MATTER_CLUSTER_IDS.FanControl).toBe(0x0202)
+  })
+
+  it('should expose correct MATTER_ATTRIBUTE_IDS', () => {
+    expect(MATTER_ATTRIBUTE_IDS.OnOff.OnOff).toBe(0x0000)
+    expect(MATTER_ATTRIBUTE_IDS.ColorControl.CurrentHue).toBe(0x0000)
+  })
+
+  it('normalizeConfig returns empty object for undefined', () => {
+    expect(normalizeConfig(undefined)).toEqual({})
+  })
+
+  it('normalizeConfig returns shallow copy of config', () => {
+    const input = { foo: 'bar', preferMatter: false }
+    const result = normalizeConfig(input as any)
+    expect(result).toMatchObject(input)
+    expect(result).not.toBe(input)
+  })
+
+  it('createPlatformProxy instantiates MatterPlatform if available and enabled', () => {
+    const HAP = vi.fn()
+    const Matter = vi.fn()
+    const api = { isMatterAvailable: () => true, isMatterEnabled: () => true }
+    const config = { enableMatter: true, preferMatter: true }
+    const Proxy = createPlatformProxy(HAP, Matter)
+    new Proxy('log', config, api)
+    expect(Matter).toHaveBeenCalled()
+    expect(HAP).not.toHaveBeenCalled()
+  })
+
+  it('createPlatformProxy falls back to HAPPlatform if Matter not available', () => {
+    const HAP = vi.fn()
+    const Matter = vi.fn()
+    const api = { isMatterAvailable: () => false, isMatterEnabled: () => false }
+    const config = { enableMatter: true, preferMatter: true }
+    const Proxy = createPlatformProxy(HAP, Matter)
+    new Proxy('log', config, api)
+    expect(HAP).toHaveBeenCalled()
+    expect(Matter).not.toHaveBeenCalled()
+  })
+})

package/todo/TODO.md

@@ -0,0 +1,80 @@
+# SwitchBot Plugin TODO List
+
+- [ ] Implement battery level trending (if historical data available)
+- [ ] Add "Export Results" button (JSON format)
+- [ ] Add "Import Results" for comparison or troubleshooting
+- [ ] Share with support for debugging
+- [ ] Compare current vs previous discovery (show differences)
+- [ ] Generate discovery report (formatted summary)
+- [ ] **Test discovery with real hardware**
+- [ ] Test BLE discovery with nearby devices
+- [ ] Test OpenAPI discovery with cloud-registered devices
+- [ ] Test with mixed BLE+API devices
+- [ ] Test connection type badge display
+- [ ] Verify deduplication works correctly
+- [ ] **Add error handling improvements**
+- [ ] Better error messages for users
+- [ ] Retry logic with exponential backoff
+- [ ] Graceful degradation when BLE unavailable
+- [ ] Network timeout handling
+- [ ] **Update README with discovery features**
+- [ ] Document BLE vs OpenAPI discovery
+- [ ] Add screenshots of new UI features
+- [ ] Explain connection type badges
+- [ ] Add troubleshooting guide for discovery issues
+- [ ] **Create developer documentation**
+- [ ] Document new modular structure
+- [ ] API documentation for endpoints
+- [ ] Contributing guidelines for UI changes
+- [ ] Better Loading States
+- [ ] Connection Recommendations
+- [ ] Device Grouping
+- [ ] Test discovery with real hardware
+- [ ] Update README with new features
+- [ ] Configurable BLE Scan
+- [ ] Discovery History/Cache
+- [ ] Connection Testing
+- [ ] Batch Import
+- [ ] Device Health Dashboard
+- [ ] Add checkboxes to select multiple devices
+- [ ] Add "Add Selected to Config" button
+- [ ] Implement bulk configuration with smart defaults
+- [ ] Add "Needs Attention" section at top
+- [ ] Implement battery level trending (if historical data available)
+- [ ] Add "Export Results" button (JSON format)
+- [ ] Add "Import Results" for comparison or troubleshooting
+- [ ] Share with support for debugging
+- [ ] Compare current vs previous discovery (show differences)
+- [ ] Generate discovery report (formatted summary)
+- [ ] Add tests for battery level trending logic
+- [ ] **Test discovery with real hardware**
+- [ ] Add tests for battery level trending logic
+- [ ] Test BLE discovery with nearby devices
+- [ ] Test OpenAPI discovery with cloud-registered devices
+- [ ] Test with mixed BLE+API devices
+- [ ] Test connection type badge display
+- [ ] Verify deduplication works correctly
+- [ ] **Add error handling improvements**
+- [ ] Better error messages for users
+- [ ] Retry logic with exponential backoff
+- [ ] Graceful degradation when BLE unavailable
+- [ ] Network timeout handling
+- [ ] **Update README with discovery features**
+- [ ] Document BLE vs OpenAPI discovery
+- [ ] Add screenshots of new UI features
+- [ ] Explain connection type badges
+- [ ] Add troubleshooting guide for discovery issues
+- [ ] **Create developer documentation**
+- [ ] Document new modular structure
+- [ ] API documentation for endpoints
+- [ ] Contributing guidelines for UI changes
+- [ ] Better Loading States
+- [ ] Connection Recommendations
+- [ ] Device Grouping
+- [ ] Test discovery with real hardware
+- [ ] Update README with new features
+- [ ] Configurable BLE Scan
+- [ ] Discovery History/Cache
+- [ ] Connection Testing
+- [ ] Batch Import
+- [ ] Device Health Dashboard

package/tsconfig.ui.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": false,
+    "declarationMap": false,
+    "outDir": "dist/homebridge-ui"
+  },
+  "include": [
+    "src/homebridge-ui/server.ts"
+  ]
+}

package/.github/npm-version-script-esm.js

@@ -1,97 +0,0 @@
-#!/bin/env node
-
-/**
- * This scripts queries the npm registry to pull out the latest version for a given tag.
- */
-
-import assert from 'node:assert'
-import child_process from 'node:child_process'
-import fs from 'node:fs'
-import process from 'node:process'
-
-const BRANCH_VERSION_PATTERN = /^([A-Z]+)-(\d+\.\d+\.\d+)$/i
-
-// Load the contents of the package.json file
-const packageJSON = JSON.parse(fs.readFileSync('package.json', 'utf8'))
-
-const refArgument = process.argv[2]
-const tagArgument = process.argv[3] || 'latest'
-
-if (!refArgument) {
-  console.error('ref argument is missing')
-  console.error('Usage: npm-version-script-esm.js <ref> [tag]')
-  process.exit(1)
-}
-
-/**
- * Queries the NPM registry for the latest version for the provided base version and tag.
- * If the tag is latest, then the base version is returned if it exists. For other tags, the latest
- * version found for that base version and tag is returned.
- * @param baseVersion The base version to query for, e.g. 2.0.0
- * @param tag The tag to query for, e.g. beta or latest
- * @returns {string} Returns the version, or '' if not found
- */
-function getTagVersionFromNpm(baseVersion, tag) {
-  try {
-    return JSON.parse(child_process.execSync(`npm info ${packageJSON.name} versions --json`).toString('utf8').trim())
-      .filter(v => tag === 'latest' ? v === baseVersion : v.startsWith(`${baseVersion}-${tag}.`)) // find all published versions for this base version and tag
-      .reduce((_, current) => current, '') // choose the last as they're sorted in ascending order, or '' if there are none
-  } catch (e) {
-    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`, e)
-    // throw e;
-    return ''
-  }
-}
-
-function desiredTargetVersion(ref) {
-  // ref is a GitHub action ref string
-  if (ref.startsWith('refs/pull/')) {
-    throw new Error('The version script was executed inside a PR!')
-  }
-
-  assert(ref.startsWith('refs/heads/'))
-  const branchName = ref.slice('refs/heads/'.length)
-
-  const results = branchName.match(BRANCH_VERSION_PATTERN)
-  if (results !== null) {
-    if (results[1] !== tagArgument) {
-      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`)
-    }
-
-    return results[2]
-  }
-
-  throw new Error(`Malformed branch name for ref: ${ref}. Can't derive the base version. Use a branch name like: beta-x.x.x or alpha-x.x.x`)
-}
-
-// derive the base version from the branch ref
-const baseVersion = desiredTargetVersion(refArgument)
-
-// query the npm registry for the latest version of the provided tag name
-const latestReleasedVersion = getTagVersionFromNpm(baseVersion, tagArgument) // e.g. 0.7.0-beta.12
-
-let publishTag
-
-if (latestReleasedVersion) {
-  console.warn(`Latest published version for ${baseVersion} with tag ${tagArgument} is ${latestReleasedVersion}`)
-  publishTag = latestReleasedVersion // set this released beta or alpha to be incremented
-} else {
-  console.warn(`No published versions for ${baseVersion} with tag ${tagArgument}`)
-  publishTag = baseVersion // start off with a new beta or alpha version
-}
-
-if (packageJSON.version !== publishTag) {
-  // report the change for CI
-  console.warn(`Changing version in package.json from ${packageJSON.version} to ${publishTag}`)
-
-  // save the package.json
-  packageJSON.version = publishTag
-  fs.writeFileSync('package.json', JSON.stringify(packageJSON, null, 2))
-
-  // perform the same change to the package-lock.json
-  const packageLockJSON = JSON.parse(fs.readFileSync('package-lock.json', 'utf8'))
-  packageLockJSON.version = publishTag
-  fs.writeFileSync('package-lock.json', JSON.stringify(packageLockJSON, null, 2))
-} else {
-  console.warn(`Leaving version in package.json at ${packageJSON.version}`)
-}

package/.github/workflows/beta-release.yml

@@ -1,52 +0,0 @@
-name: Beta Release
-
-on:
-  push:
-    branches: [beta-*.*.*, beta]
-  workflow_dispatch:
-
-jobs:
-  build_and_test:
-    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
-    with:
-      enable_coverage: false
-    secrets:
-      token: ${{ secrets.GITHUB_TOKEN }}
-  lint:
-    needs: build_and_test
-    uses: homebridge/.github/.github/workflows/eslint.yml@latest
-
-  publish:
-    needs: lint
-    permissions:
-      id-token: write
-    uses: homebridge/.github/.github/workflows/npm-publish-esm.yml@latest
-    with:
-      tag: 'beta'
-      dynamically_adjust_version: true
-      npm_version_command: 'pre'
-      pre_id: 'beta'
-    secrets:
-      npm_auth_token: ${{ secrets.npm_token }}
-
-  pre-release:
-    needs: publish
-    uses: homebridge/.github/.github/workflows/pre-release.yml@latest
-    with:
-      npm_version: ${{ needs.publish.outputs.NPM_VERSION }}
-      body: |
-        **Beta Release**
-        **Version**: v${{ needs.publish.outputs.NPM_VERSION }}
-        [How To Test Beta Releases](https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Beta-Version)
-
-  github-releases-to-discord:
-    name: Discord Webhooks
-    needs: [build_and_test,publish]
-    uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
-    with:
-      title: "SwitchBot Beta Release"
-      description: |
-        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
-      url: "https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
-    secrets:
-      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/dist/platform.d.ts

@@ -1,35 +0,0 @@
-import type { SwitchBotPluginConfig } from './settings.js';
-import type { API, Logger, PlatformConfig } from 'homebridge';
-export declare class SwitchBotHAPPlatform {
-    api: API | undefined;
-    log: Logger;
-    config: SwitchBotPluginConfig;
-    devices: any[];
-    accessories: Map<string, any>;
-    private lastConfigHash;
-    private configReloadInterval;
-    constructor(log: Logger, config: PlatformConfig, api?: API);
-    private getConfigHash;
-    private checkAndReloadDevices;
-    loadDevices(): Promise<void>;
-    configureAccessory(accessory: any): Promise<void>;
-    configureMatterAccessory?(accessory: any): void;
-}
-export declare class SwitchBotMatterPlatform {
-    api: API | undefined;
-    log: Logger;
-    config: SwitchBotPluginConfig;
-    devices: any[];
-    accessories: Map<string, any>;
-    private lastConfigHash;
-    private configReloadInterval;
-    constructor(log: Logger, config: PlatformConfig, api?: API);
-    loadDevices(): Promise<void>;
-    private getConfigHash;
-    private checkAndReloadDevices;
-    configureAccessory(accessory: any): Promise<void>;
-    configureMatterAccessory(accessory: any): void;
-    registerMatterAccessories(): Promise<void>;
-}
-export default SwitchBotHAPPlatform;
-//# sourceMappingURL=platform.d.ts.map

package/dist/platform.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AA0P7D,qBAAa,oBAAoB;IAC/B,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,qBAAqB,CAAA;IAC7B,OAAO,EAAE,GAAG,EAAE,CAAK;IAEnB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE7B,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,oBAAoB,CAA8B;gBAE9C,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAAE,GAAG;IA2C1D,OAAO,CAAC,aAAa;YAUP,qBAAqB;IAU7B,WAAW;IAoMX,kBAAkB,CAAC,SAAS,EAAE,GAAG;IAYvC,wBAAwB,CAAC,CAAC,SAAS,EAAE,GAAG;CASzC;AAGD,qBAAa,uBAAuB;IAClC,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,qBAAqB,CAAA;IAC7B,OAAO,EAAE,GAAG,EAAE,CAAK;IACnB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE7B,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,oBAAoB,CAA8B;gBAE9C,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAAE,GAAG;IA8CpD,WAAW;IAyEjB,OAAO,CAAC,aAAa;YAUP,qBAAqB;IAU7B,kBAAkB,CAAC,SAAS,EAAE,GAAG;IAWvC,wBAAwB,CAAC,SAAS,EAAE,GAAG;IAWjC,yBAAyB;CAoJhC;AAED,eAAe,oBAAoB,CAAA"}