@homebridge-plugins/homebridge-august 2.2.8-beta.0

package/.eslintrc.json

@@ -0,0 +1,86 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended" // uses the recommended rules from the @typescript-eslint/eslint-plugin
+    ],
+    "parserOptions": {
+        "ecmaVersion": 2021,
+        "sourceType": "module"
+    },
+    "ignorePatterns": [
+        "dist",
+        "server"
+    ],
+    "rules": {
+        "quotes": [
+            "warn",
+            "single"
+        ],
+        "indent": [
+            "warn",
+            2,
+            {
+                "SwitchCase": 1
+            }
+        ],
+        "linebreak-style": [
+            "warn",
+            "unix"
+        ],
+        "semi": [
+            "warn",
+            "always"
+        ],
+        "comma-dangle": [
+            "warn",
+            "always-multiline"
+        ],
+        "dot-notation": "off",
+        "eqeqeq": "warn",
+        "curly": [
+            "warn",
+            "all"
+        ],
+        "brace-style": [
+            "warn"
+        ],
+        "prefer-arrow-callback": [
+            "warn"
+        ],
+        "max-len": [
+            "warn",
+            150
+        ],
+        "no-console": [
+            "warn"
+        ], // use the provided Homebridge log method instead
+        "no-non-null-assertion": [
+            "off"
+        ],
+        "comma-spacing": [
+            "error"
+        ],
+        "no-multi-spaces": [
+            "warn",
+            {
+                "ignoreEOLComments": true
+            }
+        ],
+        "no-trailing-spaces": [
+            "warn"
+        ],
+        "lines-between-class-members": [
+            "warn",
+            "always",
+            {
+                "exceptAfterSingleLine": true
+            }
+        ],
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-explicit-any": "off"
+    }
+}

package/.github/FUNDING.yml

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

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

@@ -0,0 +1,97 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,85 @@
+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

@@ -0,0 +1,48 @@
+---
+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

@@ -0,0 +1,27 @@
+---
+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. -->

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'beta-*.*.*'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: 'github-actions' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'beta-*.*.*'
+    schedule:
+      interval: 'daily'

package/.github/labeler.yml

@@ -0,0 +1,38 @@
+# Add 'branding' label to any changes within 'docs' folder or any subfolders
+branding:
+- changed-files:
+  - any-glob-to-any-file: branding/**
+
+# Add 'docs' label to any change to .md files within the entire repository 
+docs:
+- changed-files:
+  - any-glob-to-any-file: '**/*.md'
+
+# Add 'enhancement' label to any change to src files within the source dir EXCEPT for the docs sub-folder
+enhancement:
+  - changed-files:
+    - any-glob-to-any-file: 'src/**/*'
+    - any-glob-to-any-file: 'config.schema.json'
+
+# Add 'dependencies' label to any change to src files within the source dir EXCEPT for the docs sub-folder
+dependencies:
+  - changed-files:
+    - any-glob-to-any-file: 'package.json'
+    - any-glob-to-any-file: 'package-lock.json'
+
+# Add 'beta' label to any PR that is opened against the `beta` branch
+beta:
+- base-branch: 'beta*'
+
+# Add 'alpha' label to any PR that is opened against the `alpha` branch
+alpha:
+- base-branch: 'alpha*'
+
+# Add 'latest' label to any PR that is opened against the `latest` branch
+latest:
+- base-branch: 'latest'
+
+# Add 'workflow' to any changes within 'workflow' folder or any subfolders
+workflow:
+- changed-files:
+  - any-glob-to-any-file: .github/**

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

@@ -0,0 +1,85 @@
+#!/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'
+
+import semver from 'semver'
+
+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 === null) {
+  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 tag.
+ * @param tag The tag to query for.
+ * @returns {string} Returns the version.
+ */
+function getTagVersionFromNpm(tag) {
+  try {
+    return child_process.execSync(`npm info ${packageJSON.name} version --tag="${tag}"`).toString('utf8').trim()
+  } catch (e) {
+    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`)
+    // throw e;
+    return '0.0.0'
+  }
+}
+
+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(tagArgument) // e.g. 0.7.0-beta.12
+const latestReleaseBase = semver.inc(latestReleasedVersion, 'patch') // will produce 0.7.0 (removing the preid, needed for the equality check below)
+
+let publishTag
+if (semver.eq(baseVersion, latestReleaseBase)) { // check if we are releasing another version for the latest beta or alpha
+  publishTag = latestReleasedVersion // set the current latest beta or alpha to be incremented
+} else {
+  publishTag = baseVersion // start of with a new beta or alpha version
+}
+
+// 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))

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

@@ -0,0 +1,55 @@
+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
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-august' }}
+    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
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-august' }}
+    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/homebridge-plugins/homebridge-august/wiki/Beta-Version)
+
+  github-releases-to-discord:
+    name: Discord Webhooks
+    needs: [build_and_test,publish]
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-august' }}
+    uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
+    with:
+      title: "August Beta Release"
+      description: |
+        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
+      url: "https://github.com/homebridge-plugins/homebridge-august/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
+    secrets:
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Node Build
+
+on:
+  push:
+    branches: [latest]
+  pull_request:
+  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

package/.github/workflows/changerelease.yml

@@ -0,0 +1,11 @@
+name: Changelog to Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  changerelease:
+      uses: homebridge/.github/.github/workflows/change-release.yml@latest
+      secrets:
+          token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/labeler.yml

@@ -0,0 +1,9 @@
+name: Labeler
+
+on: [pull_request]
+
+jobs:
+  labeler:
+    uses: homebridge/.github/.github/workflows/labeler.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,14 @@
+name: Release Drafter
+
+on:
+  push:
+    branches: [latest]
+  pull_request: # required for autolabeler
+    types: [opened, reopened, synchronize]
+  workflow_dispatch:
+
+jobs:
+  release-drafter:
+    uses: homebridge/.github/.github/workflows/release-drafter.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}