@matter/types 0.15.0-alpha.0-20250620-16e218ed3 → 0.15.0-alpha.0-20250625-4a4b1be1b

package/src/dcl/device-software-version.ts

@@ -0,0 +1,143 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { VendorId } from "../datatype/VendorId.js";
+
+/**
+ * DeviceSoftwareVersionModel Schema
+ * @see {@link MatterSpecification.v141.Core} § 11.23.7.
+ * DCL endpoints:
+ * * check with https://on.dcl.csa-iot.org/dcl/model/versions/{vid}/{pid} to get a list of software versions, check for newer ones
+ * * check with https://on.dcl.csa-iot.org/dcl/model/versions/{vid}/{pid}/{softwareVersion} for these details
+ * see also https://github.com/home-assistant-libs/python-matter-server/blob/main/matter_server/server/ota/dcl.py#L35
+ */
+export interface DeviceSoftwareVersionModelDclSchema {
+    /**
+     * This field SHALL identify the vendor of the product by its Vendor ID and SHALL match the VendorID
+     * field in the Basic Information Cluster of a device running the software referenced by this
+     * DeviceModel/DeviceSoftwareVersionModel record.
+     */
+    vid: VendorId; // Spec vendorId
+
+    /**
+     * This field SHALL identify the Product ID of the product instance to which a certification declaration,
+     * and thus a DCL entry, applies. This field SHALL match the ProductID field in the Basic Information
+     * Cluster of a device running the software referenced by this DeviceModel/DeviceSoftwareVersionModel
+     * record.
+     */
+    pid: number; // Spec productId
+
+    /**
+     * SoftwareVersion SHALL identify the software version number for the device model consistent with
+     * the value found in Section 11.21.2.4.3, “SoftwareVersion field”. The SoftwareVersionNumber value
+     * SHOULD NOT be displayed to an end-user. SoftwareVersion is not editable, but it would be possible
+     * to create a new device model for the same VendorID/ProductID for different versions. Both SoftwareVersion
+     * and SoftwareVersionString SHALL be included. This field SHALL match the SoftwareVersion
+     * field in the Basic Information Cluster of a device running the software certified by this
+     * DeviceModel record.
+     */
+    softwareVersion: number;
+
+    /**
+     * This field SHALL match the Software Version String field in the Basic Information Cluster of a
+     * device running the software referenced by this DeviceModel record, including format constraints
+     * on that field.
+     */
+    softwareVersionString: string;
+
+    /**
+     * CDVersionNumber SHALL identify the CD Version Number of the Certification that applies to this
+     * Software Image. The CDVersionNumber maps to version_number defined in Certification Elements TLV
+     * structure.
+     */
+    cdVersionNumber: number;
+
+    /**
+     * The FirmwareInformation field, if present, SHALL match the firmware_information field in attestation-elements
+     * field included in the Device Attestation response when this Software Image boots on
+     * the device. It is an OPTIONAL field that MAY be present only for devices that meet the requirements
+     * listed in Section 6.3.2, “Firmware Information”.
+     */
+    firmwareInformation?: string;
+
+    /**
+     * This field SHALL indicate whether this SoftwareVersion is valid. When creating an entry for a new
+     * SoftwareVersion, this typically is set to True. When the manufacturer later finds out there is some
+     * reason that this version should no longer be used (e.g. due to some bugs), the field SHALL be
+     * updated to False.
+     */
+    softwareVersionValid: boolean;
+
+    /**
+     * OtaUrl SHALL identify the URL where to obtain the OTA image. The OtaUrl field SHALL be populated
+     * unless the device manufacturer provides alternative means to update the product’s firmware.
+     * The specified URL SHOULD be available for the relevant lifetime of the corresponding software.
+     * The syntax of this field SHALL follow the syntax as specified in RFC 1738 and SHALL use the https
+     * scheme. The maximum length of this field is 256 ASCII characters.
+     */
+    otaUrl?: string;
+
+    /**
+     * OtaFileSize is the total size of the OTA software image in bytes. This field SHALL be provided if the
+     * OtaUrl field is populated.
+     */
+    otaFileSize?: number | bigint; // TODO
+
+    /**
+     * OtaChecksum SHALL contain the digest of the entire contents of the associated OTA Software
+     * Update Image under the OtaUrl field, encoded in base64 string representation. The digest SHALL
+     * have been computed using the algorithm specified in OtaChecksumType. This field SHALL be provided
+     * if the OtaUrl field is populated.
+     */
+    otaChecksum?: string;
+
+    /**
+     * OtaChecksumType SHALL identify the type of OtaChecksum. This field SHALL be provided if the
+     * OtaUrl field is populated.
+     * The value of this field SHALL be a supported numerical identifier value from the IANA Named
+     * Information Hash Algorithm Registry [https://www.iana.org/assignments/named-information/named-information.xhtml#hash-alg]
+     * established as part of RFC 6920. For example, a value of 1 would match the sha-
+     * 256 identifier, which maps to the SHA-256 digest algorithm per Section 6.2 of FIPS 180-4.
+     * The digest algorithm chosen SHALL have a minimum digest length of 256 bits, such as sha-256 (ID 1
+     * in the registry).
+     * To increase interoperability, OtaChecksumType SHALL be within the list of [1, 7, 8, 10, 11, 12].
+     */
+    otaChecksumType?: number; // TODO: Define enum for checksum types
+
+    /**
+     * MinApplicableSoftwareVersion SHALL be equal to the lowest SoftwareVersion for which this image
+     * can be applied. Also see Section 11.21.2.4.6, “MinApplicableSoftwareVersion field”.
+     */
+    minApplicableSoftwareVersion: number;
+
+    /**
+     * MaxApplicableSoftwareVersion SHALL be equal to the highest SoftwareVersion for which this
+     * image can be applied. Also see Section 11.21.2.4.7, “MaxApplicableSoftwareVersion field”.
+     */
+    maxApplicableSoftwareVersion: number;
+
+    /**
+     * ReleaseNotesUrl SHALL identify a product specific web page that contains release notes for the
+     * device model software. The specified URL SHOULD resolve to a maintained web page available for
+     * the lifetime of the corresponding software being relevant. The syntax of this field SHALL follow the
+     * syntax as specified in RFC 1738 and SHALL use the https scheme. The maximum length of this field
+     * is 256 ASCII characters.
+     */
+    releaseNotesUrl?: string;
+
+    /**
+     * SpecificationVersion SHALL identify the specification version applicable to the device model. This
+     * field SHALL match the SpecificationVersion field in the Basic Information Cluster of a device running
+     * the software certified by this DeviceModel record.
+     */
+    specificationVersion?: number;
+
+    /**
+     * The SchemaVersion field value history for this schema is provided below:
+     * * 0: Initial Release
+     */
+    schemaVersion: number;
+}

package/src/dcl/device.ts

@@ -0,0 +1,243 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { DeviceTypeId } from "../datatype/DeviceTypeId.js";
+import { VendorId } from "../datatype/VendorId.js";
+
+/**
+ * DeviceModel Schema
+ * @see {@link MatterSpecification.v141.Core} § 11.23.6.
+ * DCL endpoint:
+ *   * /dcl/model/models
+ *   * /dcl/model/models/{vid}
+ *   * /dcl/model/models/{vid}/{pid}
+ */
+export interface DeviceModelDclSchema {
+    /**
+     * This field SHALL identify the vendor of the product by its Vendor ID and SHALL match the VendorID
+     * field in the Basic Information Cluster of a device running the software referenced by this
+     * DeviceModel/DeviceSoftwareVersionModel record.
+     */
+    vid: VendorId; // Spec: vendorId
+
+    /**
+     * This field SHALL identify the Product ID of the product instance to which a certification declaration,
+     * and thus a DCL entry, applies. This field SHALL match the ProductID field in the Basic Information
+     * Cluster of a device running the software referenced by this DeviceModel/DeviceSoftwareVersionModel
+     * record.
+     */
+    pid: number; // Spec: productId
+
+    /**
+     * DeviceTypeID is the Primary Device Type identifier for the device. For example, DeviceTypeID is 10
+     * (0x000A), which is the device type identifier for a Door Lock.
+     */
+    deviceTypeID: DeviceTypeId;
+
+    /**
+     * This field SHOULD match the ProductName field in the Basic Information Cluster of a device running
+     * the software referenced by this DeviceModel record.
+     */
+    productName: string;
+
+    /**
+     * This field SHOULD match the ProductLabel field in the Basic Information Cluster of a device running
+     * the software referenced by this DeviceModel record.
+     */
+    productLabel: string;
+
+    /**
+     * This field SHALL match the PartNumber field in the Basic Information Cluster of a device running the
+     * software referenced by this DeviceModel record.
+     * Multiple products (and hence PartNumbers) can share a ProductID. For instance, there may be different
+     * packaging (with different PartNumbers) for different regions; also different colors of a product
+     * might share the ProductID but may have a different PartNumber. In such cases, the choice of a
+     * single PartNumber out of the available set of PartNumbers using this ProductID SHALL be used to
+     * populate this field.
+     */
+    partNumber: string;
+
+    /**
+     * This field SHALL identify the device’s available technologies for device discovery which SHALL be
+     * encoded as defined in Table 40, “Discovery Capabilities Bitmask”. This field SHALL match the Table
+     * 40, “Discovery Capabilities Bitmask” provided in the Section 5.1.3, “QR Code” (if a QR-code is provided
+     * on or with the product). This field SHALL be populated if the CommissioningFallbackUrl is
+     * populated, and SHOULD be populated for all other products.
+     */
+    discoveryCapabilitiesBitmask: number; // TODO
+
+    /**
+     * This field SHALL identify the device’s commissioning flow with encoding as described in Custom
+     * Flow.
+     */
+    commissioningCustomFlow: number;
+
+    /**
+     * This field SHALL identify a vendor-specific commissioning URL for the device model when the
+     * CommissioningCustomFlow field is set to '2', and MAY be set for other values of CommissioningCustomFlow.
+     * See Custom Commissioning Flow section for how this URL is used. During the lifetime of
+     * the product, the specified URL SHOULD resolve to a maintained web page. The syntax of this field
+     * SHALL follow the syntax as specified in RFC 1738 and SHALL use the https scheme. The maximum
+     * length of this field is 256 ASCII characters.
+     */
+    commissioningCustomFlowUrl?: string;
+
+    /**
+     * This field SHALL identify a hint for the steps that MAY be used to put a device that has not yet been
+     * commissioned into commissioning mode. This field is a bitmap with values defined in the Pairing
+     * Hint Table. For example, a value of 1 (bit 0 is set) indicates that a device that has not yet been commissioned
+     * will enter Commissioning Mode upon a power cycle.
+     * Devices that implement Extended Discovery SHALL reflect this value in the Pairing Hint field of
+     * Commissionable Node Discovery when they have not yet been commissioned.
+     */
+    commissioningModeInitialStepsHint: number; // TODO
+
+    /**
+     * This field SHALL be populated with the appropriate Pairing Instruction for those values of
+     * CommissioningModeInitialStepsHint, for which the Pairing Hint Table indicates a Pairing Instruction (PI)
+     * dependency.
+     * Devices that implement Extended Discovery SHALL reflect this value in the Pairing Instruction field
+     * of Commissionable Node Discovery when they have not yet been commissioned.
+     */
+    commissioningModeInitialStepsInstruction?: string;
+
+    /**
+     * This field SHALL identify a hint for the steps that MAY be used to put a device that has already been
+     * commissioned into commissioning mode. This field is a bitmap with values defined in the Pairing
+     * Hint Table. At least bit 2 SHALL be set, to indicate that a current Administrator can be used to put a
+     * device that has already been commissioned into commissioning mode (see Section 5.6.3, “Enhanced
+     * Commissioning Method (ECM)”). Devices which implement additional mechanisms to put a device
+     * that has already been commissioned into commissioning mode SHALL reflect these mechanism by
+     * setting the corresponding bits in this field.
+     * Devices that implement Extended Discovery SHALL reflect this value in the Pairing Hint field of
+     * Commissionable Node Discovery when they have already been commissioned.
+     */
+    commissioningModeSecondaryStepsHint: number; // TODO
+
+    /**
+     * This field SHALL be populated with the appropriate Pairing Instruction for those values of
+     * CommissioningModeSecondaryStepsHint, for which the Pairing Hint Table indicates a Pairing Instruction
+     * (PI) dependency.
+     * Devices that implement Extended Discovery SHALL reflect this value in the Pairing Instruction field
+     * of Commissionable Node Discovery when they have already been commissioned.
+     */
+    commissioningModeSecondaryStepsInstruction?: string;
+
+    /**
+     * This field SHALL identify a vendor-specific commissioning-fallback URL for the device model,
+     * which can be used by a Commissioner in case commissioning fails to direct the user to a manufacturer-provided
+     * mechanism to provide resolution to commissioning issues. See Commissioning Fallback
+     * section for how this URL is used.
+     * During the lifetime of the product, the specified URL SHOULD resolve to a maintained web page.
+     * The syntax of this field SHALL follow the syntax as specified in RFC 1738 and SHALL use the https
+     * scheme. The maximum length of this field is 256 ASCII characters.
+     */
+    commissioningFallbackUrl?: string;
+
+    /**
+     * This field (when provided) SHALL identify a product-specific web page containing a user manual
+     * for the device model. During the lifetime of the product, the specified URL SHOULD resolve to a
+     * maintained web page. The syntax of this field SHALL follow the syntax as specified in RFC 1738 and
+     * SHALL use the https scheme. The maximum length of this field is 256 ASCII characters.
+     */
+    userManualUrl?: string;
+
+    /**
+     * This field (when provided) SHALL identify a product specific support web page. During the lifetime
+     * of the product, the specified URL SHOULD resolve to a maintained web page. The syntax of this
+     * field SHALL follow the syntax as specified in RFC 1738 and SHALL use the https scheme. The maximum
+     * length of this field is 256 ASCII characters.
+     */
+    supportUrl?: string;
+
+    /**
+     * This field (when provided) SHALL identify a link to a product specific web page. This field SHALL
+     * match the ProductURL field in the Basic Information Cluster of a device running the software referenced
+     * by this DeviceModel record. During the lifetime of the product, the specified URL SHOULD resolve to a
+     * maintained web page. The syntax of this field SHALL follow the syntax as specified in
+     * RFC 1738 and SHALL use the https scheme. The maximum length of this field is 256 ASCII characters.
+     */
+    productUrl?: string;
+
+    /**
+     * This field (when provided) SHALL identify a link to the Localized String File of this product. This
+     * field SHALL NOT have a localized string identifier. During the lifetime of the product, the specified
+     * URL SHOULD resolve to a maintained Localized String File. The syntax of this field SHALL follow
+     * the syntax as specified in RFC 1738 and SHALL use the https scheme. The maximum length of this
+     * field is 256 ASCII characters.
+     */
+    lsfUrl?: string;
+
+    /**
+     * LsfRevision is a monotonically increasing positive integer indicating the latest available version of
+     * Localized String File. Any client can use this field to check whether it has the latest version of the
+     * Localized String File cached. When the first version of the Localized String File is published, the
+     * value of this field SHOULD be 1. When a new revision of the Localized String File is published, this
+     * value SHALL monotonically increase by 1. When a client of this information finds this to be greater
+     * than its currently stored LSF revision number, it SHOULD download the latest version of the LSF
+     * from the LsfUrl, and update its local value of this field.
+     * This field SHALL be provided if and only if when LsfUrl is provided.
+     */
+    lsfRevision?: number;
+
+    /**
+     * This field SHALL identify the configuration options for the Enhanced Setup Flow. This field is a
+     * bitmap with values defined in Enhanced Setup Flow Options Table.
+     */
+    enhancedSetupFlowOptions?: number; // TODO
+
+    /**
+     * This field (when provided) SHALL identify a link to the Enhanced Setup Flow Terms and Condition
+     * File for this product. During the lifetime of the product, the specified URL SHOULD resolve to a
+     * maintained Terms and Conditions File. The syntax of this field SHALL follow the syntax as specified
+     * in RFC 1738. The maximum length of this field is 256 ASCII characters. All URLs SHALL use the
+     * https scheme. This field SHALL be present if and only if the EnhancedSetupFlowOptions field has
+     * bit 0 set.
+     */
+    enhancedSetupFlowTCUrl?: string;
+
+    /**
+     * This field (when provided) is an increasing positive integer indicating the latest available version of
+     * the Enhanced Setup Flow Terms and Conditions file. When a new revision of the File is published,
+     * this value SHALL increase (and SHOULD increase by 1). This field SHALL be present if and only if
+     * the EnhancedSetupFlowOptions field has bit 0 set.
+     */
+    enhancedSetupFlowTCRevision?: number;
+
+    /**
+     * This field (when provided) SHALL contain the digest of the entire contents of the associated file
+     * downloaded from the EnhancedSetupFlowTCUrl field, encoded in base64 string representation and
+     * SHALL be used to ensure the contents of the downloaded file are authentic. The digest SHALL have
+     * been computed using the SHA-256 digest algorithm. This field SHALL be present if and only if the
+     * EnhancedSetupFlowOptions field has bit 0 set.
+     */
+    enhancedSetupFlowTCDigest?: string;
+
+    /**
+     * This field (when provided) SHALL indicate the total size of the Enhanced Setup Flow Terms and
+     * Conditions file in bytes, and SHALL be used to ensure the downloaded file size is within the bounds
+     * of EnhancedSetupFlowTCFileSize. This field SHALL be provided if and only if the EnhancedSetupFlowTCUrl
+     * field is present.
+     */
+    enhancedSetupFlowTCFileSize?: number;
+
+    /**
+     * This field (when provided) SHALL identify a link to a vendor-specific URL which SHALL provide a
+     * manufacturer specific means to resolve any functionality limitations indicated by the
+     * TERMS_AND_CONDITIONS_CHANGED status code. This field SHALL be present if the EnhancedSetupFlowOptions
+     * field has bit 0 set. During the lifetime of the product, the specified URL SHOULD
+     * resolve to a maintained web page. The syntax of this field SHALL follow the syntax as specified in
+     * RFC 1738. The maximum length of this field is 256 ASCII characters. All URLs SHALL use the https
+     * scheme.
+     */
+    enhancedSetupFlowMaintenanceUrl?: string;
+
+    /**
+     * The SchemaVersion field value history for this schema is provided below:
+     * * 0: Initial Release
+     */
+    schemaVersion: number;
+}

package/src/dcl/index.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from "./attestation-certificate.js";
+export * from "./device-attestation-revocation.js";
+export * from "./device-software-compliance.js";
+export * from "./device-software-version.js";
+export * from "./device.js";
+export * from "./operational-certificate.js";
+export * from "./vendor.js";

package/src/dcl/operational-certificate.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Operational Root and Intermediate Certificate Schema
+ * @see {@link MatterSpecification.v141.Core} § 11.23.5.
+ */
+export interface OperationalCertificateDclSchema {
+    /**
+     * This field uniquely identifies a certificate and SHALL contain the body of a certificate that has been
+     * added in the DCL. It SHALL be encoded in PEM format. The certificate SHALL respect the format
+     * constraints provided for that certificate type.
+     */
+    pemCert: string;
+
+    /**
+     * The field SHALL be used to identify the serial number field in the Matter certificate structure. A
+     * Matter certificate follows the same limitation on admissible serial numbers as in [RFC 5280], i.e.,
+     * that implementations SHALL admit serial numbers up to 20 octets in length, and certificate authorities
+     * SHALL NOT use serial numbers longer than 20 octets in length.
+     */
+    serialNumber: string;
+
+    /**
+     * The field SHALL be used to identify the Certificate Authority that issues the certificate. For a
+     * Operational Root CA Certificates (RCAC), this field is OPTIONAL because Issuer and
+     * Subject are the same.
+     */
+    issuer?: string;
+
+    /**
+     * The authority key identifier extension provides a means of identifying the public key corresponding
+     * to the private key used to sign a Matter certificate. This is OPTIONAL for Operational Root CA
+     * Certificates (RCAC).
+     */
+    authorityKeyID?: string;
+
+    /**
+     * This field SHALL contain the PAA certificate’s Subject field, as defined Operational Root CA Certificates
+     * (RCAC). This is OPTIONAL for Operational Root CA Certificates (RCAC). This is encoded as
+     * defined in Section 6.1, “Certificate Common Conventions”.
+     */
+    rootSubject?: string;
+
+    /**
+     * This field SHALL uniquely identify the PAA certificate’s Subject Key Identifier mandatory extension.
+     * It is defined in PAA Certificate and Operational Root CA Certificates (RCAC). This is OPTIONAL
+     * for Operational Root CA Certificates (RCAC). This is encoded as defined in Section 6.1, “Certificate
+     * Common Conventions”.
+     */
+    rootSubjectKeyID?: string;
+
+    /**
+     * This field SHALL signify whether the associated certificates is a Operational Root CA Certificate
+     * (RCAC).
+     */
+    isRoot: boolean;
+
+    /**
+     * This field uniquely identifies the DCL key that was used to register the certificate in DCL, pursuant
+     * to DCL policies.
+     */
+    owner: string;
+
+    /**
+     * This field SHALL contain the certificate’s Subject field. This is encoded as defined in Section 6.1,
+     * “Certificate Common Conventions”.
+     */
+    subject: string;
+
+    /**
+     * This field SHALL uniquely identify the PAA certificate’s Subject Key Identifier mandatory extension.
+     * This is encoded as defined in Section 6.1.2, “Key Identifier Extension Constraints”.
+     */
+    subjectKeyID: string;
+
+    /**
+     * This field SHALL contain the Vendor ID of the vendor that issued the certificate.
+     */
+    vid: number;
+
+    /**
+     * The SchemaVersion field value history for this schema is provided below:
+     * * ???
+     */
+    schemaVersion: number;
+}

package/src/dcl/vendor.ts

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { VendorId } from "../datatype/VendorId.js";
+
+/**
+ * Vendor Schema
+ * @see {@link MatterSpecification.v141.Core} § 11.23.3.
+ * DCL Endpoint: /dcl/vendorinfo/vendors or /dcl/vendorinfo/vendors/{vendorID}
+ */
+export interface VendorDclSchema {
+    /**
+     * This field SHALL uniquely identify this Vendor Schema entry and it SHALL match the Vendor’s
+     * assigned Vendor ID.
+     */
+    vendorID: VendorId;
+
+    /**
+     * This field SHALL provide a human readable (displayable) name for the product manufacturer associated
+     * with this record. Maximum length is 128 characters.
+     */
+    vendorName: string;
+
+    /**
+     * The CompanyLegalName field SHALL specify the legal name for the product manufacturer.
+     * Maximum length is 256 characters.
+     */
+    companyLegalName: string;
+
+    /**
+     * The CompanyPreferredName field, if provided, SHALL specify the Preferred Name that MAY be
+     * used for display purposes instead of the CompanyLegalName. Maximum length is 256 characters.
+     */
+    companyPreferredName?: string;
+
+    /**
+     * The VendorLandingPageUrl field (when provided) SHALL contain a link to a maintained web page
+     * containing more information about the device manufacturer, such as contact information, address,
+     * etc. During the lifetime of the products of this manufacturer, the specified URL SHOULD resolve to a
+     * maintained web page. The syntax of this field SHALL follow the syntax as specified in RFC 1738 and
+     * SHALL use the https scheme. The maximum length of this field is 256 ASCII characters.
+     */
+    vendorLandingPageUrl?: string;
+
+    /**
+     * The SchemaVersion field value history for this schema is provided below:
+     * * 0: Initial Release
+     */
+    schemaVersion: number;
+}

package/src/index.ts

@@ -10,6 +10,7 @@ export * from "./cluster/index.js";
 export * from "./commissioning/index.js";
 export * from "./common/index.js";
 export * from "./datatype/index.js";
+export * from "./dcl/index.js";
 export * from "./globals/index.js";
 export * from "./protocol/index.js";
 export * from "./schema/index.js";

package/src/protocol/definitions/general.ts

@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export enum GeneralStatusCode {
+    /** Operation completed successfully. */
+    Success = 0,
+
+    /** Generic failure, additional details may be included in the protocol specific status. */
+    Failure = 1,
+
+    /** Operation was rejected by the system because the system is in an invalid state. */
+    BadPrecondition = 2,
+
+    /** A value was out of a required range */
+    OutOfRange = 3,
+
+    /** A request was unrecognized or malformed */
+    BadRequest = 4,
+
+    /** An unrecognized or unsupported request was received. */
+    Unsupported = 5,
+
+    /** A request was not expected at this time. */
+    Unexpected = 6,
+
+    /** Insufficient resources to process the given request. */
+    ResourceExhausted = 7,
+
+    /** Device is busy and cannot handle this request at this time. */
+    Busy = 8,
+
+    /** A timeout occurred. */
+    Timeout = 9,
+
+    /** Context-specific signal to proceed */
+    Continue = 10,
+
+    /** Failure, may be due to a concurrency error. */
+    Aborted = 11,
+
+    /** An invalid/unsupported argument was provided. */
+    InvalidArgument = 12,
+
+    /** Some requested entity was not found. */
+    NotFound = 13,
+
+    /** The sender attempted to create something that already exists. */
+    AlreadyExists = 14,
+
+    /** The sender does not have sufficient permissions to execute the requested operations. */
+    PermissionDenied = 15,
+
+    /** Unrecoverable data loss or corruption has occurred. */
+    DataLoss = 16,
+
+    /** Message size is larger than the recipient can handle. */
+    MessageTooLarge = 17,
+}

package/src/protocol/definitions/index.ts

@@ -4,5 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+export * from "./general.js";
 export * from "./interaction.js";
 export * from "./secure-channel.js";