node-red-contrib-homekit-bridged 1.4.0 → 1.4.3-dev.1

package/CHANGELOG.md

@@ -11,6 +11,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.3-dev.1]
+
+### Added
+
+- Pass Characteristic key in event context for Service2
+
+### Changed
+
+- Updated hap-nodejs to [0.9.6](https://github.com/homebridge/HAP-NodeJS/releases/tag/v0.9.6) (bug fixes and security fixes)
+
+## [1.4.2]
+
+### Fixed
+
+- Resolve issue with customCharacteristics not loading from file
+- Fixed publish process
+
+## [1.4.1]
+
+### Fixed
+
+- Fix readme appearance on `flows.nodered.org`
+
 ## [1.4.0]
 
 ### Fixed
@@ -33,7 +56,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Changed
 
-- Updated hap-nodejs to 0.9.5 (added new iOS 15 Services and Characteristics)
+- Updated hap-nodejs to [0.9.5](https://github.com/homebridge/HAP-NodeJS/releases/tag/v0.9.5) (added new iOS 15 Services and Characteristics)
 - Updated dependencies to latest versions
 - Changed `BatteryService` to `Battery` in demo examples as `BatteryService` is deprecated #381 - thanks @crxporter
 - Readme rework - thanks @crxporter

package/README.md

@@ -4,7 +4,7 @@
 
 #### Do you need setup help? Have a great idea? Want to shoot the breeze with fellow users? [Join us on our Discord server!](https://discord.gg/uvYac5u)
 
-### <img src="https://github.com/NRCHKB/NRCHKB.github.io/raw/master/static/images/presentation/demonstration.gif" vspace="500" alt="NRCHKB Demonstration" align="right"/> About this Contrib
+### <img src="https://github.com/NRCHKB/NRCHKB.github.io/raw/master/static/images/presentation/demonstration.gif" alt="NRCHKB Demonstration" align="right"/> About this Contrib
 
 This is a collection of nodes which can be used to imitate HomeKit devices inside of Node-RED. Messages coming into these nodes are able to set device states and status in Apple's iOS and MacOS Home apps. Commands from Home apps (or Siri) will be passed from these nodes into your Node-RED flows.
 

package/build/lib/Storage.d.ts

@@ -13,13 +13,13 @@ export declare class Storage {
     private static log;
     static storagePath(): string;
     static init(...storagePathSegments: string[]): Promise<InitOptions>;
-    static save(type: StorageType, key: string, value: unknown): Promise<storage.WriteFileResult>;
+    static save(type: StorageType, key: string | undefined, value: unknown): Promise<storage.WriteFileResult>;
     static saveCallback(eventCallback: EventCallback, ttl?: number): string;
     static saveCustomCharacteristics(value: unknown): Promise<storage.WriteFileResult>;
     static saveService(key: string, value: unknown): Promise<storage.WriteFileResult>;
     static saveAccessory(key: string, value: unknown): Promise<storage.WriteFileResult>;
     static saveHost(key: string, serializedHost: SerializedHostType): Promise<storage.WriteFileResult>;
-    static load(type: StorageType, key: string): Promise<any>;
+    static load(type: StorageType, key?: string): Promise<any>;
     static loadCallback(key: string): EventCallback | undefined;
     static loadCustomCharacteristics(): Promise<any>;
     static loadService(key: string): Promise<SerializedService>;

package/build/lib/Storage.js

@@ -24,8 +24,9 @@ class Storage {
         return node_persist_1.default.init({ dir: Storage.storagePath() });
     }
     static save(type, key, value) {
-        Storage.log.trace(`Saving ${type}, ${key}:${value}`);
-        return node_persist_1.default.set(`${type}-${key}`, value);
+        const itemName = key ? `${type}-${key}` : type;
+        Storage.log.trace(`Saving ${itemName}:${value}`);
+        return node_persist_1.default.set(itemName, value);
     }
     static saveCallback(eventCallback, ttl = 10000) {
         const callbackID = (0, uuid_1.v4)();
@@ -40,7 +41,7 @@ class Storage {
         return callbackID;
     }
     static saveCustomCharacteristics(value) {
-        return Storage.save(StorageType_1.StorageType.CUSTOM_CHARACTERISTICS, '', value);
+        return Storage.save(StorageType_1.StorageType.CUSTOM_CHARACTERISTICS, undefined, value);
     }
     static saveService(key, value) {
         return Storage.save(StorageType_1.StorageType.SERVICE, key, value);
@@ -52,8 +53,9 @@ class Storage {
         return Storage.save(StorageType_1.StorageType.HOST, key, serializedHost);
     }
     static load(type, key) {
-        Storage.log.trace(`Loading ${type}, ${key}`);
-        return node_persist_1.default.get(`${type}-${key}`);
+        const itemName = key ? `${type}-${key}` : type;
+        Storage.log.trace(`Loading ${itemName}`);
+        return node_persist_1.default.get(itemName);
     }
     static loadCallback(key) {
         if (key in Storage.memoryStorage) {
@@ -65,7 +67,7 @@ class Storage {
         return undefined;
     }
     static loadCustomCharacteristics() {
-        return Storage.load(StorageType_1.StorageType.CUSTOM_CHARACTERISTICS, '');
+        return Storage.load(StorageType_1.StorageType.CUSTOM_CHARACTERISTICS);
     }
     static loadService(key) {
         return new Promise((resolve, reject) => {

package/build/lib/api.js

@@ -123,6 +123,8 @@ module.exports = function (RED) {
         const getCustomCharacteristics = () => {
             return Storage_1.Storage.loadCustomCharacteristics()
                 .then((value) => {
+                log.trace(`loadCustomCharacteristics()`);
+                log.trace(value);
                 if (Array.isArray(value)) {
                     return value;
                 }

package/build/lib/utils/ServiceUtils2.js

@@ -67,7 +67,10 @@ module.exports = function (node) {
                 }
                 catch (_) { }
             }
-            output.call(characteristic, allCharacteristics, { name: "get" }, { oldValue, newValue }, connection);
+            output.call(characteristic, allCharacteristics, {
+                name: "get",
+                context: { key: this.displayName },
+            }, { oldValue, newValue }, connection);
         };
         if (node.config.useEventCallback) {
             const callbackID = Storage_1.Storage.saveCallback({
@@ -77,7 +80,7 @@ module.exports = function (node) {
             log.debug(`Registered callback ${callbackID} for Characteristic ${characteristic.displayName}`);
             output.call(this, allCharacteristics, {
                 name: "get",
-                context: { callbackID },
+                context: { callbackID, key: this.displayName },
             }, { oldValue }, connection);
         }
         else {
@@ -93,14 +96,17 @@ module.exports = function (node) {
             }
         }
         catch (_) { }
-        output.call(this, allCharacteristics, "set", { newValue }, connection);
+        output.call(this, allCharacteristics, {
+            name: "set",
+            context: { key: this.displayName },
+        }, { newValue }, connection);
     };
     const onCharacteristicChange = (allCharacteristics) => function (change) {
         const { oldValue, newValue, context, originator, reason } = change;
         if (oldValue != newValue) {
             output.call(this, allCharacteristics, {
                 name: "change",
-                context: { reason },
+                context: { reason, key: this.displayName },
             }, { oldValue, newValue, context }, originator);
         }
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homekit-bridged",
-  "version": "1.4.0",
+  "version": "1.4.3-dev.1",
   "description": "Node-RED nodes to simulate Apple HomeKit devices.",
   "main": "build/nodes/nrchkb.js",
   "scripts": {
@@ -47,29 +47,29 @@
   "homepage": "https://github.com/NRCHKB/node-red-contrib-homekit-bridged#readme",
   "dependencies": {
     "@nrchkb/logger": "^1.3.3",
-    "hap-nodejs": "^0.9.5",
+    "hap-nodejs": "^0.9.6",
     "node-persist": "^3.1.0",
     "semver": "^7.3.5",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@homebridge/ciao": "^1.1.2",
-    "@node-red/registry": "^1.3.6",
+    "@node-red/registry": "^1.3.7",
     "@types/mocha": "^9.0.0",
     "@types/node": "^10.17.50",
     "@types/node-persist": "^3.1.2",
     "@types/node-red": "^1.1.1",
     "@types/semver": "^7.3.8",
     "@types/uuid": "^8.3.1",
-    "@typescript-eslint/eslint-plugin": "^4.32.0",
-    "@typescript-eslint/parser": "^4.32.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "babel-eslint": "^10.1.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.2",
     "mocha": "^9.1.2",
-    "node-red": "^1.3.6",
+    "node-red": "^1.3.7",
     "node-red-node-test-helper": "^0.2.7",
     "pinst": "^2.1.6",
     "prettier": "^2.4.1",