node-red-contrib-homebridge-automation 0.1.12-beta.9 → 0.2.1-beta.0

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

@@ -4,23 +4,25 @@
  * This scripts queries the npm registry to pull out the latest version for a given tag.
  */
 
-const fs = require("fs");
-const semver = require("semver");
-const child_process = require("child_process");
-const assert = require("assert");
+const assert = require('node:assert')
+const child_process = require('node:child_process')
+const fs = require('node:fs')
+const process = require('node:process')
 
-const BRANCH_VERSION_PATTERN = /^([A-Za-z]*)-(\d+.\d+.\d+)$/
+const semver = require('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 packageJSON = JSON.parse(fs.readFileSync('package.json', 'utf8'))
 
-let refArgument = process.argv[2];
-let tagArgument = process.argv[3] || "latest";
+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.js <ref> [tag]");
-  process.exit(1);
+  console.error('ref argument is missing')
+  console.error('Usage: npm-version-script.js <ref> [tag]')
+  process.exit(1)
 }
 
 /**
@@ -30,64 +32,54 @@ if (refArgument == null) {
  */
 function getTagVersionFromNpm(tag) {
   try {
-    return child_process.execSync(`npm info ${packageJSON.name} version --tag="${tag}"`).toString("utf8").trim();
+    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}`);
+    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`)
     // throw e;
-    return "0.0.0";
+    return '0.0.0'
   }
 }
 
 function desiredTargetVersion(ref) {
   // ref is a GitHub action ref string
-  if (ref.startsWith("refs/pull/")) {
-    throw Error("The version script was executed inside a PR!");
+  if (ref.startsWith('refs/pull/')) {
+    throw new Error('The version script was executed inside a PR!')
   }
 
-  assert(ref.startsWith("refs/heads/"))
-  let branchName = ref.slice("refs/heads/".length);
+  assert(ref.startsWith('refs/heads/'))
+  const branchName = ref.slice('refs/heads/'.length)
 
-  let results = branchName.match(BRANCH_VERSION_PATTERN);
+  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}`);
+      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`)
     }
 
-    return results[2];
-  }
-
-  // legacy mode were we use the `betaVersion` property in the package.json
-  if (branchName === "beta" && packageJSON.betaVersion) {
-    return packageJSON.betaVersion
-  }
-
-  // legacy mode were we use the `alphaVersion` property in the package.json
-  if (branchName === "alpha" && packageJSON.alphaVersion) {
-    return packageJSON.alphaVersion
+    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`);
+  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);
+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)
+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;
+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
+  publishTag = latestReleasedVersion // set the current latest beta or alpha to be incremented
 } else {
-  publishTag = baseVersion; // start of with a new beta or alpha version
+  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));
+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));
+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/Build and Publish.yml

@@ -1,13 +1,14 @@
-name: "Build, Publish and Release"
- 
- #
- # Automatically publish beta releases on pushes, require a manual workflow action for production releases
- #
- # Does the following
- # 1 - Run the documentation script against the package
- # 2 - Create the npm package using the package.json version tag ( or for beta releases, adds a beta tag and increments as needed )
- # 3 - Publish the npm package
- # 4 - For releases against the main branch, create a github release as well
+name:
+  'Build, Publish and Release'
+
+  #
+  # Automatically publish beta releases on pushes, require a manual workflow action for production releases
+  #
+  # Does the following
+  # 1 - Run the documentation script against the package
+  # 2 - Create the npm package using the package.json version tag ( or for beta releases, adds a beta tag and increments as needed )
+  # 3 - Publish the npm package
+  # 4 - For releases against the latest branch, create a github release as well
 
 on:
   push:
@@ -19,24 +20,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    # checkout repo
-    - uses: actions/checkout@v4
-
-    # get branch / tag name
-    - name: Get Branch / Tag Name
-      id: get_branch
-      run: |
-        export BRANCH_NAME=$(if [[ ${GITHUB_REF} =~ "refs/tags/" ]]; then echo ${GITHUB_REF/refs\/tags\//}; else echo ${GITHUB_REF/refs\/heads\//}; fi)
-        echo $BRANCH_NAME
-        echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT
-
-    # generate the image tag
-    - name: Get Image Tag
-      id: get_tag
-      run: |
-        export TARGET_IMAGE_TAG=$(if [ "${{ steps.get_branch.outputs.BRANCH_NAME }}" = "main" ]; then echo "main"; else echo "${{ steps.get_branch.outputs.BRANCH_NAME }}" | awk -F- '{ print $1 }'; fi)
-        echo $TARGET_IMAGE_TAG
-        echo "TARGET_IMAGE_TAG=${TARGET_IMAGE_TAG}" >> $GITHUB_OUTPUT
+      # checkout repo
+      - uses: actions/checkout@v4
+
+      # get branch / tag name
+      - name: Get Branch / Tag Name
+        id: get_branch
+        run: |
+          export BRANCH_NAME=$(if [[ ${GITHUB_REF} =~ "refs/tags/" ]]; then echo ${GITHUB_REF/refs\/tags\//}; else echo ${GITHUB_REF/refs\/heads\//}; fi)
+          echo $BRANCH_NAME
+          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT
+
+      # generate the image tag
+      - name: Get Image Tag
+        id: get_tag
+        run: |
+          export TARGET_IMAGE_TAG=$(if [ "${{ steps.get_branch.outputs.BRANCH_NAME }}" = "main" ]; then echo "main"; else echo "${{ steps.get_branch.outputs.BRANCH_NAME }}" | awk -F- '{ print $1 }'; fi)
+          echo $TARGET_IMAGE_TAG
+          echo "TARGET_IMAGE_TAG=${TARGET_IMAGE_TAG}" >> $GITHUB_OUTPUT
 
     outputs:
       BRANCH_NAME: ${{ steps.get_branch.outputs.BRANCH_NAME }}
@@ -46,50 +47,54 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    # checkout repo
-    - uses: actions/checkout@v4
-      with:
-        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
-        fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
-
-    - uses: actions/setup-node@v4
-      with:
-        node-version: lts/*
-
-    - name: Retrieve github-markdown-toc
-      run: |
-        wget -q https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
-        chmod a+x gh-md-toc
-
-    - name: Create Table of Contents
-      run: |
-        npm run-script document --if-present
-        rm gh-md-toc
-
-    - name: Commit files
-      run: |
-        git config --local user.email "github-actions[bot]@users.noreply.github.com"
-        git config --local user.name "github-actions[bot]"
-        git add *
-        git commit -a -m "Update TOC" || true
-
-    - name: Push changes
-      uses: ad-m/github-push-action@master
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        branch: ${{ github.ref }}
+      # checkout repo
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
+          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: Retrieve github-markdown-toc
+        run: |
+          wget -q https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
+          chmod a+x gh-md-toc
+
+      - name: Create Table of Contents
+        run: |
+          npm run-script document --if-present
+          rm gh-md-toc
+
+      - name: Commit files
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add * || true
+          git commit -a -m "Update TOC" || true
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
 
   publish_prod_release:
+    permissions:
+      id-token: write
     needs: [get_tags, create_documentation]
     name: Publish Release Version
     if: ${{ needs.get_tags.outputs.BRANCH_NAME == 'main' }}
     uses: homebridge/.github/.github/workflows/npm-publish.yml@latest
     with:
-      install_cmd: npm ci
+      install_cmd: npm ci 
     secrets:
-      npm_auth_token: ${{ secrets.npm_token }}
+      npm_auth_token: ${{ secrets.NPM_TOKEN }}
 
   publish_test_release:
+    permissions:
+      id-token: write
     needs: [get_tags, create_documentation]
     name: Publish Test Version - ${{ needs.get_tags.outputs.BRANCH_NAME }}
     if: ${{ needs.get_tags.outputs.BRANCH_NAME != 'main' }}
@@ -97,23 +102,24 @@ jobs:
     with:
       tag: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
       dynamically_adjust_version: true
-      npm_version_command: 'pre'
+      npm_version_command: pre
       pre_id: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
+      install_cmd: npm ci 
     secrets:
-      npm_auth_token: ${{ secrets.npm_token }}
+      npm_auth_token: ${{ secrets.NPM_TOKEN }}
 
   publish_github_release:
     needs: [publish_prod_release]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Create Release
-      uses: softprops/action-gh-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
-        name: Release ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
-        generate_release_notes: true
-        draft: false
-        prerelease: false
+      - uses: actions/checkout@v4
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+          name: Release ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+          generate_release_notes: true
+          draft: false
+          prerelease: false

package/README.md

@@ -34,6 +34,7 @@ The above Node-RED Flow, turns on my 'Outside Office' light when the powder room
       * [Jan 6, 2023 - Version 0.1.5](#jan-6-2023---version-015)
       * [Jan 11, 2023 - Version 0.1.7](#jan-11-2023---version-017)
       * [Jan 15, 2023 - Version 0.1.8](#jan-15-2023---version-018)
+      * [Dec 15, 2024 - Version 0.2.0](#dec-15-2024---version-020)
 * [Backlog / Roadmap](#backlog--roadmap)
    * [Dropped items](#dropped-items)
 * [Installation Steps](#installation-steps)
@@ -58,10 +59,6 @@ The above Node-RED Flow, turns on my 'Outside Office' light when the powder room
 * [Donations](#donations)
 * [Troubleshooting / DEBUG MODE](#troubleshooting--debug-mode)
    * [To start Node-RED in DEBUG mode, and output Homebridge-Automation debug logs start Node-RED like this.](#to-start-node-red-in-debug-mode-and-output-homebridge-automation-debug-logs-start-node-red-like-this)
-
-<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: runner, at: Sun Jul  7 00:03:36 UTC 2024 -->
-
 <!--te-->
 
 # Introduction
@@ -183,6 +180,12 @@ With a plugin, you can see if it supports Real Time events, by opening the Home
 
 - Workaround for #111
 
+### Dec 15, 2024 - Version 0.2.0
+
+- Major code base refresh, and migration from hap-node-client to hap-client ( Potential fix for #120 )
+- With the change in connectivity to homebridge, please validate all your nodes are connected after the update.  And pay particular attention to `Camera` nodes, as for some devices the name has changed.
+- Testing and Development was completed on Node-RED version: v4.0.2 and Node.js  version: v20.18.1
+
 # Backlog / Roadmap
 
 * [x] - Update Node Information with Homebridge Accessory Details ( hapEndpoint, deviceType, description )

package/eslint.config.mjs

@@ -0,0 +1,34 @@
+/** @type {import('eslint').FlatConfig[]} */
+import pluginJs from "@eslint/js";
+import pluginJest from "eslint-plugin-jest";
+import globals from "globals";
+
+
+export default [
+  {
+    files: ["**/*.js"],
+    languageOptions: {
+      sourceType: "commonjs", // This is necessary to parse imports/exports
+      globals: {
+        ...globals.browser,
+        ...globals.es2021,
+        ...globals.jest, // Add Jest globals
+      },
+    },
+    // Add any other specific rules here
+  },
+  pluginJs.configs.recommended,
+  {
+    plugins: {
+      jest: pluginJest,
+    },
+    rules: {
+      ...pluginJest.configs.recommended.rules,
+      "no-unused-vars": "warn", // Change no-unused-vars to a warning
+    },
+  },
+  {
+    // Exclude test, tools, and lib directories from linting
+    ignores: ["test/**/*", "tools/*js", "src/lib/*"], // Exclude these files from linting
+  }
+];

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.1.12-beta.9",
+  "version": "0.2.1-beta.0",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
-    "api": "documentation build HAP-NodeRed.js -f md --config docs/documentation.yml > docs/API.md",
-    "document": "./gh-md-toc --insert README.md; rm README.md.orig.* README.md.toc.*",
+    "document": "./gh-md-toc --insert --no-backup --hide-footer README.md",
     "watch": "nodemon",
-    "coverage": "nyc npm t",
-    "format": "prettier --write {.,test}/*.js *.html *.md",
-    "lint": "eslint {.,test}/*.js",
-    "test": "mocha \"test/**/*_spec.js\""
+    "lint": "eslint --max-warnings=10 .",
+    "lint:fix": "eslint --fix --max-warnings=0 .",
+    "test": "jest --detectOpenHandles",
+    "test-coverage": "jest --coverage"
   },
   "keywords": [
     "node-red",
@@ -26,28 +25,24 @@
     "url": "git+https://github.com/NorthernMan54/node-red-contrib-homebridge-automation.git"
   },
   "devDependencies": {
-    "@types/node-red": "^0.20.7",
-    "@types/jest": "^29.5.12",
-    "documentation": "14.0.3",
-    "eslint": "^8.57.0",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-import-newlines": "^1.4.0",
-    "eslint-plugin-jest": "^28.6.0",
-    "eslint-plugin-sort-exports": "^0.9.1",
-    "mocha": "^10.6.0",
+    "@types/node-red": "^1.3.5",
+    "@types/jest": "^29.5.14",
+    "@eslint/js": "^9.16.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-format": "^0.1.2",
+    "eslint-plugin-jest": "^28.8.3",
+    "globals": "^15.13.0",
+    "jest": "^29.7.0",
     "node-red": "^4.0.2",
     "node-red-node-test-helper": "^0.3.4",
-    "nodemon": "^3.1.4",
-    "nyc": "^17.0.0",
-    "prettier": "^3.3.2",
-    "rimraf": "^5.0.7",
-    "semver": "^7.6.2"
+    "nodemon": "^3.1.7",
+    "rimraf": "^6.0.1",
+    "semver": "^7.6.3"
   },
   "dependencies": {
     "better-queue": ">=3.8.12",
-    "debug": "^4.3.5",
-    "hap-node-client": ">=0.2.7"
+    "debug": "^4.3.7",
+    "@homebridge/hap-client": "^2.0.5"
   },
   "author": "NorthernMan54",
   "license": "ISC",
@@ -61,10 +56,24 @@
     ],
     "ext": "js,html",
     "ignore": [],
-    "exec": "DEBUG=hapNodeRed ~/npm/bin/node-red",
+    "exec": "DEBUG=hapNodeRed* ~/npm/bin/node-red -v -u test/node-red",
     "signal": "SIGTERM",
     "env": {
       "NODE_OPTIONS": "--trace-warnings"
     }
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "modulePathIgnorePatterns": [],
+    "coverageReporters": [
+      "lcov"
+    ],
+    "collectCoverageFrom": [
+      "src/**",
+      "!src/accessories/**",
+      "!src/lib/definitions/generate-definitions.ts",
+      "!src/lib/definitions/generator-configuration.ts",
+      "!src/test-utils"
+    ]
   }
 }