@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/dist/esm/clusters/operational-credentials.js

@@ -25,14 +25,14 @@ var OperationalCredentials;
      * This field shall contain the NOC for the struct’s associated fabric, encoded using Matter Certificate
      * Encoding.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.4.1
      */
     noc: TlvField(1, TlvByteString.bound({ maxLength: 400 })),
     /**
      * This field shall contain the ICAC or the struct’s associated fabric, encoded using Matter Certificate
      * Encoding. If no ICAC is present in the chain, this field shall be set to null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.4.2
      */
     icac: TlvField(2, TlvNullable(TlvByteString.bound({ maxLength: 400 }))),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -44,7 +44,7 @@ var OperationalCredentials;
      * for the key shall be the same as that used in the ec-pub-key field of the Matter Certificate Encoding for the
      * root in the operational certificate chain.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.5.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.5.1
      */
     rootPublicKey: TlvField(1, TlvByteString.bound({ length: 65 })),
     /**
@@ -57,7 +57,7 @@ var OperationalCredentials;
      * Clients shall consider the VendorID field value to be untrustworthy until the NOC chain associated with the
      * fabric has passed the Vendor ID Validation Procedure against the associated RCAC.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.5.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.5.2
      */
     vendorId: TlvField(2, TlvVendorId),
     /**
@@ -65,7 +65,7 @@ var OperationalCredentials;
      * match the value found in the matter-fabric-id field from the operational certificate providing the
      * operational identity under this Fabric.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.5.3
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.5.3
      */
     fabricId: TlvField(3, TlvFabricId),
     /**
@@ -73,14 +73,14 @@ var OperationalCredentials;
      * match the value found in the matter-node-id field from the operational certificate providing this operational
      * identity.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.5.4
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.5.4
      */
     nodeId: TlvField(4, TlvNodeId),
     /**
      * This field shall contain a commissioner-set label for the fabric referenced by FabricIndex. This label is set
      * by the UpdateFabricLabel command.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.4.5.5
+     * @see {@link MatterSpecification.v14.Core} § 11.18.4.5.5
      */
     label: TlvField(5, TlvString.bound({ maxLength: 32 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -90,14 +90,14 @@ var OperationalCredentials;
     /**
      * This field shall contain the octet string of the serialized attestation_elements_message.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.2.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.2.1
      */
     attestationElements: TlvField(0, TlvByteString.bound({ maxLength: 900 })),
     /**
      * This field shall contain the octet string of the necessary attestation_signature as described in Section
      * 11.18.4.7, “Attestation Information”.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.2.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.2.2
      */
     attestationSignature: TlvField(1, TlvByteString.bound({ length: 64 }))
   });
@@ -112,7 +112,7 @@ var OperationalCredentials;
      * This field shall be the DER encoded certificate corresponding to the CertificateType field in the
      * CertificateChainRequest command.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.4.1
      */
     certificate: TlvField(0, TlvByteString.bound({ maxLength: 600 }))
   });
@@ -124,14 +124,14 @@ var OperationalCredentials;
     /**
      * This field shall contain the octet string of the serialized nocsr_elements_message.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.6.1
      */
     nocsrElements: TlvField(0, TlvByteString.bound({ maxLength: 900 })),
     /**
      * This field shall contain the octet string of the necessary attestation_signature as described in Section
      * 11.18.4.9, “NOCSR Information”.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.6.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.6.2
      */
     attestationSignature: TlvField(1, TlvByteString.bound({ length: 64 }))
   });
@@ -150,7 +150,7 @@ var OperationalCredentials;
      * fabric as the accessing fabric and with the following argument fields (assuming KeySetWrite allowed a
      * GroupKeySetID set to 0):
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.8.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.8.1
      */
     ipkValue: TlvField(2, TlvByteString.bound({ length: 16 })),
     /**
@@ -171,7 +171,7 @@ var OperationalCredentials;
      * which need to eventually add an "Administer Node over CASE" Access Control Entry to finalize new Fabric
      * configuration and subsequently be able to call the CommissioningComplete command.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.8.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.8.2
      */
     caseAdminSubject: TlvField(3, TlvSubjectId),
     /**
@@ -263,7 +263,7 @@ var OperationalCredentials;
      * Thereafter, the Node shall respond with an NOCResponse with a StatusCode of OK and a FabricIndex field
      * matching the FabricIndex under which the new Node Operational Certificate (NOC) is scoped.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.8.3
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.8.3
      */
     adminVendorId: TlvField(4, TlvVendorId)
   });
@@ -284,14 +284,14 @@ var OperationalCredentials;
     /**
      * This field shall contain an NOCStatus value representing the status of an operation involving a NOC.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.10.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.10.1
      */
     statusCode: TlvField(0, TlvEnum()),
     /**
      * This field shall be present whenever StatusCode has a value of OK. If present, it shall contain the Fabric
      * Index of the Fabric last added, removed or updated.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.10.2
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.10.2
      */
     fabricIndex: TlvOptionalField(1, TlvFabricIndex),
     /**
@@ -299,7 +299,7 @@ var OperationalCredentials;
      * presented to user interfaces in any way. Its purpose is to help developers in troubleshooting errors and the
      * contents may go into logs or crash reports.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.10.3
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.10.3
      */
     debugText: TlvOptionalField(2, TlvString.bound({ maxLength: 128 }))
   });
@@ -326,7 +326,7 @@ var OperationalCredentials;
      * CommissioningComplete command. In other words, label updates apply to the state of the Fabrics Attribute as
      * currently visible, even for an existing fabric currently in process of being updated.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.11.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.11.1
      */
     label: TlvField(0, TlvString.bound({ maxLength: 32 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -373,7 +373,7 @@ var OperationalCredentials;
      *      involves the removal of the secure session data that may underpin the current set of exchanges, the Node
      *      invoking the command SHOULD NOT expect a response before terminating its secure session with the target.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.18.6.12.1
+     * @see {@link MatterSpecification.v14.Core} § 11.18.6.12.1
      */
     fabricIndex: TlvField(0, TlvFabricIndex)
   });
@@ -395,7 +395,7 @@ var OperationalCredentials;
        *
        * The number of entries in this list shall match the number of entries in the Fabrics attribute.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.1
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.1
        */
       nocs: FabricScopedAttribute(
         0,
@@ -416,14 +416,14 @@ var OperationalCredentials;
        *
        * The number of entries in this list shall match the number of entries in the NOCs attribute.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.2
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.2
        */
       fabrics: FabricScopedAttribute(1, TlvArray(OperationalCredentials2.TlvFabricDescriptor), { persistent: true, default: [] }),
       /**
        * This attribute contains the number of Fabrics that are supported by the device. This value is fixed for a
        * particular device.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.3
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.3
        */
       supportedFabrics: FixedAttribute(2, TlvUInt8.bound({ min: 5, max: 254 })),
       /**
@@ -436,7 +436,7 @@ var OperationalCredentials;
        *
        * Upon Factory Data Reset, this attribute shall be set to a default value of 0.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.4
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.4
        */
       commissionedFabrics: Attribute(3, TlvUInt8, { persistent: true }),
       /**
@@ -454,7 +454,7 @@ var OperationalCredentials;
        *
        * Upon Factory Data Reset, this attribute shall be set to a default value whereby the list is empty.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.5
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.5
        */
       trustedRootCertificates: Attribute(
         4,
@@ -468,7 +468,7 @@ var OperationalCredentials;
        * attribute reads, since a given Fabric may be referenced by a different Fabric Index locally on a remote
        * Node.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.5.6
+       * @see {@link MatterSpecification.v14.Core} § 11.18.5.6
        */
       currentFabricIndex: Attribute(5, TlvFabricIndex, { default: FabricIndex(0) })
     },
@@ -479,7 +479,7 @@ var OperationalCredentials;
        * recipient shall fail the command with a Status Code of INVALID_COMMAND. The AttestationNonce field shall
        * be used in the computation of the Attestation Information.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.1
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.1
        */
       attestationRequest: Command(
         0,
@@ -492,7 +492,7 @@ var OperationalCredentials;
        * If the CertificateType is not a valid value per CertificateChainTypeEnum then the command shall fail with
        * a Status Code of INVALID_COMMAND.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.3
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.3
        */
       certificateChainRequest: Command(
         2,
@@ -527,7 +527,7 @@ var OperationalCredentials;
        * found to collide with an existing key pair already previously generated and installed, and that check had
        * been executed, then this command shall fail with a FAILURE status code sent back to the initiator.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.5
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.5
        */
       csrRequest: Command(4, OperationalCredentials2.TlvCsrRequest, 5, OperationalCredentials2.TlvCsrResponse, { invokeAcl: AccessLevel.Administer }),
       /**
@@ -541,7 +541,7 @@ var OperationalCredentials;
        *
        * A Commissioner or Administrator SHOULD issue this command after performing the Attestation Procedure.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.8
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.8
        */
       addNoc: Command(6, OperationalCredentials2.TlvAddNocRequest, 8, OperationalCredentials2.TlvNocResponse, { invokeAcl: AccessLevel.Administer }),
       /**
@@ -599,7 +599,7 @@ var OperationalCredentials;
        * Thereafter, the Node shall respond with an NOCResponse with a StatusCode of OK and a FabricIndex field
        * matching the FabricIndex under which the updated NOC is scoped.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.9
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.9
        */
       updateNoc: Command(7, OperationalCredentials2.TlvUpdateNocRequest, 8, OperationalCredentials2.TlvNocResponse, { invokeAcl: AccessLevel.Administer }),
       /**
@@ -616,7 +616,7 @@ var OperationalCredentials;
        * by Administrators to provide additional per-fabric context when operations such as RemoveFabric are
        * considered or used.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.11
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.11
        */
       updateFabricLabel: Command(
         9,
@@ -644,7 +644,7 @@ var OperationalCredentials;
        * removal. Otherwise, users may only observe the removal of a Fabric association as persistently failing
        * attempts to reach a Node operationally.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.12
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.12
        */
       removeFabric: Command(
         10,
@@ -680,7 +680,7 @@ var OperationalCredentials;
        * Note that the only method of removing a trusted root is by removing the Fabric that uses it as its root
        * of trust using the RemoveFabric command.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.18.6.13
+       * @see {@link MatterSpecification.v14.Core} § 11.18.6.13
        */
       addTrustedRootCertificate: Command(
         11,