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

package/dist/esm/clusters/group-key-management.js

@@ -33,7 +33,7 @@ var GroupKeyManagement;
     /**
      * This field uniquely identifies the group within the scope of the given Fabric.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.3.1
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.3.1
      */
     groupId: TlvField(1, TlvGroupId),
     /**
@@ -42,7 +42,7 @@ var GroupKeyManagement;
      *
      * A GroupKeyMapStruct shall NOT accept GroupKeySetID of 0, which is reserved for the IPK.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.3.2
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.3.2
      */
     groupKeySetId: TlvField(2, TlvUInt16.bound({ min: 1 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -51,20 +51,20 @@ var GroupKeyManagement;
     /**
      * This field uniquely identifies the group within the scope of the given Fabric.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.1
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.5.1
      */
     groupId: TlvField(1, TlvGroupId),
     /**
      * This field provides the list of Endpoint IDs on the Node to which messages to this group shall be forwarded.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.2
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.5.2
      */
     endpoints: TlvField(2, TlvArray(TlvEndpointNumber, { minLength: 1 })),
     /**
      * This field provides a name for the group. This field shall contain the last GroupName written for a given
      * GroupId on any Endpoint via the Groups cluster.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.3
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.5.3
      */
     groupName: TlvOptionalField(3, TlvString.bound({ maxLength: 16 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -84,7 +84,7 @@ var GroupKeyManagement;
      * This field shall provide the fabric-unique index for the associated group key set, as specified in Section
      * 4.17.3.5.1, “Group Key Set ID”.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.1
      */
     groupKeySetId: TlvField(0, TlvUInt16),
     /**
@@ -93,49 +93,49 @@ var GroupKeyManagement;
      * When CacheAndSync is not supported in the FeatureMap of this cluster, any action attempting to set
      * CacheAndSync in the GroupKeySecurityPolicy field shall fail with an INVALID_COMMAND error.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.2
      */
     groupKeySecurityPolicy: TlvField(1, TlvEnum()),
     /**
      * This field, if not null, shall be the root credential used in the derivation of an operational group key for
      * epoch slot 0 of the given group key set. If EpochKey0 is not null, EpochStartTime0 shall NOT be null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.3
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.3
      */
     epochKey0: TlvField(2, TlvNullable(TlvByteString.bound({ length: 16 }))),
     /**
      * This field, if not null, shall define when EpochKey0 becomes valid as specified by Section 4.17.3, “Epoch
      * Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.4
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.4
      */
     epochStartTime0: TlvField(3, TlvNullable(TlvEpochUs)),
     /**
      * This field, if not null, shall be the root credential used in the derivation of an operational group key for
      * epoch slot 1 of the given group key set. If EpochKey1 is not null, EpochStartTime1 shall NOT be null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.5
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.5
      */
     epochKey1: TlvField(4, TlvNullable(TlvByteString.bound({ length: 16 }))),
     /**
      * This field, if not null, shall define when EpochKey1 becomes valid as specified by Section 4.17.3, “Epoch
      * Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.6
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.6
      */
     epochStartTime1: TlvField(5, TlvNullable(TlvEpochUs)),
     /**
      * This field, if not null, shall be the root credential used in the derivation of an operational group key for
      * epoch slot 2 of the given group key set. If EpochKey2 is not null, EpochStartTime2 shall NOT be null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.7
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.7
      */
     epochKey2: TlvField(6, TlvNullable(TlvByteString.bound({ length: 16 }))),
     /**
      * This field, if not null, shall define when EpochKey2 becomes valid as specified by Section 4.17.3, “Epoch
      * Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.8
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.8
      */
     epochStartTime2: TlvField(7, TlvNullable(TlvEpochUs)),
     /**
@@ -152,7 +152,7 @@ var GroupKeyManagement;
      * Support for GroupKeyMulticastPolicy is provisional. Correct default behavior is that implied by value
      * PerGroupID.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.5.4.9
+     * @see {@link MatterSpecification.v14.Core} § 11.2.5.4.9
      */
     groupKeyMulticastPolicy: TlvOptionalField(8, TlvEnum())
   });
@@ -167,7 +167,7 @@ var GroupKeyManagement;
      *
      * Each entry in GroupKeySetIDs is a GroupKeySetID field.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.2.7.6.1
+     * @see {@link MatterSpecification.v14.Core} § 11.2.7.6.1
      */
     groupKeySetIDs: TlvField(0, TlvArray(TlvUInt16))
   });
@@ -188,7 +188,7 @@ var GroupKeyManagement;
        * This attribute is a list of GroupKeyMapStruct entries. Each entry associates a logical Group Id with a
        * particular group key set.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.6.1
+       * @see {@link MatterSpecification.v14.Core} § 11.2.6.1
        */
       groupKeyMap: WritableFabricScopedAttribute(
         0,
@@ -206,7 +206,7 @@ var GroupKeyManagement;
        * RemoveGroup or RemoveAllGroups command causes the removal of a group mapping from its last mapped
        * endpoint, the entire GroupTable entry for that given GroupId shall be removed.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.6.2
+       * @see {@link MatterSpecification.v14.Core} § 11.2.6.2
        */
       groupTable: FabricScopedAttribute(1, TlvArray(GroupKeyManagement2.TlvGroupInfoMap), { default: [] }),
       /**
@@ -215,14 +215,14 @@ var GroupKeyManagement;
        * length of the GroupKeyMap and GroupTable list attributes shall NOT exceed the value of the
        * MaxGroupsPerFabric attribute multiplied by the number of supported fabrics.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.6.3
+       * @see {@link MatterSpecification.v14.Core} § 11.2.6.3
        */
       maxGroupsPerFabric: FixedAttribute(2, TlvUInt16, { default: 0 }),
       /**
        * Indicates the maximum number of group key sets this node supports per fabric. The value of this attribute
        * shall be set according to the minimum number of group key sets to support as specified in Group Limits.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.6.4
+       * @see {@link MatterSpecification.v14.Core} § 11.2.6.4
        */
       maxGroupKeysPerFabric: FixedAttribute(3, TlvUInt16.bound({ min: 1 }), { default: 1 })
     },
@@ -291,7 +291,7 @@ var GroupKeyManagement;
        *
        *   • Otherwise, this status code shall be set to FAILURE.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.7.1
+       * @see {@link MatterSpecification.v14.Core} § 11.2.7.1
        */
       keySetWrite: Command(0, GroupKeyManagement2.TlvKeySetWriteRequest, 0, TlvNoResponse, { invokeAcl: AccessLevel.Administer }),
       /**
@@ -306,7 +306,7 @@ var GroupKeyManagement;
        * Otherwise, if the GroupKeySetID does not refer to a Group Key Set associated with the accessing fabric,
        * then this command shall fail with a NOT_FOUND status code.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.7.2
+       * @see {@link MatterSpecification.v14.Core} § 11.2.7.2
        */
       keySetRead: Command(
         1,
@@ -335,7 +335,7 @@ var GroupKeyManagement;
        * This command shall send a SUCCESS status code back to the initiator on success, or NOT_FOUND if the
        * GroupKeySetID requested did not exist.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.7.4
+       * @see {@link MatterSpecification.v14.Core} § 11.2.7.4
        */
       keySetRemove: Command(
         3,
@@ -354,7 +354,7 @@ var GroupKeyManagement;
        * fabric and generate a KeySetReadAllIndicesResponse command containing the list of GroupKeySetID values
        * from those structs.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.2.7.5
+       * @see {@link MatterSpecification.v14.Core} § 11.2.7.5
        */
       keySetReadAllIndices: Command(
         4,