@project-chip/matter.js 0.0.2 → 0.2.0

package/dist/es/protocol/InteractionProtocol.js

@@ -0,0 +1,133 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { TlvNodeId } from "../common/NodeId.js";
+import { TlvAny } from "../tlv/TlvAny.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvEnum, TlvUInt16, TlvUInt32, TlvUInt64, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvField, TlvList, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.1. StatusResponseMessage
+ */
+export const TlvStatusResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.5.2. AttributePathIB
+ */
+const TlvAttributePath = TlvList({
+    endpointId: TlvOptionalField(2, TlvUInt16),
+    clusterId: TlvOptionalField(3, TlvUInt32),
+    id: TlvOptionalField(4, TlvUInt32),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.2. ReadRequestMessage
+ */
+export const TlvReadRequest = TlvObject({
+    attributes: TlvField(0, TlvArray(TlvAttributePath)),
+    isFabricFiltered: TlvField(3, TlvBoolean),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.3. ReportDataMessage
+ */
+export const TlvReportData = TlvObject({
+    subscriptionId: TlvOptionalField(0, TlvUInt32),
+    values: TlvField(1, TlvArray(TlvObject({
+        value: TlvField(1, TlvObject({
+            version: TlvField(0, TlvUInt32),
+            path: TlvField(1, TlvList({
+                endpointId: TlvField(2, TlvUInt16),
+                clusterId: TlvField(3, TlvUInt32),
+                id: TlvField(4, TlvUInt32),
+            })),
+            value: TlvField(2, TlvAny),
+        })),
+    }))),
+    isFabricFiltered: TlvOptionalField(4, TlvBoolean),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.4. SubscribeRequestMessage
+ */
+export const TlvSubscribeRequest = TlvObject({
+    keepSubscriptions: TlvField(0, TlvBoolean),
+    minIntervalFloorSeconds: TlvField(1, TlvUInt16),
+    maxIntervalCeilingSeconds: TlvField(2, TlvUInt16),
+    attributeRequests: TlvOptionalField(3, TlvArray(TlvAttributePath)),
+    eventRequests: TlvOptionalField(4, TlvArray(TlvList({
+        node: TlvField(0, TlvNodeId),
+        endpoint: TlvField(1, TlvUInt16),
+        cluster: TlvField(2, TlvUInt32),
+        event: TlvField(3, TlvUInt32),
+        isUrgent: TlvField(4, TlvBoolean),
+    }))),
+    eventFilters: TlvOptionalField(5, TlvArray(TlvList({
+        node: TlvField(0, TlvNodeId),
+        eventMin: TlvField(1, TlvUInt64),
+    }))),
+    isFabricFiltered: TlvField(7, TlvBoolean),
+    dataVersionFilters: TlvOptionalField(8, TlvArray(TlvObject({
+        path: TlvField(0, TlvList({
+            node: TlvField(0, TlvNodeId),
+            endpoint: TlvField(1, TlvUInt16),
+            cluster: TlvField(2, TlvUInt32),
+        })),
+        dataVersion: TlvField(1, TlvUInt32),
+    }))),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.5. SubscribeResponseMessage
+ */
+export const TlvSubscribeResponse = TlvObject({
+    subscriptionId: TlvField(0, TlvUInt32),
+    maxIntervalCeilingSeconds: TlvField(2, TlvUInt16),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.9. InvokeRequestMessage
+ */
+export const TlvInvokeRequest = TlvObject({
+    suppressResponse: TlvField(0, TlvBoolean),
+    timedRequest: TlvField(1, TlvBoolean),
+    invokes: TlvField(2, TlvArray(TlvObject({
+        path: TlvField(0, TlvList({
+            endpointId: TlvField(0, TlvUInt16),
+            clusterId: TlvField(1, TlvUInt32),
+            id: TlvField(2, TlvUInt32),
+        })),
+        args: TlvField(1, TlvAny),
+    }))),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});
+/**
+ * @see {@link MatterCoreSpecificationV1_0}, section 10.6.10. InvokeResponseMessage
+ */
+export const TlvInvokeResponse = TlvObject({
+    suppressResponse: TlvField(0, TlvBoolean),
+    responses: TlvField(1, TlvArray(TlvObject({
+        response: TlvOptionalField(0, TlvObject({
+            path: TlvField(0, TlvList({
+                endpointId: TlvField(0, TlvUInt16),
+                clusterId: TlvField(1, TlvUInt32),
+                id: TlvField(2, TlvUInt32),
+            })),
+            response: TlvField(1, TlvAny),
+        })),
+        result: TlvOptionalField(1, TlvObject({
+            path: TlvField(0, TlvList({
+                endpointId: TlvField(0, TlvUInt16),
+                clusterId: TlvField(1, TlvUInt32),
+                id: TlvField(2, TlvUInt32),
+            })),
+            result: TlvField(1, TlvObject({
+                code: TlvField(0, TlvUInt16),
+            })),
+        })),
+    }))),
+    interactionModelRevision: TlvField(0xFF, TlvUInt8),
+});

package/dist/es/schema/BitmapSchema.js

@@ -0,0 +1,125 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ByteArray } from "../util/ByteArray";
+import { Schema } from "./Schema";
+const BitRange = (type, offset, length) => ({ type, offset, length });
+export const BitFlag = (offset) => BitRange(0 /* BitRangeType.Flag */, offset, 1);
+export const BitField = (offset, length) => BitRange(1 /* BitRangeType.Number */, offset, length);
+export const BitFieldEnum = (offset, length) => BitRange(2 /* BitRangeType.Enum */, offset, length);
+class BitmapSchemaInternal extends Schema {
+    constructor(bitSchemas) {
+        super();
+        this.bitSchemas = bitSchemas;
+        const masks = {};
+        for (const name in this.bitSchemas) {
+            const { offset, length } = this.bitSchemas[name];
+            masks[name] = ((1 << length) - 1) << offset;
+        }
+        this.masks = masks;
+        // TODO: validate that bitSchemas is coherent
+    }
+    encodeInternal(value) {
+        let result = 0;
+        for (const name in this.bitSchemas) {
+            const { type, offset } = this.bitSchemas[name];
+            switch (type) {
+                case 0 /* BitRangeType.Flag */:
+                    if (value[name])
+                        result |= this.masks[name];
+                    break;
+                case 2 /* BitRangeType.Enum */:
+                case 1 /* BitRangeType.Number */:
+                    result |= value[name] << offset;
+            }
+        }
+        return result;
+    }
+    decodeInternal(bitmap) {
+        const result = {};
+        for (const name in this.bitSchemas) {
+            const { type, offset } = this.bitSchemas[name];
+            const mask = this.masks[name];
+            if (type === 0 /* BitRangeType.Flag */) {
+                result[name] = (bitmap & mask) !== 0;
+            }
+            else {
+                result[name] = (bitmap & mask) >> offset;
+            }
+        }
+        return result;
+    }
+}
+class ByteArrayBitmapSchemaInternal extends Schema {
+    constructor(bitSchemas) {
+        super();
+        this.bitSchemas = bitSchemas;
+        let maxBitLength = 0;
+        const maskOffset = {};
+        for (const name in this.bitSchemas) {
+            const { offset, length } = this.bitSchemas[name];
+            const bitOffset = offset % 8;
+            const byteOffset = (offset - bitOffset) / 8;
+            const mask = ((1 << length) - 1) << bitOffset;
+            maskOffset[name] = { bitOffset, byteOffset, mask };
+            maxBitLength = Math.max(maxBitLength, offset + length);
+        }
+        this.byteArrayLength = Math.ceil(maxBitLength / 8);
+        this.maskOffset = maskOffset;
+    }
+    encodeInternal(value) {
+        let result = new ByteArray(this.byteArrayLength);
+        for (const name in this.bitSchemas) {
+            const { type } = this.bitSchemas[name];
+            let { mask, bitOffset, byteOffset } = this.maskOffset[name];
+            switch (type) {
+                case 0 /* BitRangeType.Flag */:
+                    if (value[name])
+                        result[byteOffset] |= mask;
+                    break;
+                case 2 /* BitRangeType.Enum */:
+                case 1 /* BitRangeType.Number */:
+                    let numValue = value[name];
+                    while (mask !== 0) {
+                        result[byteOffset++] |= ((numValue & mask) << bitOffset) & 0xFF;
+                        const bitWritten = 8 - bitOffset;
+                        bitOffset = 0;
+                        numValue = numValue >> bitWritten;
+                        mask = mask >> 8;
+                    }
+            }
+        }
+        return result;
+    }
+    decodeInternal(bitmap) {
+        if (bitmap.length !== this.byteArrayLength)
+            throw new Error(`Unexpected length: ${bitmap.length}. Expected ${this.byteArrayLength}`);
+        const result = {};
+        for (const name in this.bitSchemas) {
+            const { type } = this.bitSchemas[name];
+            let { mask, bitOffset, byteOffset } = this.maskOffset[name];
+            if (type === 0 /* BitRangeType.Flag */) {
+                result[name] = (bitmap[byteOffset] & mask) !== 0;
+            }
+            else {
+                let value = 0;
+                let valueBitOffset = 0;
+                while (mask !== 0) {
+                    value |= ((bitmap[byteOffset++] & mask) >> bitOffset) << valueBitOffset;
+                    const bitWritten = 8 - bitOffset;
+                    bitOffset = 0;
+                    valueBitOffset += bitWritten;
+                    mask = mask >> 8;
+                }
+                result[name] = value;
+            }
+        }
+        return result;
+    }
+}
+/** Declares a bitmap schema by indicating the bit position and their names. */
+export const BitmapSchema = (bitSchemas) => new BitmapSchemaInternal(bitSchemas);
+/** Declares a bitmap schema backed by a ByteArray by indicating the bit position and their names. */
+export const ByteArrayBitmapSchema = (bitSchemas) => new ByteArrayBitmapSchemaInternal(bitSchemas);

package/dist/{tlv → es/tlv}/TlvObject.js

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { TlvSchema } from "./TlvSchema.js";
+import { TlvAny } from "./TlvAny.js";
 ;
 /**
  * Schema to encode an object in TLV.
@@ -48,8 +49,11 @@ export class ObjectSchema extends TlvSchema {
             if (id === undefined)
                 throw new Error("Structure element tags should have an id.");
             const fieldName = this.fieldById[id];
-            if (fieldName === undefined)
-                throw new Error(`Unknown field ${id}`);
+            if (fieldName === undefined) {
+                // Ignore unknown field by decoding it as raw TLV so we skip forward the proper length.
+                TlvAny.decodeTlvInternalValue(reader, elementTypeLength);
+                continue;
+            }
             const { field, name } = fieldName;
             result[name] = field.schema.decodeTlvInternalValue(reader, elementTypeLength);
         }

package/dist/{util → es/util}/ByteArray.js

@@ -16,6 +16,8 @@ Uint8Array.prototype.equals = function (other) {
 };
 Uint8Array.fromHex = function (hexString) {
     var _a;
+    if (hexString.length === 0)
+        return new ByteArray(0);
     if (hexString.length % 2 !== 0)
         throw new Error("Hex string should have an even length.");
     const bytes = (_a = hexString.match(/.{1,2}/g)) === null || _a === void 0 ? void 0 : _a.map(byteHex => parseInt(byteHex, 16));

package/dist/{util → es/util}/Type.js

@@ -3,4 +3,4 @@
  * Copyright 2022 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-export {};
+export const Merge = (a, b) => (Object.assign(Object.assign({}, a), b));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@project-chip/matter.js",
-  "version": "0.0.2",
+  "version": "0.2.0",
   "description": "Matter protocol in pure js",
   "keywords": [
     "iot",
@@ -23,8 +23,8 @@
     "url": "https://github.com/project-chip/matter.js.git"
   },
   "scripts": {
-    "clean": "rm -rf dist; rm -rf dist-cjs",
-    "build": "npm run clean; tsc --project tsconfig.dist.json; tsc --project tsconfig.dist-cjs.json",
+    "clean": "rm -rf dist; rm -rf out",
+    "build": "npm run clean; tsc --project tsconfig.dist-es.json; tsc --project tsconfig.dist-cjs.json; tsc --project tsconfig.dist-dts.json",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test-web": "karma start karma.conf.cjs"
   },
@@ -40,10 +40,9 @@
     "typescript": "^4.9.3"
   },
   "files": [
-    "dist/**/*",
-    "dist-cjs/**/*"
+    "dist/**/*"
   ],
-  "main": "dist-cjs/matter.js",
-  "module": "dist/matter.js",
-  "types": "dist/matter.d.ts"
+  "main": "dist/cjs/matter.js",
+  "module": "dist/es/matter.js",
+  "types": "dist/dts/matter.d.ts"
 }

package/dist/schema/BitmapSchema.js

@@ -1,48 +0,0 @@
-/**
- * @license
- * Copyright 2022 Project CHIP Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Schema } from "./Schema.js";
-const BitRange = (type, offset, length) => ({ type, mask: ((1 << length) - 1) << offset, offset });
-export const BitFlag = (offset) => BitRange(0 /* BitRangeType.Flag */, offset, 1);
-export const BitField = (offset, length) => BitRange(1 /* BitRangeType.Number */, offset, length);
-export const BitFieldEnum = (offset, length) => BitRange(2 /* BitRangeType.Enum */, offset, length);
-class BitmapSchemaInternal extends Schema {
-    constructor(bitSchemas) {
-        super();
-        this.bitSchemas = bitSchemas;
-        // TODO: validate that bitSchemas is coherent
-    }
-    encodeInternal(value) {
-        let result = 0;
-        for (const name in this.bitSchemas) {
-            const { type, offset, mask } = this.bitSchemas[name];
-            switch (type) {
-                case 0 /* BitRangeType.Flag */:
-                    if (value[name])
-                        result |= mask;
-                    break;
-                case 2 /* BitRangeType.Enum */:
-                case 1 /* BitRangeType.Number */:
-                    result |= value[name] << offset;
-            }
-        }
-        return result;
-    }
-    decodeInternal(bitmap) {
-        const result = {};
-        for (const name in this.bitSchemas) {
-            const { type, offset, mask } = this.bitSchemas[name];
-            if (type === 0 /* BitRangeType.Flag */) {
-                result[name] = (bitmap & mask) !== 0;
-            }
-            else {
-                result[name] = (bitmap & mask) >> offset;
-            }
-        }
-        return result;
-    }
-}
-/** Declares a bitmap schema by indicating the bit position and their names. */
-export const BitmapSchema = (bitSchemas) => new BitmapSchemaInternal(bitSchemas);

package/dist-cjs/schema/BitmapSchema.js

@@ -1,55 +0,0 @@
-"use strict";
-/**
- * @license
- * Copyright 2022 Project CHIP Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BitmapSchema = exports.BitFieldEnum = exports.BitField = exports.BitFlag = void 0;
-const Schema_js_1 = require("./Schema.js");
-const BitRange = (type, offset, length) => ({ type, mask: ((1 << length) - 1) << offset, offset });
-const BitFlag = (offset) => BitRange(0 /* BitRangeType.Flag */, offset, 1);
-exports.BitFlag = BitFlag;
-const BitField = (offset, length) => BitRange(1 /* BitRangeType.Number */, offset, length);
-exports.BitField = BitField;
-const BitFieldEnum = (offset, length) => BitRange(2 /* BitRangeType.Enum */, offset, length);
-exports.BitFieldEnum = BitFieldEnum;
-class BitmapSchemaInternal extends Schema_js_1.Schema {
-    constructor(bitSchemas) {
-        super();
-        this.bitSchemas = bitSchemas;
-        // TODO: validate that bitSchemas is coherent
-    }
-    encodeInternal(value) {
-        let result = 0;
-        for (const name in this.bitSchemas) {
-            const { type, offset, mask } = this.bitSchemas[name];
-            switch (type) {
-                case 0 /* BitRangeType.Flag */:
-                    if (value[name])
-                        result |= mask;
-                    break;
-                case 2 /* BitRangeType.Enum */:
-                case 1 /* BitRangeType.Number */:
-                    result |= value[name] << offset;
-            }
-        }
-        return result;
-    }
-    decodeInternal(bitmap) {
-        const result = {};
-        for (const name in this.bitSchemas) {
-            const { type, offset, mask } = this.bitSchemas[name];
-            if (type === 0 /* BitRangeType.Flag */) {
-                result[name] = (bitmap & mask) !== 0;
-            }
-            else {
-                result[name] = (bitmap & mask) >> offset;
-            }
-        }
-        return result;
-    }
-}
-/** Declares a bitmap schema by indicating the bit position and their names. */
-const BitmapSchema = (bitSchemas) => new BitmapSchemaInternal(bitSchemas);
-exports.BitmapSchema = BitmapSchema;