@matter/protocol 0.16.0-alpha.0-20250913-0bc2515df → 0.16.0-alpha.0-20250920-809524dba

package/dist/cjs/bdx/BdxClient.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BdxMessenger } from "./BdxMessenger.js";
+import { BdxSession } from "./BdxSession.js";
+import { BdxSessionConfiguration } from "./BdxSessionConfiguration.js";
+/**
+ * BDX Client to initiate a BDX transfer.
+ * Unless differently configured it tries to be the Driver of the transfer.
+ * Asynchronous transfer is provisional, implemented in theory but disabled internally.
+ */
+export declare class BdxClient {
+    #private;
+    /**
+     * Create a BDX client to initiate a BDX transfer as sender.
+     * A file designator needs to be provided and needs to exist in the storage context.
+     */
+    static asSender(messenger: BdxMessenger, options: BdxSessionConfiguration.SenderInitiatorOptions): BdxClient;
+    /**
+     * Create a BDX client to initiate a BDX transfer as receiver.
+     * A file designator needs to be provided. The content will be written to the storage context.
+     */
+    static asReceiver(messenger: BdxMessenger, options: BdxSessionConfiguration.InitiatorOptions): BdxClient;
+    constructor(bdxSession: BdxSession);
+    /** This is the main entry point to initiate and process the BDX transfer. */
+    processTransfer(): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=BdxClient.d.ts.map

package/dist/cjs/bdx/BdxClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BdxClient.d.ts","sourceRoot":"","sources":["../../../src/bdx/BdxClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,SAAS;;IAGlB;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,uBAAuB,CAAC,sBAAsB;IAIhG;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,uBAAuB,CAAC,gBAAgB;gBAIhF,UAAU,EAAE,UAAU;IAIlC,6EAA6E;IAC7E,eAAe;IAIf,KAAK;CAGR"}

package/dist/cjs/bdx/BdxClient.js

@@ -0,0 +1,57 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var BdxClient_exports = {};
+__export(BdxClient_exports, {
+  BdxClient: () => BdxClient
+});
+module.exports = __toCommonJS(BdxClient_exports);
+var import_BdxSession = require("./BdxSession.js");
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+class BdxClient {
+  #session;
+  /**
+   * Create a BDX client to initiate a BDX transfer as sender.
+   * A file designator needs to be provided and needs to exist in the storage context.
+   */
+  static asSender(messenger, options) {
+    return new BdxClient(import_BdxSession.BdxSession.asSender(messenger, options));
+  }
+  /**
+   * Create a BDX client to initiate a BDX transfer as receiver.
+   * A file designator needs to be provided. The content will be written to the storage context.
+   */
+  static asReceiver(messenger, options) {
+    return new BdxClient(import_BdxSession.BdxSession.asReceiver(messenger, options));
+  }
+  constructor(bdxSession) {
+    this.#session = bdxSession;
+  }
+  /** This is the main entry point to initiate and process the BDX transfer. */
+  processTransfer() {
+    return this.#session.processTransfer();
+  }
+  close() {
+    return this.#session.close();
+  }
+}
+//# sourceMappingURL=BdxClient.js.map

package/dist/cjs/bdx/BdxClient.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/bdx/BdxClient.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,wBAA2B;AAP3B;AAAA;AAAA;AAAA;AAAA;AAeO,MAAM,UAAU;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,SAAS,WAAyB,SAAyD;AAC9F,WAAO,IAAI,UAAU,6BAAW,SAAS,WAAW,OAAO,CAAC;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,WAAW,WAAyB,SAAmD;AAC1F,WAAO,IAAI,UAAU,6BAAW,WAAW,WAAW,OAAO,CAAC;AAAA,EAClE;AAAA,EAEA,YAAY,YAAwB;AAChC,SAAK,WAAW;AAAA,EACpB;AAAA;AAAA,EAGA,kBAAkB;AACd,WAAO,KAAK,SAAS,gBAAgB;AAAA,EACzC;AAAA,EAEA,QAAQ;AACJ,WAAO,KAAK,SAAS,MAAM;AAAA,EAC/B;AACJ;",
+  "names": []
+}

package/dist/cjs/bdx/BdxError.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MatterError } from "#general";
+import { BdxStatusCode, GeneralStatusCode } from "#types";
+/** Error class used by the BDX protocol. */
+export declare class BdxError extends MatterError {
+    #private;
+    constructor(message: string, code?: BdxStatusCode);
+    get code(): BdxStatusCode;
+    static is(error: unknown): error is BdxError;
+}
+/** Error base Class for all errors related to the BDX status response messages. */
+export declare class BdxStatusResponseError extends MatterError {
+    readonly generalStatusCode: GeneralStatusCode;
+    readonly protocolStatusCode: BdxStatusCode;
+    constructor(message: string, generalStatusCode: GeneralStatusCode, protocolStatusCode: BdxStatusCode);
+}
+//# sourceMappingURL=BdxError.d.ts.map

package/dist/cjs/bdx/BdxError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BdxError.d.ts","sourceRoot":"","sources":["../../../src/bdx/BdxError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE1D,4CAA4C;AAC5C,qBAAa,QAAS,SAAQ,WAAW;;gBAGzB,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,aAAqC;IAKxE,IAAI,IAAI,IAAI,aAAa,CAExB;IAED,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO;CAG3B;AAED,mFAAmF;AACnF,qBAAa,sBAAuB,SAAQ,WAAW;aAG/B,iBAAiB,EAAE,iBAAiB;aACpC,kBAAkB,EAAE,aAAa;gBAFjD,OAAO,EAAE,MAAM,EACC,iBAAiB,EAAE,iBAAiB,EACpC,kBAAkB,EAAE,aAAa;CAMxD"}

package/dist/cjs/bdx/BdxError.js

@@ -0,0 +1,54 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var BdxError_exports = {};
+__export(BdxError_exports, {
+  BdxError: () => BdxError,
+  BdxStatusResponseError: () => BdxStatusResponseError
+});
+module.exports = __toCommonJS(BdxError_exports);
+var import_general = require("#general");
+var import_types = require("#types");
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+class BdxError extends import_general.MatterError {
+  #code;
+  constructor(message, code = import_types.BdxStatusCode.Unknown) {
+    super(`BDX error ${import_types.BdxStatusCode[code]}(${code}): ${message}`);
+    this.#code = code;
+  }
+  get code() {
+    return this.#code;
+  }
+  static is(error) {
+    return error instanceof BdxError;
+  }
+}
+class BdxStatusResponseError extends import_general.MatterError {
+  constructor(message, generalStatusCode, protocolStatusCode) {
+    super(
+      `(${import_types.GeneralStatusCode[generalStatusCode]} (${generalStatusCode}) / ${import_types.BdxStatusCode[protocolStatusCode]} (${protocolStatusCode})) ${message}`
+    );
+    this.generalStatusCode = generalStatusCode;
+    this.protocolStatusCode = protocolStatusCode;
+  }
+}
+//# sourceMappingURL=BdxError.js.map

package/dist/cjs/bdx/BdxError.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/bdx/BdxError.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAA4B;AAC5B,mBAAiD;AAPjD;AAAA;AAAA;AAAA;AAAA;AAUO,MAAM,iBAAiB,2BAAY;AAAA,EACtC;AAAA,EAEA,YAAY,SAAiB,OAAsB,2BAAc,SAAS;AACtE,UAAM,aAAa,2BAAc,IAAI,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE;AAC7D,SAAK,QAAQ;AAAA,EACjB;AAAA,EAEA,IAAI,OAAsB;AACtB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,OAAO,GAAG,OAAgB;AACtB,WAAO,iBAAiB;AAAA,EAC5B;AACJ;AAGO,MAAM,+BAA+B,2BAAY;AAAA,EAC7C,YACH,SACgB,mBACA,oBAClB;AACE;AAAA,MACI,IAAI,+BAAkB,iBAAiB,CAAC,KAAK,iBAAiB,OAAO,2BAAc,kBAAkB,CAAC,KAAK,kBAAkB,MAAM,OAAO;AAAA,IAC9I;AALgB;AACA;AAAA,EAKpB;AACJ;",
+  "names": []
+}

package/dist/cjs/bdx/BdxMessenger.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Message } from "#codec/MessageCodec.js";
+import { Duration } from "#general";
+import { MessageExchange } from "#protocol/MessageExchange.js";
+import { BdxMessageType, BdxStatusCode } from "#types";
+import { BdxReceiveAccept, BdxSendAccept } from "./schema/BdxAcceptMessagesSchema.js";
+import { BdxBlock, BdxBlockAck, BdxBlockAckEof, BdxBlockEof, BdxBlockQuery, BdxBlockQueryWithSkip } from "./schema/BdxBlockMessagesSchema.js";
+import { BdxInit } from "./schema/BdxInitMessagesSchema.js";
+import { BdxMessage } from "./schema/BdxMessage.js";
+export declare const BDX_TRANSFER_IDLE_TIMEOUT: Duration;
+/** Messenger class that contains all Bdx Messages */
+export declare class BdxMessenger {
+    #private;
+    /**
+     * Creates a new BdxMessenger instance.
+     * @param exchange Exchange to use for the messaging
+     * @param messageTimeout Communication Timeout for the Bdx Messages, defaults to 5 minutes as defined for Matter OTA transfers
+     */
+    constructor(exchange: MessageExchange, messageTimeout?: Duration);
+    get channel(): import("../index.js").MessageChannel;
+    get exchange(): MessageExchange;
+    get maxPayloadSize(): number;
+    /**
+     * Waits for the next message and returns it.
+     * A List of allowed expected message types can be provided.
+     * If the message type is not in the list, an error will be thrown.
+     */
+    nextMessage(expectedMessageTypes: BdxMessageType[], timeout?: Duration, expectedMessageInfo?: string): Promise<BdxMessage<any>>;
+    send(bdxMessage: BdxMessage<any>): Promise<void>;
+    /** Sends a Bdx SendInit message and waits for the SendAccept message as a response and returns it decoded. */
+    sendSendInit(message: BdxInit): Promise<BdxSendAccept>;
+    /** Sends a ReceiveInit message and waits for the ReceiveAccept message as a response and returns it decoded. */
+    sendReceiveInit(message: BdxInit): Promise<BdxReceiveAccept>;
+    /** Encodes and sends a Bdx SendAccept message. */
+    sendSendAccept(message: BdxSendAccept): Promise<void>;
+    /** Encodes and sends a Bdx ReceiveAccept message. */
+    sendReceiveAccept(message: BdxReceiveAccept): Promise<void>;
+    /** Encodes and sends a Bdx Block message. */
+    sendBlock(message: BdxBlock): Promise<void>;
+    /** Encodes and sends a Bdx BlockQuery message. */
+    sendBlockQuery(message: BdxBlockQuery): Promise<void>;
+    /** Encodes and sends a Bdx BlockQueryWithSkip message. */
+    sendBlockQueryWithSkip(message: BdxBlockQueryWithSkip): Promise<void>;
+    /** Encodes and sends a Bdx BlockEof message. */
+    sendBlockEof(message: BdxBlockEof): Promise<void>;
+    /** Encodes and sends a Bdx BlockAck message. */
+    sendBlockAck(message: BdxBlockAck): Promise<void>;
+    /** Encodes and sends a Bdx BlockAckEof message */
+    sendBlockAckEof(message: BdxBlockAckEof): Promise<void>;
+    /** Read the next Block message, accepts Block and BlockEof messages. Returns the decoded message and it's type. */
+    readBlock(): Promise<BdxMessage<BdxMessageType.Block | BdxMessageType.BlockEof>>;
+    /**
+     * Read the next BlockQuery message, accepts BlockQuery and BlockQueryWithSkip and BlockAck messages.
+     * When a BlockAck is received, it will be validated and the next BlockQuery message will be read.
+     * Returns the decoded message and it's type.
+     */
+    readBlockQuery(): Promise<BdxMessage<BdxMessageType.BlockQuery | BdxMessageType.BlockQueryWithSkip>>;
+    /** Reads the next BlockAckEof message and returns the decoded message. */
+    readBlockAckEof(): Promise<BdxBlockAckEof>;
+    /** Reads the next BlockAck message and returns the decoded message. */
+    readBlockAck(): Promise<BdxBlockAck>;
+    /** Sends a Bdx Error StatusReport message with the given protocol status. */
+    sendError(code: BdxStatusCode): Promise<void>;
+    protected throwIfErrorStatusReport(message: Message, logHint?: string): void;
+    close(): Promise<void>;
+    /**
+     * Ensure that the value is a safe JavaScript "number" type and that it is not too large. Matter spec allows also
+     * 64bit values, but they make little sense for now, so make sure we handle them as too large. MAX_SAFE_INTEGER is
+     * 2^53-1 and is enough for now.
+     */
+    static asSafeNumber(value: number | bigint | undefined, context?: string, bdxErrorCode?: BdxStatusCode): number;
+}
+//# sourceMappingURL=BdxMessenger.d.ts.map

package/dist/cjs/bdx/BdxMessenger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BdxMessenger.d.ts","sourceRoot":"","sources":["../../../src/bdx/BdxMessenger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAGH,QAAQ,EAMX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,aAAa,EAAwC,MAAM,QAAQ,CAAC;AAE7F,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EACH,QAAQ,EACR,WAAW,EACX,cAAc,EACd,WAAW,EACX,aAAa,EACb,qBAAqB,EACxB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAKpD,eAAO,MAAM,yBAAyB,UAAa,CAAC;AAEpD,qDAAqD;AACrD,qBAAa,YAAY;;IAIrB;;;;OAIG;gBACS,QAAQ,EAAE,eAAe,EAAE,cAAc,WAA4B;IAQjF,IAAI,OAAO,yCAEV;IAED,IAAI,QAAQ,oBAEX;IAED,IAAI,cAAc,WAEjB;IAED;;;;OAIG;IACG,WAAW,CACb,oBAAoB,EAAE,cAAc,EAAE,EACtC,OAAO,WAAuB,EAC9B,mBAAmB,CAAC,EAAE,MAAM,GAC7B,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAuBrB,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;IAStC,8GAA8G;IACxG,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ5D,gHAAgH;IAC1G,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQlE,kDAAkD;IAC5C,cAAc,CAAC,OAAO,EAAE,aAAa;IAI3C,qDAAqD;IAC/C,iBAAiB,CAAC,OAAO,EAAE,gBAAgB;IAIjD,6CAA6C;IACvC,SAAS,CAAC,OAAO,EAAE,QAAQ;IAIjC,kDAAkD;IAC5C,cAAc,CAAC,OAAO,EAAE,aAAa;IAI3C,0DAA0D;IACpD,sBAAsB,CAAC,OAAO,EAAE,qBAAqB;IAI3D,gDAAgD;IAC1C,YAAY,CAAC,OAAO,EAAE,WAAW;IAIvC,gDAAgD;IAC1C,YAAY,CAAC,OAAO,EAAE,WAAW;IAIvC,kDAAkD;IAC5C,eAAe,CAAC,OAAO,EAAE,cAAc;IAI7C,mHAAmH;IAC7G,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAStF;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,UAAU,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;IA0B1G,0EAA0E;IACpE,eAAe,IAAI,OAAO,CAAC,cAAc,CAAC;IAMhD,uEAAuE;IACjE,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAM1C,6EAA6E;IAC7E,SAAS,CAAC,IAAI,EAAE,aAAa;IAsB7B,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM;IAwBrE,KAAK;IAIL;;;;OAIG;IACH,MAAM,CAAC,YAAY,CACf,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAClC,OAAO,SAAK,EACZ,YAAY,gBAAwB,GACrC,MAAM;CASZ"}

package/dist/cjs/bdx/BdxMessenger.js

@@ -0,0 +1,245 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var BdxMessenger_exports = {};
+__export(BdxMessenger_exports, {
+  BDX_TRANSFER_IDLE_TIMEOUT: () => BDX_TRANSFER_IDLE_TIMEOUT,
+  BdxMessenger: () => BdxMessenger
+});
+module.exports = __toCommonJS(BdxMessenger_exports);
+var import_general = require("#general");
+var import_types = require("#types");
+var import_BdxError = require("./BdxError.js");
+var import_BdxMessage = require("./schema/BdxMessage.js");
+var import_BdxStatusMessageSchema = require("./schema/BdxStatusMessageSchema.js");
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = import_general.Logger.get("BdxMessenger");
+const BDX_TRANSFER_IDLE_TIMEOUT = (0, import_general.Minutes)(5);
+class BdxMessenger {
+  #exchange;
+  #messageTimeout;
+  /**
+   * Creates a new BdxMessenger instance.
+   * @param exchange Exchange to use for the messaging
+   * @param messageTimeout Communication Timeout for the Bdx Messages, defaults to 5 minutes as defined for Matter OTA transfers
+   */
+  constructor(exchange, messageTimeout = BDX_TRANSFER_IDLE_TIMEOUT) {
+    if (!exchange.channel.isReliable) {
+      throw new import_general.ImplementationError("Bdx Protocol requires a reliable channel for message exchange");
+    }
+    this.#messageTimeout = messageTimeout;
+    this.#exchange = exchange;
+  }
+  get channel() {
+    return this.#exchange.channel;
+  }
+  get exchange() {
+    return this.#exchange;
+  }
+  get maxPayloadSize() {
+    return this.#exchange.maxPayloadSize;
+  }
+  /**
+   * Waits for the next message and returns it.
+   * A List of allowed expected message types can be provided.
+   * If the message type is not in the list, an error will be thrown.
+   */
+  async nextMessage(expectedMessageTypes, timeout = this.#messageTimeout, expectedMessageInfo) {
+    logger.debug(
+      `Waiting for Bdx ${expectedMessageTypes.map((t) => import_types.BdxMessageType[t]).join("/")} message with timeout ${timeout}ms`
+    );
+    const message = await this.exchange.nextMessage({ timeout });
+    const messageType = message.payloadHeader.messageType;
+    if (expectedMessageInfo === void 0) {
+      expectedMessageInfo = expectedMessageTypes.map((t) => `${t} (${import_types.BdxMessageType[t]})`).join(",");
+    }
+    this.throwIfErrorStatusReport(message, expectedMessageInfo);
+    if (!expectedMessageTypes.includes(messageType))
+      throw new import_general.UnexpectedDataError(
+        `Received unexpected message type: ${import_types.BdxMessageType[messageType] ?? "unknown"}#${messageType}, expected: ${expectedMessageInfo}`
+      );
+    logger.debug(
+      `Received Bdx ${import_types.BdxMessageType[messageType]}${message.payload.byteLength > 0 ? ` with ${message.payload.byteLength}bytes` : ""}`,
+      message
+    );
+    return import_BdxMessage.BdxMessage.decode(messageType, message.payload);
+  }
+  async send(bdxMessage) {
+    const { kind: messageType, message } = bdxMessage;
+    logger.debug(
+      `Sending Bdx ${import_types.BdxMessageType[messageType]}${"data" in message && import_general.Bytes.isBytes(message.data) ? ` with ${message.data.byteLength}bytes` : ""}`,
+      message
+    );
+    await this.exchange.send(messageType, import_BdxMessage.BdxMessage.encode(bdxMessage));
+  }
+  /** Sends a Bdx SendInit message and waits for the SendAccept message as a response and returns it decoded. */
+  async sendSendInit(message) {
+    await this.send({ kind: import_types.BdxMessageType.SendInit, message });
+    const response = await this.nextMessage([import_types.BdxMessageType.SendAccept]);
+    import_BdxMessage.BdxMessage.assert(response, import_types.BdxMessageType.SendAccept);
+    return response.message;
+  }
+  /** Sends a ReceiveInit message and waits for the ReceiveAccept message as a response and returns it decoded. */
+  async sendReceiveInit(message) {
+    await this.send({ kind: import_types.BdxMessageType.ReceiveInit, message });
+    const response = await this.nextMessage([import_types.BdxMessageType.ReceiveAccept]);
+    import_BdxMessage.BdxMessage.assert(response, import_types.BdxMessageType.ReceiveAccept);
+    return response.message;
+  }
+  /** Encodes and sends a Bdx SendAccept message. */
+  async sendSendAccept(message) {
+    await this.send({ kind: import_types.BdxMessageType.SendAccept, message });
+  }
+  /** Encodes and sends a Bdx ReceiveAccept message. */
+  async sendReceiveAccept(message) {
+    await this.send({ kind: import_types.BdxMessageType.ReceiveAccept, message });
+  }
+  /** Encodes and sends a Bdx Block message. */
+  async sendBlock(message) {
+    await this.send({ kind: import_types.BdxMessageType.Block, message });
+  }
+  /** Encodes and sends a Bdx BlockQuery message. */
+  async sendBlockQuery(message) {
+    await this.send({ kind: import_types.BdxMessageType.BlockQuery, message });
+  }
+  /** Encodes and sends a Bdx BlockQueryWithSkip message. */
+  async sendBlockQueryWithSkip(message) {
+    await this.send({ kind: import_types.BdxMessageType.BlockQueryWithSkip, message });
+  }
+  /** Encodes and sends a Bdx BlockEof message. */
+  async sendBlockEof(message) {
+    await this.send({ kind: import_types.BdxMessageType.BlockEof, message });
+  }
+  /** Encodes and sends a Bdx BlockAck message. */
+  async sendBlockAck(message) {
+    await this.send({ kind: import_types.BdxMessageType.BlockAck, message });
+  }
+  /** Encodes and sends a Bdx BlockAckEof message */
+  async sendBlockAckEof(message) {
+    await this.send({ kind: import_types.BdxMessageType.BlockAckEof, message });
+  }
+  /** Read the next Block message, accepts Block and BlockEof messages. Returns the decoded message and it's type. */
+  async readBlock() {
+    const block = await this.nextMessage([import_types.BdxMessageType.Block, import_types.BdxMessageType.BlockEof]);
+    if (import_BdxMessage.BdxMessage.is(block, import_types.BdxMessageType.Block) && block.message.data.byteLength === 0) {
+      throw new import_BdxError.BdxError("Received empty data in Block message", import_types.BdxStatusCode.BadMessageContent);
+    }
+    return block;
+  }
+  /**
+   * Read the next BlockQuery message, accepts BlockQuery and BlockQueryWithSkip and BlockAck messages.
+   * When a BlockAck is received, it will be validated and the next BlockQuery message will be read.
+   * Returns the decoded message and it's type.
+   */
+  async readBlockQuery() {
+    let response = await this.nextMessage([
+      import_types.BdxMessageType.BlockQuery,
+      import_types.BdxMessageType.BlockQueryWithSkip,
+      import_types.BdxMessageType.BlockAck
+    ]);
+    let expectedBlockMessageCounter = void 0;
+    if (import_BdxMessage.BdxMessage.is(response, import_types.BdxMessageType.BlockAck)) {
+      expectedBlockMessageCounter = (response.message.blockCounter + 1) % 4294967296;
+      response = await this.nextMessage([import_types.BdxMessageType.BlockQuery, import_types.BdxMessageType.BlockQueryWithSkip]);
+    }
+    if (expectedBlockMessageCounter !== void 0 && response.message.blockCounter !== expectedBlockMessageCounter) {
+      throw new import_BdxError.BdxError(
+        `Received BlockQuery with unexpected block counter: ${response.message.blockCounter}, expected: ${expectedBlockMessageCounter}`,
+        import_types.BdxStatusCode.BadBlockCounter
+      );
+    }
+    return response;
+  }
+  /** Reads the next BlockAckEof message and returns the decoded message. */
+  async readBlockAckEof() {
+    const response = await this.nextMessage([import_types.BdxMessageType.BlockAckEof]);
+    import_BdxMessage.BdxMessage.assert(response, import_types.BdxMessageType.BlockAckEof);
+    return response.message;
+  }
+  /** Reads the next BlockAck message and returns the decoded message. */
+  async readBlockAck() {
+    const response = await this.nextMessage([import_types.BdxMessageType.BlockAck]);
+    import_BdxMessage.BdxMessage.assert(response, import_types.BdxMessageType.BlockAck);
+    return response.message;
+  }
+  /** Sends a Bdx Error StatusReport message with the given protocol status. */
+  sendError(code) {
+    return this.#sendStatusReport(import_types.GeneralStatusCode.Failure, code);
+  }
+  /** Encodes and sends a Bdx StatusReport message with the given general and protocol status. */
+  async #sendStatusReport(generalStatus, protocolStatus, requiresAck) {
+    await this.#exchange.send(
+      import_types.SecureMessageType.StatusReport,
+      import_BdxStatusMessageSchema.BdxStatusMessage.encode({
+        generalStatus,
+        protocolStatus
+      }),
+      {
+        requiresAck,
+        logContext: {
+          generalStatus: import_types.GeneralStatusCode[generalStatus] ?? import_general.Diagnostic.hex(generalStatus),
+          protocolStatus: import_types.BdxStatusCode[protocolStatus] ?? import_general.Diagnostic.hex(protocolStatus)
+        }
+      }
+    );
+  }
+  throwIfErrorStatusReport(message, logHint) {
+    const {
+      payloadHeader: { messageType },
+      payload
+    } = message;
+    if (messageType !== import_types.SecureMessageType.StatusReport) return;
+    const { generalStatus, protocolId, protocolStatus } = import_BdxStatusMessageSchema.BdxStatusMessage.decode(payload);
+    if (generalStatus !== import_types.GeneralStatusCode.Success) {
+      throw new import_BdxError.BdxStatusResponseError(
+        `Received general error status for protocol ${protocolId}${logHint ? ` (${logHint})` : ""}`,
+        generalStatus,
+        protocolStatus
+      );
+    }
+    if (protocolStatus !== import_types.BdxStatusCode.Success) {
+      throw new import_BdxError.BdxStatusResponseError(
+        `Received general success status, but protocol status is not Success${logHint ? ` (${logHint})` : ""}`,
+        generalStatus,
+        protocolStatus
+      );
+    }
+  }
+  close() {
+    return this.#exchange.close();
+  }
+  /**
+   * Ensure that the value is a safe JavaScript "number" type and that it is not too large. Matter spec allows also
+   * 64bit values, but they make little sense for now, so make sure we handle them as too large. MAX_SAFE_INTEGER is
+   * 2^53-1 and is enough for now.
+   */
+  static asSafeNumber(value, context = "", bdxErrorCode = import_types.BdxStatusCode.Unknown) {
+    if (typeof value !== "number" && typeof value !== "bigint") {
+      throw new import_general.InternalError(`${context} ${value} is not a number`);
+    }
+    if (value > Number.MAX_SAFE_INTEGER) {
+      throw new import_BdxError.BdxError(`${context} ${value} exceeds maximum safe integer value`, bdxErrorCode);
+    }
+    return Number(value);
+  }
+}
+//# sourceMappingURL=BdxMessenger.js.map

package/dist/cjs/bdx/BdxMessenger.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/bdx/BdxMessenger.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,qBASO;AAEP,mBAAoF;AACpF,sBAAiD;AAWjD,wBAA2B;AAC3B,oCAAiC;AA/BjC;AAAA;AAAA;AAAA;AAAA;AAiCA,MAAM,SAAS,sBAAO,IAAI,cAAc;AAEjC,MAAM,gCAA4B,wBAAQ,CAAC;AAG3C,MAAM,aAAa;AAAA,EACtB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAY,UAA2B,iBAAiB,2BAA2B;AAC/E,QAAI,CAAC,SAAS,QAAQ,YAAY;AAC9B,YAAM,IAAI,mCAAoB,+DAA+D;AAAA,IACjG;AACA,SAAK,kBAAkB;AACvB,SAAK,YAAY;AAAA,EACrB;AAAA,EAEA,IAAI,UAAU;AACV,WAAO,KAAK,UAAU;AAAA,EAC1B;AAAA,EAEA,IAAI,WAAW;AACX,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,iBAAiB;AACjB,WAAO,KAAK,UAAU;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,YACF,sBACA,UAAU,KAAK,iBACf,qBACwB;AACxB,WAAO;AAAA,MACH,mBAAmB,qBAAqB,IAAI,OAAK,4BAAe,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,yBAAyB,OAAO;AAAA,IACjH;AAEA,UAAM,UAAU,MAAM,KAAK,SAAS,YAAY,EAAE,QAAQ,CAAC;AAC3D,UAAM,cAAc,QAAQ,cAAc;AAC1C,QAAI,wBAAwB,QAAW;AACnC,4BAAsB,qBAAqB,IAAI,OAAK,GAAG,CAAC,KAAK,4BAAe,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG;AAAA,IAC/F;AACA,SAAK,yBAAyB,SAAS,mBAAmB;AAC1D,QAAI,CAAC,qBAAqB,SAAS,WAAW;AAC1C,YAAM,IAAI;AAAA,QACN,qCAAqC,4BAAe,WAAW,KAAK,SAAS,IAAI,WAAW,eAAe,mBAAmB;AAAA,MAClI;AAEJ,WAAO;AAAA,MACH,gBAAgB,4BAAe,WAAW,CAAC,GAAG,QAAQ,QAAQ,aAAa,IAAI,SAAS,QAAQ,QAAQ,UAAU,UAAU,EAAE;AAAA,MAC9H;AAAA,IACJ;AACA,WAAO,6BAAW,OAAO,aAAa,QAAQ,OAAO;AAAA,EACzD;AAAA,EAEA,MAAM,KAAK,YAA6B;AACpC,UAAM,EAAE,MAAM,aAAa,QAAQ,IAAI;AACvC,WAAO;AAAA,MACH,eAAe,4BAAe,WAAW,CAAC,GAAG,UAAU,WAAW,qBAAM,QAAQ,QAAQ,IAAI,IAAI,SAAS,QAAQ,KAAK,UAAU,UAAU,EAAE;AAAA,MAC5I;AAAA,IACJ;AACA,UAAM,KAAK,SAAS,KAAK,aAAa,6BAAW,OAAO,UAAU,CAAC;AAAA,EACvE;AAAA;AAAA,EAGA,MAAM,aAAa,SAA0C;AACzD,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,UAAU,QAAQ,CAAC;AAE1D,UAAM,WAAW,MAAM,KAAK,YAAY,CAAC,4BAAe,UAAU,CAAC;AACnE,iCAAW,OAAO,UAAU,4BAAe,UAAU;AACrD,WAAO,SAAS;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,gBAAgB,SAA6C;AAC/D,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,aAAa,QAAQ,CAAC;AAE7D,UAAM,WAAW,MAAM,KAAK,YAAY,CAAC,4BAAe,aAAa,CAAC;AACtE,iCAAW,OAAO,UAAU,4BAAe,aAAa;AACxD,WAAO,SAAS;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,eAAe,SAAwB;AACzC,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,YAAY,QAAQ,CAAC;AAAA,EAChE;AAAA;AAAA,EAGA,MAAM,kBAAkB,SAA2B;AAC/C,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,eAAe,QAAQ,CAAC;AAAA,EACnE;AAAA;AAAA,EAGA,MAAM,UAAU,SAAmB;AAC/B,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,OAAO,QAAQ,CAAC;AAAA,EAC3D;AAAA;AAAA,EAGA,MAAM,eAAe,SAAwB;AACzC,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,YAAY,QAAQ,CAAC;AAAA,EAChE;AAAA;AAAA,EAGA,MAAM,uBAAuB,SAAgC;AACzD,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,oBAAoB,QAAQ,CAAC;AAAA,EACxE;AAAA;AAAA,EAGA,MAAM,aAAa,SAAsB;AACrC,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,UAAU,QAAQ,CAAC;AAAA,EAC9D;AAAA;AAAA,EAGA,MAAM,aAAa,SAAsB;AACrC,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,UAAU,QAAQ,CAAC;AAAA,EAC9D;AAAA;AAAA,EAGA,MAAM,gBAAgB,SAAyB;AAC3C,UAAM,KAAK,KAAK,EAAE,MAAM,4BAAe,aAAa,QAAQ,CAAC;AAAA,EACjE;AAAA;AAAA,EAGA,MAAM,YAAiF;AACnF,UAAM,QAAQ,MAAM,KAAK,YAAY,CAAC,4BAAe,OAAO,4BAAe,QAAQ,CAAC;AACpF,QAAI,6BAAW,GAAG,OAAO,4BAAe,KAAK,KAAK,MAAM,QAAQ,KAAK,eAAe,GAAG;AAEnF,YAAM,IAAI,yBAAS,wCAAwC,2BAAc,iBAAiB;AAAA,IAC9F;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,iBAAqG;AACvG,QAAI,WAAW,MAAM,KAAK,YAAY;AAAA,MAClC,4BAAe;AAAA,MACf,4BAAe;AAAA,MACf,4BAAe;AAAA,IACnB,CAAC;AACD,QAAI,8BAAkD;AACtD,QAAI,6BAAW,GAAG,UAAU,4BAAe,QAAQ,GAAG;AAClD,qCAA+B,SAAS,QAAQ,eAAe,KAAK;AACpE,iBAAW,MAAM,KAAK,YAAY,CAAC,4BAAe,YAAY,4BAAe,kBAAkB,CAAC;AAAA,IACpG;AAGA,QACI,gCAAgC,UAChC,SAAS,QAAQ,iBAAiB,6BACpC;AACE,YAAM,IAAI;AAAA,QACN,sDAAsD,SAAS,QAAQ,YAAY,eAAe,2BAA2B;AAAA,QAC7H,2BAAc;AAAA,MAClB;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAAA;AAAA,EAGA,MAAM,kBAA2C;AAC7C,UAAM,WAAW,MAAM,KAAK,YAAY,CAAC,4BAAe,WAAW,CAAC;AACpE,iCAAW,OAAO,UAAU,4BAAe,WAAW;AACtD,WAAO,SAAS;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,eAAqC;AACvC,UAAM,WAAW,MAAM,KAAK,YAAY,CAAC,4BAAe,QAAQ,CAAC;AACjE,iCAAW,OAAO,UAAU,4BAAe,QAAQ;AACnD,WAAO,SAAS;AAAA,EACpB;AAAA;AAAA,EAGA,UAAU,MAAqB;AAC3B,WAAO,KAAK,kBAAkB,+BAAkB,SAAS,IAAI;AAAA,EACjE;AAAA;AAAA,EAGA,MAAM,kBAAkB,eAAkC,gBAA+B,aAAuB;AAC5G,UAAM,KAAK,UAAU;AAAA,MACjB,+BAAkB;AAAA,MAClB,+CAAiB,OAAO;AAAA,QACpB;AAAA,QACA;AAAA,MACJ,CAAC;AAAA,MACD;AAAA,QACI;AAAA,QACA,YAAY;AAAA,UACR,eAAe,+BAAkB,aAAa,KAAK,0BAAW,IAAI,aAAa;AAAA,UAC/E,gBAAgB,2BAAc,cAAc,KAAK,0BAAW,IAAI,cAAc;AAAA,QAClF;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA,EAEU,yBAAyB,SAAkB,SAAkB;AACnE,UAAM;AAAA,MACF,eAAe,EAAE,YAAY;AAAA,MAC7B;AAAA,IACJ,IAAI;AACJ,QAAI,gBAAgB,+BAAkB,aAAc;AAEpD,UAAM,EAAE,eAAe,YAAY,eAAe,IAAI,+CAAiB,OAAO,OAAO;AACrF,QAAI,kBAAkB,+BAAkB,SAAS;AAC7C,YAAM,IAAI;AAAA,QACN,8CAA8C,UAAU,GAAG,UAAU,KAAK,OAAO,MAAM,EAAE;AAAA,QACzF;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,mBAAmB,2BAAc,SAAS;AAC1C,YAAM,IAAI;AAAA,QACN,sEAAsE,UAAU,KAAK,OAAO,MAAM,EAAE;AAAA,QACpG;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,QAAQ;AACJ,WAAO,KAAK,UAAU,MAAM;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,aACH,OACA,UAAU,IACV,eAAe,2BAAc,SACvB;AACN,QAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAAU;AACxD,YAAM,IAAI,6BAAc,GAAG,OAAO,IAAI,KAAK,kBAAkB;AAAA,IACjE;AACA,QAAI,QAAQ,OAAO,kBAAkB;AACjC,YAAM,IAAI,yBAAS,GAAG,OAAO,IAAI,KAAK,uCAAuC,YAAY;AAAA,IAC7F;AACA,WAAO,OAAO,KAAK;AAAA,EACvB;AACJ;",
+  "names": []
+}

package/dist/cjs/bdx/BdxProtocol.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { StorageContext } from "#general";
+import { MessageExchange } from "#protocol/MessageExchange.js";
+import { ProtocolHandler } from "#protocol/ProtocolHandler.js";
+import { Message } from "../codec/MessageCodec.js";
+import { BdxSessionConfiguration } from "./BdxSessionConfiguration.js";
+/** BDX protocol handler. */
+export declare class BdxProtocol implements ProtocolHandler {
+    #private;
+    readonly id = 2;
+    readonly requiresSecureSession = true;
+    /**
+     * Create a new BDX protocol handler.
+     * @param storage StorageContext to read or write files from/to.
+     * @param options BDX options/limits to use for this session. us this to control how the transfer should behave.
+     */
+    constructor(storage: StorageContext, options?: BdxSessionConfiguration.Config);
+    onNewExchange(exchange: MessageExchange, message: Message): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=BdxProtocol.d.ts.map

package/dist/cjs/bdx/BdxProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BdxProtocol.d.ts","sourceRoot":"","sources":["../../../src/bdx/BdxProtocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAuB,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAGnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAKvE,4BAA4B;AAC5B,qBAAa,WAAY,YAAW,eAAe;;IAC/C,QAAQ,CAAC,EAAE,KAAmB;IAC9B,QAAQ,CAAC,qBAAqB,QAAQ;IAKtC;;;;OAIG;gBACS,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,uBAAuB,CAAC,MAAM;IAKvE,aAAa,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO;IAiDzD,KAAK;CAOd"}