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

package/test/{platform.hap.test.ts → platform.test.ts}

@@ -10,7 +10,7 @@ import { readFileSync, writeFileSync } from 'node:fs'
 
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
-import { AugustPlatformHAP } from '../src/Platform.HAP.js'
+import { AugustPlatform } from '../src/Platform.HAP.js'
 
 // Mock the august-yale module
 vi.mock('august-yale', () => {
@@ -37,7 +37,7 @@ vi.mock('node:fs', () => ({
 }))
 
 describe('augustPlatform', () => {
-  let platform: AugustPlatformHAP
+  let platform: AugustPlatform
   let mockApi: API
   let mockLog: Logging
   let mockConfig: AugustPlatformConfig
@@ -110,7 +110,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -137,7 +137,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -165,7 +165,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -192,7 +192,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -217,7 +217,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -245,7 +245,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -277,7 +277,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Test the public method
     const normalizedCredentials = await platform.getNormalizedCredentials()
@@ -302,7 +302,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // Access the private method for testing
     const normalizeMethod = (platform as any).normalizeCredentialsForApi.bind(platform)
@@ -327,7 +327,7 @@ describe('augustPlatform', () => {
       },
     }
 
-    platform = new AugustPlatformHAP(mockLog, config, mockApi)
+    platform = new AugustPlatform(mockLog, config, mockApi)
 
     // First call should normalize and cache
     const firstCall = await platform.getNormalizedCredentials()
@@ -346,7 +346,7 @@ describe('augustPlatform', () => {
   describe('discoverDevices', () => {
     it('should handle 401 authentication errors and trigger re-authentication', async () => {
       // Create platform instance
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // Mock August.details to throw 401 error
       const August = await import('august-yale')
@@ -370,7 +370,7 @@ describe('augustPlatform', () => {
 
     it('should handle "unauthorized" errors and trigger re-authentication', async () => {
       // Create platform instance
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // Mock August.details to throw unauthorized error
       const August = await import('august-yale')
@@ -391,7 +391,7 @@ describe('augustPlatform', () => {
 
     it('should re-throw non-authentication errors', async () => {
       // Create platform instance
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // Mock August.details to throw non-401 error
       const August = await import('august-yale')
@@ -405,7 +405,7 @@ describe('augustPlatform', () => {
 
     it('should process devices successfully when no errors occur', async () => {
       // Create platform instance
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // Mock successful August.details response
       const August = await import('august-yale')
@@ -440,7 +440,7 @@ describe('augustPlatform', () => {
         },
       }
 
-      platform = new AugustPlatformHAP(mockLog, configWithExcludes, mockApi)
+      platform = new AugustPlatform(mockLog, configWithExcludes, mockApi)
 
       const August = await import('august-yale')
       const mockDeviceIncluded = { lockId: 'included-lock-id', LockName: 'Included Lock' } as any
@@ -465,7 +465,7 @@ describe('augustPlatform', () => {
         },
       }
 
-      platform = new AugustPlatformHAP(mockLog, configWithExcludes, mockApi)
+      platform = new AugustPlatform(mockLog, configWithExcludes, mockApi)
 
       const August = await import('august-yale')
       const mockDeviceIncluded = { lockId: 'included-lock-id', LockName: 'Included Lock' } as any
@@ -492,7 +492,7 @@ describe('augustPlatform', () => {
       // Make uuid.generate return predictable UUIDs based on input
       vi.mocked(mockApi.hap.uuid.generate).mockImplementation((input: any) => `uuid-${input}`)
 
-      platform = new AugustPlatformHAP(mockLog, configWithExcludes, mockApi)
+      platform = new AugustPlatform(mockLog, configWithExcludes, mockApi)
 
       // Simulate a cached accessory for the excluded lock
       const mockAccessory = {
@@ -528,7 +528,7 @@ describe('augustPlatform', () => {
         },
       }
 
-      platform = new AugustPlatformHAP(mockLog, configWithEmptyExcludes, mockApi)
+      platform = new AugustPlatform(mockLog, configWithEmptyExcludes, mockApi)
 
       const August = await import('august-yale')
       const mockDeviceA = { lockId: 'lock-a', LockName: 'Lock A' } as any
@@ -554,7 +554,7 @@ describe('augustPlatform', () => {
         },
       }
 
-      platform = new AugustPlatformHAP(mockLog, configWithBoth, mockApi)
+      platform = new AugustPlatform(mockLog, configWithBoth, mockApi)
 
       const August = await import('august-yale')
       const mockDeviceIncluded = { lockId: 'included-lock-id', LockName: 'Included Lock' } as any
@@ -585,7 +585,7 @@ describe('augustPlatform', () => {
 
       vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfigFile))
 
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // This should not throw an error when trying to set installId
       await expect(platform.validated()).resolves.toBeUndefined()
@@ -605,7 +605,7 @@ describe('augustPlatform', () => {
 
       vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfigFile))
 
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       // This should not throw an error when trying to set installId
       await expect(platform.validated()).resolves.toBeUndefined()
@@ -625,7 +625,7 @@ describe('augustPlatform', () => {
 
       vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfigFile))
 
-      platform = new AugustPlatformHAP(mockLog, mockConfig, mockApi)
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
 
       await platform.validated()
 

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. -->