@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/esm/clusters/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/clusters/messages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,OAAO,EAAiB,KAAK,EAAiB,MAAM,uBAAuB,CAAC;AAMvH,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,QAAQ,CAAC;IACtB;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;WAMG;QACH,oBAAoB,yBAAyB;QAE7C;;;;;;;WAOG;QACH,oBAAoB,yBAAyB;QAE7C;;;;;;WAMG;QACH,iBAAiB,sBAAsB;QAEvC;;;;;;;WAOG;QACH,iBAAiB,sBAAsB;KAC1C;IAED;;;;;OAKG;IACH,KAAY,eAAe;QACvB;;WAEG;QACH,GAAG,IAAI;QAEP;;WAEG;QACH,MAAM,IAAI;QAEV;;WAEG;QACH,IAAI,IAAI;QAER;;WAEG;QACH,QAAQ,IAAI;KACf;IAED;;;;OAIG;IACI,MAAM,cAAc;QACvB;;;;;;;;WAQG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;;WAOG;;KAEN,CAAC;IAEF;;;;OAIG;IACI,MAAM,wBAAwB;QACjC;;;;WAIG;;QAGH;;;;WAIG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;;;OAIG;IACI,MAAM,UAAU;QACnB;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;WAIG;;YAvGH;;;;;;;;eAQG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;;QA2DH;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;WAUG;;YAlFH;;;;eAIG;;YAGH;;;;eAIG;;;;MA2EL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,OAAQ,SAAQ,cAAc,CAAC,OAAO,UAAU,CAAC;KAAG;IAErE;;;;OAIG;IACI,MAAM,yBAAyB;QAClC;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;WAIG;;YAhLH;;;;;;;;eAQG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;;QAoIH;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;WAUG;;YA3JH;;;;eAIG;;YAGH;;;;eAIG;;;MAkJL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,sBAAuB,SAAQ,cAAc,CAAC,OAAO,yBAAyB,CAAC;KAAG;IAEnG;;;;OAIG;IACI,MAAM,wBAAwB;QACjC;;;;;;;;;;WAUG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;;;OAIG;IACI,MAAM,qBAAqB;QAC9B;;;;WAIG;;;MAIL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;OAIG;IACI,MAAM,wBAAwB;QACjC;;;;WAIG;;;MAIL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;;;;OAKG;IACH,KAAY,uBAAuB;QAC/B;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,SAAS,IAAI;QAEb;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,UAAU,IAAI;QAEd;;WAEG;QACH,MAAM,IAAI;KACb;IAED;;;;OAIG;IACI,MAAM,uBAAuB;QAChC;;;;WAIG;;QAGH;;;;;WAKG;;QAGH;;;;;WAKG;;;;MAKL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,oBAAqB,SAAQ,cAAc,CAAC,OAAO,uBAAuB,CAAC;KAAG;IAE/F;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;;;YAKH;;;;;;;;eAQG;;gBAvVP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;mBAIG;;oBAvGH;;;;;;;;uBAQG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;;uBAOG;;;gBA2DH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;mBAUG;;oBAlFH;;;;uBAIG;;oBAGH;;;;uBAIG;;;;;YA2WC;;;;;;;;eAQG;;;;YASH;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;;gBA1TP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;mBAIG;;oBAhLH;;;;;;;;uBAQG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;;uBAOG;;;gBAoIH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;mBAUG;;oBA3JH;;;;uBAIG;;oBAGH;;;;uBAIG;;;;YAuZC;;eAEG;;gBAxPP;;;;;;;;;;mBAUG;;;;;YAmPC;;;;eAIG;;gBAtOP;;;;mBAIG;;;;YAqOC;;;;eAIG;;gBAtNP;;;;mBAIG;;;;YAqNC;;;;;eAKG;;gBAtKP;;;;mBAIG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;;;;;QAsJH;;WAEG;;;;;;;;;;;;;;KAKL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YA3IpB;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;;;YAKH;;;;;;;;eAQG;;gBAvVP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;mBAIG;;oBAvGH;;;;;;;;uBAQG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;;uBAOG;;;gBA2DH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;mBAUG;;oBAlFH;;;;uBAIG;;oBAGH;;;;uBAIG;;;;;YA2WC;;;;;;;;eAQG;;;;YASH;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;;gBA1TP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;mBAIG;;oBAhLH;;;;;;;;uBAQG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;;uBAOG;;;gBAoIH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;mBAUG;;oBA3JH;;;;uBAIG;;oBAGH;;;;uBAIG;;;;YAuZC;;eAEG;;gBAxPP;;;;;;;;;;mBAUG;;;;;YAmPC;;;;eAIG;;gBAtOP;;;;mBAIG;;;;YAqOC;;;;eAIG;;gBAtNP;;;;mBAIG;;;;YAqNC;;;;;eAKG;;gBAtKP;;;;mBAIG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;mBAKG;;;;;;QAsJH;;WAEG;;;;;;;;;;;;;;UAU4C,CAAC;IAEpD;;;;;;OAMG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;AAC/C,eAAO,MAAM,eAAe,kBAAmB,CAAC"}

package/dist/esm/clusters/messages.js

@@ -0,0 +1,401 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { FabricScopedAttribute, Attribute, Command, TlvNoResponse, Event, EventPriority } from "../cluster/Cluster.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvByteString, TlvString } from "../tlv/TlvString.js";
+import { TlvEnum, TlvUInt16, TlvBitmap, TlvEpochS, TlvUInt64, TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvFabricIndex } from "../datatype/FabricIndex.js";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+var Messages;
+((Messages2) => {
+  let Feature;
+  ((Feature2) => {
+    Feature2["ReceivedConfirmation"] = "ReceivedConfirmation";
+    Feature2["ConfirmationResponse"] = "ConfirmationResponse";
+    Feature2["ConfirmationReply"] = "ConfirmationReply";
+    Feature2["ProtectedMessages"] = "ProtectedMessages";
+  })(Feature = Messages2.Feature || (Messages2.Feature = {}));
+  let MessagePriority;
+  ((MessagePriority2) => {
+    MessagePriority2[MessagePriority2["Low"] = 0] = "Low";
+    MessagePriority2[MessagePriority2["Medium"] = 1] = "Medium";
+    MessagePriority2[MessagePriority2["High"] = 2] = "High";
+    MessagePriority2[MessagePriority2["Critical"] = 3] = "Critical";
+  })(MessagePriority = Messages2.MessagePriority || (Messages2.MessagePriority = {}));
+  Messages2.MessageControl = {
+    /**
+     * Message requires confirmation from user
+     *
+     * This bit shall indicate that the message originator requests a confirmation of receipt by the user. If
+     * 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
+     */
+    confirmationRequired: BitFlag(0),
+    /**
+     * Message requires response from user
+     *
+     * 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
+     */
+    responseRequired: BitFlag(1),
+    /**
+     * Message supports reply message from user
+     *
+     * 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
+     */
+    replyMessage: BitFlag(2),
+    /**
+     * Message has already been confirmed
+     *
+     * 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
+     */
+    messageConfirmed: BitFlag(3),
+    /**
+     * Message required PIN/password protection
+     *
+     * 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
+     */
+    messageProtected: BitFlag(4)
+  };
+  Messages2.TlvMessageResponseOption = TlvObject({
+    /**
+     * 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
+     */
+    messageResponseId: TlvField(0, 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
+     */
+    label: TlvField(1, TlvString.bound({ maxLength: 32 }))
+  });
+  Messages2.TlvMessage = TlvObject({
+    /**
+     * This field shall indicate a globally unique ID for this message.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.1
+     */
+    messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
+    /**
+     * This field shall indicate the priority level for this message.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.2
+     */
+    priority: TlvField(1, TlvEnum()),
+    /**
+     * This field shall indicate control information related to the message.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.3
+     */
+    messageControl: TlvField(2, TlvBitmap(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
+     */
+    startTime: TlvField(3, TlvNullable(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
+     */
+    duration: TlvField(4, TlvNullable(TlvUInt64)),
+    /**
+     * This field shall indicate a string containing the message to be presented.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.6
+     */
+    messageText: TlvField(5, TlvString.bound({ maxLength: 256 })),
+    /**
+     * This field shall indicate a list of potential responses to the message. The entries in this list shall have
+     * unique values of MessageResponseID.
+     *
+     * If the ResponseRequired bit is set on the message but this list is empty, the device shall provide a generic
+     * acknowledgement button, e.g. "OK".
+     *
+     * 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
+     */
+    responses: TlvOptionalField(6, TlvArray(Messages2.TlvMessageResponseOption, { maxLength: 4 })),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  Messages2.TlvPresentMessagesRequest = TlvObject({
+    /**
+     * This field shall indicate a globally unique ID for this message. See MessageID.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.1
+     */
+    messageId: TlvField(0, 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
+     */
+    priority: TlvField(1, TlvEnum()),
+    /**
+     * This field shall indicate control information related to the message. See MessageControl.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.3
+     */
+    messageControl: TlvField(2, TlvBitmap(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
+     */
+    startTime: TlvField(3, TlvNullable(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
+     */
+    duration: TlvField(4, TlvNullable(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
+     */
+    messageText: TlvField(5, TlvString.bound({ maxLength: 256 })),
+    /**
+     * This field shall indicate a list of potential responses to the message. The entries in this list shall have
+     * unique values of MessageResponseID.
+     *
+     * If the ResponseRequired bit is set on the message but this list is empty, the device shall provide a generic
+     * acknowledgement button, e.g. "OK".
+     *
+     * 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
+     */
+    responses: TlvOptionalField(6, TlvArray(Messages2.TlvMessageResponseOption, { maxLength: 4 }))
+  });
+  Messages2.TlvCancelMessagesRequest = TlvObject({
+    /**
+     * This field shall indicate the MessageIDs for the messages being cancelled.
+     *
+     * Cancelling a message shall cause it to be removed from Messages, cause its MessageID to be removed from
+     * ActiveMessageIDs and cause any active presentation of the message to cease.
+     *
+     * 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
+     */
+    messageIDs: TlvField(0, TlvArray(TlvByteString.bound({ length: 16 }), { maxLength: 8 }))
+  });
+  Messages2.TlvMessageQueuedEvent = TlvObject({
+    /**
+     * This field shall indicate the MessageID for newly added message.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1.1
+     */
+    messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  Messages2.TlvMessagePresentedEvent = TlvObject({
+    /**
+     * This field shall indicate the MessageID for the message being presented.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.2.1
+     */
+    messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  let FutureMessagePreference;
+  ((FutureMessagePreference2) => {
+    FutureMessagePreference2[FutureMessagePreference2["Allowed"] = 0] = "Allowed";
+    FutureMessagePreference2[FutureMessagePreference2["Increased"] = 1] = "Increased";
+    FutureMessagePreference2[FutureMessagePreference2["Reduced"] = 2] = "Reduced";
+    FutureMessagePreference2[FutureMessagePreference2["Disallowed"] = 3] = "Disallowed";
+    FutureMessagePreference2[FutureMessagePreference2["Banned"] = 4] = "Banned";
+  })(FutureMessagePreference = Messages2.FutureMessagePreference || (Messages2.FutureMessagePreference = {}));
+  Messages2.TlvMessageCompleteEvent = TlvObject({
+    /**
+     * This field shall indicate the MessageID for the message being confirmed.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.1
+     */
+    messageId: TlvField(0, 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
+     */
+    responseId: TlvOptionalField(1, TlvNullable(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
+     */
+    reply: TlvOptionalField(2, TlvNullable(TlvString.bound({ maxLength: 256 }))),
+    futureMessagesPreference: TlvField(3, TlvNullable(TlvEnum())),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  Messages2.Base = MutableCluster.Component({
+    id: 151,
+    name: "Messages",
+    revision: 3,
+    features: {
+      /**
+       * ReceivedConfirmation
+       *
+       * 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
+       */
+      receivedConfirmation: BitFlag(0),
+      /**
+       * ConfirmationResponse
+       *
+       * 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
+       */
+      confirmationResponse: BitFlag(1),
+      /**
+       * ConfirmationReply
+       *
+       * 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
+       */
+      confirmationReply: BitFlag(2),
+      /**
+       * ProtectedMessages
+       *
+       * 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
+       */
+      protectedMessages: BitFlag(3)
+    },
+    attributes: {
+      /**
+       * Indicates a list of queued messages.
+       *
+       * In addition to filtering based upon fabric, to preserve user privacy, the server may further limit the
+       * 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
+       */
+      messages: FabricScopedAttribute(0, TlvArray(Messages2.TlvMessage, { maxLength: 8 }), { default: [] }),
+      /**
+       * Indicates a list of the MessageIDs of the Messages currently being presented. If this list is empty, no
+       * messages are currently being presented.
+       *
+       * 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
+       */
+      activeMessageIDs: Attribute(
+        1,
+        TlvArray(TlvByteString.bound({ length: 16 }), { maxLength: 8 }),
+        { default: [] }
+      )
+    },
+    commands: {
+      /**
+       * Upon receipt, this shall cause the message in the passed fields to be appended to the Messages attribute.
+       *
+       * If appending the message would cause the number of messages to be greater than the capacity of the list,
+       * the device shall NOT append any message to Messages, and shall return a status code of
+       * RESOURCE_EXHAUSTED.
+       *
+       * When displaying a message in response to this command, an indication (ex. visual) of the origin node of
+       * the command shall be provided. This could be in the form of a friendly name label which uniquely
+       * identifies the node to the user. This friendly name label is typically assigned by the Matter Admin at
+       * the time of commissioning and, when it’s a device, is often editable by the user. It might be a
+       * combination of a company name and friendly name, for example, ”Acme” or “Acme Streaming Service on
+       * Alice’s Phone”.
+       *
+       * NOTE
+       *
+       * It is currently not specified where the friendly name label can be found on the node, meaning that
+       * clients SHOULD NOT rely on a certain method they happen to observe in a particular server instance,
+       * since other instances could employ a different method.
+       *
+       * 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
+       */
+      presentMessagesRequest: Command(0, Messages2.TlvPresentMessagesRequest, 0, TlvNoResponse),
+      /**
+       * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.2
+       */
+      cancelMessagesRequest: Command(1, Messages2.TlvCancelMessagesRequest, 1, TlvNoResponse)
+    },
+    events: {
+      /**
+       * This event shall be generated when a message is added to the messages attribute.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1
+       */
+      messageQueued: Event(0, 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
+       */
+      messagePresented: Event(1, 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
+       */
+      messageComplete: Event(2, EventPriority.Info, Messages2.TlvMessageCompleteEvent)
+    },
+    /**
+     * This metadata controls which MessagesCluster elements matter.js activates for specific feature combinations.
+     */
+    extensions: MutableCluster.Extensions(
+      { flags: { confirmationResponse: true, receivedConfirmation: false }, component: false },
+      { flags: { confirmationReply: true, receivedConfirmation: false }, component: false }
+    )
+  });
+  Messages2.ClusterInstance = MutableCluster(Messages2.Base);
+  Messages2.Cluster = Messages2.ClusterInstance;
+  Messages2.Complete = Messages2.Cluster;
+})(Messages || (Messages = {}));
+const MessagesCluster = Messages.Cluster;
+ClusterRegistry.register(Messages.Complete);
+export {
+  Messages,
+  MessagesCluster
+};
+//# sourceMappingURL=messages.js.map

package/dist/esm/clusters/messages.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/messages.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB,SAAS,uBAAuB,WAAW,SAAS,eAAe,OAAO,qBAAqB;AAC/F,SAAS,gBAAgB;AACzB,SAAS,UAAU,kBAAkB,iBAAiB;AACtD,SAAS,eAAe,iBAAiB;AACzC,SAAS,SAAS,WAAW,WAAW,WAAW,WAAW,iBAAiB;AAC/E,SAAS,mBAAmB;AAE5B,SAAS,sBAAsB;AAE/B,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,cAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AAQH,IAAAA,SAAA,0BAAuB;AAUvB,IAAAA,SAAA,0BAAuB;AASvB,IAAAA,SAAA,uBAAoB;AAUpB,IAAAA,SAAA,uBAAoB;AAAA,KArCZ,UAAAD,UAAA,YAAAA,UAAA;AA8CL,MAAK;AAAL,IAAKE,qBAAL;AAIH,IAAAA,kCAAA,SAAM,KAAN;AAKA,IAAAA,kCAAA,YAAS,KAAT;AAKA,IAAAA,kCAAA,UAAO,KAAP;AAKA,IAAAA,kCAAA,cAAW,KAAX;AAAA,KAnBQ,kBAAAF,UAAA,oBAAAA,UAAA;AA2BL,EAAMA,UAAA,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU1B,sBAAsB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU/B,kBAAkB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAS3B,cAAc,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUvB,kBAAkB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU3B,kBAAkB,QAAQ,CAAC;AAAA,EAC/B;AAOO,EAAMA,UAAA,2BAA2B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM9C,mBAAmB,SAAS,GAAG,UAAU,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO1D,OAAO,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EACzD,CAAC;AAcM,EAAMA,UAAA,aAAa,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMhC,WAAW,SAAS,GAAG,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO1D,UAAU,SAAS,GAAG,QAAyB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOhD,gBAAgB,SAAS,GAAG,UAAU,WAAWA,UAAA,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQhE,WAAW,SAAS,GAAG,YAAY,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ7C,UAAU,SAAS,GAAG,YAAY,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO5C,aAAa,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,IAAI,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAa5D,WAAW,iBAAiB,GAAG,SAASA,UAAA,0BAA0B,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,IAEnF,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAcM,EAAMA,UAAA,4BAA4B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM/C,WAAW,SAAS,GAAG,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO1D,UAAU,SAAS,GAAG,QAAyB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOhD,gBAAgB,SAAS,GAAG,UAAU,WAAWA,UAAA,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQhE,WAAW,SAAS,GAAG,YAAY,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ7C,UAAU,SAAS,GAAG,YAAY,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO5C,aAAa,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,IAAI,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAa5D,WAAW,iBAAiB,GAAG,SAASA,UAAA,0BAA0B,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,EACvF,CAAC;AAcM,EAAMA,UAAA,2BAA2B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAY9C,YAAY,SAAS,GAAG,SAAS,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,EAC3F,CAAC;AAcM,EAAMA,UAAA,wBAAwB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM3C,WAAW,SAAS,GAAG,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA,IAE1D,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAcM,EAAMA,UAAA,2BAA2B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM9C,WAAW,SAAS,GAAG,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA,IAE1D,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAeM,MAAK;AAAL,IAAKG,6BAAL;AAIH,IAAAA,kDAAA,aAAU,KAAV;AAKA,IAAAA,kDAAA,eAAY,KAAZ;AAKA,IAAAA,kDAAA,aAAU,KAAV;AAKA,IAAAA,kDAAA,gBAAa,KAAb;AAKA,IAAAA,kDAAA,YAAS,KAAT;AAAA,KAxBQ,0BAAAH,UAAA,4BAAAA,UAAA;AAgCL,EAAMA,UAAA,0BAA0B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM7C,WAAW,SAAS,GAAG,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ1D,YAAY,iBAAiB,GAAG,YAAY,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQtD,OAAO,iBAAiB,GAAG,YAAY,UAAU,MAAM,EAAE,WAAW,IAAI,CAAC,CAAC,CAAC;AAAA,IAE3E,0BAA0B,SAAS,GAAG,YAAY,QAAiC,CAAC,CAAC;AAAA,IACrF,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAYM,EAAMA,UAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,sBAAsB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAU/B,sBAAsB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAU/B,mBAAmB,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAU5B,mBAAmB,QAAQ,CAAC;AAAA,IAChC;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAUR,UAAU,sBAAsB,GAAK,SAASA,UAAA,YAAY,EAAE,WAAW,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAW5F,kBAAkB;AAAA,QACd;AAAA,QACA,SAAS,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC;AAAA,QAC9D,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA,IACJ;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MA0BN,wBAAwB,QAAQ,GAAKA,UAAA,2BAA2B,GAAK,aAAa;AAAA;AAAA;AAAA;AAAA,MAKlF,uBAAuB,QAAQ,GAAKA,UAAA,0BAA0B,GAAK,aAAa;AAAA,IACpF;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMJ,eAAe,MAAM,GAAK,cAAc,MAAMA,UAAA,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOnE,kBAAkB,MAAM,GAAK,cAAc,MAAMA,UAAA,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQzE,iBAAiB,MAAM,GAAK,cAAc,MAAMA,UAAA,uBAAuB;AAAA,IAC3E;AAAA;AAAA;AAAA;AAAA,IAKA,YAAY,eAAe;AAAA,MACvB,EAAE,OAAO,EAAE,sBAAsB,MAAM,sBAAsB,MAAM,GAAG,WAAW,MAAM;AAAA,MACvF,EAAE,OAAO,EAAE,mBAAmB,MAAM,sBAAsB,MAAM,GAAG,WAAW,MAAM;AAAA,IACxF;AAAA,EACJ,CAAC;AAKM,EAAMA,UAAA,kBAAkB,eAAeA,UAAA,IAAI;AAW3C,EAAMA,UAAA,UAAmBA,UAAA;AACzB,EAAMA,UAAA,WAAWA,UAAA;AAAA,GAjmBX;AAqmBV,MAAM,kBAAkB,SAAS;AACxC,gBAAgB,SAAS,SAAS,QAAQ;",
+  "names": ["Messages", "Feature", "MessagePriority", "FutureMessagePreference"]
+}