node-switchbot 3.0.2-beta.5 → 3.1.0

package/BLE.md

@@ -731,6 +731,7 @@ Actually, the `WoSmartLock ` is an object inherited from the [`SwitchbotDevice`]
 The `setKey()` method initialises the key information required for encrypted communication with the SmartLock
 
 This must be set before any control commands are sent to the device. To obtain the key information you will need to use an external tool - see [`pySwitchbot`](https://github.com/Danielhiversen/pySwitchbot/tree/master?tab=readme-ov-file#obtaining-locks-encryption-key) project for an example script.
+Or, use [`switchbot-get-encryption-key`](https://www.npmjs.com/package/switchbot-get-encryption-key) npm script.
 
 | Property        | Type   | Description                                                                                      |
 | :-------------- | :----- | :----------------------------------------------------------------------------------------------- |

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [3.1.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v3.1.0) (2024-10-11)
+
+### What's Changed
+- Added support for emitting logs from this module from the `SwitchBotBLE` class.
+- Housekeeping and update dependencies
+
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v3.0.1...v3.1.0
+
 ## [3.0.1](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v3.0.1) (2024-10-05)
 
 ### What's Changed
@@ -16,6 +24,7 @@ All notable changes to this project will be documented in this file. This projec
 #### ⚠️ Breaking Changes
 - Have added OpenAPI Functionality into `node-switchbot`, so now it is able to handle both APIs with just one module.
   - There are now two different Classes `SwitchBotBLE` and `SwitchBotOpenAPI` that can be used interact with the two different APIs
+    - `SwitchBotOpenApi` support emitting logs from this module.
     - You will need to update your current setup from`SwitchBot` to `SwitchBotBLE` to be able to interact with the BLE API
 - Updated the documents to explain both the `BLE` and the `OpenAPI` Functionality within `node-switchbot`
 

package/dist/switchbot-openapi.d.ts

@@ -1,7 +1,7 @@
 import type { Server } from 'node:http';
 import type { pushResponse } from './types/devicepush.js';
 import type { devices } from './types/deviceresponse.js';
-import type { deviceStatus } from './types/devicestatus.js';
+import type { deviceStatus, deviceStatusRequest } from './types/devicestatus.js';
 import { EventEmitter } from 'node:events';
 /**
  * The `SwitchBotOpenAPI` class provides methods to interact with the SwitchBot OpenAPI.
@@ -85,12 +85,12 @@ export declare class SwitchBotOpenAPI extends EventEmitter {
      * Retrieves the status of a specific device.
      *
      * @param deviceId - The unique identifier of the device.
-     * @returns {Promise<{ response: deviceStatus, statusCode: number }>} A promise that resolves to the device status.
+     * @returns {Promise<{ response: deviceStatus, statusCode: deviceStatusRequest['statusCode'] }>} A promise that resolves to the device status.
      * @throws An error if the request fails.
      */
     getDeviceStatus(deviceId: string): Promise<{
         response: deviceStatus;
-        statusCode: number;
+        statusCode: deviceStatusRequest['statusCode'];
     }>;
     /**
      * Generates the headers required for authentication with the SwitchBot OpenAPI.

package/dist/switchbot-openapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"switchbot-openapi.d.ts","sourceRoot":"","sources":["../src/switchbot-openapi.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAmB,MAAM,EAAkB,MAAM,WAAW,CAAA;AAExE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAK3D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAO1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAQ;IAEvB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAO;IAE3C;;;;;OAKG;gBACS,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAOzC;;;;;OAKG;YACW,OAAO;IAIrB;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAatE;;;;;;;;;OASG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAE,MAAkB,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC,CAAA;KAAE,CAAC;IAqB/L;;;;;;OAMG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,YAAY,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAgBhG;;;;;;;;;OASG;IACH,OAAO,CAAC,eAAe,CAiBtB;IAED;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6F9C;;;;;;;OAOG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAqBhD"}
+{"version":3,"file":"switchbot-openapi.d.ts","sourceRoot":"","sources":["../src/switchbot-openapi.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAmB,MAAM,EAAkB,MAAM,WAAW,CAAA;AAExE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAKhF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAO1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAQ;IAEvB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAO;IAE3C;;;;;OAKG;gBACS,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAOzC;;;;;OAKG;YACW,OAAO;IAIrB;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAatE;;;;;;;;;OASG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAE,MAAkB,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC,CAAA;KAAE,CAAC;IAqB/L;;;;;;OAMG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,YAAY,CAAC;QAAC,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;KAAE,CAAC;IAgB3H;;;;;;;;;OASG;IACH,OAAO,CAAC,eAAe,CAiBtB;IAED;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6F9C;;;;;;;OAOG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAqBhD"}

package/dist/switchbot-openapi.js

@@ -119,7 +119,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
      * Retrieves the status of a specific device.
      *
      * @param deviceId - The unique identifier of the device.
-     * @returns {Promise<{ response: deviceStatus, statusCode: number }>} A promise that resolves to the device status.
+     * @returns {Promise<{ response: deviceStatus, statusCode: deviceStatusRequest['statusCode'] }>} A promise that resolves to the device status.
      * @throws An error if the request fails.
      */
     async getDeviceStatus(deviceId) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-switchbot",
   "type": "module",
-  "version": "3.0.2-beta.5",
+  "version": "3.1.0",
   "description": "The node-switchbot is a Node.js module which allows you to control your Switchbot Devices through Bluetooth (BLE).",
   "author": "OpenWonderLabs (https://github.com/OpenWonderLabs)",
   "license": "MIT",
@@ -50,7 +50,7 @@
   "dependencies": {
     "@stoprocent/noble": "^1.15.1",
     "async-mutex": "^0.5.0",
-    "undici": "^6.19.8"
+    "undici": "^6.20.0"
   },
   "optionalDependencies": {
     "@stoprocent/bluetooth-hci-socket": "^1.4.1"
@@ -62,7 +62,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/jest": "^29.5.13",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.7.4",
+    "@types/node": "^22.7.5",
     "@types/semver": "^7.5.8",
     "@types/sinon": "^17.0.3",
     "@types/source-map-support": "^0.5.10",
@@ -75,8 +75,8 @@
     "shx": "^0.3.4",
     "sinon": "^19.0.2",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.26.8",
-    "typescript": "^5.6.2",
+    "typedoc": "^0.26.9",
+    "typescript": "^5.6.3",
     "vitest": "^2.1.2"
   }
 }

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));