@matter/types 0.16.0-alpha.0-20251103-b47ffa15b → 0.16.0-alpha.0-20251106-4e10fd77b

package/dist/esm/clusters/diagnostic-logs.d.ts

@@ -12,7 +12,7 @@ import { Status as GlobalStatus } from "../globals/Status.js";
 import { Identity } from "#general";
 export declare namespace DiagnosticLogs {
     /**
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.1
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.1
      */
     enum Intent {
         /**
@@ -21,7 +21,7 @@ export declare 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.v141.Core} § 11.11.4.1.1
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.1.1
          */
         EndUserSupport = 0,
         /**
@@ -30,7 +30,7 @@ export declare 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.v141.Core} § 11.11.4.1.2
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.1.2
          */
         NetworkDiag = 1,
         /**
@@ -39,12 +39,12 @@ export declare 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.v141.Core} § 11.11.4.1.3
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.1.3
          */
         CrashLogs = 2
     }
     /**
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.3
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.3
      */
     enum TransferProtocol {
         /**
@@ -52,7 +52,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using the LogContent attribute of the response
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.4.3.1
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.3.1
          */
         ResponsePayload = 0,
         /**
@@ -60,21 +60,21 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using BDX as defined in BDX Protocol
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.4.3.2
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.3.2
          */
         Bdx = 1
     }
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.1
      */
     const TlvRetrieveLogsRequest: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * 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.v141.Core} § 11.11.5.1.1
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.1
          */
         intent: import("../tlv/TlvObject.js").FieldType<Intent>;
         /**
@@ -84,7 +84,7 @@ export declare 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.v141.Core} § 11.11.5.1.2
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.2
          */
         requestedProtocol: import("../tlv/TlvObject.js").FieldType<TransferProtocol>;
         /**
@@ -119,19 +119,19 @@ export declare 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.v141.Core} § 11.11.5.1.3
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.3
          */
         transferFileDesignator: import("../tlv/TlvObject.js").OptionalFieldType<string>;
     }>;
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.1
      */
     interface RetrieveLogsRequest extends TypeFromSchema<typeof TlvRetrieveLogsRequest> {
     }
     /**
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.2
      */
     enum Status {
         /**
@@ -139,7 +139,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if diagnostic logs will be or are being transferred.
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.1
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.1
          */
         Success = 0,
         /**
@@ -148,7 +148,7 @@ export declare namespace DiagnosticLogs {
          * shall be used when a BDX session is requested, however, all available logs were provided in a LogContent
          * field.
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.2
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.2
          */
         Exhausted = 1,
         /**
@@ -157,7 +157,7 @@ export declare 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.v141.Core} § 11.11.4.2.3
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.3
          */
         NoLogs = 2,
         /**
@@ -166,7 +166,7 @@ export declare 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.v141.Core} § 11.11.4.2.4
+         * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.4
          */
         Busy = 3,
         /**
@@ -174,14 +174,14 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if the Node is denying the current transfer of diagnostic logs for any reason.
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.5
+         * @see {@link MatterSpecification.v142.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
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.2
      */
     class ExhaustedError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
@@ -189,7 +189,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.NoLogs}.
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.3
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.3
      */
     class NoLogsError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
@@ -197,7 +197,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.Busy}.
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.4
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.4
      */
     class BusyError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
@@ -205,7 +205,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.Denied}.
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.4.2.5
+     * @see {@link MatterSpecification.v142.Core} § 11.11.4.2.5
      */
     class DeniedError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
@@ -214,13 +214,13 @@ export declare 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.v141.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2
      */
     const TlvRetrieveLogsResponse: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * This field shall indicate the result of an attempt to retrieve diagnostic logs.
          *
-         * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.1
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.1
          */
         status: import("../tlv/TlvObject.js").FieldType<Status>;
         /**
@@ -228,7 +228,7 @@ export declare 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.v141.Core} § 11.11.5.2.2
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.2
          */
         logContent: import("../tlv/TlvObject.js").FieldType<AllowSharedBufferSource>;
         /**
@@ -236,7 +236,7 @@ export declare 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.v141.Core} § 11.11.5.2.3
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.3
          */
         utcTimeStamp: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
         /**
@@ -244,7 +244,7 @@ export declare 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.v141.Core} § 11.11.5.2.4
+         * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.4
          */
         timeSinceBoot: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
     }>;
@@ -252,7 +252,7 @@ export declare 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.v141.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2
      */
     interface RetrieveLogsResponse extends TypeFromSchema<typeof TlvRetrieveLogsResponse> {
     }
@@ -267,14 +267,14 @@ export declare namespace DiagnosticLogs {
             /**
              * Reception of this command starts the process of retrieving diagnostic logs from a Node.
              *
-             * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
+             * @see {@link MatterSpecification.v142.Core} § 11.11.5.1
              */
             readonly retrieveLogsRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * 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.v141.Core} § 11.11.5.1.1
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.1
                  */
                 intent: import("../tlv/TlvObject.js").FieldType<Intent>;
                 /**
@@ -284,7 +284,7 @@ export declare 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.v141.Core} § 11.11.5.1.2
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.2
                  */
                 requestedProtocol: import("../tlv/TlvObject.js").FieldType<TransferProtocol>;
                 /**
@@ -319,14 +319,14 @@ export declare 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.v141.Core} § 11.11.5.1.3
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.3
                  */
                 transferFileDesignator: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             }>, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * This field shall indicate the result of an attempt to retrieve diagnostic logs.
                  *
-                 * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.1
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.1
                  */
                 status: import("../tlv/TlvObject.js").FieldType<Status>;
                 /**
@@ -334,7 +334,7 @@ export declare 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.v141.Core} § 11.11.5.2.2
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.2
                  */
                 logContent: import("../tlv/TlvObject.js").FieldType<AllowSharedBufferSource>;
                 /**
@@ -342,7 +342,7 @@ export declare 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.v141.Core} § 11.11.5.2.3
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.3
                  */
                 utcTimeStamp: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
                 /**
@@ -350,7 +350,7 @@ export declare 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.v141.Core} § 11.11.5.2.4
+                 * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.4
                  */
                 timeSinceBoot: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
             }>, any>;
@@ -363,7 +363,7 @@ export declare 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.v141.Core} § 11.11
+     * @see {@link MatterSpecification.v142.Core} § 11.11
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }

package/dist/esm/clusters/diagnostic-logs.js

@@ -29,7 +29,7 @@ var DiagnosticLogs;
      * 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.v141.Core} § 11.11.5.1.1
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.1
      */
     intent: TlvField(0, TlvEnum()),
     /**
@@ -39,7 +39,7 @@ var 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.v141.Core} § 11.11.5.1.2
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.2
      */
     requestedProtocol: TlvField(1, TlvEnum()),
     /**
@@ -74,7 +74,7 @@ var 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.v141.Core} § 11.11.5.1.3
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.1.3
      */
     transferFileDesignator: TlvOptionalField(2, TlvString.bound({ maxLength: 32 }))
   });
@@ -114,7 +114,7 @@ var DiagnosticLogs;
     /**
      * This field shall indicate the result of an attempt to retrieve diagnostic logs.
      *
-     * @see {@link MatterSpecification.v141.Core} § 11.11.5.2.1
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.1
      */
     status: TlvField(0, TlvEnum()),
     /**
@@ -122,7 +122,7 @@ var 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.v141.Core} § 11.11.5.2.2
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.2
      */
     logContent: TlvField(1, TlvByteString.bound({ maxLength: 1024 })),
     /**
@@ -130,7 +130,7 @@ var 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.v141.Core} § 11.11.5.2.3
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.3
      */
     utcTimeStamp: TlvOptionalField(2, TlvEpochUs),
     /**
@@ -138,7 +138,7 @@ var 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.v141.Core} § 11.11.5.2.4
+     * @see {@link MatterSpecification.v142.Core} § 11.11.5.2.4
      */
     timeSinceBoot: TlvOptionalField(3, TlvSysTimeUs)
   });
@@ -150,7 +150,7 @@ var DiagnosticLogs;
       /**
        * Reception of this command starts the process of retrieving diagnostic logs from a Node.
        *
-       * @see {@link MatterSpecification.v141.Core} § 11.11.5.1
+       * @see {@link MatterSpecification.v142.Core} § 11.11.5.1
        */
       retrieveLogsRequest: Command(0, DiagnosticLogs2.TlvRetrieveLogsRequest, 1, DiagnosticLogs2.TlvRetrieveLogsResponse)
     }