@matter/types 0.13.0-alpha.0-20250328-6dde053de → 0.13.0-alpha.0-20250330-df5a17eba

package/dist/cjs/clusters/messages.js

@@ -61,7 +61,7 @@ var Messages;
      * confirmation is required, the device SHOULD present the message until it is either confirmed by the user
      * selecting a confirmation option, or the message expires.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.1
      */
     confirmationRequired: (0, import_BitmapSchema.BitFlag)(0),
     /**
@@ -70,7 +70,7 @@ var Messages;
      * This bit shall indicate that a MessagePresented event SHOULD be generated based on the response of the user
      * to the message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.2
      */
     responseRequired: (0, import_BitmapSchema.BitFlag)(1),
     /**
@@ -78,7 +78,7 @@ var Messages;
      *
      * This bit shall indicate that a free-form user reply is to be included in the confirmation of receipt.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.3
      */
     replyMessage: (0, import_BitmapSchema.BitFlag)(2),
     /**
@@ -87,7 +87,7 @@ var Messages;
      * This bit shall indicate the current confirmation state of a message, which is useful in the event that there
      * are multiple Messages cluster client devices on a network.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.4
      */
     messageConfirmed: (0, import_BitmapSchema.BitFlag)(3),
     /**
@@ -96,7 +96,7 @@ var Messages;
      * This bit shall indicate that user authentication (e.g. by password or PIN) is required before viewing a
      * message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.5
      */
     messageProtected: (0, import_BitmapSchema.BitFlag)(4)
   };
@@ -104,13 +104,13 @@ var Messages;
     /**
      * This field shall indicate a unique unsigned 32-bit number identifier for this message response option.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.6.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.6.1
      */
     messageResponseId: (0, import_TlvObject.TlvField)(0, import_TlvNumber.TlvUInt32.bound({ min: 1 })),
     /**
      * This field shall indicate the text for this option; e.g. "Yes", "No", etc.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.6.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.6.2
      */
     label: (0, import_TlvObject.TlvField)(1, import_TlvString.TlvString.bound({ maxLength: 32 }))
   });
@@ -118,39 +118,39 @@ var Messages;
     /**
      * This field shall indicate a globally unique ID for this message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.1
      */
     messageId: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the priority level for this message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.2
      */
     priority: (0, import_TlvObject.TlvField)(1, (0, import_TlvNumber.TlvEnum)()),
     /**
      * This field shall indicate control information related to the message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.3
      */
     messageControl: (0, import_TlvObject.TlvField)(2, (0, import_TlvNumber.TlvBitmap)(import_TlvNumber.TlvUInt16, Messages2.MessageControl)),
     /**
      * This field shall indicate the time in UTC at which the message becomes available to be presented. A null
      * value shall indicate "now."
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.4
      */
     startTime: (0, import_TlvObject.TlvField)(3, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvEpochS)),
     /**
      * This field shall indicate the amount of time, in milliseconds, after the StartTime during which the message
      * is available to be presented. A null value shall indicate "until changed".
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.5
      */
     duration: (0, import_TlvObject.TlvField)(4, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvUInt64)),
     /**
      * This field shall indicate a string containing the message to be presented.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.6
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.6
      */
     messageText: (0, import_TlvObject.TlvField)(5, import_TlvString.TlvString.bound({ maxLength: 256 })),
     /**
@@ -162,7 +162,7 @@ var Messages;
      *
      * If the ResponseRequired bit is not set on the message, this list shall be ignored.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.7
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.7
      */
     responses: (0, import_TlvObject.TlvOptionalField)(6, (0, import_TlvArray.TlvArray)(Messages2.TlvMessageResponseOption, { maxLength: 4 })),
     fabricIndex: (0, import_TlvObject.TlvField)(254, import_FabricIndex.TlvFabricIndex)
@@ -171,39 +171,39 @@ var Messages;
     /**
      * This field shall indicate a globally unique ID for this message. See MessageID.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.1
      */
     messageId: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the priority level for this message. See Priority.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.2
      */
     priority: (0, import_TlvObject.TlvField)(1, (0, import_TlvNumber.TlvEnum)()),
     /**
      * This field shall indicate control information related to the message. See MessageControl.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.3
      */
     messageControl: (0, import_TlvObject.TlvField)(2, (0, import_TlvNumber.TlvBitmap)(import_TlvNumber.TlvUInt16, Messages2.MessageControl)),
     /**
      * This field shall indicate the time in UTC at which the message becomes available to be presented. A null
      * value shall indicate "now." See StartTime.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.4
      */
     startTime: (0, import_TlvObject.TlvField)(3, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvEpochS)),
     /**
      * This field shall indicate the amount of time, in milliseconds, after the StartTime during which the message
      * is available to be presented. A null value shall indicate "until changed". See Duration.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.5
      */
     duration: (0, import_TlvObject.TlvField)(4, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvUInt64)),
     /**
      * This field shall indicate a string containing the message to be presented. See MessageText.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.6
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.6
      */
     messageText: (0, import_TlvObject.TlvField)(5, import_TlvString.TlvString.bound({ maxLength: 256 })),
     /**
@@ -215,7 +215,7 @@ var Messages;
      *
      * If the ResponseRequired bit is not set on the message, this list shall be ignored. See Responses.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.7
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.7
      */
     responses: (0, import_TlvObject.TlvOptionalField)(6, (0, import_TlvArray.TlvArray)(Messages2.TlvMessageResponseOption, { maxLength: 4 }))
   });
@@ -229,7 +229,7 @@ var Messages;
      * Message IDs in this command that indicate messages that do not exist in Messages, or that are not scoped to
      * the fabric of the sender, shall be ignored.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.2.1
      */
     messageIDs: (0, import_TlvObject.TlvField)(0, (0, import_TlvArray.TlvArray)(import_TlvString.TlvByteString.bound({ length: 16 }), { maxLength: 8 }))
   });
@@ -237,7 +237,7 @@ var Messages;
     /**
      * This field shall indicate the MessageID for newly added message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.1.1
      */
     messageId: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ length: 16 })),
     fabricIndex: (0, import_TlvObject.TlvField)(254, import_FabricIndex.TlvFabricIndex)
@@ -246,7 +246,7 @@ var Messages;
     /**
      * This field shall indicate the MessageID for the message being presented.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.2.1
      */
     messageId: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ length: 16 })),
     fabricIndex: (0, import_TlvObject.TlvField)(254, import_FabricIndex.TlvFabricIndex)
@@ -263,21 +263,21 @@ var Messages;
     /**
      * This field shall indicate the MessageID for the message being confirmed.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.1
      */
     messageId: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the MessageResponseID selected by the user. If there was no response before the
      * Duration of the message has elapsed, this field shall be null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.2
      */
     responseId: (0, import_TlvObject.TlvOptionalField)(1, (0, import_TlvNullable.TlvNullable)(import_TlvNumber.TlvUInt32)),
     /**
      * This field shall indicate a user-provided reply to the message. If there was no reply, or the message did not
      * have the ReplyRequired bit set, this field shall be null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.3
      */
     reply: (0, import_TlvObject.TlvOptionalField)(2, (0, import_TlvNullable.TlvNullable)(import_TlvString.TlvString.bound({ maxLength: 256 }))),
     futureMessagesPreference: (0, import_TlvObject.TlvField)(3, (0, import_TlvNullable.TlvNullable)((0, import_TlvNumber.TlvEnum)())),
@@ -294,7 +294,7 @@ var Messages;
        * This feature shall indicate that the device can get confirmation from a user that the message was
        * received.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.1
        */
       receivedConfirmation: (0, import_BitmapSchema.BitFlag)(0),
       /**
@@ -303,7 +303,7 @@ var Messages;
        * This feature shall indicate that the device is capable of presenting a list of responses to the user and
        * recording the user’s choice of response.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.2
        */
       confirmationResponse: (0, import_BitmapSchema.BitFlag)(1),
       /**
@@ -312,7 +312,7 @@ var Messages;
        * This feature shall indicate that the device is capable of collecting a free-form text response to a
        * message.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.3
        */
       confirmationReply: (0, import_BitmapSchema.BitFlag)(2),
       /**
@@ -321,7 +321,7 @@ var Messages;
        * This feature shall indicate that the device is capable of requiring the user to authenticate before
        * viewing a message; e.g. entering a PIN or password before viewing a message with billing information.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.4
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.4
        */
       protectedMessages: (0, import_BitmapSchema.BitFlag)(3)
     },
@@ -333,7 +333,7 @@ var Messages;
        * set of messages returned in a read request. At minimum, the server shall return to a client those
        * messages that the client itself created/submitted.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.6.1
        */
       messages: (0, import_Cluster.FabricScopedAttribute)(0, (0, import_TlvArray.TlvArray)(Messages2.TlvMessage, { maxLength: 8 }), { default: [] }),
       /**
@@ -343,7 +343,7 @@ var Messages;
        * This list shall NOT be fabric-scoped; it shall contain MessageIDs for all Messages being presented, no
        * matter what fabric the client that queued them is on.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.6.2
        */
       activeMessageIDs: (0, import_Cluster.Attribute)(
         1,
@@ -375,11 +375,11 @@ var Messages;
        * The device SHOULD make it possible for the user to view which nodes have access to this cluster and to
        * individually remove privileges for each node.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1
        */
       presentMessagesRequest: (0, import_Cluster.Command)(0, Messages2.TlvPresentMessagesRequest, 0, import_Cluster.TlvNoResponse),
       /**
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.2
        */
       cancelMessagesRequest: (0, import_Cluster.Command)(1, Messages2.TlvCancelMessagesRequest, 1, import_Cluster.TlvNoResponse)
     },
@@ -387,20 +387,20 @@ var Messages;
       /**
        * This event shall be generated when a message is added to the messages attribute.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.1
        */
       messageQueued: (0, import_Cluster.Event)(0, import_Cluster.EventPriority.Info, Messages2.TlvMessageQueuedEvent),
       /**
        * This event shall be generated when the message is presented to the user.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.2
        */
       messagePresented: (0, import_Cluster.Event)(1, import_Cluster.EventPriority.Info, Messages2.TlvMessagePresentedEvent),
       /**
        * This event shall be generated when the message is confirmed by the user, or when the Duration of the
        * message has elapsed without confirmation.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3
        */
       messageComplete: (0, import_Cluster.Event)(2, import_Cluster.EventPriority.Info, Messages2.TlvMessageCompleteEvent)
     },