@project-chip/matter.js 0.0.2 → 0.2.0

package/README.md

@@ -4,6 +4,20 @@
 
 Implementation of Matter protocol in typescript with no native dependencies (and very limited dependencies).
 
+## Current status
+
+This is work in progress.
+
+Completed implementations:
+- [X] TLV codec (coder/decoder) and schema mapping and validation engine
+- [X] 12 cluster definitions (including TLV structures for all messages)
+
+## matter.js usage
+
+matter.js is used at the core of those two projects:
+* [matternode](https://github.com/project-chip/matternode): a light-weight node.js implementation of a Matter Node
+* [node-matter](https://github.com/mfucci/node-matter): a Matter client / server running on node.js compatible with HA (Android / iOs support in progress)
+
 ## Tests
 
 Run tests in node.js: npm run test

package/dist/cjs/cluster/AccessControlCluster.js

@@ -0,0 +1,105 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessControlCluster = void 0;
+const Cluster_js_1 = require("./Cluster.js");
+const ClusterId_js_1 = require("../common/ClusterId.js");
+const EndpointNumber_js_1 = require("../common/EndpointNumber.js");
+const DeviceTypeId_js_1 = require("../common/DeviceTypeId.js");
+const NodeId_js_1 = require("../common/NodeId.js");
+const SubjectId_js_1 = require("../common/SubjectId.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvNullable_js_1 = require("../tlv/TlvNullable.js");
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvArray_js_1 = require("../tlv/TlvArray.js");
+const TlvString_js_1 = require("../tlv/TlvString.js");
+/**
+ *
+ * Defines the clusters on this Node to which this Access Control Entry grants access.
+ *
+ * A single target SHALL contain at least one field (Cluster, Endpoint, or DeviceType), and SHALL NOT
+ * contain both an Endpoint field and a DeviceType field.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.10.5.3
+ */
+const TlvTarget = (0, TlvObject_js_1.TlvObject)({
+    /** Cluster to grant access on. */
+    cluster: (0, TlvObject_js_1.TlvField)(0, (0, TlvNullable_js_1.TlvNullable)(ClusterId_js_1.TlvClusterId)),
+    /** Endpoint to grant access on. */
+    endpoint: (0, TlvObject_js_1.TlvField)(1, (0, TlvNullable_js_1.TlvNullable)(EndpointNumber_js_1.TlvEndpointNumber)),
+    /** Device type to grant access on. */
+    deviceType: (0, TlvObject_js_1.TlvField)(1, (0, TlvNullable_js_1.TlvNullable)(DeviceTypeId_js_1.TlvDeviceTypeId)),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 9.10.5.3 */
+const TlvAccessControlEntry = (0, TlvObject_js_1.TlvObject)({
+    /** Specifies the level of privilege granted by this Access Control Entry. */
+    privilege: (0, TlvObject_js_1.TlvField)(1, (0, TlvNumber_js_1.TlvEnum)()),
+    /** Specifies the authentication mode required by this Access Control Entry. */
+    authMode: (0, TlvObject_js_1.TlvField)(2, (0, TlvNumber_js_1.TlvEnum)()),
+    /** Specifies a list of Subject IDs, to which this Access Control Entry grants access. */
+    subjects: (0, TlvObject_js_1.TlvField)(3, (0, TlvNullable_js_1.TlvNullable)((0, TlvArray_js_1.TlvArray)(SubjectId_js_1.TlvSubjectId))),
+    /** Specifies a list of TargetStruct, which define the clusters on this Node to which this Access Control Entry grants access. */
+    targets: (0, TlvObject_js_1.TlvField)(4, (0, TlvNullable_js_1.TlvNullable)((0, TlvArray_js_1.TlvArray)(TlvTarget))), /* maxArrayLength: targetsPerAccessControlEntry */
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 9.10.5.4 */
+const TlvAccessControlExtensionEntry = (0, TlvObject_js_1.TlvObject)({
+    /** Used by manufacturers to store arbitrary TLV-encoded data related to a fabric’s Access Control Entries. */
+    data: (0, TlvObject_js_1.TlvField)(1, TlvString_js_1.TlvByteString.bound({ maxLength: 128 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 9.10.7.1 */
+const AccessChangeEvent = (entrySchema) => ({
+    /** The Node ID of the Administrator that made the change, if the change occurred via a CASE session. */
+    adminNodeID: (0, TlvObject_js_1.TlvField)(1, (0, TlvNullable_js_1.TlvNullable)(NodeId_js_1.TlvNodeId)),
+    /** The Passcode ID of the Administrator that made the change, if the change occurred via a PASE session. */
+    adminPasscodeID: (0, TlvObject_js_1.TlvField)(2, (0, TlvNullable_js_1.TlvNullable)(TlvNumber_js_1.TlvUInt16)),
+    /** The type of change as appropriate. */
+    changeType: (0, TlvObject_js_1.TlvField)(3, (0, TlvNumber_js_1.TlvEnum)()),
+    /** The latest value of the changed entry. */
+    latestValue: (0, TlvObject_js_1.TlvField)(4, (0, TlvNullable_js_1.TlvNullable)(entrySchema)),
+});
+/**
+ * The Access Control Cluster exposes a data model view of a Node’s Access Control List (ACL),
+ * which codifies the rules used to manage and enforce Access Control for the Node’s endpoints
+ * and their associated cluster instances. Access to this Access Control Cluster itself requires
+ * a special Administer privilege level, such that only Nodes granted such privilege (hereafter
+ * termed "Administrators") can manage the Access Control Cluster.
+ * The Access Control Cluster SHALL be present on the root node endpoint of each Node, and SHALL
+ * NOT be present on any other Endpoint of any Node.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.10
+ */
+exports.AccessControlCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x1f,
+    name: "Access Control",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.10.5 */
+    attributes: {
+        /** Codifies a single grant of privilege on this Node. */
+        acl: (0, Cluster_js_1.WritableAttribute)(0, (0, TlvArray_js_1.TlvArray)(TlvAccessControlEntry), { default: [], writeAcl: 2 /* AccessLevel.Administer */, readAcl: 2 /* AccessLevel.Administer */ }),
+        /** MAY be used by Administrators to store arbitrary data related to fabric’s Access Control Entries. */
+        extension: (0, Cluster_js_1.OptionalWritableAttribute)(1, (0, TlvArray_js_1.TlvArray)(TlvAccessControlExtensionEntry), { default: [], writeAcl: 2 /* AccessLevel.Administer */, readAcl: 2 /* AccessLevel.Administer */ }),
+        /** Provide the minimum number of Subjects per entry that are supported by this server. */
+        subjectsPerAccessControlEntry: (0, Cluster_js_1.Attribute)(2, TlvNumber_js_1.TlvUInt16.bound({ min: 4 }), { default: 4 }),
+        /** Provides the minimum number of Targets per entry that are supported by this server. */
+        targetsPerAccessControlEntry: (0, Cluster_js_1.Attribute)(3, TlvNumber_js_1.TlvUInt16.bound({ min: 3 }), { default: 3 }),
+        /** Provides the minimum number of ACL Entries per fabric that are supported by this server. */
+        accessControlEntriesPerFabric: (0, Cluster_js_1.Attribute)(4, TlvNumber_js_1.TlvUInt16.bound({ min: 3 }), { default: 3 }),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.10.7 */
+    events: {
+        /**
+         * The cluster SHALL send AccessControlEntryChanged events whenever its ACL attribute data is changed by an
+         * Administrator.
+         */
+        accessControlEntryChanged: (0, Cluster_js_1.Event)(0, 1 /* EventPriority.Info */, AccessChangeEvent(TlvAccessControlEntry)),
+        /**
+         * The cluster SHALL send AccessControlExtensionChanged events whenever its extension attribute data is changed
+         * by an Administrator.
+         */
+        accessControlExtensionChanged: (0, Cluster_js_1.Event)(1, 1 /* EventPriority.Info */, AccessChangeEvent(TlvAccessControlExtensionEntry)), /* readAcl: AccessLevel.Administer */
+    },
+});

package/dist/cjs/cluster/BasicInformationCluster.js

@@ -0,0 +1,92 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicInformationCluster = void 0;
+const FabricIndex_js_1 = require("../common/FabricIndex.js");
+const VendorId_js_1 = require("../common/VendorId.js");
+const TlvBoolean_js_1 = require("../tlv/TlvBoolean.js");
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvString_js_1 = require("../tlv/TlvString.js");
+const Cluster_js_1 = require("./Cluster.js");
+/**
+ * Provides constant values related to overall global capabilities of this Node, that are not cluster-specific.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.1.6.2
+ */
+const TlvCapabilityMinima = (0, TlvObject_js_1.TlvObject)({
+    /** Indicates the minimum number of concurrent CASE sessions that are supported per fabric. */
+    caseSessionsPerFabric: (0, TlvObject_js_1.TlvField)(0, TlvNumber_js_1.TlvUInt16.bound({ min: 3 })),
+    /** Indicate the actual minimum number of concurrent subscriptions supported per fabric. */
+    subscriptionsPerFabric: (0, TlvObject_js_1.TlvField)(1, TlvNumber_js_1.TlvUInt16.bound({ min: 3 })),
+});
+/**
+ * This cluster provides attributes and events for determining basic information about Nodes, which supports both
+ * commissioning and operational determination of Node characteristics, such as Vendor ID, Product ID and serial number,
+ * which apply to the whole Node. Also allows setting user device information such as location.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.1
+ */
+exports.BasicInformationCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x28,
+    name: "Basic Information",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.1.6.3 */
+    attributes: {
+        /** Revision number of the Data Model against which the Node is certified */
+        dataModelRevision: (0, Cluster_js_1.Attribute)(0, TlvNumber_js_1.TlvUInt16),
+        /** Human-readable (displayable) name of the vendor for the Node. */
+        vendorName: (0, Cluster_js_1.Attribute)(1, TlvString_js_1.TlvString32max),
+        /** Specifies the {@link VendorId}. */
+        vendorId: (0, Cluster_js_1.Attribute)(2, VendorId_js_1.TlvVendorId),
+        /** Human-readable name of the model for the Node such as the model number assigned by the vendor. */
+        productName: (0, Cluster_js_1.Attribute)(3, TlvString_js_1.TlvString32max),
+        /** Product ID assigned by the vendor that is unique to the specific product of the Node. */
+        productId: (0, Cluster_js_1.Attribute)(4, TlvNumber_js_1.TlvUInt16),
+        /** User defined name for the Node. It is set during initial commissioning and may be updated by further reconfigurations. */
+        nodeLabel: (0, Cluster_js_1.WritableAttribute)(5, TlvString_js_1.TlvString32max, { default: "", writeAcl: 1 /* AccessLevel.Manage */ }),
+        /** ISO 3166-1 alpha-2 code where the Node is located. Might affect some regulatory aspects. */
+        location: (0, Cluster_js_1.WritableAttribute)(6, TlvString_js_1.TlvString.bound({ length: 2 }), { default: "XX", writeAcl: 2 /* AccessLevel.Administer */ }),
+        /** Version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined. */
+        hardwareVersion: (0, Cluster_js_1.Attribute)(7, TlvNumber_js_1.TlvUInt16, { default: 0 }),
+        /** Human-readable representation of the {@link BasicInformationCluster.attributes.hardwareVersion hardwareVersion} attribute. */
+        hardwareVersionString: (0, Cluster_js_1.Attribute)(8, TlvString_js_1.TlvString.bound({ minLength: 1, maxLength: 64 })),
+        /** Current version number for the software running on this Node. A larger value is newer than a lower value. */
+        softwareVersion: (0, Cluster_js_1.Attribute)(9, TlvNumber_js_1.TlvUInt32, { default: 0 }),
+        /** Human-readable representation of the {@link BasicInformationCluster.attributes.softwareVersion softwareVersion} attribute. */
+        softwareVersionString: (0, Cluster_js_1.Attribute)(10, TlvString_js_1.TlvString.bound({ minLength: 1, maxLength: 64 })),
+        /** Node manufacturing date formatted with YYYYMMDD. The additional 8 characters might include other vendor related information. */
+        manufacturingDate: (0, Cluster_js_1.OptionalAttribute)(11, TlvString_js_1.TlvString.bound({ minLength: 8, maxLength: 16 })),
+        /** Human-readable vendor assigned part number for the Node whose meaning and numbering scheme is vendor defined. */
+        partNumber: (0, Cluster_js_1.OptionalAttribute)(12, TlvString_js_1.TlvString32max),
+        /** Link to a product specific web page following the syntax as specified in RFC 3986. */
+        productURL: (0, Cluster_js_1.OptionalAttribute)(13, TlvString_js_1.TlvString256max),
+        /** Vendor specific human readable product label. */
+        productLabel: (0, Cluster_js_1.OptionalAttribute)(14, TlvString_js_1.TlvString64max),
+        /** Human readable serial number. */
+        serialNumber: (0, Cluster_js_1.OptionalAttribute)(15, TlvString_js_1.TlvString32max),
+        /** Allows to disable the ability to configure the Node through an on-Node user interface. */
+        localConfigDisabled: (0, Cluster_js_1.OptionalWritableAttribute)(16, TlvBoolean_js_1.TlvBoolean, { default: false, writeAcl: 1 /* AccessLevel.Manage */ }),
+        /** Indicates whether the Node can be reached over the non-native network for bridged devices. */
+        reachable: (0, Cluster_js_1.OptionalAttribute)(17, TlvBoolean_js_1.TlvBoolean, { default: true }),
+        /** Unique identifier for the device, which is constructed in a manufacturer specific manner, updated during factory reset. */
+        uniqueId: (0, Cluster_js_1.OptionalAttribute)(18, TlvString_js_1.TlvString32max),
+        /** Minimum guaranteed value for some system-wide, not cluster-specific, resource capabilities. */
+        capabilityMinima: (0, Cluster_js_1.Attribute)(19, TlvCapabilityMinima, { default: { caseSessionsPerFabric: 3, subscriptionsPerFabric: 3 } }),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.1.6.5 */
+    events: {
+        /** First event fired as soon as reasonable after completing a boot or reboot process. */
+        startUp: (0, Cluster_js_1.Event)(0, 0 /* EventPriority.Critical */, { softwareVersion: (0, TlvObject_js_1.TlvField)(0, TlvNumber_js_1.TlvUInt32) }),
+        /** Last event fired prior to any orderly shutdown sequence on a best-effort basis. */
+        shutDown: (0, Cluster_js_1.OptionalEvent)(1, 0 /* EventPriority.Critical */),
+        /** Fired prior to permanently leaving a given Fabric. */
+        leave: (0, Cluster_js_1.OptionalEvent)(2, 1 /* EventPriority.Info */, { fabricIndex: (0, TlvObject_js_1.TlvField)(0, FabricIndex_js_1.TlvFabricIndex) }),
+        /** Fired when there is a change in the {@link BasicInformationCluster.attributes.reachable reachable} attribute. */
+        reachableChanged: (0, Cluster_js_1.OptionalEvent)(3, 1 /* EventPriority.Info */, { reachableNewValue: (0, TlvObject_js_1.TlvField)(0, TlvBoolean_js_1.TlvBoolean) }),
+    },
+});

package/dist/cjs/cluster/BindingCluster.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BindingCluster = void 0;
+const Cluster_js_1 = require("./Cluster.js");
+const ClusterId_js_1 = require("../common/ClusterId.js");
+const EndpointNumber_js_1 = require("../common/EndpointNumber.js");
+const NodeId_js_1 = require("../common/NodeId.js");
+const GroupId_js_1 = require("../common/GroupId.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvArray_js_1 = require("../tlv/TlvArray.js");
+/**
+ * Provides information about endpoint conformance to a release of a device type definition.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.5.5.1
+ */
+const TlvTarget = (0, TlvObject_js_1.TlvObject)({
+    /**  Contains the remote target node ID. If the Endpoint field is present, this field SHALL be present. */
+    node: (0, TlvObject_js_1.TlvOptionalField)(1, NodeId_js_1.TlvNodeId),
+    /** Contains the target group ID that represents remote endpoints. If the Endpoint field is present, this field SHALL NOT be present. */
+    group: (0, TlvObject_js_1.TlvOptionalField)(2, GroupId_js_1.TlvGroupId),
+    /** Contains the remote endpoint that the local endpoint is bound to. If the Group field is present, this field SHALL NOT be present. */
+    endpoint: (0, TlvObject_js_1.TlvOptionalField)(3, EndpointNumber_js_1.TlvEndpointNumber),
+    /**
+     * Contains the cluster ID (client & server) on the local and target endpoint(s). If this field is present, the
+     * client cluster SHALL also exist on this endpoint (with this Binding cluster). If this field is present, the
+     * target SHALL be this cluster on the target endpoint(s).
+     */
+    cluster: (0, TlvObject_js_1.TlvOptionalField)(4, ClusterId_js_1.TlvClusterId),
+});
+/**
+ * A binding represents a persistent relationship between an endpoint and one or more other local or
+ * remote endpoints. A binding does not require that the relationship exists. It is up to the node
+ * application to set up the relationship.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.6
+ */
+exports.BindingCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x1e,
+    name: "Binding",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.6.5 */
+    attributes: {
+        /** List of device types and corresponding revisions declaring endpoint conformance. */
+        binding: (0, Cluster_js_1.WritableAttribute)(0, (0, TlvArray_js_1.TlvArray)(TlvTarget), { default: [] }), /* non-volatile */
+    },
+});

package/dist/cjs/cluster/BridgedDeviceBasicInformationCluster.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BridgedDeviceBasicInformationCluster = void 0;
+const FabricIndex_js_1 = require("../common/FabricIndex.js");
+const VendorId_js_1 = require("../common/VendorId.js");
+const TlvBoolean_js_1 = require("../tlv/TlvBoolean.js");
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvString_js_1 = require("../tlv/TlvString.js");
+const Cluster_js_1 = require("./Cluster.js");
+/**
+ * This Cluster serves two purposes towards a Node communicating with a Bridge:
+ * * indicate that the functionality on the Endpoint where it is placed (and its Parts) is bridged from a
+ *   non-Matter technology, and
+ * * provide a centralized collection of attributes that the Node MAY collect to aid in conveying information
+ *   regarding the Bridged Device to a user, such as the vendor name, the model name, or user-assigned name.
+ *
+ * This cluster is Derived from Basic Information Cluster.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.13
+ */
+exports.BridgedDeviceBasicInformationCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x39,
+    name: "Bridged Device Basic Information",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.13.6 */
+    attributes: {
+        /** Human-readable (displayable) name of the vendor for the Node. */
+        vendorName: (0, Cluster_js_1.OptionalAttribute)(1, TlvString_js_1.TlvString32max),
+        /** Specifies the {@link VendorId}. */
+        vendorId: (0, Cluster_js_1.OptionalAttribute)(2, VendorId_js_1.TlvVendorId),
+        /** Human-readable name of the model for the Node such as the model number assigned by the vendor. */
+        productName: (0, Cluster_js_1.OptionalAttribute)(3, TlvString_js_1.TlvString32max),
+        /** User defined name for the Node. It is set during initial commissioning and may be updated by further reconfigurations. */
+        nodeLabel: (0, Cluster_js_1.OptionalWritableAttribute)(5, TlvString_js_1.TlvString32max, { default: "", writeAcl: 1 /* AccessLevel.Manage */ }),
+        /** Version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined. */
+        hardwareVersion: (0, Cluster_js_1.OptionalAttribute)(7, TlvNumber_js_1.TlvUInt16, { default: 0 }),
+        /** Human-readable representation of the {@link BasicInformationCluster.attributes.hardwareVersion hardwareVersion} attribute. */
+        hardwareVersionString: (0, Cluster_js_1.OptionalAttribute)(8, TlvString_js_1.TlvString.bound({ minLength: 1, maxLength: 64 })),
+        /** Current version number for the software running on this Node. A larger value is newer than a lower value. */
+        softwareVersion: (0, Cluster_js_1.OptionalAttribute)(9, TlvNumber_js_1.TlvUInt32, { default: 0 }),
+        /** Human-readable representation of the {@link BasicInformationCluster.attributes.softwareVersion softwareVersion} attribute. */
+        softwareVersionString: (0, Cluster_js_1.OptionalAttribute)(10, TlvString_js_1.TlvString.bound({ minLength: 1, maxLength: 64 })),
+        /** Node manufacturing date formatted with YYYYMMDD. The additional 8 characters might include other vendor related information. */
+        manufacturingDate: (0, Cluster_js_1.OptionalAttribute)(11, TlvString_js_1.TlvString.bound({ minLength: 8, maxLength: 16 })),
+        /** Human-readable vendor assigned part number for the Node whose meaning and numbering scheme is vendor defined. */
+        partNumber: (0, Cluster_js_1.OptionalAttribute)(12, TlvString_js_1.TlvString32max),
+        /** Link to a product specific web page following the syntax as specified in RFC 3986. */
+        productURL: (0, Cluster_js_1.OptionalAttribute)(13, TlvString_js_1.TlvString256max),
+        /** Vendor specific human readable product label. */
+        productLabel: (0, Cluster_js_1.OptionalAttribute)(14, TlvString_js_1.TlvString64max),
+        /** Human-readable serial number. */
+        serialNumber: (0, Cluster_js_1.OptionalAttribute)(15, TlvString_js_1.TlvString32max),
+        /** Indicates whether the bridged device is reachable by the bridge over the non-Matter network. */
+        reachable: (0, Cluster_js_1.Attribute)(17, TlvBoolean_js_1.TlvBoolean, { default: true }),
+        /** Unique identifier for the device, which is constructed in a manufacturer specific manner, updated during factory reset. */
+        uniqueId: (0, Cluster_js_1.OptionalAttribute)(18, TlvString_js_1.TlvString32max),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.1.6.5 */
+    events: {
+        /** First event fired as soon as reasonable after completing a boot or reboot process. */
+        startUp: (0, Cluster_js_1.OptionalEvent)(0, 0 /* EventPriority.Critical */, { softwareVersion: (0, TlvObject_js_1.TlvField)(0, TlvNumber_js_1.TlvUInt32) }),
+        /** Last event fired prior to any orderly shutdown sequence on a best-effort basis. */
+        shutDown: (0, Cluster_js_1.OptionalEvent)(1, 0 /* EventPriority.Critical */),
+        /** Fired prior to permanently leaving a given Fabric. */
+        leave: (0, Cluster_js_1.OptionalEvent)(2, 1 /* EventPriority.Info */, { fabricIndex: (0, TlvObject_js_1.TlvField)(0, FabricIndex_js_1.TlvFabricIndex) }),
+        /** Fired when there is a change in the {@link BasicInformationCluster.attributes.reachable reachable} attribute */
+        reachableChanged: (0, Cluster_js_1.Event)(3, 1 /* EventPriority.Info */, { reachableNewValue: (0, TlvObject_js_1.TlvField)(0, TlvBoolean_js_1.TlvBoolean) }),
+    },
+});

package/dist/cjs/cluster/Cluster.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cluster = exports.GlobalAttributes = exports.OptionalEvent = exports.Event = exports.OptionalCommand = exports.Command = exports.TlvNoResponse = exports.TlvNoArguments = exports.OptionalWritableAttribute = exports.WritableAttribute = exports.OptionalAttribute = exports.Attribute = void 0;
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvVoid_js_1 = require("../tlv/TlvVoid.js");
+const Type_js_1 = require("../util/Type.js");
+;
+const Attribute = (id, schema, { default: conformanceValue, readAcl = 0 /* AccessLevel.View */ } = {}) => ({ id, schema, optional: false, writable: false, default: conformanceValue, readAcl });
+exports.Attribute = Attribute;
+const OptionalAttribute = (id, schema, { default: conformanceValue, readAcl = 0 /* AccessLevel.View */ } = {}) => ({ id, schema, optional: true, writable: false, default: conformanceValue, readAcl });
+exports.OptionalAttribute = OptionalAttribute;
+const WritableAttribute = (id, schema, { default: conformanceValue, readAcl = 0 /* AccessLevel.View */, writeAcl = 0 /* AccessLevel.View */ } = {}) => ({ id, schema, optional: false, writable: true, default: conformanceValue, readAcl, writeAcl });
+exports.WritableAttribute = WritableAttribute;
+const OptionalWritableAttribute = (id, schema, { default: conformanceValue, readAcl = 0 /* AccessLevel.View */, writeAcl = 0 /* AccessLevel.View */ } = {}) => ({ id, schema, optional: true, writable: true, default: conformanceValue, readAcl, writeAcl });
+exports.OptionalWritableAttribute = OptionalWritableAttribute;
+/* Interfaces and helper methods to define a cluster command */
+exports.TlvNoArguments = (0, TlvObject_js_1.TlvObject)({});
+exports.TlvNoResponse = TlvVoid_js_1.TlvVoid;
+;
+;
+const Command = (requestId, requestSchema, responseId, responseSchema) => ({ optional: false, requestId, requestSchema, responseId, responseSchema });
+exports.Command = Command;
+const OptionalCommand = (requestId, requestSchema, responseId, responseSchema) => ({ optional: true, requestId, requestSchema, responseId, responseSchema });
+exports.OptionalCommand = OptionalCommand;
+const Event = (id, priority, data = {}) => ({ id, schema: (0, TlvObject_js_1.TlvObject)(data), priority, optional: false });
+exports.Event = Event;
+const OptionalEvent = (id, priority, data = {}) => ({ id, schema: (0, TlvObject_js_1.TlvObject)(data), priority, optional: true });
+exports.OptionalEvent = OptionalEvent;
+const GlobalAttributes = (features) => ({
+    clusterRevision: (0, exports.Attribute)(0xFFFD, TlvNumber_js_1.TlvUInt16),
+    featureMap: (0, exports.Attribute)(0xFFFC, (0, TlvNumber_js_1.TlvBitmap)(TlvNumber_js_1.TlvUInt32, features)),
+});
+exports.GlobalAttributes = GlobalAttributes;
+const Cluster = ({ id, name, revision, features = {}, attributes = {}, commands = {}, events = {}, }) => ({
+    id,
+    name,
+    revision,
+    features,
+    commands,
+    attributes: (0, Type_js_1.Merge)(attributes, (0, exports.GlobalAttributes)(features)),
+    events,
+});
+exports.Cluster = Cluster;

package/dist/cjs/cluster/DescriptorCluster.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DescriptorCluster = void 0;
+const Cluster_js_1 = require("./Cluster.js");
+const DeviceTypeId_js_1 = require("../common/DeviceTypeId.js");
+const ClusterId_js_1 = require("../common/ClusterId.js");
+const EndpointNumber_js_1 = require("../common/EndpointNumber.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvArray_js_1 = require("../tlv/TlvArray.js");
+/**
+ * Provides information about endpoint conformance to a release of a device type definition.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.5.5.1
+ */
+const TlvDeviceType = (0, TlvObject_js_1.TlvObject)({
+    /** Indicates the device type definition */
+    type: (0, TlvObject_js_1.TlvField)(0, DeviceTypeId_js_1.TlvDeviceTypeId),
+    /** Indicates the implemented revision of the device type definition */
+    revision: (0, TlvObject_js_1.TlvField)(1, TlvNumber_js_1.TlvUInt16.bound({ min: 1 })),
+});
+/**
+ * This cluster describes an endpoint instance on the node, independently of other endpoints, but also
+ * allows composition of endpoints to conform to complex device type patterns.
+ * This Cluster is also meant to replace the support from the Zigbee Device Object (ZDO) for describing a node,
+ * its endpoints and clusters.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.5
+ */
+exports.DescriptorCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x1d,
+    name: "Descriptor",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.5.4 */
+    attributes: {
+        /** List of device types and corresponding revisions declaring endpoint conformance. */
+        deviceTypeList: (0, Cluster_js_1.Attribute)(0, (0, TlvArray_js_1.TlvArray)(TlvDeviceType, { minLength: 1 })),
+        /** List containing each cluster ID for the server clusters present on the endpoint instance. */
+        serverList: (0, Cluster_js_1.Attribute)(1, (0, TlvArray_js_1.TlvArray)(ClusterId_js_1.TlvClusterId), { default: [] }),
+        /** List containing each cluster ID for the client clusters present on the endpoint instance. */
+        clientList: (0, Cluster_js_1.Attribute)(3, (0, TlvArray_js_1.TlvArray)(ClusterId_js_1.TlvClusterId), { default: [] }),
+        /**
+         * This indicates composition of the device type instance. Device type instance composition SHALL
+         * include the endpoints in this list.
+         */
+        partsList: (0, Cluster_js_1.Attribute)(4, (0, TlvArray_js_1.TlvArray)(EndpointNumber_js_1.TlvEndpointNumber), { default: [] }),
+    },
+});

package/dist/cjs/cluster/GeneralCommissioningCluster.js

@@ -0,0 +1,89 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneralCommissioningCluster = void 0;
+const Cluster_js_1 = require("./Cluster.js");
+const TlvObject_js_1 = require("../tlv/TlvObject.js");
+const TlvNumber_js_1 = require("../tlv/TlvNumber.js");
+const TlvString_js_1 = require("../tlv/TlvString.js");
+const TlvBoolean_js_1 = require("../tlv/TlvBoolean.js");
+/**
+ * This structure provides some constant values that MAY be of use to all commissioners.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.9.5.2
+ */
+const TlvBasicCommissioningInfo = (0, TlvObject_js_1.TlvObject)({
+    /** Contains a conservative initial duration (in seconds) to set in the FailSafe for the commissioning flow to complete successfully. */
+    failSafeExpiryLengthSeconds: (0, TlvObject_js_1.TlvField)(0, TlvNumber_js_1.TlvUInt16),
+    /** Contain a conservative value in seconds denoting the maximum total duration for which a fail-safe timer can be re-armed. */
+    maxCumulativeFailsafeSeconds: (0, TlvObject_js_1.TlvField)(1, TlvNumber_js_1.TlvUInt16),
+});
+/**
+ * Used by the following commands as response payload:
+ * ArmFailSafeResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.3
+ * CommissioningCompleteResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.7
+ * CommissioningCompleteResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.7
+ */
+const TlvCommissioningSuccessFailureResponse = (0, TlvObject_js_1.TlvObject)({
+    /** Contain the result of the operation. */
+    errorCode: (0, TlvObject_js_1.TlvField)(0, (0, TlvNumber_js_1.TlvEnum)()),
+    /** Should help developers in troubleshooting errors. The value MAY go into logs or crash reports, not User UIs. */
+    debugText: (0, TlvObject_js_1.TlvField)(1, TlvString_js_1.TlvString.bound({ maxLength: 128 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.9.7.3. */
+const TlvArmFailSafeRequest = (0, TlvObject_js_1.TlvObject)({
+    /** Contains timeframe for fail-safe timer actions. */
+    expiryLengthSeconds: (0, TlvObject_js_1.TlvField)(0, TlvNumber_js_1.TlvUInt16),
+    /** Value to atomically set the Breadcrumb attribute on success of this command. */
+    breadcrumbStep: (0, TlvObject_js_1.TlvField)(1, TlvNumber_js_1.TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.9.7.4 */
+const TlvSetRegulatoryConfigRequest = (0, TlvObject_js_1.TlvObject)({
+    /** Contains the new regulatory location to be set. */
+    newRegulatoryConfig: (0, TlvObject_js_1.TlvField)(0, (0, TlvNumber_js_1.TlvEnum)()),
+    /** Contains a ISO 3166-1 alpha-2 country code*/
+    countryCode: (0, TlvObject_js_1.TlvField)(1, TlvString_js_1.TlvString.bound({ length: 2 })),
+    /** Value to atomically set the Breadcrumb attribute on success of this command. */
+    breadcrumbStep: (0, TlvObject_js_1.TlvField)(2, TlvNumber_js_1.TlvUInt64),
+});
+/**
+ * This cluster is used to manage global aspects of the Commissioning flow.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.9
+ */
+exports.GeneralCommissioningCluster = (0, Cluster_js_1.Cluster)({
+    id: 0x30,
+    name: "General Commissioning",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.9.6 */
+    attributes: {
+        /** Allows for the storage of a client-provided small payload which Administrators and Commissioners MAY write
+         * and then subsequently read, to keep track of their own progress.
+         */
+        breadcrumb: (0, Cluster_js_1.WritableAttribute)(0, TlvNumber_js_1.TlvUInt64, { default: BigInt(0), writeAcl: 2 /* AccessLevel.Administer */ }),
+        /** Describe critical parameters needed at the beginning of commissioning flow. */
+        commissioningInfo: (0, Cluster_js_1.Attribute)(1, TlvBasicCommissioningInfo),
+        /** Indicates the regulatory configuration for the product. */
+        regulatoryConfig: (0, Cluster_js_1.Attribute)(2, (0, TlvNumber_js_1.TlvEnum)()),
+        /** Indicates if this Node needs to be told an exact RegulatoryLocation. */
+        locationCapability: (0, Cluster_js_1.Attribute)(3, (0, TlvNumber_js_1.TlvEnum)(), { default: 2 /* RegulatoryLocationType.IndoorOutdoor */ }),
+        /** Indicates whether this device supports "concurrent connection flow" commissioning mode */
+        supportsConcurrentConnections: (0, Cluster_js_1.Attribute)(4, TlvBoolean_js_1.TlvBoolean, { default: true }),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.9.7 */
+    commands: {
+        /** Arms the persistent fail-safe timer with an expiry time of now + ExpiryLengthSeconds using device clock. */
+        armFailSafe: (0, Cluster_js_1.Command)(0, TlvArmFailSafeRequest, 1, TlvCommissioningSuccessFailureResponse),
+        /** Sets or Updates the regulatory configuration to be used during commissioning. */
+        setRegulatoryConfig: (0, Cluster_js_1.Command)(2, TlvSetRegulatoryConfigRequest, 3, TlvCommissioningSuccessFailureResponse),
+        /**
+         * Informs that all steps of Commissioning/Reconfiguration needed during the fail-safe period have been
+         * completed.
+         */
+        commissioningComplete: (0, Cluster_js_1.Command)(4, Cluster_js_1.TlvNoArguments, 5, TlvCommissioningSuccessFailureResponse),
+    },
+});