@zwave-js/host 9.3.0 → 9.3.1-0-pr-4661-5ac6caf

package/build/ZWaveHost.d.ts

@@ -1,5 +1,5 @@
-import type { ConfigManager } from "@zwave-js/config";
-import type { CommandClasses, ControllerLogger, SecurityManager, SecurityManager2, ValueDB } from "@zwave-js/core";
+import type { CompatConfig, ConfigManager } from "@zwave-js/config";
+import type { CommandClasses, ControllerLogger, Maybe, SecurityClass, SecurityManager, SecurityManager2, ValueDB } from "@zwave-js/core";
 import type { ReadonlyThrowingMap } from "@zwave-js/shared";
 import type { ZWaveNodeBase } from "./ZWaveNodeBase";
 export interface ZWaveHostOptions {
@@ -21,34 +21,45 @@ export interface ZWaveHostOptions {
         nodeInterview: number;
     };
 }
-/** Host application abstractions to be used in Serial API and CC implemenations */
+/** Host application abstractions to be used in Serial API and CC implementations */
 export interface ZWaveHost {
-    controllerLog: ControllerLogger;
-    /** Gives access to the configuration files */
-    configManager: ConfigManager;
-    /** Management of Security S0 keys and nonces */
-    securityManager: SecurityManager | undefined;
-    /** Management of Security S2 keys and nonces */
-    securityManager2: SecurityManager2 | undefined;
     /** The ID of this node in the current network */
     ownNodeId: number;
     /** The Home ID of the current network */
     homeId: number;
-    /** Readonly access to all node instances known to the host */
-    nodes: ReadonlyThrowingMap<number, ZWaveNodeBase>;
-    options: ZWaveHostOptions;
+    /** Management of Security S0 keys and nonces */
+    securityManager: SecurityManager | undefined;
+    /** Management of Security S2 keys and nonces */
+    securityManager2: SecurityManager2 | undefined;
     /**
      * Retrieves the maximum version of a command class that can be used to communicate with a node.
      * Returns 1 if the node claims that it does not support a CC.
      * Throws if the CC is not implemented in this library yet.
      */
     getSafeCCVersionForNode(cc: CommandClasses, nodeId: number, endpointIndex?: number): number;
+    /**
+     * Determines whether a CC must be secure for a given node and endpoint.
+     */
+    isCCSecure(cc: CommandClasses, nodeId: number, endpointIndex?: number): boolean;
+    getHighestSecurityClass(nodeId: number): SecurityClass | undefined;
+    hasSecurityClass(nodeId: number, securityClass: SecurityClass): Maybe<boolean>;
+    setSecurityClass(nodeId: number, securityClass: SecurityClass, granted: boolean): void;
     /**
      * Returns the next callback ID. Callback IDs are used to correllate requests
      * to the controller/nodes with its response
      */
     getNextCallbackId(): number;
+    getCompatConfig?: (nodeId: number) => CompatConfig | undefined;
+}
+/** A more featureful version of the ZWaveHost interface, which is meant to be used on the controller application side. */
+export interface ZWaveApplicationHost extends ZWaveHost {
+    /** Gives access to the configuration files */
+    configManager: ConfigManager;
+    options: ZWaveHostOptions;
+    controllerLog: ControllerLogger;
     /** Returns the value DB which belongs to the node with the given ID */
     getValueDB(nodeId: number): ValueDB;
+    /** Readonly access to all node instances known to the host */
+    nodes: ReadonlyThrowingMap<number, ZWaveNodeBase>;
 }
 //# sourceMappingURL=ZWaveHost.d.ts.map

package/build/ZWaveHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ZWaveHost.d.ts","sourceRoot":"","sources":["../src/ZWaveHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EACX,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,OAAO,EACP,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,WAAW,gBAAgB;IAChC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,QAAQ,EAAE;QAOT,yFAAyF;QACzF,UAAU,EAAE,MAAM,CAAC;QAEnB,iFAAiF;QACjF,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAED,mFAAmF;AACnF,MAAM,WAAW,SAAS;IAEzB,aAAa,EAAE,gBAAgB,CAAC;IAEhC,8CAA8C;IAC9C,aAAa,EAAE,aAAa,CAAC;IAE7B,gDAAgD;IAChD,eAAe,EAAE,eAAe,GAAG,SAAS,CAAC;IAC7C,gDAAgD;IAChD,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAE/C,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IAEf,8DAA8D;IAC9D,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAElD,OAAO,EAAE,gBAAgB,CAAC;IAE1B;;;;OAIG;IACH,uBAAuB,CACtB,EAAE,EAAE,cAAc,EAClB,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,GACpB,MAAM,CAAC;IAEV;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAC;IAE5B,uEAAuE;IACvE,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;CACpC"}
+{"version":3,"file":"ZWaveHost.d.ts","sourceRoot":"","sources":["../src/ZWaveHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,KAAK,EACX,cAAc,EACd,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,OAAO,EACP,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,WAAW,gBAAgB;IAChC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,QAAQ,EAAE;QAOT,yFAAyF;QACzF,UAAU,EAAE,MAAM,CAAC;QAEnB,iFAAiF;QACjF,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,WAAW,SAAS;IACzB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IAEf,gDAAgD;IAChD,eAAe,EAAE,eAAe,GAAG,SAAS,CAAC;IAC7C,gDAAgD;IAChD,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,uBAAuB,CACtB,EAAE,EAAE,cAAc,EAClB,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,GACpB,MAAM,CAAC;IAEV;;OAEG;IACH,UAAU,CACT,EAAE,EAAE,cAAc,EAClB,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC;IAEX,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IAEnE,gBAAgB,CACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,aAAa,GAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;IAElB,gBAAgB,CACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,GACd,IAAI,CAAC;IAER;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,YAAY,GAAG,SAAS,CAAC;CAC/D;AAED,0HAA0H;AAC1H,MAAM,WAAW,oBAAqB,SAAQ,SAAS;IACtD,8CAA8C;IAC9C,aAAa,EAAE,aAAa,CAAC;IAE7B,OAAO,EAAE,gBAAgB,CAAC;IAG1B,aAAa,EAAE,gBAAgB,CAAC;IAEhC,uEAAuE;IACvE,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEpC,8DAA8D;IAC9D,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAClD"}

package/build/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./FileSystem";
+export * from "./mocks";
 export * from "./ZWaveEndpointBase";
 export * from "./ZWaveHost";
 export * from "./ZWaveNodeBase";

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}

package/build/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./FileSystem"), exports);
+__exportStar(require("./mocks"), exports);
 __exportStar(require("./ZWaveEndpointBase"), exports);
 __exportStar(require("./ZWaveHost"), exports);
 __exportStar(require("./ZWaveNodeBase"), exports);

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,sDAAoC;AACpC,8CAA4B;AAC5B,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,0CAAwB;AACxB,sDAAoC;AACpC,8CAA4B;AAC5B,kDAAgC"}

package/build/mocks.d.ts

@@ -0,0 +1,15 @@
+import { type ThrowingMap } from "@zwave-js/shared";
+import type { Overwrite } from "alcalzone-shared/types";
+import type { ZWaveApplicationHost, ZWaveHost } from "./ZWaveHost";
+import type { ZWaveNodeBase } from "./ZWaveNodeBase";
+export interface CreateTestingHostOptions {
+    homeId: ZWaveHost["homeId"];
+    ownNodeId: ZWaveHost["ownNodeId"];
+    getSafeCCVersionForNode: ZWaveHost["getSafeCCVersionForNode"];
+}
+export declare type TestingHost = Overwrite<ZWaveApplicationHost, {
+    nodes: ThrowingMap<number, ZWaveNodeBase>;
+}>;
+/** Creates a {@link ZWaveApplicationHost} that can be used for testing */
+export declare function createTestingHost(options?: Partial<CreateTestingHostOptions>): TestingHost;
+//# sourceMappingURL=mocks.d.ts.map

package/build/mocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mocks.d.ts","sourceRoot":"","sources":["../src/mocks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,WAAW,wBAAwB;IACxC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IAClC,uBAAuB,EAAE,SAAS,CAAC,yBAAyB,CAAC,CAAC;CAC9D;AAED,oBAAY,WAAW,GAAG,SAAS,CAClC,oBAAoB,EACpB;IAAE,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CAAE,CAC7C,CAAC;AAEF,0EAA0E;AAC1E,wBAAgB,iBAAiB,CAChC,OAAO,GAAE,OAAO,CAAC,wBAAwB,CAAM,GAC7C,WAAW,CA8Eb"}

package/build/mocks.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestingHost = void 0;
+const config_1 = require("@zwave-js/config");
+const core_1 = require("@zwave-js/core");
+const shared_1 = require("@zwave-js/shared");
+/** Creates a {@link ZWaveApplicationHost} that can be used for testing */
+function createTestingHost(options = {}) {
+    var _a, _b, _c;
+    let callbackId = 0xff;
+    const getNextCallbackId = () => {
+        callbackId = (callbackId + 1) & 0xff;
+        if (callbackId < 1)
+            callbackId = 1;
+        return callbackId;
+    };
+    const valuesStorage = new Map();
+    const metadataStorage = new Map();
+    const valueDBCache = new Map();
+    const ret = {
+        homeId: (_a = options.homeId) !== null && _a !== void 0 ? _a : 0x7e570001,
+        ownNodeId: (_b = options.ownNodeId) !== null && _b !== void 0 ? _b : 1,
+        securityManager: undefined,
+        securityManager2: undefined,
+        getCompatConfig: undefined,
+        controllerLog: new Proxy({}, {
+            get() {
+                return () => {
+                    /* intentionally empty */
+                };
+            },
+        }),
+        configManager: new config_1.ConfigManager(),
+        options: {
+            attempts: {
+                nodeInterview: 1,
+                openSerialPort: 1,
+                sendData: 3,
+                controller: 3,
+            },
+        },
+        nodes: (0, shared_1.createThrowingMap)((nodeId) => {
+            throw new core_1.ZWaveError(`Node ${nodeId} was not found!`, core_1.ZWaveErrorCodes.Controller_NodeNotFound);
+        }),
+        getSafeCCVersionForNode: (_c = options.getSafeCCVersionForNode) !== null && _c !== void 0 ? _c : (() => 100),
+        getNextCallbackId,
+        getValueDB: (nodeId) => {
+            if (!valueDBCache.has(nodeId)) {
+                valueDBCache.set(nodeId, new core_1.ValueDB(nodeId, valuesStorage, metadataStorage));
+            }
+            return valueDBCache.get(nodeId);
+        },
+        isCCSecure: (ccId, nodeId, endpointIndex = 0) => {
+            var _a;
+            const node = ret.nodes.get(nodeId);
+            const endpoint = node === null || node === void 0 ? void 0 : node.getEndpoint(endpointIndex);
+            return ((node === null || node === void 0 ? void 0 : node.isSecure) !== false &&
+                !!((_a = (endpoint !== null && endpoint !== void 0 ? endpoint : node)) === null || _a === void 0 ? void 0 : _a.isCCSecure(ccId)) &&
+                !!(ret.securityManager || ret.securityManager2));
+        },
+        getHighestSecurityClass: (nodeId) => {
+            const node = ret.nodes.getOrThrow(nodeId);
+            return node.getHighestSecurityClass();
+        },
+        hasSecurityClass: (nodeId, securityClass) => {
+            const node = ret.nodes.getOrThrow(nodeId);
+            return node.hasSecurityClass(securityClass);
+        },
+        setSecurityClass: (nodeId, securityClass, granted) => {
+            const node = ret.nodes.getOrThrow(nodeId);
+            node.setSecurityClass(securityClass, granted);
+        },
+    };
+    return ret;
+}
+exports.createTestingHost = createTestingHost;
+//# sourceMappingURL=mocks.js.map

package/build/mocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mocks.js","sourceRoot":"","sources":["../src/mocks.ts"],"names":[],"mappings":";;;AAAA,6CAAiD;AACjD,yCAAsE;AACtE,6CAAuE;AAgBvE,0EAA0E;AAC1E,SAAgB,iBAAiB,CAChC,UAA6C,EAAE;;IAE/C,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC9B,UAAU,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;QACrC,IAAI,UAAU,GAAG,CAAC;YAAE,UAAU,GAAG,CAAC,CAAC;QACnC,OAAO,UAAU,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IAChC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;IAClC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAmB,CAAC;IAEhD,MAAM,GAAG,GAAgB;QACxB,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,UAAU;QACpC,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC;QACjC,eAAe,EAAE,SAAS;QAC1B,gBAAgB,EAAE,SAAS;QAC3B,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,IAAI,KAAK,CAAC,EAAS,EAAE;YACnC,GAAG;gBACF,OAAO,GAAG,EAAE;oBACX,yBAAyB;gBAC1B,CAAC,CAAC;YACH,CAAC;SACD,CAAC;QACF,aAAa,EAAE,IAAI,sBAAa,EAAE;QAClC,OAAO,EAAE;YACR,QAAQ,EAAE;gBACT,aAAa,EAAE,CAAC;gBAChB,cAAc,EAAE,CAAC;gBACjB,QAAQ,EAAE,CAAC;gBACX,UAAU,EAAE,CAAC;aACb;SACD;QACD,KAAK,EAAE,IAAA,0BAAiB,EAAC,CAAC,MAAM,EAAE,EAAE;YACnC,MAAM,IAAI,iBAAU,CACnB,QAAQ,MAAM,iBAAiB,EAC/B,sBAAe,CAAC,uBAAuB,CACvC,CAAC;QACH,CAAC,CAAC;QACF,uBAAuB,EAAE,MAAA,OAAO,CAAC,uBAAuB,mCAAI,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC;QACvE,iBAAiB;QACjB,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;YACtB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC9B,YAAY,CAAC,GAAG,CACf,MAAM,EACN,IAAI,cAAO,CACV,MAAM,EACN,aAAoB,EACpB,eAAsB,CACtB,CACD,CAAC;aACF;YACD,OAAO,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;QAClC,CAAC;QACD,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,GAAG,CAAC,EAAE,EAAE;;YAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,CAAC,aAAa,CAAC,CAAC;YAClD,OAAO,CACN,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,MAAK,KAAK;gBACxB,CAAC,CAAC,CAAA,MAAA,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,0CAAE,UAAU,CAAC,IAAI,CAAC,CAAA;gBACtC,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAC/C,CAAC;QACH,CAAC;QACD,uBAAuB,EAAE,CAAC,MAAM,EAAE,EAAE;YACnC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACvC,CAAC;QACD,gBAAgB,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC7C,CAAC;QACD,gBAAgB,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE;YACpD,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;KACD,CAAC;IACF,OAAO,GAAG,CAAC;AACZ,CAAC;AAhFD,8CAgFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zwave-js/host",
-  "version": "9.3.0",
+  "version": "9.3.1-0-pr-4661-5ac6caf",
   "description": "zwave-js: Host abstractions",
   "publishConfig": {
     "access": "public"
@@ -48,13 +48,15 @@
     "watch": "yarn run build --watch --pretty"
   },
   "dependencies": {
-    "@zwave-js/core": "9.3.0",
-    "@zwave-js/shared": "9.3.0"
+    "@zwave-js/core": "9.3.1-0-pr-4661-5ac6caf",
+    "@zwave-js/shared": "9.3.1-0-pr-4661-5ac6caf",
+    "alcalzone-shared": "^4.0.1"
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",
     "@types/node": "^14.18.16",
     "jest-extended": "^2.0.0",
     "typescript": "4.6.4"
-  }
+  },
+  "stableVersion": "9.3.0"
 }