@switchbot/homebridge-switchbot 4.3.1-beta.1 → 4.3.1-beta.3

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

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

@@ -22,7 +22,7 @@ jobs:
     if: ${{ github.repository == 'OpenWonderLabs/homebridge-switchbot' }}
     permissions:
       id-token: write
-    uses: OpenWonderLabs/.github/.github/workflows/npm-publish.yml@latest
+    uses: OpenWonderLabs/.github/.github/workflows/npm-publish-esm.yml@latest
     with:
       tag: 'beta'
       dynamically_adjust_version: true

package/.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
     if: ${{ github.repository == 'OpenWonderLabs/homebridge-switchbot' }}
     permissions:
       id-token: write
-    uses: OpenWonderLabs/.github/.github/workflows/npm-publish.yml@latest
+    uses: OpenWonderLabs/.github/.github/workflows/npm-publish-esm.yml@latest
     secrets:
       npm_auth_token: ${{ secrets.npm_token }}
 

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,14 @@
+import { describe, expect, it, vi } from 'vitest';
+import registerPlatform from './index.js';
+import { SwitchBotPlatform } from './platform.js';
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
+describe('index.ts', () => {
+    it('should register the platform with homebridge', () => {
+        const api = {
+            registerPlatform: vi.fn(),
+        };
+        registerPlatform(api);
+        expect(api.registerPlatform).toHaveBeenCalledWith(PLUGIN_NAME, PLATFORM_NAME, SwitchBotPlatform);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAEjD,OAAO,gBAAgB,MAAM,YAAY,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE1D,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,GAAG,GAAG;YACV,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;SACR,CAAA;QAEnB,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAErB,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAA;IAClG,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/docs/functions/default.html

@@ -1,2 +1,2 @@
 <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>default | @switchbot/homebridge-switchbot</title><meta name="description" content="Documentation for @switchbot/homebridge-switchbot"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"><script defer="" src="../assets/main.js"></script><script async="" src="../assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
-<main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">@switchbot/homebridge-switchbot</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Function default</h1></div></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type">API</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/blob/92317be236d295931222e0c4f0d5208738450461/src/index.ts#L11">index.ts:11</a></li></ul></aside></li></ul></section></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="../modules.html">@switchbot/homebridge-switchbot</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>
+<main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">@switchbot/homebridge-switchbot</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Function default</h1></div></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type">API</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/blob/7f316898a707cbc28d21a4a6638678032b74c0a3/src/index.ts#L11">index.ts:11</a></li></ul></aside></li></ul></section></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="../modules.html">@switchbot/homebridge-switchbot</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>

package/package.json

@@ -2,7 +2,7 @@
   "name": "@switchbot/homebridge-switchbot",
   "displayName": "SwitchBot",
   "type": "module",
-  "version": "4.3.1-beta.1",
+  "version": "4.3.1-beta.3",
   "description": "The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.",
   "author": "SwitchBot <support@wondertechlabs.com> (https://github.com/SwitchBot)",
   "contributors": [
@@ -82,31 +82,31 @@
     "@homebridge/plugin-ui-utils": "^2.0.1",
     "async-mqtt": "^2.6.3",
     "fakegato-history": "^0.6.5",
-    "homebridge-lib": "^7.1.2",
-    "node-switchbot": "^3.4.9",
+    "homebridge-lib": "^7.1.3",
+    "node-switchbot": "^3.5.0-beta.4",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^3.16.0",
+    "@antfu/eslint-config": "^4.1.1",
     "@types/aes-js": "^3.1.4",
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.10.7",
+    "@types/node": "^22.13.1",
     "@types/semver": "^7.5.8",
     "@types/source-map-support": "^0.5.10",
     "@typhonjs-typedoc/typedoc-theme-dmt": "^0.3.1",
-    "@vitest/coverage-v8": "^3.0.0",
+    "@vitest/coverage-v8": "^3.0.5",
     "eslint": "^9.19.0",
     "eslint-plugin-format": "^1.0.1",
     "homebridge": "^1.8.5",
-    "homebridge-config-ui-x": "4.68.0",
+    "homebridge-config-ui-x": "4.69.0",
     "nodemon": "^3.1.9",
     "shx": "^0.3.4",
     "ts-node": "^10.9.2",
     "typedoc": "^0.27.6",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.0"
+    "vitest": "^3.0.5"
   },
   "directories": {
     "doc": "docs"

package/src/index.test.ts

@@ -0,0 +1,19 @@
+import type { API } from 'homebridge'
+
+import { describe, expect, it, vi } from 'vitest'
+
+import registerPlatform from './index.js'
+import { SwitchBotPlatform } from './platform.js'
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
+
+describe('index.ts', () => {
+  it('should register the platform with homebridge', () => {
+    const api = {
+      registerPlatform: vi.fn(),
+    } as unknown as API
+
+    registerPlatform(api)
+
+    expect(api.registerPlatform).toHaveBeenCalledWith(PLUGIN_NAME, PLATFORM_NAME, SwitchBotPlatform)
+  })
+})

package/tsconfig.json

@@ -7,8 +7,7 @@
     ],
     "rootDir": "src",
     "module": "ES2022",
-    "moduleResolution": "node",
-    "types": ["node"],
+    "moduleResolution": "bundler",
     "strict": true,
     "noImplicitAny": false,
     "declaration": true,

package/.eslintrc

@@ -1,86 +0,0 @@
-{
-  "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/npm-version-script.cjs

@@ -1,81 +0,0 @@
-#!/bin/env node
-
-/**
- * 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 BRANCH_VERSION_PATTERN = /^([A-Za-z]*)-(\d+.\d+.\d+)$/
-
-// Load the contents of the package.json file
-const packageJSON = JSON.parse(fs.readFileSync("package.json", "utf8"));
-
-let refArgument = process.argv[2];
-let tagArgument = process.argv[3] || "latest";
-
-if (refArgument == null) {
-  console.error("ref argument is missing");
-  console.error("Usage: npm-version-script.cjs <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) {
-    throw e;
-  }
-}
-
-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!");
-  }
-
-  assert(ref.startsWith("refs/heads/"))
-  let branchName = ref.slice("refs/heads/".length);
-
-  let 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];
-  }
-
-  // legacy mode were we use the `betaVersion` property in the package.json
-  if (branchName === "beta" && packageJSON.betaVersion) {
-    return packageJSON.betaVersion
-  }
-
-  throw new Error("Malformed branch name for ref: " + ref + ". Can't derive the base version. Use a branch name like: beta-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
-  publishTag = latestReleasedVersion; // set the current latest beta to be incremented
-} else {
-  publishTag = baseVersion; // start of with a new beta version
-}
-
-// save the package.json
-packageJSON.version = publishTag;
-fs.writeFileSync("package.json", JSON.stringify(packageJSON, null, 2));