@homebridge-plugins/homebridge-august 3.2.3 → 3.3.0-beta.1

package/package.json

@@ -2,21 +2,31 @@
   "name": "@homebridge-plugins/homebridge-august",
   "displayName": "August",
   "type": "module",
-  "version": "3.2.3",
+  "version": "3.3.0-beta.1",
   "description": "The August plugin allows you to access your August & Yale device(s) from HomeKit.",
   "author": {
-    "name": "donavanbecker",
-    "url": "https://github.com/donavanbecker"
+    "name": "bwp91",
+    "email": "bwp91@icloud.com"
   },
+  "contributors": [
+    {
+      "name": "donavanbecker",
+      "url": "https://github.com/donavanbecker"
+    }
+  ],
   "license": "ISC",
   "funding": [
     {
-      "type": "Paypal",
-      "url": "https://paypal.me/donavanbecker"
+      "type": "github",
+      "url": "https://github.com/sponsors/bwp91"
     },
     {
-      "type": "GitHub",
-      "url": "https://github.com/sponsors/donavanbecker"
+      "type": "kofi",
+      "url": "https://ko-fi.com/bwp91"
+    },
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/BenPotter"
     }
   ],
   "homepage": "https://github.com/homebridge-plugins/homebridge-august",
@@ -39,18 +49,15 @@
   "main": "dist/index.js",
   "engines": {
     "homebridge": "^2.0.0",
-    "node": "^22 || ^24"
+    "node": "^22.12.0 || ^24.0.0"
   },
   "scripts": {
-    "check": "npm install && npm outdated",
-    "lint": "eslint src --no-warn-ignored",
-    "lint:fix": "eslint src --fix --no-warn-ignored",
-    "watch": "npm run build && npm run plugin-ui && npm link && nodemon",
+    "lint": "eslint . --max-warnings=0",
+    "lint:fix": "npm run lint -- --fix",
+    "watch": "npm run build && npm link && nodemon",
     "plugin-ui": "rsync ./src/homebridge-ui/public/index.html ./dist/homebridge-ui/public/",
-    "build": "npm run clean && tsc && npm run plugin-ui && cp package.json dist/package.json || true",
-    "prepublishOnly": "npm run lint && npm run build && npm run plugin-ui && npm run docs && npm run docs:lint",
-    "postpublish": "npm run clean && npm ci",
-    "clean": "shx rm -rf ./dist",
+    "build": "rimraf ./dist && tsc && npm run plugin-ui",
+    "prepublishOnly": "npm run lint && npm run build",
     "test": "vitest run",
     "test:watch": "vitest watch",
     "test-coverage": "npm run test -- --coverage",
@@ -61,24 +68,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@homebridge/plugin-ui-utils": "^2.2.3",
-    "august-yale": "^1.2.2",
+    "@homebridge/plugin-ui-utils": "^2.2.5",
+    "august-yale": "1.2.3-beta.0",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^8.2.0",
-    "@types/node": "^25.6.0",
-    "@vitest/coverage-v8": "^4.1.5",
-    "eslint": "^10.3.0",
-    "eslint-plugin-format": "^2.0.1",
-    "eslint-plugin-html": "^8.1.4",
-    "eslint-plugin-perfectionist": "^5.8.0",
-    "eslint-plugin-unused-imports": "^4.4.1",
-    "homebridge": "^2.0.0",
+    "@antfu/eslint-config": "^9.1.0",
+    "@types/node": "^26.1.1",
+    "@vitest/coverage-v8": "^4.1.10",
+    "homebridge": "^2.1.1",
     "nodemon": "^3.1.14",
-    "shx": "^0.4.0",
-    "typedoc": "^0.28.19",
+    "rimraf": "^6.1.3",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.20",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.5"
+    "vitest": "^4.1.10"
+  },
+  "allowScripts": {
+    "fsevents@2.3.3": true
   }
-}
+}

package/test/connectivity-manager.test.ts

@@ -88,7 +88,7 @@ vi.mock('august-yale', () => {
 // Helper: build a stub Logging object that records calls.
 function makeLog(): Logging & { _calls: { level: string, msg: string }[] } {
   const calls: { level: string, msg: string }[] = []
-  const stub = ((..._args: any[]) => {}) as any
+  const stub = (() => {}) as any
   stub._calls = calls
   for (const level of ['info', 'warn', 'error', 'debug', 'success'] as const) {
     stub[level] = (msg: string) => calls.push({ level, msg })
@@ -101,7 +101,7 @@ async function fakeCredentials(): Promise<credentials> {
   return { installId: 'test-install', apiKey: 'test-key' } as unknown as credentials
 }
 
-describe('ConnectivityManager', () => {
+describe('connectivityManager', () => {
   beforeEach(() => {
     // Use fake timers so probes can be advanced deterministically without
     // waiting for real backoff windows (5s..5min).
@@ -187,7 +187,7 @@ describe('ConnectivityManager', () => {
       await m.init()
       const transientErr = Object.assign(new Error('Unprocessable Entity'), { statusCode: 422 })
       await expect(
-        m.execute('test', async () => { throw transientErr }),
+        m.execute('test', async () => Promise.reject(transientErr)),
       ).rejects.toBe(transientErr)
       expect(m.getState()).toBe('healthy')
     })
@@ -209,7 +209,7 @@ describe('ConnectivityManager', () => {
       await m.init()
       expect(onClientChanged).toHaveBeenCalledTimes(1)
       const authErr = Object.assign(new Error('Unauthorized'), { statusCode: 401 })
-      const result = await m.execute('test', async () => { throw authErr })
+      const result = await m.execute('test', async () => Promise.reject(authErr))
       expect(result).toBeUndefined()
       // Allow the rebuild promise to resolve.
       await vi.runAllTimersAsync()
@@ -221,7 +221,7 @@ describe('ConnectivityManager', () => {
       const m = new ConnectivityManager(makeLog(), fakeCredentials)
       await m.init()
       const { TimeoutError } = await import('august-yale')
-      const result = await m.execute('test', async () => { throw new TimeoutError('timed out') })
+      const result = await m.execute('test', async () => Promise.reject(new TimeoutError('timed out')))
       expect(result).toBeUndefined()
       expect(m.getState()).toBe('degraded')
     })
@@ -233,7 +233,7 @@ describe('ConnectivityManager', () => {
       const m = new ConnectivityManager(makeLog(), fakeCredentials)
       await m.init()
       const { NetworkError } = await import('august-yale')
-      const result = await m.execute('test', async () => { throw new NetworkError('socket hang up', undefined, 'ECONNRESET') })
+      const result = await m.execute('test', async () => Promise.reject(new NetworkError('socket hang up', undefined, 'ECONNRESET')))
       expect(result).toBeUndefined()
       expect(m.getState()).toBe('degraded')
     })
@@ -244,7 +244,7 @@ describe('ConnectivityManager', () => {
       await m.init()
       expect(onClientChanged).toHaveBeenCalledTimes(1)
       const { InvalidAuth } = await import('august-yale')
-      const result = await m.execute('test', async () => { throw new InvalidAuth('session expired') })
+      const result = await m.execute('test', async () => Promise.reject(new InvalidAuth('session expired')))
       expect(result).toBeUndefined()
       await vi.runAllTimersAsync()
       expect(onClientChanged).toHaveBeenCalledTimes(2)
@@ -262,7 +262,7 @@ describe('ConnectivityManager', () => {
       const { AbortedError } = await import('august-yale')
       const err = new AbortedError('client destroyed', undefined, 'UND_ERR_DESTROYED')
       await expect(
-        m.execute('test', async () => { throw err }),
+        m.execute('test', async () => Promise.reject(err)),
       ).rejects.toBe(err)
       // State stays healthy — no probe scheduled.
       expect(m.getState()).toBe('healthy')
@@ -275,7 +275,7 @@ describe('ConnectivityManager', () => {
       const m = new ConnectivityManager(makeLog(), fakeCredentials)
       await m.init()
       const err = Object.assign(new Error('Bad Gateway'), { statusCode: 502 })
-      await m.execute('test', async () => { throw err })
+      await m.execute('test', async () => Promise.reject(err))
       expect(m.getState()).toBe('degraded')
     })
   })
@@ -289,7 +289,7 @@ describe('ConnectivityManager', () => {
 
       // Network failure: degrades and schedules probe.
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(m.getState()).toBe('degraded')
 
       // Probe calls resetTransport() on the existing client and then its
@@ -320,7 +320,7 @@ describe('ConnectivityManager', () => {
       }))
 
       // Trigger degraded.
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(m.getState()).toBe('degraded')
 
       // Advance past first backoff + probe timeout.
@@ -345,7 +345,7 @@ describe('ConnectivityManager', () => {
       const m = new ConnectivityManager(makeLog(), fakeCredentials)
       await m.init()
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('blip') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('blip')))
       expect(m.getState()).toBe('degraded')
       // Next call succeeds.
       const result = await m.execute('test', async () => 'recovered')
@@ -372,7 +372,7 @@ describe('ConnectivityManager', () => {
 
       // Trigger degraded.
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(m.getState()).toBe('degraded')
 
       // Advance past the first backoff: probe runs, default mock has
@@ -406,7 +406,7 @@ describe('ConnectivityManager', () => {
       ))
 
       // Trigger degraded.
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(m.getState()).toBe('degraded')
 
       // Advance past first probe → offline.
@@ -429,7 +429,7 @@ describe('ConnectivityManager', () => {
       await m.init()
 
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(m.getState()).toBe('degraded')
 
       // PubNub reconnect → immediate probe. Default mock has .locks()
@@ -471,8 +471,8 @@ describe('ConnectivityManager', () => {
       // Fire two execute()s concurrently — each will see a 401, each will
       // request a rebuild. The manager must coalesce these into one rebuild.
       await Promise.all([
-        m.execute('a', async () => { throw authErr }),
-        m.execute('b', async () => { throw authErr }),
+        m.execute('a', async () => Promise.reject(authErr)),
+        m.execute('b', async () => Promise.reject(authErr)),
       ])
       await vi.runAllTimersAsync()
 
@@ -489,14 +489,14 @@ describe('ConnectivityManager', () => {
       m.onStateChange(listener)
 
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       // healthy -> degraded fires once.
       expect(listener).toHaveBeenCalledWith('degraded', 'healthy')
       expect(listener).toHaveBeenCalledTimes(1)
 
       // A second network error while already degraded should NOT fire
       // again (no transition).
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(listener).toHaveBeenCalledTimes(1)
     })
 
@@ -508,7 +508,7 @@ describe('ConnectivityManager', () => {
       unsubscribe()
 
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(listener).not.toHaveBeenCalled()
     })
 
@@ -516,11 +516,13 @@ describe('ConnectivityManager', () => {
       const m = new ConnectivityManager(makeLog(), fakeCredentials)
       await m.init()
       const good = vi.fn()
-      m.onStateChange(() => { throw new Error('listener bug') })
+      m.onStateChange(() => {
+        throw new Error('listener bug')
+      })
       m.onStateChange(good)
 
       const { TimeoutError } = await import('august-yale')
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
       expect(good).toHaveBeenCalledTimes(1)
     })
   })
@@ -544,7 +546,7 @@ describe('ConnectivityManager', () => {
       ))
 
       // Trigger degraded.
-      await m.execute('test', async () => { throw new TimeoutError('boom') })
+      await m.execute('test', async () => Promise.reject(new TimeoutError('boom')))
 
       // Drive past first probe so we land in offline.
       await vi.advanceTimersByTimeAsync(15_000)

package/.github/FUNDING.yml

@@ -1,4 +0,0 @@
-# These are supported funding model platforms
-
-github: donavanbecker
-custom: paypal.me/DonavanBecker

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,97 +0,0 @@
-name: Bug-Report
-description: Report a Bug to help us improve
-title: "Bug:"
-labels: [bug]
-assignees: 'donavanbecker'
-body:
-  - type: markdown
-    attributes:
-      value: |
-        You must use the issue template below when submitting a bug.
-  - type: input
-    attributes:
-      label: Describe The Bug
-      placeholder: A clear and concise description of what the bug is.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: To Reproduce
-      placeholder: Steps to reproduce the behavior.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Expected behavior
-      placeholder: A clear and concise description of what you expected to happen.
-    validations:
-      required: true
-  - type: textarea
-    id: Logs
-    attributes:
-      label: Relevant log output
-      placeholder: Bug reports that do not contain logs may be closed without warning. Show the Homebridge logs here. If using Homebridge Config-UI-X, you can easly download your log by visiting the log page on the UI and Clicking the Download Icon in the top right. Remove any sensitive information, such as your homebridge-august refreshToken. Please Turn on Debug Mode before submitting your Issue so more logs can be shared to fix the issue being submitted.
-      render: shell
-    validations:
-      required: true
-  - type: textarea
-    id: Config
-    attributes:
-      label: Config for homebridge-august
-      placeholder: Paste your homebridge config.json here. Remove any sensitive information, such as your homebridge-august consumerKey/ consumerSecret / refreshToken.
-      render: shell
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Screenshots
-      description: If applicable add screenshots to help explain your problem.
-      placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Device & Model
-      placeholder: If applicable, add screenshots to help explain your problem.
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: |
-        Environment
-  - type: input
-    attributes:
-      label: Node.js Version
-      placeholder: v14.17.6
-    validations:
-      required: true  
-  - type: input
-    attributes:
-      label: NPM Version
-      placeholder: v7.22.0
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge Version
-      placeholder: If applicable, add screenshots to help explain your problem.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge August Plugin Version
-      placeholder: v10.0.1
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge Config UI X Plugin Version
-      placeholder: v4.41.2
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Operating System
-      placeholder: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
-    validations:
-      required: true

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Homebridge Discord Channel for August
-    url: https://discord.gg/8fpZA4S
-    about: Please ask and answer questions here.
-  - name: Homebridge-August - Pull Requests
-    url: https://github.com/homebridge-plugins/homebridge-august/pulls
-    about: Please report security vulnerabilities here.

package/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,38 +0,0 @@
-name: Feature Request
-description: Suggest an idea for this project
-title: "Feature Request: "
-labels: [enhancement]
-assignees: 'donavanbecker'
-body:
-  - type: markdown
-    attributes:
-      value: |
-        You must use the issue template below when submitting a feature request.
-  - type: markdown
-    attributes:
-      value: |
-        Is your feature request related to a problem? Please describe.
-  - type: input
-    attributes:
-      label: Problem
-      placeholder: A clear and concise description of what the problem is. Ex. I am always frustrated when [...] 
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Solution
-      placeholder: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Alternatives
-      placeholder: A clear and concise description of any alternative solutions or features you have considered.
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Additional context
-      placeholder: Add any other context or screenshots about the feature request here. Post device logs here.
-    validations:
-      required: false

package/.github/ISSUE_TEMPLATE/support-request.yml

@@ -1,85 +0,0 @@
-name: Support Request
-description: Need help?
-title: "Support Request:"
-labels: [question]
-assignees: 'donavanbecker'
-body:
-  - type: markdown
-    attributes:
-      value: |
-        You must use the issue template below when submitting a support request.
-  - type: input
-    attributes:
-      label: Describe Your Problem
-      placeholder: A clear and concise description of what problem you are trying to solve.
-    validations:
-      required: true
-  - type: textarea
-    id: Logs
-    attributes:
-      label: Relevant log output
-      placeholder: Bug reports that do not contain logs may be closed without warning. Show the Homebridge logs here. If using Homebridge Config-UI-X, you can easly download your log by visiting the log page on the UI and Clicking the Download Icon in the top right. Remove any sensitive information, such as your homebridge-august refreshToken. Please Turn on Debug Mode before submitting your Issue so more logs can be shared to fix the issue being submitted.
-      render: shell
-    validations:
-      required: false
-  - type: textarea
-    id: Config
-    attributes:
-      label: Config for homebridge-august
-      placeholder: Paste your homebridge config.json here. Remove any sensitive information, such as your homebridge-august consumerKey/ consumerSecret refreshToken.
-      render: shell
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Screenshots
-      description: If applicable add screenshots to help explain your problem.
-      placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Device & Model
-      placeholder: If applicable, add screenshots to help explain your problem.
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: |
-        Environment
-  - type: input
-    attributes:
-      label: Node.js Version
-      placeholder: v14.17.5
-    validations:
-      required: true  
-  - type: input
-    attributes:
-      label: NPM Version
-      placeholder: v7.20.5
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge Version
-      placeholder: If applicable, add screenshots to help explain your problem.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge August Plugin Version
-      placeholder: v10.0.1
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Homebridge Config UI X Plugin Version
-      placeholder: v4.41.2
-    validations:
-      required: false
-  - type: input
-    attributes:
-      label: Operating System
-      placeholder: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
-    validations:
-      required: true

package/.github/ISSUE_TEMPLATE.md

@@ -1,48 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-<!-- You must use the issue template below when submitting a bug -->
-
-**Describe The Bug:**
-<!-- A clear and concise description of what the bug is. -->
-
-**To Reproduce:**
-<!-- Steps to reproduce the behavior. -->
-
-**Expected behavior:**
-<!-- A clear and concise description of what you expected to happen. -->
-
-**Logs:**
-<!-- Bug reports that do not contain logs may be closed without warning. -->
-
-```
-Show the Homebridge / Homebridge Config UI X logs here.
-```
-
-**Homebridge Config:**
-
-```json
-Show your homebridge config.json here
-```
-
-**Screenshots:**
-<!-- If applicable, add screenshots to help explain your problem. -->
-
-**Environment:**
-
-* **Node.js Version**: <!-- node -v -->
-* **NPM Version**: <!-- npm -v -->
-* **Homebridge Version**: <!-- homebridge -V -->
-* **Homebridge August Plugin Version**:
-* **Homebridge Config UI X Version**:
-* **Operating System**: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
-* **Process Supervisor**: Docker / Systemd / init.d / pm2 / launchctl / hb-service / other / none
-
-
-<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

package/.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -1,27 +0,0 @@
----
-name: Enhancement
-about: Contribute to Plugin through Pull Request
-title: ''
-labels: 'enhancement'
-assignees: 'donavanbecker'
----
-
-**Is your enhancement related to a problem? Please describe.**
-
-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
-
-**Describe the solution you are addding**
-
-<!-- A clear and concise description of what you want to happen. -->
-
-**Changes Proposed in this Pull Request**
-
-<!-- A clear and concise description of what is being changed. -->
-
-**Describe alternatives you've considered**
-
-<!-- A clear and concise description of any alternative solutions or features you've considered. -->
-
-**Additional context**
-
-<!-- Add any other context or screenshots about the feature request here. -->