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

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

@@ -10,7 +10,7 @@ import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { Identity } from "#general";
 export declare namespace DiagnosticLogs {
     /**
-     * @see {@link MatterSpecification.v13.Core} § 11.11.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.11.4.1
      */
     enum Intent {
         /**
@@ -19,7 +19,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.v13.Core} § 11.11.4.1.1
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.1
          */
         EndUserSupport = 0,
         /**
@@ -28,7 +28,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.v13.Core} § 11.11.4.1.2
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.2
          */
         NetworkDiag = 1,
         /**
@@ -37,12 +37,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.v13.Core} § 11.11.4.1.3
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.1.3
          */
         CrashLogs = 2
     }
     /**
-     * @see {@link MatterSpecification.v13.Core} § 11.11.4.3
+     * @see {@link MatterSpecification.v14.Core} § 11.11.4.3
      */
     enum TransferProtocol {
         /**
@@ -50,7 +50,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.v13.Core} § 11.11.4.3.1
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.3.1
          */
         ResponsePayload = 0,
         /**
@@ -58,21 +58,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.v13.Core} § 11.11.4.3.2
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.3.2
          */
         Bdx = 1
     }
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v14.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.v13.Core} § 11.11.5.1.1
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.1
          */
         intent: import("../tlv/TlvObject.js").FieldType<Intent>;
         /**
@@ -82,7 +82,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.v13.Core} § 11.11.5.1.2
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.2
          */
         requestedProtocol: import("../tlv/TlvObject.js").FieldType<TransferProtocol>;
         /**
@@ -117,19 +117,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.v13.Core} § 11.11.5.1.3
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.3
          */
         transferFileDesignator: import("../tlv/TlvObject.js").OptionalFieldType<string>;
     }>;
     /**
      * Input to the DiagnosticLogs retrieveLogsRequest command
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1
      */
     interface RetrieveLogsRequest extends TypeFromSchema<typeof TlvRetrieveLogsRequest> {
     }
     /**
-     * @see {@link MatterSpecification.v13.Core} § 11.11.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.11.4.2
      */
     enum Status {
         /**
@@ -137,7 +137,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if diagnostic logs will be or are being transferred.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.11.4.2.1
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.1
          */
         Success = 0,
         /**
@@ -146,7 +146,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.v13.Core} § 11.11.4.2.2
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.2
          */
         Exhausted = 1,
         /**
@@ -155,7 +155,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.v13.Core} § 11.11.4.2.3
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.3
          */
         NoLogs = 2,
         /**
@@ -164,7 +164,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.v13.Core} § 11.11.4.2.4
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.4
          */
         Busy = 3,
         /**
@@ -172,7 +172,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if the Node is denying the current transfer of diagnostic logs for any reason.
          *
-         * @see {@link MatterSpecification.v13.Core} § 11.11.4.2.5
+         * @see {@link MatterSpecification.v14.Core} § 11.11.4.2.5
          */
         Denied = 4
     }
@@ -180,13 +180,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.v13.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v14.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.v13.Core} § 11.11.5.2.1
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.1
          */
         status: import("../tlv/TlvObject.js").FieldType<Status>;
         /**
@@ -194,7 +194,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.v13.Core} § 11.11.5.2.2
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.2
          */
         logContent: import("../tlv/TlvObject.js").FieldType<Uint8Array<ArrayBufferLike>>;
         /**
@@ -202,7 +202,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.v13.Core} § 11.11.5.2.3
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.3
          */
         utcTimeStamp: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
         /**
@@ -210,7 +210,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.v13.Core} § 11.11.5.2.4
+         * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.4
          */
         timeSinceBoot: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
     }>;
@@ -218,7 +218,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.v13.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2
      */
     interface RetrieveLogsResponse extends TypeFromSchema<typeof TlvRetrieveLogsResponse> {
     }
@@ -233,14 +233,14 @@ export declare namespace DiagnosticLogs {
             /**
              * Reception of this command starts the process of retrieving diagnostic logs from a Node.
              *
-             * @see {@link MatterSpecification.v13.Core} § 11.11.5.1
+             * @see {@link MatterSpecification.v14.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.v13.Core} § 11.11.5.1.1
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.1
                  */
                 intent: import("../tlv/TlvObject.js").FieldType<Intent>;
                 /**
@@ -250,7 +250,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.v13.Core} § 11.11.5.1.2
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.2
                  */
                 requestedProtocol: import("../tlv/TlvObject.js").FieldType<TransferProtocol>;
                 /**
@@ -285,14 +285,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.v13.Core} § 11.11.5.1.3
+                 * @see {@link MatterSpecification.v14.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.v13.Core} § 11.11.5.2.1
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.1
                  */
                 status: import("../tlv/TlvObject.js").FieldType<Status>;
                 /**
@@ -300,7 +300,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.v13.Core} § 11.11.5.2.2
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.2
                  */
                 logContent: import("../tlv/TlvObject.js").FieldType<Uint8Array<ArrayBufferLike>>;
                 /**
@@ -308,7 +308,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.v13.Core} § 11.11.5.2.3
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.3
                  */
                 utcTimeStamp: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
                 /**
@@ -316,7 +316,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.v13.Core} § 11.11.5.2.4
+                 * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.4
                  */
                 timeSinceBoot: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
             }>, any>;
@@ -329,7 +329,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.v13.Core} § 11.11
+     * @see {@link MatterSpecification.v14.Core} § 11.11
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }

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

@@ -51,7 +51,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.v13.Core} § 11.11.5.1.1
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.1
      */
     intent: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.TlvEnum)()),
     /**
@@ -61,7 +61,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.v13.Core} § 11.11.5.1.2
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.2
      */
     requestedProtocol: (0, import_TlvObject.TlvField)(1, (0, import_TlvNumber.TlvEnum)()),
     /**
@@ -96,7 +96,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.v13.Core} § 11.11.5.1.3
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.1.3
      */
     transferFileDesignator: (0, import_TlvObject.TlvOptionalField)(2, import_TlvString.TlvString.bound({ maxLength: 32 }))
   });
@@ -112,7 +112,7 @@ var DiagnosticLogs;
     /**
      * This field shall indicate the result of an attempt to retrieve diagnostic logs.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.11.5.2.1
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.1
      */
     status: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.TlvEnum)()),
     /**
@@ -120,7 +120,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.v13.Core} § 11.11.5.2.2
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.2
      */
     logContent: (0, import_TlvObject.TlvField)(1, import_TlvString.TlvByteString.bound({ maxLength: 1024 })),
     /**
@@ -128,7 +128,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.v13.Core} § 11.11.5.2.3
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.3
      */
     utcTimeStamp: (0, import_TlvObject.TlvOptionalField)(2, import_TlvNumber.TlvEpochUs),
     /**
@@ -136,7 +136,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.v13.Core} § 11.11.5.2.4
+     * @see {@link MatterSpecification.v14.Core} § 11.11.5.2.4
      */
     timeSinceBoot: (0, import_TlvObject.TlvOptionalField)(3, import_TlvNumber.TlvSysTimeUs)
   });
@@ -148,7 +148,7 @@ var DiagnosticLogs;
       /**
        * Reception of this command starts the process of retrieving diagnostic logs from a Node.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.11.5.1
+       * @see {@link MatterSpecification.v14.Core} § 11.11.5.1
        */
       retrieveLogsRequest: (0, import_Cluster.Command)(0, DiagnosticLogs2.TlvRetrieveLogsRequest, 1, DiagnosticLogs2.TlvRetrieveLogsResponse)
     }