node-red-contrib-homekit-bridged 1.5.0-dev.12 → 1.5.0-dev.14

package/build/lib/HAPServiceNode.js

@@ -8,6 +8,7 @@ const hap_nodejs_1 = require("hap-nodejs");
 const NRCHKBError_1 = __importDefault(require("./NRCHKBError"));
 const FlowType_1 = require("./types/FlowType");
 const HostType_1 = __importDefault(require("./types/HostType"));
+const NodeStatusUtils_1 = require("./utils/NodeStatusUtils");
 module.exports = (RED) => {
     const nrchkbConfigCompatibilityOverride = function () {
         const self = this;
@@ -23,17 +24,7 @@ module.exports = (RED) => {
     };
     const preInit = function (config) {
         const self = this;
-        self.lastStatusId = 0;
-        self.setStatus = (status) => {
-            self.status(status);
-            self.lastStatusId = new Date().getTime();
-            return self.lastStatusId;
-        };
-        self.clearStatus = (statusId) => {
-            if (statusId === self.lastStatusId) {
-                self.setStatus({});
-            }
-        };
+        self.nodeStatusUtils = new NodeStatusUtils_1.NodeStatusUtils(self);
         self.config = config;
         self.name = self.config.name;
         const log = (0, logger_1.logger)('NRCHKB', 'HAPServiceNode', self.config.name, self);
@@ -46,7 +37,7 @@ module.exports = (RED) => {
             if (self.config.waitForSetupMsg) {
                 log.debug('Waiting for Setup message. It should be of format {"payload":{"nrchkb":{"setup":{}}}}');
                 self.setupDone = false;
-                self.setStatus({
+                self.nodeStatusUtils.setStatus({
                     fill: 'blue',
                     shape: 'dot',
                     text: 'Waiting for Setup',
@@ -90,6 +81,7 @@ module.exports = (RED) => {
         }
     };
     const configure = function () {
+        var _a;
         const self = this;
         const log = (0, logger_1.logger)('NRCHKB', 'HAPServiceNode', self.config.name, self);
         const Utils = require('./utils')(self);
@@ -123,7 +115,7 @@ module.exports = (RED) => {
                 throw new NRCHKBError_1.default('Parent Service not assigned');
             }
             self.hostNode = self.parentNode.hostNode;
-            self.parentNode.childNodes.push(self);
+            (_a = self.parentNode.childNodes) === null || _a === void 0 ? void 0 : _a.push(self);
             self.accessory = self.parentNode.accessory;
         }
         self.name = self.config.name;
@@ -171,9 +163,9 @@ module.exports = (RED) => {
         }, self.parentService);
         self.characteristicProperties = CharacteristicUtils.load(self.service, self.config);
         if (self.config.isParent) {
-            self.publishTimers = BridgeUtils.delayedPublish(self);
+            BridgeUtils.delayedPublish(self);
         }
-        self.setStatus({
+        self.nodeStatusUtils.setStatus({
             fill: 'yellow',
             shape: 'ring',
             text: self.hostNode.config.pinCode,

package/build/lib/HAPServiceNode2.js

@@ -8,6 +8,7 @@ const hap_nodejs_1 = require("hap-nodejs");
 const NRCHKBError_1 = __importDefault(require("./NRCHKBError"));
 const FlowType_1 = require("./types/FlowType");
 const HostType_1 = __importDefault(require("./types/HostType"));
+const NodeStatusUtils_1 = require("./utils/NodeStatusUtils");
 module.exports = (RED) => {
     const nrchkbConfigCompatibilityOverride = function () {
         const self = this;
@@ -23,17 +24,7 @@ module.exports = (RED) => {
     };
     const preInit = function (config) {
         const self = this;
-        self.lastStatusId = 0;
-        self.setStatus = (status) => {
-            self.status(status);
-            self.lastStatusId = new Date().getTime();
-            return self.lastStatusId;
-        };
-        self.clearStatus = (statusId) => {
-            if (statusId === self.lastStatusId) {
-                self.setStatus({});
-            }
-        };
+        self.nodeStatusUtils = new NodeStatusUtils_1.NodeStatusUtils(self);
         self.config = config;
         self.name = self.config.name;
         const log = (0, logger_1.logger)('NRCHKB', 'HAPServiceNode2', self.config.name, self);
@@ -46,7 +37,7 @@ module.exports = (RED) => {
             if (self.config.waitForSetupMsg) {
                 log.debug('Waiting for Setup message. It should be of format {"payload":{"nrchkb":{"setup":{}}}}');
                 self.setupDone = false;
-                self.setStatus({
+                self.nodeStatusUtils.setStatus({
                     fill: 'blue',
                     shape: 'dot',
                     text: 'Waiting for Setup',
@@ -90,6 +81,7 @@ module.exports = (RED) => {
         }
     };
     const configure = function () {
+        var _a;
         const self = this;
         const log = (0, logger_1.logger)('NRCHKB', 'HAPServiceNode2', self.config.name, self);
         const Utils = require('./utils')(self);
@@ -123,7 +115,7 @@ module.exports = (RED) => {
                 throw new NRCHKBError_1.default('Parent Service not assigned');
             }
             self.hostNode = self.parentNode.hostNode;
-            self.parentNode.childNodes.push(self);
+            (_a = self.parentNode.childNodes) === null || _a === void 0 ? void 0 : _a.push(self);
             self.accessory = self.parentNode.accessory;
         }
         self.name = self.config.name;
@@ -173,7 +165,7 @@ module.exports = (RED) => {
         if (self.config.isParent) {
             BridgeUtils.delayedPublish(self);
         }
-        self.setStatus({
+        self.nodeStatusUtils.setStatus({
             fill: 'yellow',
             shape: 'ring',
             text: self.hostNode.config.pinCode,

package/build/lib/types/HAPService2NodeType.d.ts

@@ -1,12 +1,12 @@
 import { Accessory, Characteristic, CharacteristicChange, CharacteristicGetCallback, CharacteristicProps, CharacteristicSetCallback, CharacteristicValue, Service } from 'hap-nodejs';
 import { HAPConnection } from 'hap-nodejs/dist/lib/util/eventedhttp';
 import { NodeAPI } from 'node-red';
+import { NodeStatusUtils } from '../utils/NodeStatusUtils';
 import HAPHostNodeType from './HAPHostNodeType';
 import HAPService2ConfigType from './HAPService2ConfigType';
 import HAPServiceNodeType from './HAPServiceNodeType';
 import NodeType from './NodeType';
 import PublishTimersType from './PublishTimersType';
-import StatusUtilType from './StatusUtilType';
 declare type HAPService2NodeType = NodeType & {
     config: HAPService2ConfigType;
     RED: NodeAPI;
@@ -15,7 +15,7 @@ declare type HAPService2NodeType = NodeType & {
     handleWaitForSetup: (msg: any) => any;
     onIdentify: (paired: boolean, callback: () => any) => void;
     hostNode: HAPHostNodeType;
-    childNodes: (HAPService2NodeType | HAPServiceNodeType)[];
+    childNodes?: (HAPService2NodeType | HAPServiceNodeType)[];
     service: Service;
     parentService: Service;
     parentNode?: HAPService2NodeType | HAPServiceNodeType;
@@ -31,5 +31,6 @@ declare type HAPService2NodeType = NodeType & {
     onCharacteristicChange: (this: Characteristic, change: CharacteristicChange) => void;
     uniqueIdentifier: string;
     reachable?: boolean;
-} & StatusUtilType;
+    nodeStatusUtils: NodeStatusUtils;
+};
 export default HAPService2NodeType;

package/build/lib/types/HAPServiceNodeType.d.ts

@@ -1,12 +1,12 @@
 import { Accessory, Characteristic, CharacteristicChange, CharacteristicGetCallback, CharacteristicProps, CharacteristicSetCallback, CharacteristicValue, Service } from 'hap-nodejs';
 import { HAPConnection } from 'hap-nodejs/dist/lib/util/eventedhttp';
 import { NodeAPI } from 'node-red';
+import { NodeStatusUtils } from '../utils/NodeStatusUtils';
 import HAPHostNodeType from './HAPHostNodeType';
 import HAPService2NodeType from './HAPService2NodeType';
 import HAPServiceConfigType from './HAPServiceConfigType';
 import NodeType from './NodeType';
 import PublishTimersType from './PublishTimersType';
-import StatusUtilType from './StatusUtilType';
 declare type HAPServiceNodeType = NodeType & {
     config: HAPServiceConfigType;
     RED: NodeAPI;
@@ -15,7 +15,7 @@ declare type HAPServiceNodeType = NodeType & {
     handleWaitForSetup: (msg: any) => any;
     onIdentify: (paired: boolean, callback: () => any) => void;
     hostNode: HAPHostNodeType;
-    childNodes: (HAPService2NodeType | HAPServiceNodeType)[];
+    childNodes?: (HAPService2NodeType | HAPServiceNodeType)[];
     service: Service;
     parentService: Service;
     parentNode?: HAPService2NodeType | HAPServiceNodeType;
@@ -31,5 +31,6 @@ declare type HAPServiceNodeType = NodeType & {
     onCharacteristicChange: (this: Characteristic, change: CharacteristicChange) => void;
     uniqueIdentifier: string;
     reachable?: boolean;
-} & StatusUtilType;
+    nodeStatusUtils: NodeStatusUtils;
+};
 export default HAPServiceNodeType;

package/build/lib/types/HAPStatusNodeType.d.ts

@@ -1,11 +1,12 @@
 import { NodeAPI } from 'node-red';
+import { NodeStatusUtils } from '../utils/NodeStatusUtils';
 import HAPServiceNodeType from './HAPServiceNodeType';
 import HAPStatusConfigType from './HAPStatusConfigType';
 import NodeType from './NodeType';
-import StatusUtilType from './StatusUtilType';
 declare type HAPStatusNodeType = NodeType & {
     config: HAPStatusConfigType;
     RED: NodeAPI;
     serviceNode?: HAPServiceNodeType;
-} & StatusUtilType;
+    nodeStatusUtils: NodeStatusUtils;
+};
 export default HAPStatusNodeType;

package/build/lib/utils/AccessoryUtils.js

@@ -77,13 +77,14 @@ module.exports = function (node) {
         return accessory;
     };
     const onIdentify = function (paired, callback) {
+        var _a;
         if (paired) {
             log.debug(`Identify called on paired Accessory ${node.accessory.displayName}`);
         }
         else {
             log.debug(`Identify called on unpaired Accessory ${node.accessory.displayName}`);
         }
-        const nodes = node.childNodes;
+        const nodes = (_a = node.childNodes) !== null && _a !== void 0 ? _a : [];
         for (let i = 0, len = nodes.length; i < len; i++) {
             const topic = nodes[i].config.topic
                 ? nodes[i].config.topic
@@ -93,13 +94,13 @@ module.exports = function (node) {
                 name: nodes[i].name,
                 topic: topic,
             };
-            const statusId = nodes[i].setStatus({
+            const statusId = nodes[i].nodeStatusUtils.setStatus({
                 fill: 'yellow',
                 shape: 'dot',
                 text: 'Identify : 1',
             });
             setTimeout(function () {
-                nodes[i].clearStatus(statusId);
+                nodes[i].nodeStatusUtils.clearStatus(statusId);
             }, 3000);
             nodes[i].send([msg, msg]);
         }

package/build/lib/utils/BridgeUtils.js

@@ -29,7 +29,7 @@ module.exports = function () {
                 }
                 catch (error) {
                     log.error(`${hostTypeName} publish failed due to ${error}`);
-                    node.setStatus({
+                    node.nodeStatusUtils.setStatus({
                         fill: 'red',
                         shape: 'ring',
                         text: 'Error while publishing ' + hostTypeName,

package/build/lib/utils/NodeStatusUtils.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node-red__registry" />
+import { NodeStatus } from '@node-red/registry';
+import NodeType from '../types/NodeType';
+declare type StatusType = 'NO_RESPONSE' | 'MSG';
+declare type NodeStatusWithType = NodeStatus & {
+    type?: StatusType;
+};
+declare type Status = string | NodeStatusWithType;
+export declare class NodeStatusUtils {
+    private node;
+    protected lastStatusId?: number;
+    protected lastStatusType?: StatusType;
+    constructor(node: Pick<NodeType, 'status'>);
+    setStatus(status: Status, timeout?: number): number;
+    clearStatusByType(type: StatusType): void;
+    clearStatus(statusId?: number, timeout?: number): void;
+}
+export {};

package/build/lib/utils/NodeStatusUtils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeStatusUtils = void 0;
+const DEFAULT_STATUS_TYPE = 'MSG';
+class NodeStatusUtils {
+    constructor(node) {
+        this.node = node;
+    }
+    setStatus(status, timeout) {
+        var _a;
+        this.node.status(status);
+        const newStatusId = new Date().getTime();
+        this.lastStatusId = newStatusId;
+        if (typeof status !== 'string') {
+            this.lastStatusType = (_a = status.type) !== null && _a !== void 0 ? _a : DEFAULT_STATUS_TYPE;
+        }
+        else {
+            this.lastStatusType = DEFAULT_STATUS_TYPE;
+        }
+        if (timeout) {
+            this.clearStatus(newStatusId, timeout);
+        }
+        return newStatusId;
+    }
+    clearStatusByType(type) {
+        if (this.lastStatusType === type) {
+            this.clearStatus();
+        }
+    }
+    clearStatus(statusId, timeout) {
+        if (statusId !== undefined) {
+            if (statusId === this.lastStatusId) {
+                if (timeout) {
+                    setTimeout(function (nodeStatusUtil) {
+                        nodeStatusUtil.clearStatus(statusId);
+                    }, timeout, this);
+                }
+                else {
+                    this.setStatus('');
+                }
+            }
+        }
+        else {
+            this.setStatus('');
+        }
+    }
+}
+exports.NodeStatusUtils = NodeStatusUtils;

package/build/lib/utils/ServiceUtils.js

@@ -43,6 +43,7 @@ module.exports = function (node) {
         }
     };
     const onValueChange = function (allCharacteristics, outputNumber, { oldValue, newValue, context }, connection) {
+        var _a, _b, _c, _d, _e;
         const topic = node.config.topic ? node.config.topic : node.topic_in;
         const msg = { payload: {}, hap: {}, name: node.name, topic: topic };
         const key = this.constructor.name;
@@ -56,22 +57,25 @@ module.exports = function (node) {
         if (oldValue !== undefined) {
             msg.hap.oldValue = oldValue;
         }
-        if (!node.reachable) {
-            msg.hap.reachable = false;
-            node.setStatus({
-                fill: 'yellow',
-                shape: 'dot',
+        msg.hap.reachable = (_a = node.reachable) !== null && _a !== void 0 ? _a : (_b = node.parentNode) === null || _b === void 0 ? void 0 : _b.reachable;
+        if (msg.hap.reachable === false) {
+            ;
+            [node, ...((_c = node.childNodes) !== null && _c !== void 0 ? _c : [])].forEach((n) => n.nodeStatusUtils.setStatus({
+                fill: 'red',
+                shape: 'ring',
                 text: 'Not reachable',
-            }, 3000);
+                type: 'NO_RESPONSE',
+            }));
         }
         else {
-            msg.hap.reachable = true;
             msg.hap.newValue = newValue;
-            node.setStatus({
+            node.nodeStatusUtils.setStatus({
                 fill: 'yellow',
                 shape: 'dot',
                 text: key + ': ' + newValue,
             }, 3000);
+            (_d = node.childNodes) === null || _d === void 0 ? void 0 : _d.forEach((n) => n.nodeStatusUtils.clearStatusByType('NO_RESPONSE'));
+            (_e = node.parentNode) === null || _e === void 0 ? void 0 : _e.nodeStatusUtils.clearStatusByType('NO_RESPONSE');
         }
         log.debug(`${node.name} received ${key} : ${newValue}`);
         if (connection ||
@@ -234,7 +238,7 @@ module.exports = function (node) {
     const waitForParent = () => {
         log.debug('Waiting for Parent Service');
         return new Promise((resolve) => {
-            node.setStatus({
+            node.nodeStatusUtils.setStatus({
                 fill: 'blue',
                 shape: 'dot',
                 text: 'Waiting for Parent Service',

package/build/lib/utils/ServiceUtils2.js

@@ -15,6 +15,7 @@ module.exports = function (node) {
     const CameraSource = require('../cameraSource').Camera;
     const NO_RESPONSE_MSG = 'NO_RESPONSE';
     const output = function (allCharacteristics, event, { oldValue, newValue }, connection) {
+        var _a, _b, _c, _d, _e;
         const eventObject = typeof event === 'object' ? event : { name: event };
         log.debug(`${eventObject.name} event, oldValue: ${oldValue}, newValue: ${newValue}, connection ${connection === null || connection === void 0 ? void 0 : connection.sessionID}`);
         const msg = {
@@ -32,22 +33,25 @@ module.exports = function (node) {
             oldValue,
         };
         const key = this.constructor.name;
-        if (!node.reachable) {
-            msg.hap.reachable = false;
-            node.setStatus({
-                fill: 'yellow',
-                shape: 'dot',
+        msg.hap.reachable = (_a = node.reachable) !== null && _a !== void 0 ? _a : (_b = node.parentNode) === null || _b === void 0 ? void 0 : _b.reachable;
+        if (msg.hap.reachable === false) {
+            ;
+            [node, ...((_c = node.childNodes) !== null && _c !== void 0 ? _c : [])].forEach((n) => n.nodeStatusUtils.setStatus({
+                fill: 'red',
+                shape: 'ring',
                 text: 'Not reachable',
-            }, 3000);
+                type: 'NO_RESPONSE',
+            }));
         }
         else {
-            msg.hap.reachable = true;
             msg.hap.newValue = newValue;
-            node.setStatus({
+            node.nodeStatusUtils.setStatus({
                 fill: 'yellow',
                 shape: 'dot',
                 text: `[${eventObject.name}] ${key}${newValue != undefined ? `: ${newValue}` : ''}`,
             }, 3000);
+            (_d = node.childNodes) === null || _d === void 0 ? void 0 : _d.forEach((n) => n.nodeStatusUtils.clearStatusByType('NO_RESPONSE'));
+            (_e = node.parentNode) === null || _e === void 0 ? void 0 : _e.nodeStatusUtils.clearStatusByType('NO_RESPONSE');
         }
         msg.payload[key] = newValue;
         if (connection) {
@@ -257,7 +261,7 @@ module.exports = function (node) {
     const waitForParent = () => {
         log.debug('Waiting for Parent Service');
         return new Promise((resolve) => {
-            node.setStatus({
+            node.nodeStatusUtils.setStatus({
                 fill: 'blue',
                 shape: 'dot',
                 text: 'Waiting for Parent Service',

package/build/nodes/standalone.html

@@ -20,6 +20,7 @@
         <select id="node-config-input-advertiser">
             <option value="bonjour-hap" selected="selected">BONJOUR</option>
             <option value="ciao">CIAO</option>
+            <option value="avahi">AVAHI</option>
         </select>
     </div>
     <div class="form-row">
@@ -105,7 +106,7 @@
         <li><strong>Accessory Category</strong>: What kind of category is this Accessory, default <em>OTHER</em></li>
         <li><strong>Pin Code</strong>: Specify the Pin for the pairing process.</li>
         <li><strong>Port</strong>: If you are behind a Firewall, you may want to specify a port. Cannot be 1880 as it is reserved for node-red. Otherwise, leave empty.</li>
-        <li><strong>Advertiser</strong>: Which MDNS advertiser to use <em>ciao</em> (new, improved but not yet proved) or (good old) <em>bonjour</em>. Default <em>bonjour</em>.</li>
+        <li><strong>Advertiser</strong>: Which MDNS advertiser to use <em>ciao</em> (new, improved but not yet proved) or (good old) <em>bonjour</em> or experimental <em>avahi</em>. Default <em>bonjour</em>.</li>
         <li><strong>Allow Insecure Request</strong>: Should we allow insecure request? Default false.</li>
         <li><strong>Manufacturer, Model, Serial Number</strong>: Can be anything you want.</li>
         <li><strong>Firmware Revision</strong>: Should be a version number string in the form of <em>MAJOR.MINOR.REVISION</em> e.g. <em>1.2.0</em>. Other types of strings are ignored and won't be displayed.</li>
@@ -157,7 +158,7 @@
                 value: 'bonjour-hap',
                 required: false,
                 validate: function (value) {
-                    if (value) return value === 'bonjour-hap' || value === 'ciao'
+                    if (value) return value === 'bonjour-hap' || value === 'ciao' || value === 'avahi'
                     else return true
                 },
             },

package/build/nodes/status.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = require("@nrchkb/logger");
 const hap_nodejs_1 = require("hap-nodejs");
+const NodeStatusUtils_1 = require("../lib/utils/NodeStatusUtils");
 const log = (0, logger_1.logger)('NRCHKB', 'HAPStatusNode');
 module.exports = (RED) => {
     log.debug('Registering homekit-status type');
@@ -9,27 +10,7 @@ module.exports = (RED) => {
         const self = this;
         self.config = config;
         RED.nodes.createNode(self, config);
-        self.lastStatusId = 0;
-        self.setStatus = (status, timeout) => {
-            self.status(status);
-            self.lastStatusId = new Date().getTime();
-            if (timeout) {
-                self.clearStatus(self.lastStatusId, timeout);
-            }
-            return self.lastStatusId;
-        };
-        self.clearStatus = (statusId, delay) => {
-            if (statusId === self.lastStatusId) {
-                if (delay) {
-                    setTimeout(function () {
-                        self.setStatus({});
-                    }, delay);
-                }
-                else {
-                    self.setStatus({});
-                }
-            }
-        };
+        self.nodeStatusUtils = new NodeStatusUtils_1.NodeStatusUtils(self);
         try {
             self.serviceNode = RED.nodes.getNode(self.config.serviceNodeId);
         }
@@ -38,7 +19,7 @@ module.exports = (RED) => {
         }
         self.on('input', (_) => {
             if (self.serviceNode) {
-                self.setStatus({
+                self.nodeStatusUtils.setStatus({
                     fill: 'green',
                     shape: 'dot',
                     text: 'Done',
@@ -49,11 +30,11 @@ module.exports = (RED) => {
                 });
             }
             else {
-                self.setStatus({
+                self.nodeStatusUtils.setStatus({
                     fill: 'red',
                     shape: 'dot',
                     text: 'Check your config',
-                }, 3000);
+                });
             }
         });
         self.on('close', (_, done) => {

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "node-red-contrib-homekit-bridged",
-  "version": "1.5.0-dev.12",
+  "version": "1.5.0-dev.14",
   "description": "Node-RED nodes to simulate Apple HomeKit devices.",
   "main": "build/nodes/nrchkb.js",
   "scripts": {
     "build": "npm run clean && tsc",
     "clean": "rimraf build/lib build/**/*.js",
-    "test": "npm run build && mocha -r ts-node/register './src/**/*.test.[tj]s' --exit --timeout 30000",
+    "test": "mocha -r ts-node/register './src/**/*.test.[tj]s' --exit --timeout 30000",
     "prettier": "prettier --write \"**/*.{js,ts}\"",
-    "eslint": "eslint \"**/*.ts\"",
+    "eslint": "eslint \"src/**/*.ts\"",
     "prepare": "husky install"
   },
   "repository": {
@@ -55,7 +55,7 @@
   "devDependencies": {
     "@homebridge/ciao": "^1.1.5",
     "@node-red/registry": "^2.2.3",
-    "@types/mocha": "^9.1.1",
+    "@types/mocha": "^10.0.0",
     "@types/node": "^10.17.60",
     "@types/node-persist": "^3.1.3",
     "@types/node-red": "^1.2.1",

package/build/lib/types/StatusUtilType.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="node-red__registry" />
-import { NodeStatus } from '@node-red/registry';
-declare type StatusUtilType = {
-    lastStatusId: number;
-    setStatus: (status: string | NodeStatus, timeout?: number) => number;
-    clearStatus: (statusId: number, delay?: number) => void;
-};
-export default StatusUtilType;

package/build/lib/types/StatusUtilType.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });