hap-nodejs 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/lib/util/promise-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-utils.js","sourceRoot":"","sources":["../../../src/lib/util/promise-utils.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,SAAgB,cAAc,CAAC,OAAe;IAC5C,OAAO,IAAI,OAAO,CAAO,UAAA,OAAO;QAC9B,UAAU,CAAC,cAAM,OAAA,OAAO,EAAE,EAAT,CAAS,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,wCAIC;AAUD,wDAAwD;AACxD,SAAgB,cAAc,CAAuD,OAAe,EAAE,KAAY,EAAE,OAAc;IAAd,wBAAA,EAAA,cAAc;IAChI,OAAO,IAAI,OAAO,CAAW,UAAC,OAAO,EAAE,MAAM;QAC3C,wCAAwC;QACxC,IAAI,SAAyB,CAAC;QAE9B,8DAA8D;QAC9D,IAAM,eAAe,GAAG;YAAC,cAAY;iBAAZ,UAAY,EAAZ,qBAAY,EAAZ,IAAY;gBAAZ,yBAAY;;YACnC,YAAY,CAAC,SAAS,CAAC,CAAC;YAExB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC1E,CAAC,CAAC;QAEF,SAAS,GAAG,UAAU,CAAC;YACrB,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;YAC/C,MAAM,CAAC,IAAI,KAAK,CAAC,+BAAwB,KAAK,gBAAa,CAAC,CAAC,CAAC;QAChE,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAnBD,wCAmBC"}

package/dist/lib/util/request-util.d.ts

@@ -9,12 +9,28 @@ import { CharacteristicProps, Formats } from "../Characteristic";
  * @param value - The value which should be formatted
  * @param props - The characteristic properties used to format the value.
  * @private
+ * @group Utils
  */
 export declare function formatOutgoingCharacteristicValue(value: Nullable<CharacteristicValue>, props: CharacteristicProps): Nullable<CharacteristicValue>;
 export declare function formatOutgoingCharacteristicValue(value: CharacteristicValue, props: CharacteristicProps): CharacteristicValue;
+/**
+ * @group Utils
+ */
 export declare function isNumericFormat(format: Formats | string): boolean;
+/**
+ * @group Utils
+ */
 export declare function isUnsignedNumericFormat(format: Formats | string): boolean;
+/**
+ * @group Utils
+ */
 export declare function isIntegerNumericFormat(format: Formats | string): boolean;
+/**
+ * @group Utils
+ */
 export declare function numericLowerBound(format: Formats | string): number;
+/**
+ * @group Utils
+ */
 export declare function numericUpperBound(format: Formats | string): number;
 //# sourceMappingURL=request-util.d.ts.map

package/dist/lib/util/request-util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-util.d.ts","sourceRoot":"","sources":["../../../src/lib/util/request-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjE;;;;;;;;;GASG;AACH,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,mBAAmB,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AACnJ,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,mBAAmB,GAAG,mBAAmB,CAAA;AAkB9H,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAYjE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAUzE;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAWxE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAclE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAiBlE"}
+{"version":3,"file":"request-util.d.ts","sourceRoot":"","sources":["../../../src/lib/util/request-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,mBAAmB,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AACnJ,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,mBAAmB,GAAG,mBAAmB,CAAA;AAkB9H;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAYjE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAUzE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAWxE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAclE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAkBlE"}

package/dist/lib/util/request-util.js

@@ -17,74 +17,90 @@ function formatOutgoingCharacteristicValue(value, props) {
     return value;
 }
 exports.formatOutgoingCharacteristicValue = formatOutgoingCharacteristicValue;
+/**
+ * @group Utils
+ */
 function isNumericFormat(format) {
     switch (format) {
-        case "int" /* INT */:
-        case "float" /* FLOAT */:
-        case "uint8" /* UINT8 */:
-        case "uint16" /* UINT16 */:
-        case "uint32" /* UINT32 */:
-        case "uint64" /* UINT64 */:
+        case "int" /* Formats.INT */:
+        case "float" /* Formats.FLOAT */:
+        case "uint8" /* Formats.UINT8 */:
+        case "uint16" /* Formats.UINT16 */:
+        case "uint32" /* Formats.UINT32 */:
+        case "uint64" /* Formats.UINT64 */:
             return true;
         default:
             return false;
     }
 }
 exports.isNumericFormat = isNumericFormat;
+/**
+ * @group Utils
+ */
 function isUnsignedNumericFormat(format) {
     switch (format) {
-        case "uint8" /* UINT8 */:
-        case "uint16" /* UINT16 */:
-        case "uint32" /* UINT32 */:
-        case "uint64" /* UINT64 */:
+        case "uint8" /* Formats.UINT8 */:
+        case "uint16" /* Formats.UINT16 */:
+        case "uint32" /* Formats.UINT32 */:
+        case "uint64" /* Formats.UINT64 */:
             return true;
         default:
             return false;
     }
 }
 exports.isUnsignedNumericFormat = isUnsignedNumericFormat;
+/**
+ * @group Utils
+ */
 function isIntegerNumericFormat(format) {
     switch (format) {
-        case "int" /* INT */:
-        case "uint8" /* UINT8 */:
-        case "uint16" /* UINT16 */:
-        case "uint32" /* UINT32 */:
-        case "uint64" /* UINT64 */:
+        case "int" /* Formats.INT */:
+        case "uint8" /* Formats.UINT8 */:
+        case "uint16" /* Formats.UINT16 */:
+        case "uint32" /* Formats.UINT32 */:
+        case "uint64" /* Formats.UINT64 */:
             return true;
         default:
             return false;
     }
 }
 exports.isIntegerNumericFormat = isIntegerNumericFormat;
+/**
+ * @group Utils
+ */
 function numericLowerBound(format) {
     switch (format) {
-        case "int" /* INT */:
+        case "int" /* Formats.INT */:
             return -2147483648;
-        case "float" /* FLOAT */:
+        case "float" /* Formats.FLOAT */:
             return -Number.MAX_VALUE;
-        case "uint8" /* UINT8 */:
-        case "uint16" /* UINT16 */:
-        case "uint32" /* UINT32 */:
-        case "uint64" /* UINT64 */:
+        case "uint8" /* Formats.UINT8 */:
+        case "uint16" /* Formats.UINT16 */:
+        case "uint32" /* Formats.UINT32 */:
+        case "uint64" /* Formats.UINT64 */:
             return 0;
         default:
             throw new Error("Unable to determine numeric lower bound for " + format);
     }
 }
 exports.numericLowerBound = numericLowerBound;
+/**
+ * @group Utils
+ */
 function numericUpperBound(format) {
     switch (format) {
-        case "int" /* INT */:
+        case "int" /* Formats.INT */:
             return 2147483647;
-        case "float" /* FLOAT */:
+        case "float" /* Formats.FLOAT */:
             return Number.MAX_VALUE;
-        case "uint8" /* UINT8 */:
+        case "uint8" /* Formats.UINT8 */:
             return 255;
-        case "uint16" /* UINT16 */:
+        case "uint16" /* Formats.UINT16 */:
             return 65535;
-        case "uint32" /* UINT32 */:
+        case "uint32" /* Formats.UINT32 */:
             return 4294967295;
-        case "uint64" /* UINT64 */:
+        case "uint64" /* Formats.UINT64 */:
+            // eslint-disable-next-line @typescript-eslint/no-loss-of-precision
             return 18446744073709551615; // don't get fooled, javascript uses 18446744073709552000 here
         default:
             throw new Error("Unable to determine numeric lower bound for " + format);

package/dist/lib/util/request-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-util.js","sourceRoot":"","sources":["../../../src/lib/util/request-util.ts"],"names":[],"mappings":";;;AAeA,SAAgB,iCAAiC,CAAC,KAAoC,EAAE,KAA0B;;IAChH,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC9B,OAAO,KAAK,CAAA,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAAC;KACpB;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE;YACxC,OAAO,KAAK,CAAC;SACd;QAED,IAAM,IAAI,GAAG,MAAA,KAAK,CAAC,QAAQ,mCAAI,CAAC,CAAC;QACjC,IAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;QAElC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;KAC9F;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAfD,8EAeC;AAED,SAAgB,eAAe,CAAC,MAAwB;IACtD,QAAQ,MAAM,EAAE;QACd,qBAAiB;QACjB,yBAAmB;QACnB,yBAAmB;QACnB,2BAAoB;QACpB,2BAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KAChB;AACH,CAAC;AAZD,0CAYC;AAED,SAAgB,uBAAuB,CAAC,MAAwB;IAC9D,QAAQ,MAAM,EAAE;QACd,yBAAmB;QACnB,2BAAoB;QACpB,2BAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KAChB;AACH,CAAC;AAVD,0DAUC;AAED,SAAgB,sBAAsB,CAAC,MAAwB;IAC7D,QAAQ,MAAM,EAAE;QACd,qBAAiB;QACjB,yBAAmB;QACnB,2BAAoB;QACpB,2BAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KAChB;AACH,CAAC;AAXD,wDAWC;AAED,SAAgB,iBAAiB,CAAC,MAAwB;IACxD,QAAQ,MAAM,EAAE;QACd;YACE,OAAO,CAAC,UAAU,CAAC;QACrB;YACE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QAC3B,yBAAmB;QACnB,2BAAoB;QACpB,2BAAoB;QACpB;YACE,OAAO,CAAC,CAAC;QACX;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,MAAM,CAAC,CAAC;KAC5E;AACH,CAAC;AAdD,8CAcC;AAED,SAAgB,iBAAiB,CAAC,MAAwB;IACxD,QAAQ,MAAM,EAAE;QACd;YACE,OAAO,UAAU,CAAC;QACpB;YACE,OAAO,MAAM,CAAC,SAAS,CAAC;QAC1B;YACE,OAAO,GAAG,CAAC;QACb;YACE,OAAO,KAAK,CAAC;QACf;YACE,OAAO,UAAU,CAAC;QACpB;YACE,OAAO,oBAAoB,CAAC,CAAC,8DAA8D;QAC7F;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,MAAM,CAAC,CAAC;KAC5E;AACH,CAAC;AAjBD,8CAiBC"}
+{"version":3,"file":"request-util.js","sourceRoot":"","sources":["../../../src/lib/util/request-util.ts"],"names":[],"mappings":";;;AAgBA,SAAgB,iCAAiC,CAAC,KAAoC,EAAE,KAA0B;;IAChH,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC9B,OAAO,KAAK,CAAA,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAAC;KACpB;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE;YACxC,OAAO,KAAK,CAAC;SACd;QAED,IAAM,IAAI,GAAG,MAAA,KAAK,CAAC,QAAQ,mCAAI,CAAC,CAAC;QACjC,IAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;QAElC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;KAC9F;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAfD,8EAeC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,MAAwB;IACtD,QAAQ,MAAM,EAAE;QAChB,6BAAiB;QACjB,iCAAmB;QACnB,iCAAmB;QACnB,mCAAoB;QACpB,mCAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAZD,0CAYC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CAAC,MAAwB;IAC9D,QAAQ,MAAM,EAAE;QAChB,iCAAmB;QACnB,mCAAoB;QACpB,mCAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAVD,0DAUC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IAC7D,QAAQ,MAAM,EAAE;QAChB,6BAAiB;QACjB,iCAAmB;QACnB,mCAAoB;QACpB,mCAAoB;QACpB;YACE,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAXD,wDAWC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,MAAwB;IACxD,QAAQ,MAAM,EAAE;QAChB;YACE,OAAO,CAAC,UAAU,CAAC;QACrB;YACE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QAC3B,iCAAmB;QACnB,mCAAoB;QACpB,mCAAoB;QACpB;YACE,OAAO,CAAC,CAAC;QACX;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,MAAM,CAAC,CAAC;KAC1E;AACH,CAAC;AAdD,8CAcC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,MAAwB;IACxD,QAAQ,MAAM,EAAE;QAChB;YACE,OAAO,UAAU,CAAC;QACpB;YACE,OAAO,MAAM,CAAC,SAAS,CAAC;QAC1B;YACE,OAAO,GAAG,CAAC;QACb;YACE,OAAO,KAAK,CAAC;QACf;YACE,OAAO,UAAU,CAAC;QACpB;YACE,mEAAmE;YACnE,OAAO,oBAAoB,CAAC,CAAC,8DAA8D;QAC7F;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,MAAM,CAAC,CAAC;KAC1E;AACH,CAAC;AAlBD,8CAkBC"}

package/dist/lib/util/time.d.ts

@@ -1,4 +1,10 @@
 /// <reference types="node" />
-export declare function epochMillisFromMillisSince2001_01_01Buffer(millis: Buffer): number;
+/**
+ * @group Utils
+ */
 export declare function epochMillisFromMillisSince2001_01_01(millis: number): number;
+/**
+ * @group Utils
+ */
+export declare function epochMillisFromMillisSince2001_01_01Buffer(millis: Buffer): number;
 //# sourceMappingURL=time.d.ts.map

package/dist/lib/util/time.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../../src/lib/util/time.ts"],"names":[],"mappings":";AAKA,wBAAgB,0CAA0C,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIjF;AAED,wBAAgB,oCAAoC,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE3E"}
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../../src/lib/util/time.ts"],"names":[],"mappings":";AAKA;;GAEG;AACH,wBAAgB,oCAAoC,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE3E;AAED;;GAEG;AACH,wBAAgB,0CAA0C,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIjF"}

package/dist/lib/util/time.js

@@ -1,18 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.epochMillisFromMillisSince2001_01_01 = exports.epochMillisFromMillisSince2001_01_01Buffer = void 0;
+exports.epochMillisFromMillisSince2001_01_01Buffer = exports.epochMillisFromMillisSince2001_01_01 = void 0;
 var tslib_1 = require("tslib");
 var assert_1 = tslib_1.__importDefault(require("assert"));
 var tlv_1 = require("./tlv");
 var EPOCH_MILLIS_2001_01_01 = Date.UTC(2001, 0, 1, 0, 0, 0, 0);
-function epochMillisFromMillisSince2001_01_01Buffer(millis) {
-    assert_1.default(millis.length === 8, "can only parse 64 bit buffers!");
-    var millisSince2001 = tlv_1.readUInt64BE(millis);
-    return epochMillisFromMillisSince2001_01_01(millisSince2001);
-}
-exports.epochMillisFromMillisSince2001_01_01Buffer = epochMillisFromMillisSince2001_01_01Buffer;
+/**
+ * @group Utils
+ */
 function epochMillisFromMillisSince2001_01_01(millis) {
     return EPOCH_MILLIS_2001_01_01 + millis;
 }
 exports.epochMillisFromMillisSince2001_01_01 = epochMillisFromMillisSince2001_01_01;
+/**
+ * @group Utils
+ */
+function epochMillisFromMillisSince2001_01_01Buffer(millis) {
+    (0, assert_1.default)(millis.length === 8, "can only parse 64 bit buffers!");
+    var millisSince2001 = (0, tlv_1.readUInt64LE)(millis);
+    return epochMillisFromMillisSince2001_01_01(millisSince2001);
+}
+exports.epochMillisFromMillisSince2001_01_01Buffer = epochMillisFromMillisSince2001_01_01Buffer;
 //# sourceMappingURL=time.js.map

package/dist/lib/util/time.js.map

@@ -1 +1 @@
-{"version":3,"file":"time.js","sourceRoot":"","sources":["../../../src/lib/util/time.ts"],"names":[],"mappings":";;;;AAAA,0DAA4B;AAC5B,6BAAqC;AAErC,IAAM,uBAAuB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEjE,SAAgB,0CAA0C,CAAC,MAAc;IACvE,gBAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,gCAAgC,CAAC,CAAC;IAC9D,IAAM,eAAe,GAAG,kBAAY,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,oCAAoC,CAAC,eAAe,CAAC,CAAC;AAC/D,CAAC;AAJD,gGAIC;AAED,SAAgB,oCAAoC,CAAC,MAAc;IACjE,OAAO,uBAAuB,GAAG,MAAM,CAAC;AAC1C,CAAC;AAFD,oFAEC"}
+{"version":3,"file":"time.js","sourceRoot":"","sources":["../../../src/lib/util/time.ts"],"names":[],"mappings":";;;;AAAA,0DAA4B;AAC5B,6BAAqC;AAErC,IAAM,uBAAuB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEjE;;GAEG;AACH,SAAgB,oCAAoC,CAAC,MAAc;IACjE,OAAO,uBAAuB,GAAG,MAAM,CAAC;AAC1C,CAAC;AAFD,oFAEC;AAED;;GAEG;AACH,SAAgB,0CAA0C,CAAC,MAAc;IACvE,IAAA,gBAAM,EAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,gCAAgC,CAAC,CAAC;IAC9D,IAAM,eAAe,GAAG,IAAA,kBAAY,EAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,oCAAoC,CAAC,eAAe,CAAC,CAAC;AAC/D,CAAC;AAJD,gGAIC"}

package/dist/lib/util/tlv.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="node" />
-export declare type TLVEncodable = Buffer | number | string;
+/**
+ * @group TLV8
+ */
+export type TLVEncodable = Buffer | number | string;
+/**
+ * @group TLV8
+ */
 export declare function encode(type: number, data: TLVEncodable | TLVEncodable[], ...args: any[]): Buffer;
 /**
  * This method is the legacy way of decoding tlv data.
@@ -7,22 +13,106 @@ export declare function encode(type: number, data: TLVEncodable | TLVEncodable[]
  * Should the decoder encounter multiple instances of the same id, it will just concatenate the buffer data.
  *
  * @param buffer - TLV8 data
+ *
+ * Note: Please use {@link decodeWithLists} which properly decodes list elements.
+ *
+ * @group TLV8
  */
 export declare function decode(buffer: Buffer): Record<number, Buffer>;
+/**
+ * Decode a buffer coding TLV8 encoded entries.
+ *
+ * This method decodes multiple entries split by a TLV delimiter properly into Buffer arrays.
+ * It properly reassembles tlv entries if they were split across multiple entries due to exceeding the max tlv entry size of 255 bytes.
+ * @param buffer - The Buffer containing TLV8 encoded data.
+ *
+ * @group TLV8
+ */
 export declare function decodeWithLists(buffer: Buffer): Record<number, Buffer | Buffer[]>;
+/**
+ * This method can be used to parse a TLV8 encoded list that was concatenated.
+ *
+ * If you are thinking about using this method, try to refactor the code to use {@link decodeWithLists} instead of {@link decode}.
+ * The single reason of this method's existence are the shortcomings {@link decode}, as it concatenates multiple tlv8 list entries
+ * into a single Buffer.
+ * This method can be used to undo that, by specifying the concatenated buffer and the tlv id of the element that should
+ * mark the beginning of a new tlv8 list entry.
+ *
+ * @param data - The concatenated tlv8 list entries (probably output of {@link decode}).
+ * @param entryStartId - The tlv id that marks the beginning of a new tlv8 entry.
+ *
+ * @group TLV8
+ */
 export declare function decodeList(data: Buffer, entryStartId: number): Record<number, Buffer>[];
+/**
+ * @deprecated This implementation is considered broken. Don't use it.
+ *
+ * @group TLV8
+ */
 export declare function writeUInt64(value: number): Buffer;
 /**
- * @param buffer
- * @deprecated This is pretty much broken
+ * @deprecated This implementation is considered broken. Don't use it.
+ *
+ * @group TLV8
  */
 export declare function readUInt64(buffer: Buffer): number;
+/**
+ * @group TLV8
+ */
+export declare function readUInt64LE(buffer: Buffer, offset?: number): number;
+/**
+ * @deprecated The method was named wrongfully and actually reads an UInt64 in **little endian** format.
+ * @group TLV8
+ */
 export declare function readUInt64BE(buffer: Buffer, offset?: number): number;
+/**
+ * `writeUint32LE`
+ * @group TLV8
+ */
 export declare function writeUInt32(value: number): Buffer;
+/**
+ * `readUInt32LE`
+ * @group TLV8
+ */
 export declare function readUInt32(buffer: Buffer): number;
+/**
+ * @group TLV8
+ */
 export declare function writeFloat32LE(value: number): Buffer;
+/**
+ * `writeUInt16LE`
+ * @group TLV8
+ */
 export declare function writeUInt16(value: number): Buffer;
+/**
+ * `readUInt16LE`
+ * @group TLV8
+ */
 export declare function readUInt16(buffer: Buffer): number;
-export declare function readVariableUIntLE(buffer: Buffer, offset?: number): number;
-export declare function writeVariableUIntLE(number: number, offset?: number): Buffer;
+/**
+ * Reads variable size unsigned integer {@link writeVariableUIntLE}.
+ * @param buffer - The buffer to read from. It must have exactly the size of the given integer.
+ * @group TLV8
+ */
+export declare function readVariableUIntLE(buffer: Buffer): number;
+/**
+ * @deprecated Can't define an offset. The original implementation messed up here!
+ * @group TLV8
+ */
+export declare function readVariableUIntLE(buffer: Buffer, offset: number): number;
+/**
+ * Writes variable size unsigned integer.
+ * Either:
+ * - `UInt8`
+ * - `UInt16LE`
+ * - `UInt32LE`
+ * @param number
+ * @group TLV8
+ */
+export declare function writeVariableUIntLE(number: number): Buffer;
+/**
+ * @deprecated Can't define an offset. The original implementation messed up here!
+ * @group TLV8
+ */
+export declare function writeVariableUIntLE(number: number, offset: number): Buffer;
 //# sourceMappingURL=tlv.d.ts.map

package/dist/lib/util/tlv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tlv.d.ts","sourceRoot":"","sources":["../../../src/lib/util/tlv.ts"],"names":[],"mappings":";AASA,oBAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpD,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAkDhG;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAyB7D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAqDjF;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,4BAsC5D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,UAWxC;AAGD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,UAGxC;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,UAG9D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,UAMxC;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,UAExC;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,UAI3C;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,UAMxC;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,UAExC;AACD,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,CAarE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,CAoBtE"}
+{"version":3,"file":"tlv.d.ts","sourceRoot":"","sources":["../../../src/lib/util/tlv.ts"],"names":[],"mappings":";AAUA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpD;;GAEG;AAEH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAsDhG;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA0B7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAsDjF;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAwCvF;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAWjD;AAGD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGjD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,CAI/D;AAGD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,CAE/D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIpD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEjD;AAGD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;AAC3D;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;AAkB3E;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAK,MAAM,CAAC;AAC9D;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC"}

package/dist/lib/util/tlv.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeVariableUIntLE = exports.readVariableUIntLE = exports.readUInt16 = exports.writeUInt16 = exports.writeFloat32LE = exports.readUInt32 = exports.writeUInt32 = exports.readUInt64BE = exports.readUInt64 = exports.writeUInt64 = exports.decodeList = exports.decodeWithLists = exports.decode = exports.encode = void 0;
+exports.writeVariableUIntLE = exports.readVariableUIntLE = exports.readUInt16 = exports.writeUInt16 = exports.writeFloat32LE = exports.readUInt32 = exports.writeUInt32 = exports.readUInt64BE = exports.readUInt64LE = exports.readUInt64 = exports.writeUInt64 = exports.decodeList = exports.decodeWithLists = exports.decode = exports.encode = void 0;
 var tslib_1 = require("tslib");
 var assert_1 = tslib_1.__importDefault(require("assert"));
 var hapCrypto = tslib_1.__importStar(require("../util/hapCrypto"));
@@ -9,6 +9,10 @@ var hapCrypto = tslib_1.__importStar(require("../util/hapCrypto"));
  * https://en.wikipedia.org/wiki/Type-length-value
  */
 var EMPTY_TLV_TYPE = 0x00; // and empty tlv with id 0 is usually used as delimiter for tlv lists
+/**
+ * @group TLV8
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function encode(type, data) {
     var e_1, _a;
     var args = [];
@@ -17,10 +21,10 @@ function encode(type, data) {
     }
     var encodedTLVBuffers = [];
     // coerce data to Buffer if needed
-    if (typeof data === 'number') {
+    if (typeof data === "number") {
         data = Buffer.from([data]);
     }
-    else if (typeof data === 'string') {
+    else if (typeof data === "string") {
         data = Buffer.from(data);
     }
     if (Array.isArray(data)) {
@@ -31,9 +35,7 @@ function encode(type, data) {
                 if (!first) {
                     encodedTLVBuffers.push(Buffer.from([EMPTY_TLV_TYPE, 0])); // push delimiter
                 }
-                else {
-                    first = false;
-                }
+                first = false;
                 encodedTLVBuffers.push(encode(type, entry));
             }
         }
@@ -44,6 +46,9 @@ function encode(type, data) {
             }
             finally { if (e_1) throw e_1.error; }
         }
+        if (first) { // we have a zero length array!
+            encodedTLVBuffers.push(Buffer.from([type, 0]));
+        }
     }
     else if (data.length <= 255) {
         encodedTLVBuffers.push(Buffer.concat([Buffer.from([type, data.length]), data]));
@@ -67,7 +72,7 @@ function encode(type, data) {
     if (args.length >= 2) {
         // chop off the first two arguments which we already processed, and process the rest recursively
         var _b = tslib_1.__read(args), nextType = _b[0], nextData = _b[1], nextArgs = _b.slice(2);
-        var remainingTLVBuffer = encode.apply(void 0, tslib_1.__spreadArray([nextType, nextData], tslib_1.__read(nextArgs)));
+        var remainingTLVBuffer = encode.apply(void 0, tslib_1.__spreadArray([nextType, nextData], tslib_1.__read(nextArgs), false));
         // append the remaining encoded arguments directly to the buffer
         encodedTLVBuffers.push(remainingTLVBuffer);
     }
@@ -80,8 +85,13 @@ exports.encode = encode;
  * Should the decoder encounter multiple instances of the same id, it will just concatenate the buffer data.
  *
  * @param buffer - TLV8 data
+ *
+ * Note: Please use {@link decodeWithLists} which properly decodes list elements.
+ *
+ * @group TLV8
  */
 function decode(buffer) {
+    (0, assert_1.default)(buffer instanceof Buffer, "Illegal argument. tlv.decode() expects Buffer type!");
     var objects = {};
     var leftLength = buffer.length;
     var currentIndex = 0;
@@ -103,6 +113,15 @@ function decode(buffer) {
     return objects;
 }
 exports.decode = decode;
+/**
+ * Decode a buffer coding TLV8 encoded entries.
+ *
+ * This method decodes multiple entries split by a TLV delimiter properly into Buffer arrays.
+ * It properly reassembles tlv entries if they were split across multiple entries due to exceeding the max tlv entry size of 255 bytes.
+ * @param buffer - The Buffer containing TLV8 encoded data.
+ *
+ * @group TLV8
+ */
 function decodeWithLists(buffer) {
     var result = {};
     var leftBytes = buffer.length;
@@ -142,7 +161,7 @@ function decodeWithLists(buffer) {
                 }
             }
             else {
-                throw new Error("Found duplicated tlv entry with type " + type + " and length " + length + " (lastItemWasDelimiter: " + lastItemWasDelimiter + ", lastType: " + lastType + ", lastLength: " + lastLength + ")");
+                throw new Error("Found duplicated tlv entry with type ".concat(type, " and length ").concat(length, "         (lastItemWasDelimiter: ").concat(lastItemWasDelimiter, ", lastType: ").concat(lastType, ", lastLength: ").concat(lastLength, ")"));
             }
         }
         else {
@@ -155,6 +174,20 @@ function decodeWithLists(buffer) {
     return result;
 }
 exports.decodeWithLists = decodeWithLists;
+/**
+ * This method can be used to parse a TLV8 encoded list that was concatenated.
+ *
+ * If you are thinking about using this method, try to refactor the code to use {@link decodeWithLists} instead of {@link decode}.
+ * The single reason of this method's existence are the shortcomings {@link decode}, as it concatenates multiple tlv8 list entries
+ * into a single Buffer.
+ * This method can be used to undo that, by specifying the concatenated buffer and the tlv id of the element that should
+ * mark the beginning of a new tlv8 list entry.
+ *
+ * @param data - The concatenated tlv8 list entries (probably output of {@link decode}).
+ * @param entryStartId - The tlv id that marks the beginning of a new tlv8 entry.
+ *
+ * @group TLV8
+ */
 function decodeList(data, entryStartId) {
     var objectsList = [];
     var leftLength = data.length;
@@ -170,10 +203,11 @@ function decodeList(data, entryStartId) {
             }
             objects = {};
         }
-        if (objects === undefined)
+        if (objects === undefined) {
             throw new Error("Error parsing tlv list: Encountered uninitialized storage object");
-        if (objects[type]) { // append to buffer if we have an already data for this type
-            objects[type] = Buffer.concat([value, objects[type]]);
+        }
+        if (objects[type]) { // append to buffer if we have already data for this type
+            objects[type] = Buffer.concat([objects[type], value]);
         }
         else {
             objects[type] = value;
@@ -181,11 +215,17 @@ function decodeList(data, entryStartId) {
         currentIndex += 2 + length;
         leftLength -= 2 + length;
     }
-    if (objects !== undefined)
-        objectsList.push(objects); // push last entry
+    if (objects !== undefined) {
+        objectsList.push(objects);
+    } // push last entry
     return objectsList;
 }
 exports.decodeList = decodeList;
+/**
+ * @deprecated This implementation is considered broken. Don't use it.
+ *
+ * @group TLV8
+ */
 function writeUInt64(value) {
     var float64 = new Float64Array(1);
     float64[0] = value;
@@ -199,48 +239,83 @@ function writeUInt64(value) {
 exports.writeUInt64 = writeUInt64;
 // noinspection JSUnusedGlobalSymbols
 /**
- * @param buffer
- * @deprecated This is pretty much broken
+ * @deprecated This implementation is considered broken. Don't use it.
+ *
+ * @group TLV8
  */
 function readUInt64(buffer) {
     var float64 = new Float64Array(buffer);
     return float64[0];
 }
 exports.readUInt64 = readUInt64;
-function readUInt64BE(buffer, offset) {
+/**
+ * @group TLV8
+ */
+function readUInt64LE(buffer, offset) {
     if (offset === void 0) { offset = 0; }
     var low = buffer.readUInt32LE(offset);
+    // javascript doesn't allow to shift by 32(?), therefore we multiply here
     return buffer.readUInt32LE(offset + 4) * 0x100000000 + low;
 }
+exports.readUInt64LE = readUInt64LE;
+// noinspection JSUnusedGlobalSymbols
+/**
+ * @deprecated The method was named wrongfully and actually reads an UInt64 in **little endian** format.
+ * @group TLV8
+ */
+function readUInt64BE(buffer, offset) {
+    if (offset === void 0) { offset = 0; }
+    return readUInt64LE(buffer, offset);
+}
 exports.readUInt64BE = readUInt64BE;
+/**
+ * `writeUint32LE`
+ * @group TLV8
+ */
 function writeUInt32(value) {
     var buffer = Buffer.alloc(4);
     buffer.writeUInt32LE(value, 0);
     return buffer;
 }
 exports.writeUInt32 = writeUInt32;
+/**
+ * `readUInt32LE`
+ * @group TLV8
+ */
 function readUInt32(buffer) {
     return buffer.readUInt32LE(0);
 }
 exports.readUInt32 = readUInt32;
+/**
+ * @group TLV8
+ */
 function writeFloat32LE(value) {
     var buffer = Buffer.alloc(4);
     buffer.writeFloatLE(value, 0);
     return buffer;
 }
 exports.writeFloat32LE = writeFloat32LE;
+/**
+ * `writeUInt16LE`
+ * @group TLV8
+ */
 function writeUInt16(value) {
     var buffer = Buffer.alloc(2);
     buffer.writeUInt16LE(value, 0);
     return buffer;
 }
 exports.writeUInt16 = writeUInt16;
+/**
+ * `readUInt16LE`
+ * @group TLV8
+ */
 function readUInt16(buffer) {
     return buffer.readUInt16LE(0);
 }
 exports.readUInt16 = readUInt16;
 function readVariableUIntLE(buffer, offset) {
     if (offset === void 0) { offset = 0; }
+    (0, assert_1.default)(offset === 0, "Can't define a offset different than 0!");
     switch (buffer.length) {
         case 1:
             return buffer.readUInt8(offset);
@@ -249,7 +324,7 @@ function readVariableUIntLE(buffer, offset) {
         case 4:
             return buffer.readUInt32LE(offset);
         case 8:
-            return readUInt64BE(buffer, offset);
+            return readUInt64LE(buffer, offset);
         default:
             throw new Error("Can't read uint LE with length " + buffer.length);
     }
@@ -257,21 +332,18 @@ function readVariableUIntLE(buffer, offset) {
 exports.readVariableUIntLE = readVariableUIntLE;
 function writeVariableUIntLE(number, offset) {
     if (offset === void 0) { offset = 0; }
-    assert_1.default(number >= 0, "Can't encode a negative integer as unsigned integer");
+    (0, assert_1.default)(number >= 0, "Can't encode a negative integer as unsigned integer");
+    (0, assert_1.default)(offset === 0, "Can't define a offset different than 0!");
     if (number <= 255) {
         var buffer = Buffer.alloc(1);
         buffer.writeUInt8(number, offset);
         return buffer;
     }
     else if (number <= 65535) {
-        var buffer = Buffer.alloc(2);
-        buffer.writeUInt16LE(number, offset);
-        return buffer;
+        return writeUInt16(number);
     }
     else if (number <= 4294967295) {
-        var buffer = Buffer.alloc(4);
-        buffer.writeUInt32LE(number, offset);
-        return buffer;
+        return writeUInt32(number);
     }
     else {
         var buffer = Buffer.alloc(8);