@project-chip/matter.js 0.2.0 → 0.3.0

package/dist/es/cluster/OnOffCluster.js

@@ -1,39 +1,50 @@
 /**
  * @license
- * Copyright 2022 Project CHIP Authors
+ * Copyright 2022-2023 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Attribute, Cluster, Command, TlvNoArguments, TlvNoResponse } from "./Cluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { Attribute, Cluster, Command, TlvNoResponse } from "./Cluster.js";
 /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
-// const TlvEffectVariant = TlvUInt8 as TlvSchema<DyingLightEffectVariant | DelayedAllOffEffectVariant>;
+/*
+const TlvEffectVariant = TlvUInt8 as TlvSchema<DyingLightEffectVariant | DelayedAllOffEffectVariant>;
+*/
 /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4 */
-/* const TlvOffWithEffectRequest = TlvObject({
+/*
+const TlvOffWithEffectRequest = TlvObject({
     effectIdentifier: TlvField(0, TlvEnum<OnOffEffectIdentifier>()),
     effectVariant: TlvField(1, TlvEffectVariant),
 }) as TlvSchema<
     { effectIdentifier: OnOffEffectIdentifier.DelayedAllOff, effectVariant: DelayedAllOffEffectVariant } |
     { effectIdentifier: OnOffEffectIdentifier.DyingLight, effectVariant: DyingLightEffectVariant }
-    >; */
+>;
+*/
 /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
-/* const TlvOnOffControlBitmap = TlvBitmap(TlvUInt8, {
-    acceptOnlyWhenOn: BitFlag(1),
-}) */
+/*
+const TlvOnOffControlBitmap = TlvBitmap(TlvUInt8, {
+    acceptOnlyWhenOn: BitFlag(0),
+});
+*/
 /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.6. */
-/* const TlvOnWithTimedOffRequest = TlvObject({
+/*
+const TlvOnWithTimedOffRequest = TlvObject({
     onOffControl: TlvField(0, TlvOnOffControlBitmap),
     onTime: TlvField(1, TlvNullable(TlvUInt8.bound({ min: 0, max: 254 }))),
     offWaitTime: TlvField(2, TlvNullable(TlvUInt8.bound({ min: 0, max: 254 }))),
-}); */
+});
+*/
 /**
  * Attributes and commands for switching devices between 'On' and 'Off' states.
  *
  * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5
  */
 export const OnOffCluster = Cluster({
+    // TODO create two cluster definitions ... One with set Lighting Flag and one without to make
+    //  Attributes and Comments correctly optional
     id: 0x06,
-    name: "On/Off",
+    name: "OnOff",
     revision: 4,
     features: {
         /** Level Control for Lighting - Behavior that supports lighting applications */
@@ -42,22 +53,30 @@ export const OnOffCluster = Cluster({
     /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.6 */
     attributes: {
         /** Indicates whether the device type implemented on the endpoint is turned off (false) or turned on (true). */
-        onOff: Attribute(0, TlvBoolean, { default: false }), /* reportable: true, scene:true */
+        onOff: Attribute(0, TlvBoolean, { persistent: true, default: false }), /* reportable: true, scene:true - Specs 1.0 wrong here, using chip XMLs*/
         // The following attributes are only needed for "Level Control for Lighting" support
-        /** Used to remember if a state is already storednin an old scene to not store one again when sending another Off command */
-        //globalSceneControl: OptionalAttribute(0x4000,  TlvBoolean, { default: true }),
         /**
+         * Mandatory Attribute when extended lightingLevelControl is used!
+         * Used to remember if a state is already stored in an old scene to not store one again when sending another Off command
+         */
+        //globalSceneControl: OptionalAttribute(0x4000, TlvBoolean, { default: true }),
+        /**
+         * Mandatory Attribute when extended lightingLevelControl is used!
          * Specifies the length of time (in 1/10ths second) that the ‘On’ state SHALL be maintained before
          * automatically transitioning to the ‘Off’ state when using the OnWithTimedOff command.
          */
-        //onTime: OptionalWritableAttribute(0x4001, TlvNullable(TlvUInt16)), { default: 0 }), /* unit: 1/10s */
+        //onTime: OptionalWritableAttribute(0x4001, TlvNullable(TlvUInt16), { default: 0 }), /* unit: 1/10s */
         /**
+         * Mandatory Attribute when extended lightingLevelControl is used!
          * Specifies the length of time (in 1/10ths second) that the ‘Off’ state SHALL be guarded to prevent
          * another OnWithTimedOff command turning the server back to its ‘On’ state
          */
         //offWaitTime: OptionalWritableAttribute(0x4002, TlvNullable(TlvUInt16), { default: 0 }), /* unit: 1/10s */
-        /** Defines the desired startup behavior of a device when it is supplied with power. */
-        //startUpOnOff: OptionalWritableAttribute(0x4003, TlvNullable(TlvEnum<StartUpOnOff>()), { writeAcl: AccessLevel.Manage }),
+        /**
+         * Mandatory Attribute when extended lightingLevelControl is used!
+         * Defines the desired startup behavior of a device when it is supplied with power.
+         */
+        //startUpOnOff: OptionalWritableAttribute(0x4003, TlvNullable(TlvEnum<StartUpOnOff>()), { persistent: true, writeAcl: AccessLevel.Manage }),
     },
     /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7 */
     commands: {
@@ -85,18 +104,21 @@ export const OnOffCluster = Cluster({
         // So we declare them option for now!
         // TODO: Split these out into a separate Cluster Spec that adds "Level Control for Lighting" support
         /**
+         * Mandatory Command when extended lightingLevelControl is used!
          * The OffWithEffect command allows devices to be turned off using enhanced ways of fading.
          */
-        //offWithEffect: OptionalCommand(0x40, OffWithEffectRequestT, 0x40, NoResponseT),
+        //offWithEffect: OptionalCommand(0x40, TlvOffWithEffectRequest, 0x40, TlvNoResponse),
         /**
+         * Mandatory Command when extended lightingLevelControl is used!
          * The OnWithRecallGlobalScene command allows the recall of the settings when the device was turned off.
          */
-        //onWithRecallGlobalScene: OptionalCommand(0x41, NoArgumentsT, 0x41, NoResponseT),
+        //onWithRecallGlobalScene: OptionalCommand(0x41, TlvNoArguments, 0x41, TlvNoResponse),
         /**
+         * Mandatory Command when extended lightingLevelControl is used!
          * The OnWithTimedOff command allows devices to be turned on for a specific duration with a guarded off
          * duration so that SHOULD the device be subsequently switched off, further OnWithTimedOff commands, received
          * during this time, are prevented from turning the devices back on.
          */
-        //onWithTimedOff: OptionalCommand(0x42, OnWithTimedOffRequestT, 0x42, NoResponseT),
+        //onWithTimedOff: OptionalCommand(0x42, TlvOnWithTimedOffRequest, 0x42, TlvNoResponse),
     },
 });

package/dist/es/cluster/OperationalCredentialsCluster.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command } from "./Cluster.js";
+import { FabricIndex } from "../datatype/FabricIndex.js";
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.1 */
+export declare const RESP_MAX = 900;
+/**
+ * Used by the CertificateChainRequest command to convey which certificate from the device attestation certificate
+ * chain to transmit back to the client.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.8 */
+export declare const enum CertificateChainType {
+    /** Request the DER- encoded DAC certificate */
+    DeviceAttestation = 1,
+    /** Request the DER- encoded PAI certificate */
+    ProductAttestationIntermediate = 2
+}
+/**
+ * Used by the NOCResponse datatype response command to convey detailed outcome of several of this cluster’s operations.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.9 */
+export declare const enum OperationalCertStatus {
+    /** OK, no error. */
+    Success = 0,
+    /** Public Key in the NOC does not match the public key in the NOCSR. */
+    InvalidPublicKey = 1,
+    /** The Node Operational ID in the NOC is not formatted correctly. */
+    InvalidNodeOpId = 2,
+    /** Any other validation error in NOC chain. */
+    InvalidOperationalCert = 3,
+    /** No record of prior CSR for which this NOC could match. */
+    MissingCsr = 4,
+    /** NOCs table full, cannot add another one. */
+    TableFull = 5,
+    /** Invalid CaseAdminSubject field for an AddNOC command. */
+    InvalidAdminSubject = 6,
+    /** Trying to AddNOC instead of UpdateNOC against an existing Fabric. */
+    FabricConflict = 9,
+    /** Label already exists on another Fabric. */
+    LabelConflict = 10,
+    /** FabricIndex argument is invalid. */
+    InvalidFabricIndex = 11
+}
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.4 */
+export declare const TlvAttestation: import("../tlv/TlvObject.js").ObjectSchema<{
+    declaration: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    attestationNonce: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    timestamp: import("../tlv/TlvObject.js").FieldType<number>;
+    firmwareInfo: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+}>;
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.6 */
+export declare const TlvCertSigningRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+    certSigningRequest: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    certSigningRequestNonce: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    vendorReserved1: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+    vendorReserved2: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+    vendorReserved3: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+}>;
+/**
+ * This cluster is used to add or remove Operational Credentials on a Commissionee or Node, as well as manage the
+ * associated Fabrics.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17
+ */
+export declare const OperationalCredentialsCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, {
+    nocs: Attribute<{
+        noc: Uint8Array;
+        icac: Uint8Array | null;
+    }[]>;
+    fabrics: Attribute<{
+        fabricId: import("../datatype/FabricId.js").FabricId;
+        nodeId: import("../datatype/NodeId.js").NodeId;
+        vendorId: import("../datatype/VendorId.js").VendorId;
+        fabricIndex: FabricIndex;
+        rootPublicKey: Uint8Array;
+        label: string;
+    }[]>;
+    supportedFabrics: Attribute<number>;
+    commissionedFabrics: Attribute<number>;
+    trustedRootCertificates: Attribute<Uint8Array[]>;
+    currentFabricIndex: Attribute<FabricIndex>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, {
+    /** Sender is requesting attestation information from the receiver. */
+    requestAttestation: Command<{
+        attestationNonce: Uint8Array;
+    }, {
+        signature: Uint8Array;
+        elements: Uint8Array;
+    }>;
+    /** Sender is requesting a device attestation certificate from the receiver. */
+    requestCertChain: Command<{
+        type: CertificateChainType;
+    }, {
+        certificate: Uint8Array;
+    }>;
+    /** Sender is requesting a certificate signing request (CSR) from the receiver. */
+    requestCertSigning: Command<{
+        certSigningRequestNonce: Uint8Array;
+        isForUpdateNOC?: boolean | undefined;
+    }, {
+        signature: Uint8Array;
+        elements: Uint8Array;
+    }>;
+    /** Sender is requesting to add the new node operational certificates. */
+    addOperationalCert: Command<{
+        identityProtectionKey: Uint8Array;
+        operationalCert: Uint8Array;
+        adminVendorId: import("../datatype/VendorId.js").VendorId;
+        caseAdminNode: import("../datatype/NodeId.js").NodeId;
+        intermediateCaCert?: Uint8Array | undefined;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /** Sender is requesting to update the node operational certificates. */
+    updateOperationalCert: Command<{
+        operationalCert: Uint8Array;
+        intermediateCaCert?: Uint8Array | undefined;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command SHALL be used by an Administrative Node to set the user-visible Label field for a given
+     * Fabric, as reflected by entries in the Fabrics attribute.
+     */
+    updateFabricLabel: Command<{
+        label: string;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command is used by Administrative Nodes to remove a given fabric index and delete all associated
+     * fabric-scoped data.
+     */
+    removeFabric: Command<{
+        fabricIndex: FabricIndex;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command SHALL add a Trusted Root CA Certificate, provided as its CHIP Certificate representation.
+     */
+    addRootCert: Command<{
+        certificate: Uint8Array;
+    }, void>;
+}, import("./Cluster.js").Events>;
+//# sourceMappingURL=OperationalCredentialsCluster.d.ts.map

package/dist/es/cluster/OperationalCredentialsCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationalCredentialsCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/OperationalCredentialsCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAe,SAAS,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,cAAc,CAAC;AAMvF,OAAO,EAAE,WAAW,EAAkB,MAAM,4BAA4B,CAAC;AAUzE,2DAA2D;AAC3D,eAAO,MAAM,QAAQ,MAAM,CAAC;AAwC5B;;;;0DAI0D;AAC1D,0BAAkB,oBAAoB;IAClC,+CAA+C;IAC/C,iBAAiB,IAAI;IAErB,+CAA+C;IAC/C,8BAA8B,IAAI;CACrC;AAuFD;;;0DAG0D;AAC1D,0BAAkB,qBAAqB;IACnC,oBAAoB;IACpB,OAAO,IAAO;IAEd,wEAAwE;IACxE,gBAAgB,IAAO;IAEvB,qEAAqE;IACrE,eAAe,IAAO;IAEtB,+CAA+C;IAC/C,sBAAsB,IAAO;IAE7B,6DAA6D;IAC7D,UAAU,IAAO;IAEjB,+CAA+C;IAC/C,SAAS,IAAO;IAEhB,4DAA4D;IAC5D,mBAAmB,IAAO;IAE1B,wEAAwE;IACxE,cAAc,IAAO;IAErB,8CAA8C;IAC9C,aAAa,KAAO;IAEpB,uCAAuC;IACvC,kBAAkB,KAAO;CAC5B;AAcD,2DAA2D;AAC3D,eAAO,MAAM,cAAc;;;;;EAKzB,CAAC;AAEH,2DAA2D;AAC3D,eAAO,MAAM,qBAAqB;;;;;;EAMhC,CAAC;AAcH;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;IA4BlC,sEAAsE;;;;;;;IAGtE,+EAA+E;;;;;;IAG/E,kFAAkF;;;;;;;;IAGlF,yEAAyE;;;;;;;;;;;;IAGzE,wEAAwE;;;;;;;;;IAGxE;;;OAGG;;;;;;;;IAGH;;;OAGG;;;;;;;;IAGH;;OAEG;;;;iCAGT,CAAC"}

package/dist/es/cluster/OperationalCredentialsCluster.js

@@ -1,20 +1,21 @@
 /**
  * @license
- * Copyright 2022 Project CHIP Authors
+ * Copyright 2022-2023 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { TlvVendorId } from "../common/VendorId.js";
-import { TlvNodeId } from "../common/NodeId.js";
-import { TlvSubjectId } from "../common/SubjectId.js";
-import { TlvFabricId } from "../common/FabricId.js";
-import { TlvFabricIndex } from "../common/FabricIndex.js";
 import { Attribute, Cluster, Command, TlvNoResponse } from "./Cluster.js";
 import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
 import { TlvByteString, TlvString, TlvString32max } from "../tlv/TlvString.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TlvFabricId } from "../datatype/FabricId.js";
+import { TlvNodeId } from "../datatype/NodeId.js";
+import { FabricIndex, TlvFabricIndex } from "../datatype/FabricIndex.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
 import { TlvBoolean } from "../tlv/TlvBoolean.js";
 import { TlvEnum, TlvUInt32, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvSubjectId } from "../datatype/SubjectId.js";
 import { TlvArray } from "../tlv/TlvArray.js";
+// TODO: Rename to NodeOperationalCredentialsCluster to match with specs
 /** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.1 */
 export const RESP_MAX = 900;
 /**
@@ -28,11 +29,13 @@ const TlvFabricDescriptor = TlvObject({
     /** Contains the value of AdminVendorID provided in the AddNOC command that led to the creation of this FabricDescriptorStruct. */
     vendorId: TlvField(2, TlvVendorId),
     /** Contains the FabricID allocated to the fabric referenced by FabricIndex. */
-    fabricID: TlvField(3, TlvFabricId),
+    fabricId: TlvField(3, TlvFabricId),
     /** Contain the NodeID in use within the fabric referenced by FabricIndex. */
-    nodeID: TlvField(4, TlvNodeId),
+    nodeId: TlvField(4, TlvNodeId),
     /** Contains a commissioner-set label for the fabric referenced by FabricIndex. */
-    label: TlvField(5, TlvString.bound({ maxLength: 32 })), /* default: "" */
+    label: TlvField(5, TlvString.bound({ maxLength: 32 })),
+    // TODO: this data is scoped in the fabric context and should be marked as such
+    fabricIndex: TlvField(0xfe, TlvFabricIndex),
 });
 /**
  * Encodes a fabric sensitive NOC chain, underpinning a commissioned Operational Identity for a given Node.
@@ -42,8 +45,8 @@ const TlvFabricDescriptor = TlvObject({
 const TlvNoc = TlvObject({
     /** Contains the NOC for the struct’s associated fabric. */
     noc: TlvField(1, TlvByteString.bound({ maxLength: 400 })),
-    /** Contain the ICAC or the struct’s associated fabric. */
-    icac: TlvField(2, TlvNullable(TlvByteString.bound({ maxLength: 400 }))), /* default(not present): null */
+    /** Contains the ICAC or the struct’s associated fabric. */
+    icac: TlvField(2, TlvNullable(TlvByteString.bound({ maxLength: 400 }))), /* default(not present): null, fabricSensitive: true */
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.1 */
 const TlvAttestationRequest = TlvObject({
@@ -54,7 +57,7 @@ const TlvAttestationRequest = TlvObject({
 const TlvAttestationResponse = TlvObject({
     /** Contains the octet string of the serialized attestation_elements_message. */
     elements: TlvField(0, TlvByteString.bound({ maxLength: RESP_MAX })),
-    /** Contain the octet string of the necessary attestation_signature. */
+    /** Contains the octet string of the necessary attestation_signature. */
     signature: TlvField(1, TlvByteString.bound({ length: 64 })),
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.5 */
@@ -72,7 +75,7 @@ const TlvCertSigningRequestRequest = TlvObject({
 const TlvCertSigningRequestResponse = TlvObject({
     /** Contains the octet string of the serialized nocsr_elements_message. */
     elements: TlvField(0, TlvByteString.bound({ maxLength: RESP_MAX })),
-    /** Contain the octet string of the necessary attestation_signature. */
+    /** Contains the octet string of the necessary attestation_signature. */
     signature: TlvField(1, TlvByteString.bound({ length: 64 })),
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.3 */
@@ -155,22 +158,22 @@ const TlvRemoveFabricRequest = TlvObject({
  */
 export const OperationalCredentialsCluster = Cluster({
     id: 0x3e,
-    name: "Operational Credentials",
+    name: "OperationalCredentials",
     revision: 1,
     /** @see {@link MatterCoreSpecificationV1_0} § 11.17.6 */
     attributes: {
         /** Contains all NOCs applicable to this Node. */
-        nocs: Attribute(0, TlvArray(TlvNoc), { readAcl: 2 /* AccessLevel.Administer */ }),
+        nocs: Attribute(0, TlvArray(TlvNoc), { persistent: true, omitChanges: true, readAcl: 2 /* AccessLevel.Administer */ }),
         /** Describes all fabrics to which this Node is commissioned. */
-        fabrics: Attribute(1, TlvArray(TlvFabricDescriptor)),
+        fabrics: Attribute(1, TlvArray(TlvFabricDescriptor), { persistent: true }),
         /** Contains the number of Fabrics that are supported by the device. */
         supportedFabrics: Attribute(2, TlvUInt8.bound({ min: 5, max: 254 })),
         /** Contains the number of Fabrics to which the device is currently commissioned. */
-        commissionedFabrics: Attribute(3, TlvUInt8),
+        commissionedFabrics: Attribute(3, TlvUInt8, { persistent: true }),
         /** Contains a read-only list of Trusted Root CA Certificates installed on the Node. */
-        trustedRootCertificates: Attribute(4, TlvArray(TlvByteString, { maxLength: 400 })),
-        /** Contain accessing fabric index. */
-        currentFabricIndex: Attribute(5, TlvUInt8),
+        trustedRootCertificates: Attribute(4, TlvArray(TlvByteString, { maxLength: 400 }), { persistent: true, omitChanges: true }),
+        /** Contains accessing fabric index. */
+        currentFabricIndex: Attribute(5, TlvFabricIndex, { default: new FabricIndex(0) }),
     },
     /** @see {@link MatterCoreSpecificationV1_0} § 11.17.7 */
     commands: {