@matter/types 0.14.0-alpha.0-20250531-7ed2d6da8 → 0.14.0-alpha.0-20250602-37f27bb02

package/src/clusters/diagnostic-logs.ts

@@ -12,12 +12,14 @@ import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
 import { TlvEnum, TlvEpochUs, TlvSysTimeUs } from "../tlv/TlvNumber.js";
 import { TlvString, TlvByteString } from "../tlv/TlvString.js";
 import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { StatusResponseError } from "../common/StatusResponseError.js";
+import { Status as GlobalStatus } from "../globals/Status.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
 export namespace DiagnosticLogs {
     /**
-     * @see {@link MatterSpecification.v14.Core} § 11.11.4.1
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.1
      */
     export enum Intent {
         /**
@@ -26,7 +28,7 @@ export namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to retrieve logs for the intention of providing support
          * to an end-user.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.1
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.1.1
          */
         EndUserSupport = 0,
 
@@ -36,7 +38,7 @@ export namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to diagnose the network(s) for which the Node is
          * currently commissioned (and/or connected) or has previously been commissioned (and/or connected).
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.2
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.1.2
          */
         NetworkDiag = 1,
 
@@ -46,13 +48,13 @@ export namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to retrieve any crash logs that may be present on a
          * Node.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.3
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.1.3
          */
         CrashLogs = 2
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Core} § 11.11.4.3
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.3
      */
     export enum TransferProtocol {
         /**
@@ -60,7 +62,7 @@ export namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using the LogContent attribute of the response
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.3.1
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.3.1
          */
         ResponsePayload = 0,
 
@@ -69,7 +71,7 @@ export namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using BDX as defined in BDX Protocol
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.3.2
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.3.2
          */
         Bdx = 1
     }
@@ -77,14 +79,14 @@ export namespace DiagnosticLogs {
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
      */
     export const TlvRetrieveLogsRequest = TlvObject({
         /**
          * This field shall indicate why the diagnostic logs are being retrieved from the Node. A Node may utilize this
          * field to selectively determine the logs to transfer.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.1
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.1.1
          */
         intent: TlvField(0, TlvEnum<Intent>()),
 
@@ -95,7 +97,7 @@ export namespace DiagnosticLogs {
          * TransferProtocolEnum of ResponsePayload. If this field is set to ResponsePayload the receiving Node shall
          * only utilize the LogContent field of the RetrieveLogsResponse command to transfer diagnostic log information.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.2
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.1.2
          */
         requestedProtocol: TlvField(1, TlvEnum<TransferProtocol>()),
 
@@ -131,7 +133,7 @@ export namespace DiagnosticLogs {
          * If the Intent and/or the RequestedProtocol arguments contain invalid (out of range) values the command shall
          * fail with a Status Code of INVALID_COMMAND.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.3
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.1.3
          */
         transferFileDesignator: TlvOptionalField(2, TlvString.bound({ maxLength: 32 }))
     });
@@ -139,12 +141,12 @@ export namespace DiagnosticLogs {
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
      */
     export interface RetrieveLogsRequest extends TypeFromSchema<typeof TlvRetrieveLogsRequest> {}
 
     /**
-     * @see {@link MatterSpecification.v14.Core} § 11.11.4.2
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2
      */
     export enum Status {
         /**
@@ -152,7 +154,7 @@ export namespace DiagnosticLogs {
          *
          * shall be used if diagnostic logs will be or are being transferred.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.1
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.1
          */
         Success = 0,
 
@@ -162,7 +164,7 @@ export namespace DiagnosticLogs {
          * shall be used when a BDX session is requested, however, all available logs were provided in a LogContent
          * field.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.2
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.2
          */
         Exhausted = 1,
 
@@ -172,7 +174,7 @@ export namespace DiagnosticLogs {
          * shall be used if the Node does not currently have any diagnostic logs of the requested type (Intent) to
          * transfer.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.3
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.3
          */
         NoLogs = 2,
 
@@ -182,7 +184,7 @@ export namespace DiagnosticLogs {
          * shall be used if the Node is unable to handle the request (e.g. in the process of another transfer) and the
          * Client SHOULD re-attempt the request later.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.4
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.4
          */
         Busy = 3,
 
@@ -191,22 +193,82 @@ export namespace DiagnosticLogs {
          *
          * shall be used if the Node is denying the current transfer of diagnostic logs for any reason.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.5
+         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.5
          */
         Denied = 4
     }
 
+    /**
+     * Thrown for cluster status code {@link Status.Exhausted}.
+     *
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.2
+     */
+    export class ExhaustedError extends StatusResponseError {
+        constructor(
+            message = "All logs has been transferred",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.Exhausted
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
+    /**
+     * Thrown for cluster status code {@link Status.NoLogs}.
+     *
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.3
+     */
+    export class NoLogsError extends StatusResponseError {
+        constructor(
+            message = "No logs of the requested type available",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.NoLogs
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
+    /**
+     * Thrown for cluster status code {@link Status.Busy}.
+     *
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.4
+     */
+    export class BusyError extends StatusResponseError {
+        constructor(
+            message = "Unable to handle request, retry later",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.Busy
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
+    /**
+     * Thrown for cluster status code {@link Status.Denied}.
+     *
+     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.5
+     */
+    export class DeniedError extends StatusResponseError {
+        constructor(
+            message = "The request is denied, no logs being transferred",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.Denied
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
     /**
      * This shall be generated as a response to the RetrieveLogsRequest. The data for this command is shown in the
      * following.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v141.Core} § 11.11.5.2
      */
     export const TlvRetrieveLogsResponse = TlvObject({
         /**
          * This field shall indicate the result of an attempt to retrieve diagnostic logs.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.1
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.1
          */
         status: TlvField(0, TlvEnum<Status>()),
 
@@ -215,7 +277,7 @@ export namespace DiagnosticLogs {
          * SHOULD utilize this field to transfer the newest diagnostic log entries. This field shall be empty if BDX is
          * requested and the Status field has a value of Success.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.2
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.2
          */
         logContent: TlvField(1, TlvByteString.bound({ maxLength: 1024 })),
 
@@ -224,7 +286,7 @@ export namespace DiagnosticLogs {
          * maintains a wall clock. When included, the UTCTimeStamp field shall contain the value of the oldest log entry
          * in the diagnostic logs that are being transferred.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.3
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.3
          */
         utcTimeStamp: TlvOptionalField(2, TlvEpochUs),
 
@@ -233,7 +295,7 @@ export namespace DiagnosticLogs {
          * TimeSinceBoot field shall contain the time of the oldest log entry in the diagnostic logs that are being
          * transferred represented by the number of microseconds since the last time the Node went through a reboot.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.4
+         * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.4
          */
         timeSinceBoot: TlvOptionalField(3, TlvSysTimeUs)
     });
@@ -242,7 +304,7 @@ export namespace DiagnosticLogs {
      * This shall be generated as a response to the RetrieveLogsRequest. The data for this command is shown in the
      * following.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v141.Core} § 11.11.5.2
      */
     export interface RetrieveLogsResponse extends TypeFromSchema<typeof TlvRetrieveLogsResponse> {}
 
@@ -258,7 +320,7 @@ export namespace DiagnosticLogs {
             /**
              * Reception of this command starts the process of retrieving diagnostic logs from a Node.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.11.5.1
+             * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
              */
             retrieveLogsRequest: Command(0x0, TlvRetrieveLogsRequest, 0x1, TlvRetrieveLogsResponse)
         }
@@ -271,7 +333,7 @@ export namespace DiagnosticLogs {
      * once for the Node. The Node SHOULD also implement the BDX Initiator and BDX Sender roles as defined in the BDX
      * Protocol.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.11
+     * @see {@link MatterSpecification.v141.Core} § 11.11
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/dishwasher-alarm.ts

@@ -27,7 +27,7 @@ export namespace DishwasherAlarm {
     /**
      * These are optional features supported by DishwasherAlarmCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.4
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.4
      */
     export enum Feature {
         /**
@@ -35,13 +35,13 @@ export namespace DishwasherAlarm {
          *
          * This feature indicates that alarms can be reset via the Reset command.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.4.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.4.1
          */
         Reset = "Reset"
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 8.4.4.1
+     * @see {@link MatterSpecification.v141.Cluster} § 8.4.4.1
      */
     export const Alarm = {
         /**
@@ -78,7 +78,7 @@ export namespace DishwasherAlarm {
     /**
      * Input to the DishwasherAlarm reset command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.1
      */
     export const TlvResetRequest = TlvObject({
         /**
@@ -87,7 +87,7 @@ export namespace DishwasherAlarm {
          * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
          * status code shall be FAILURE.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.1.1
          */
         alarms: TlvField(0, TlvBitmap(TlvUInt32, Alarm))
     });
@@ -95,14 +95,14 @@ export namespace DishwasherAlarm {
     /**
      * Input to the DishwasherAlarm reset command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.1
      */
     export interface ResetRequest extends TypeFromSchema<typeof TlvResetRequest> {}
 
     /**
      * Input to the DishwasherAlarm modifyEnabledAlarms command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.2
      */
     export const TlvModifyEnabledAlarmsRequest = TlvObject({
         /**
@@ -124,7 +124,7 @@ export namespace DishwasherAlarm {
          * field from this command. After that the server shall also update the value of its State attribute to reflect
          * the status of the new alarm set as indicated by the new value of the Mask attribute.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.2.1
          */
         mask: TlvField(0, TlvBitmap(TlvUInt32, Alarm))
     });
@@ -132,27 +132,27 @@ export namespace DishwasherAlarm {
     /**
      * Input to the DishwasherAlarm modifyEnabledAlarms command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.2
      */
     export interface ModifyEnabledAlarmsRequest extends TypeFromSchema<typeof TlvModifyEnabledAlarmsRequest> {}
 
     /**
      * Body of the DishwasherAlarm notify event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1
      */
     export const TlvNotifyEvent = TlvObject({
         /**
          * This field shall indicate those alarms that have become active.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1.1
          */
         active: TlvField(0, TlvBitmap(TlvUInt32, Alarm)),
 
         /**
          * This field shall indicate those alarms that have become inactive.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1.2
          */
         inactive: TlvField(1, TlvBitmap(TlvUInt32, Alarm)),
 
@@ -160,14 +160,14 @@ export namespace DishwasherAlarm {
          * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
          * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.4
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1.4
          */
         state: TlvField(2, TlvBitmap(TlvUInt32, Alarm)),
 
         /**
          * This field shall be a copy of the Mask attribute when this event was generated.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1.3
+         * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1.3
          */
         mask: TlvField(3, TlvBitmap(TlvUInt32, Alarm))
     });
@@ -175,7 +175,7 @@ export namespace DishwasherAlarm {
     /**
      * Body of the DishwasherAlarm notify event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1
      */
     export interface NotifyEvent extends TypeFromSchema<typeof TlvNotifyEvent> {}
 
@@ -189,7 +189,7 @@ export namespace DishwasherAlarm {
              * will be latched when set, and will not reset to inactive when the underlying condition which caused the
              * alarm is no longer present, and so requires an explicit reset using the Reset command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.2
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.6.2
              */
             latch: FixedAttribute(0x1, TlvBitmap(TlvUInt32, Alarm))
         },
@@ -199,7 +199,7 @@ export namespace DishwasherAlarm {
              * This command resets active and latched alarms (if possible). Any generated Notify event shall contain
              * fields that represent the state of the server after the command has been processed.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.1
              */
             reset: Command(0x0, TlvResetRequest, 0x0, TlvNoResponse)
         }
@@ -217,7 +217,7 @@ export namespace DishwasherAlarm {
             /**
              * This feature indicates that alarms can be reset via the Reset command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.4.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.4.1
              */
             reset: BitFlag(0)
         },
@@ -227,7 +227,7 @@ export namespace DishwasherAlarm {
              * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be
              * enabled.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.6.1
              */
             mask: Attribute(0x0, TlvBitmap(TlvUInt32, Alarm)),
 
@@ -235,7 +235,7 @@ export namespace DishwasherAlarm {
              * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
              * alarm is active, otherwise the alarm is inactive.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.3
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.6.3
              */
             state: Attribute(0x2, TlvBitmap(TlvUInt32, Alarm)),
 
@@ -245,7 +245,7 @@ export namespace DishwasherAlarm {
              *
              * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.6.4
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.6.4
              */
             supported: FixedAttribute(0x3, TlvBitmap(TlvUInt32, Alarm))
         },
@@ -254,7 +254,7 @@ export namespace DishwasherAlarm {
             /**
              * This command allows a client to request that an alarm be enabled or suppressed at the server.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.7.2
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.7.2
              */
             modifyEnabledAlarms: OptionalCommand(0x1, TlvModifyEnabledAlarmsRequest, 0x1, TlvNoResponse)
         },
@@ -263,7 +263,7 @@ export namespace DishwasherAlarm {
             /**
              * This event shall be generated when one or more alarms change state, and shall have these fields:
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.15.8.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.15.8.1
              */
             notify: Event(0x0, EventPriority.Info, TlvNotifyEvent)
         },
@@ -287,7 +287,7 @@ export namespace DishwasherAlarm {
      * DishwasherAlarmCluster supports optional features that you can enable with the DishwasherAlarmCluster.with()
      * factory method.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 8.4
+     * @see {@link MatterSpecification.v141.Cluster} § 8.4
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}