@zwave-js/host 9.3.0

package/build/FileSystem.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+/** Defines which methods must be supported by a replacement filesystem */
+export interface FileSystem {
+    ensureDir(path: string): Promise<void>;
+    writeFile(file: string, data: string | Buffer, options?: {
+        encoding: string;
+    } | string): Promise<void>;
+    readFile(file: string, encoding: string): Promise<string>;
+    pathExists(path: string): Promise<boolean>;
+}
+//# sourceMappingURL=FileSystem.d.ts.map

package/build/FileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../src/FileSystem.ts"],"names":[],"mappings":";AAAA,0EAA0E;AAC1E,MAAM,WAAW,UAAU;IAC1B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,SAAS,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EACL;QACA,QAAQ,EAAE,MAAM,CAAC;KAChB,GACD,MAAM,GACP,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3C"}

package/build/FileSystem.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FileSystem.js.map

package/build/FileSystem.js.map

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

package/build/ZWaveEndpointBase.d.ts

@@ -0,0 +1,10 @@
+import type { CommandClasses } from "@zwave-js/core";
+export interface ZWaveEndpointBase {
+    readonly nodeId: number;
+    readonly index: number;
+    getCCVersion(cc: CommandClasses): number;
+    supportsCC(cc: CommandClasses): boolean;
+    controlsCC(cc: CommandClasses): boolean;
+    isCCSecure(cc: CommandClasses): boolean;
+}
+//# sourceMappingURL=ZWaveEndpointBase.d.ts.map

package/build/ZWaveEndpointBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZWaveEndpointBase.d.ts","sourceRoot":"","sources":["../src/ZWaveEndpointBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,WAAW,iBAAiB;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,CAAC;IACzC,UAAU,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC;IACxC,UAAU,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC;IACxC,UAAU,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC;CACxC"}

package/build/ZWaveEndpointBase.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ZWaveEndpointBase.js.map

package/build/ZWaveEndpointBase.js.map

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

package/build/ZWaveHost.d.ts

@@ -0,0 +1,54 @@
+import type { ConfigManager } from "@zwave-js/config";
+import type { CommandClasses, ControllerLogger, SecurityManager, SecurityManager2, ValueDB } from "@zwave-js/core";
+import type { ReadonlyThrowingMap } from "@zwave-js/shared";
+import type { ZWaveNodeBase } from "./ZWaveNodeBase";
+export interface ZWaveHostOptions {
+    /**
+     * Some Command Classes support reporting that a value is unknown.
+     * When this flag is `false`, unknown values are exposed as `undefined`.
+     * When it is `true`, unknown values are exposed as the literal string "unknown" (even if the value is normally numeric).
+     * Default: `false`
+     */
+    preserveUnknownValues?: boolean;
+    attempts: {
+        /** How often the driver should try communication with the controller before giving up */
+        controller: number;
+        /** How often the driver should try sending SendData commands before giving up */
+        sendData: number;
+        /**
+         * How many attempts should be made for each node interview before giving up
+         */
+        nodeInterview: number;
+    };
+}
+/** Host application abstractions to be used in Serial API and CC implemenations */
+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;
+    /**
+     * 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;
+    /**
+     * Returns the next callback ID. Callback IDs are used to correllate requests
+     * to the controller/nodes with its response
+     */
+    getNextCallbackId(): number;
+    /** Returns the value DB which belongs to the node with the given ID */
+    getValueDB(nodeId: number): ValueDB;
+}
+//# sourceMappingURL=ZWaveHost.d.ts.map

package/build/ZWaveHost.d.ts.map

@@ -0,0 +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"}

package/build/ZWaveHost.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ZWaveHost.js.map

package/build/ZWaveHost.js.map

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

package/build/ZWaveNodeBase.d.ts

@@ -0,0 +1,16 @@
+import type { DeviceConfig } from "@zwave-js/config";
+import type { FLiRS, InterviewStage, Maybe, NodeStatus, SecurityClassOwner } from "@zwave-js/core";
+import type { ZWaveEndpointBase } from "./ZWaveEndpointBase";
+export interface ZWaveNodeBase extends ZWaveEndpointBase, SecurityClassOwner {
+    readonly id: number;
+    isListening: boolean | undefined;
+    isFrequentListening: FLiRS | undefined;
+    readonly canSleep: boolean | undefined;
+    readonly status: NodeStatus;
+    interviewStage: InterviewStage;
+    deviceConfig?: DeviceConfig;
+    getEndpoint(index: 0): ZWaveEndpointBase;
+    getEndpoint(index: number): ZWaveEndpointBase | undefined;
+    readonly isSecure: Maybe<boolean>;
+}
+//# sourceMappingURL=ZWaveNodeBase.d.ts.map

package/build/ZWaveNodeBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZWaveNodeBase.d.ts","sourceRoot":"","sources":["../src/ZWaveNodeBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,KAAK,EACL,UAAU,EACV,kBAAkB,EAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,WAAW,aAAc,SAAQ,iBAAiB,EAAE,kBAAkB;IAC3E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,mBAAmB,EAAE,KAAK,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,cAAc,EAAE,cAAc,CAAC;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,iBAAiB,CAAC;IACzC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAClC"}

package/build/ZWaveNodeBase.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ZWaveNodeBase.js.map

package/build/ZWaveNodeBase.js.map

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

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./FileSystem";
+export * from "./ZWaveEndpointBase";
+export * from "./ZWaveHost";
+export * from "./ZWaveNodeBase";
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +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"}

package/build/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FileSystem"), exports);
+__exportStar(require("./ZWaveEndpointBase"), exports);
+__exportStar(require("./ZWaveHost"), exports);
+__exportStar(require("./ZWaveNodeBase"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.js.map

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

package/build/index_safe.d.ts

@@ -0,0 +1,5 @@
+export * from "./FileSystem";
+export * from "./ZWaveEndpointBase";
+export * from "./ZWaveHost";
+export * from "./ZWaveNodeBase";
+//# sourceMappingURL=index_safe.d.ts.map

package/build/index_safe.d.ts.map

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

package/build/index_safe.js

@@ -0,0 +1,22 @@
+"use strict";
+/* @noExternalImports */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FileSystem"), exports);
+__exportStar(require("./ZWaveEndpointBase"), exports);
+__exportStar(require("./ZWaveHost"), exports);
+__exportStar(require("./ZWaveNodeBase"), exports);
+//# sourceMappingURL=index_safe.js.map

package/build/index_safe.js.map

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

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@zwave-js/host",
+  "version": "9.3.0",
+  "description": "zwave-js: Host abstractions",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "main": "build/index.js",
+  "exports": {
+    ".": "./build/index.js",
+    "./package.json": "./package.json",
+    "./safe": "./build/index_safe.js"
+  },
+  "types": "build/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "safe": [
+        "build/index_safe.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "build/**/*.{js,d.ts,map}"
+  ],
+  "author": {
+    "name": "AlCalzone",
+    "email": "d.griesel@gmx.net"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/AlCalzone/node-zwave-js#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlCalzone/node-zwave-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AlCalzone/node-zwave-js/issues"
+  },
+  "funding": {
+    "url": "https://github.com/sponsors/AlCalzone/"
+  },
+  "engines": {
+    "node": ">=12.22.2 <13 || >=14.13.0 <15 || >= 16 <16.9.0 || >16.9.0"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json --verbose",
+    "clean": "yarn run build --clean",
+    "watch": "yarn run build --watch --pretty"
+  },
+  "dependencies": {
+    "@zwave-js/core": "9.3.0",
+    "@zwave-js/shared": "9.3.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@types/node": "^14.18.16",
+    "jest-extended": "^2.0.0",
+    "typescript": "4.6.4"
+  }
+}