@azure/service-bus 7.10.0-beta.1 → 7.10.0-beta.3

package/dist/browser/models.d.ts

@@ -0,0 +1,328 @@
+import type { OperationOptionsBase } from "./modelsToBeSharedWithEventHubs.js";
+import type Long from "long";
+import type { ServiceBusReceivedMessage } from "./serviceBusMessage.js";
+import type { ServiceBusError } from "./serviceBusError.js";
+/**
+ * Arguments to the `processError` callback.
+ */
+export interface ProcessErrorArgs {
+    /**
+     * The error.
+     */
+    error: Error | ServiceBusError;
+    /**
+     * The operation where the error originated.
+     *
+     * 'abandon': Errors that occur when if `abandon` is triggered automatically.
+     * 'complete': Errors that occur when autoComplete completes a message.
+     * 'processMessageCallback': Errors thrown from the user's `processMessage` callback passed to `subscribe`.
+     * 'receive': Errors thrown when receiving messages.
+     * 'renewLock': Errors thrown when automatic lock renewal fails.
+     */
+    errorSource: "abandon" | "complete" | "processMessageCallback" | "receive" | "renewLock";
+    /**
+     * The entity path for the current receiver.
+     */
+    entityPath: string;
+    /**
+     * The fully qualified namespace for the Service Bus.
+     */
+    fullyQualifiedNamespace: string;
+    /**
+     * The identifier of the client that raised this event.
+     */
+    identifier: string;
+}
+/**
+ * @internal
+ */
+export interface InternalProcessErrorArgs extends Omit<ProcessErrorArgs, "errorSource"> {
+    /**
+     * The operation where the error originated.
+     *
+     * 'abandon': Errors that occur when if `abandon` is triggered automatically.
+     * 'complete': Errors that occur when autoComplete completes a message.
+     * 'processMessageCallback': Errors thrown from the user's `processMessage` callback passed to `subscribe`.
+     * 'receive': Errors thrown when receiving messages.
+     * 'renewLock': Errors thrown when automatic lock renewal fails.
+     */
+    errorSource: ProcessErrorArgs["errorSource"] | "internal";
+}
+/**
+ * The general message handler interface (used for streamMessages).
+ */
+export interface MessageHandlers {
+    /**
+     * Handler that processes messages from service bus.
+     *
+     * @param message - A message received from Service Bus.
+     */
+    processMessage(message: ServiceBusReceivedMessage): Promise<void>;
+    /**
+     * Handler that processes errors that occur during receiving.
+     *
+     * This handler will be called for any error that occurs in the receiver when
+     *   - receiving the message, or
+     *   - executing your `processMessage` callback, or
+     *   - receiver is completing the message on your behalf after successfully running your `processMessage` callback and `autoCompleteMessages` is enabled
+     *   - receiver is abandoning the message on your behalf if running your `processMessage` callback fails and `autoCompleteMessages` is enabled
+     *   - receiver is renewing the lock on your behalf due to auto lock renewal feature being enabled
+     *
+     * Note that when receiving messages in a stream using `subscribe()`, the receiver will automatically retry receiving messages on all errors unless
+     * `close()` is called on the subscription. It is completely up to users to decide what errors are considered non-recoverable and to handle them
+     * accordingly in this callback.
+     * For a list of errors occurs within Service Bus, please refer to https://learn.microsoft.com/javascript/api/\@azure/service-bus/servicebuserror?view=azure-node-latest
+     * @param args - The error and additional context to indicate where
+     * the error originated.
+     */
+    processError(args: ProcessErrorArgs): Promise<void>;
+}
+/**
+ * @internal
+ */
+export interface InternalMessageHandlers extends MessageHandlers {
+    /**
+     * Called when the connection is initialized but before we've added credits.
+     * NOTE: This handler is completely internal and only used for tests.
+     */
+    postInitialize?: () => Promise<void>;
+    /**
+     * Called before we actually initialize the link itself.
+     * NOTE: This handler is completely internal and only used for tests.
+     */
+    preInitialize?: () => Promise<void>;
+    /**
+     * Forwards internal errors that are not normally reported to the customer to `processError`.
+     * (defaults to false)
+     */
+    forwardInternalErrors?: boolean;
+}
+/**
+ * Represents the possible receive modes for the receiver.
+ * @internal
+ */
+export type ReceiveMode = "peekLock" | "receiveAndDelete";
+/**
+ * Options to use when creating a receiver.
+ */
+export interface ServiceBusReceiverOptions {
+    /**
+     * Represents the receive mode for the receiver.
+     *
+     * In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
+     *
+     * In peekLock mode, the receiver has a lock on the message for the duration specified on the
+     * queue/subscription.
+     *
+     * Messages that are not settled within the lock duration will be redelivered as many times as
+     * the max delivery count set on the queue/subscription, after which they get sent to a separate
+     * dead letter queue.
+     *
+     * You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
+     * the message.
+     *
+     * More information about how peekLock and message settlement works here:
+     * https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
+     *
+     */
+    receiveMode?: "peekLock" | "receiveAndDelete";
+    /**
+     * Represents the sub queue that is applicable for any queue or subscription.
+     * Valid values are "deadLetter" and "transferDeadLetter". To learn more about dead letter queues,
+     * see https://learn.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
+     */
+    subQueueType?: "deadLetter" | "transferDeadLetter";
+    /**
+     * The maximum duration, in milliseconds, that the lock on the message will be renewed automatically by the client.
+     * This auto renewal stops once the message is settled.
+     *
+     * - **Default**: `300 * 1000` milliseconds (5 minutes).
+     * - **To disable autolock renewal**, set this to `0`.
+     *
+     * **Example:**
+     *
+     *    If the message lock expires in 2 minutes and your message processing time is 8 minutes...
+     *
+     *    Set maxAutoLockRenewalDurationInMs to 10 minutes, and the message lock will be automatically renewed for 4 times
+     *    (equivalent to having the message locked for 4 times its lock duration by leveraging the lock renewals).
+     */
+    maxAutoLockRenewalDurationInMs?: number;
+    /**
+     * Option to disable the client from running JSON.parse() on the message body when receiving the message.
+     * Not applicable if the message was sent with AMQP body type value or sequence. Use this option when you
+     * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
+     */
+    skipParsingBodyAsJson?: boolean;
+    /**
+     * Whether to skip converting Date type on properties of message annotations
+     * or application properties into numbers when receiving the message. By
+     * default, properties of Date type is converted into UNIX epoch number for
+     * compatibility.
+     */
+    skipConvertingDate?: boolean;
+    /**
+     * Sets the name to identify the receiver. This can be used to correlate logs and exceptions.
+     * If not specified or empty, a random unique one will be used.
+     */
+    identifier?: string;
+}
+/**
+ * Options to use when creating a sender.
+ */
+export interface ServiceBusSenderOptions {
+    /**
+     * Sets the name to identify the sender. This can be used to correlate logs and exceptions.
+     * If not specified or empty, a random unique one will be used.
+     */
+    identifier?: string;
+}
+/**
+ * Options to configure the `createBatch` method on the `Sender`.
+ * - `maxSizeInBytes`: The upper limit for the size of batch.
+ *
+ * Example usage:
+ * ```ts snippet:ignore
+ * {
+ *     maxSizeInBytes: 1024 * 1024 // 1 MB
+ * }
+ * ```
+ */
+export interface CreateMessageBatchOptions extends OperationOptionsBase {
+    /**
+     * The upper limit for the size of batch. The `tryAdd` function will return `false` after this limit is reached.
+     */
+    maxSizeInBytes?: number;
+}
+/**
+ * Options when receiving a batch of messages from Service Bus.
+ */
+export interface ReceiveMessagesOptions extends OperationOptionsBase {
+    /**
+     * The maximum amount of time to wait for messages to arrive.
+     *  **Default**: `60000` milliseconds.
+     */
+    maxWaitTimeInMs?: number;
+}
+/**
+ * Options when getting an iterable iterator from Service Bus.
+ */
+export interface GetMessageIteratorOptions extends OperationOptionsBase {
+}
+/**
+ * Options used when subscribing to a Service Bus queue or subscription.
+ */
+export interface SubscribeOptions extends OperationOptionsBase {
+    /**
+     * Indicates whether the message should be settled automatically based on the result from the
+     * user provided `processMessage` callback.
+     *
+     * - If an error is thrown from the `processMessage` callback the message will be abandoned
+     *   using `receiver.abandonMessage()`. Doing so will make the message available again from the
+     *   queue/subscription and the delivery count will be incremented.
+     * - If NO error is thrown from `processMessage` the message will be completed
+     *   using `receiver.completeMessage()`. Doing so removes the message from the queue/subscription.
+     *
+     * This option is ignored if messages are received in the `receiveAndDelete` receive mode or if
+     * the message is already settled in the user provided message callback.
+     *
+     * - **Default**: `true`.
+     */
+    autoCompleteMessages?: boolean;
+    /**
+     * The maximum number of concurrent calls that the library
+     * can make to the user's message handler. Once this limit has been reached, more messages will
+     * not be received until at least one of the calls to the user's message handler has completed.
+     * - **Default**: `1`.
+     */
+    maxConcurrentCalls?: number;
+}
+/**
+ * Describes the options passed to the `acceptSession` and `acceptNextSession` methods
+ * when using a Queue/Subscription that has sessions enabled.
+ */
+export interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {
+    /**
+     * Represents the receive mode for the receiver.
+     *
+     * In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
+     *
+     * In peekLock mode, the receiver has a lock on the message for the duration specified on the
+     * queue/subscription.
+     *
+     * Messages that are not settled within the lock duration will be redelivered as many times as
+     * the max delivery count set on the queue/subscription, after which they get sent to a separate
+     * dead letter queue.
+     *
+     * You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on
+     * the message.
+     *
+     * More information about how peekLock and message settlement works here:
+     * https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
+     *
+     */
+    receiveMode?: "peekLock" | "receiveAndDelete";
+    /**
+     * The maximum duration, in milliseconds, that the lock on the session will be renewed automatically by the client.
+     *
+     * - **Default**: `300000` milliseconds (5 minutes).
+     * - **To disable autolock renewal**, set this to `0`.
+     *
+     * **Example:**
+     *
+     *    If the lock expires in 2 minutes and your processing time is 8 minutes...
+     *
+     *    Set maxAutoLockRenewalDurationInMs to 10 minutes, and the lock will be automatically renewed about 4 times
+     *    (equivalent to having the session locked for 4 times its lock duration by leveraging the lock renewals).
+     */
+    maxAutoLockRenewalDurationInMs?: number;
+    /**
+     * Option to disable the client from running JSON.parse() on the message body when receiving the message.
+     * Not applicable if the message was sent with AMQP body type value or sequence. Use this option when you
+     * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
+     */
+    skipParsingBodyAsJson?: boolean;
+    /**
+     * Whether to skip converting Date type on properties of message annotations
+     * or application properties into numbers when receiving the message. By
+     * default, properties of Date type is converted into UNIX epoch number for
+     * compatibility.
+     */
+    skipConvertingDate?: boolean;
+    /**
+     * Sets the name to identify the session receiver. This can be used to correlate logs and exceptions.
+     * If not specified or empty, a random unique one will be used.
+     */
+    identifier?: string;
+}
+/**
+ * Describes the options passed to the `peekMessages` method on a receiver.
+ */
+export interface PeekMessagesOptions extends OperationOptionsBase {
+    /**
+     * The sequence number to start peeking messages from (inclusive).
+     */
+    fromSequenceNumber?: Long;
+}
+/**
+ * Options to configure messages deletion.
+ */
+export interface DeleteMessagesOptions extends OperationOptionsBase {
+    /**
+     * If specified, only messages enqueued before this time are deleted.
+     */
+    beforeEnqueueTime?: Date;
+    /**
+     * Up to `maxMessageCount` messages will be deleted.
+     */
+    maxMessageCount: number;
+}
+/**
+ * Options to configure deletion of all messages in an entity.
+ */
+export interface PurgeMessagesOptions extends OperationOptionsBase {
+    /**
+     * If specified, only messages enqueued before this time are deleted.
+     */
+    beforeEnqueueTime?: Date;
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/browser/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,eAAe,CAAC;IAC/B;;;;;;;;OAQG;IACH,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,wBAAwB,GAAG,SAAS,GAAG,WAAW,CAAC;IACzF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC;IACrF;;;;;;;;OAQG;IACH,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,kBAAkB,CAAC;IAC9C;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,oBAAoB,CAAC;IAEnD;;;;;;;;;;;;;OAaG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAClE;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;CAAG;AAE1E;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,kBAAkB,CAAC;IAC9C;;;;;;;;;;;;OAYG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;OAEG;IACH,kBAAkB,CAAC,EAAE,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;OAEG;IACH,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,IAAI,CAAC;CAC1B"}

package/dist/browser/models.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=models.js.map

package/dist/browser/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationOptionsBase } from \"./modelsToBeSharedWithEventHubs.js\";\nimport type Long from \"long\";\nimport type { ServiceBusReceivedMessage } from \"./serviceBusMessage.js\";\nimport type { ServiceBusError } from \"./serviceBusError.js\";\n\n/**\n * Arguments to the `processError` callback.\n */\nexport interface ProcessErrorArgs {\n  /**\n   * The error.\n   */\n  error: Error | ServiceBusError;\n  /**\n   * The operation where the error originated.\n   *\n   * 'abandon': Errors that occur when if `abandon` is triggered automatically.\n   * 'complete': Errors that occur when autoComplete completes a message.\n   * 'processMessageCallback': Errors thrown from the user's `processMessage` callback passed to `subscribe`.\n   * 'receive': Errors thrown when receiving messages.\n   * 'renewLock': Errors thrown when automatic lock renewal fails.\n   */\n  errorSource: \"abandon\" | \"complete\" | \"processMessageCallback\" | \"receive\" | \"renewLock\";\n  /**\n   * The entity path for the current receiver.\n   */\n  entityPath: string;\n  /**\n   * The fully qualified namespace for the Service Bus.\n   */\n  fullyQualifiedNamespace: string;\n  /**\n   * The identifier of the client that raised this event.\n   */\n  identifier: string;\n}\n\n/**\n * @internal\n */\nexport interface InternalProcessErrorArgs extends Omit<ProcessErrorArgs, \"errorSource\"> {\n  /**\n   * The operation where the error originated.\n   *\n   * 'abandon': Errors that occur when if `abandon` is triggered automatically.\n   * 'complete': Errors that occur when autoComplete completes a message.\n   * 'processMessageCallback': Errors thrown from the user's `processMessage` callback passed to `subscribe`.\n   * 'receive': Errors thrown when receiving messages.\n   * 'renewLock': Errors thrown when automatic lock renewal fails.\n   */\n  errorSource: ProcessErrorArgs[\"errorSource\"] | \"internal\";\n}\n\n/**\n * The general message handler interface (used for streamMessages).\n */\nexport interface MessageHandlers {\n  /**\n   * Handler that processes messages from service bus.\n   *\n   * @param message - A message received from Service Bus.\n   */\n  processMessage(message: ServiceBusReceivedMessage): Promise<void>;\n  /**\n   * Handler that processes errors that occur during receiving.\n   *\n   * This handler will be called for any error that occurs in the receiver when\n   *   - receiving the message, or\n   *   - executing your `processMessage` callback, or\n   *   - receiver is completing the message on your behalf after successfully running your `processMessage` callback and `autoCompleteMessages` is enabled\n   *   - receiver is abandoning the message on your behalf if running your `processMessage` callback fails and `autoCompleteMessages` is enabled\n   *   - receiver is renewing the lock on your behalf due to auto lock renewal feature being enabled\n   *\n   * Note that when receiving messages in a stream using `subscribe()`, the receiver will automatically retry receiving messages on all errors unless\n   * `close()` is called on the subscription. It is completely up to users to decide what errors are considered non-recoverable and to handle them\n   * accordingly in this callback.\n   * For a list of errors occurs within Service Bus, please refer to https://learn.microsoft.com/javascript/api/\\@azure/service-bus/servicebuserror?view=azure-node-latest\n   * @param args - The error and additional context to indicate where\n   * the error originated.\n   */\n  processError(args: ProcessErrorArgs): Promise<void>;\n}\n\n/**\n * @internal\n */\nexport interface InternalMessageHandlers extends MessageHandlers {\n  /**\n   * Called when the connection is initialized but before we've added credits.\n   * NOTE: This handler is completely internal and only used for tests.\n   */\n  postInitialize?: () => Promise<void>;\n\n  /**\n   * Called before we actually initialize the link itself.\n   * NOTE: This handler is completely internal and only used for tests.\n   */\n  preInitialize?: () => Promise<void>;\n\n  /**\n   * Forwards internal errors that are not normally reported to the customer to `processError`.\n   * (defaults to false)\n   */\n  forwardInternalErrors?: boolean;\n}\n\n/**\n * Represents the possible receive modes for the receiver.\n * @internal\n */\nexport type ReceiveMode = \"peekLock\" | \"receiveAndDelete\";\n\n/**\n * Options to use when creating a receiver.\n */\nexport interface ServiceBusReceiverOptions {\n  /**\n   * Represents the receive mode for the receiver.\n   *\n   * In receiveAndDelete mode, messages are deleted from Service Bus as they are received.\n   *\n   * In peekLock mode, the receiver has a lock on the message for the duration specified on the\n   * queue/subscription.\n   *\n   * Messages that are not settled within the lock duration will be redelivered as many times as\n   * the max delivery count set on the queue/subscription, after which they get sent to a separate\n   * dead letter queue.\n   *\n   * You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on\n   * the message.\n   *\n   * More information about how peekLock and message settlement works here:\n   * https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock\n   *\n   */\n  receiveMode?: \"peekLock\" | \"receiveAndDelete\";\n  /**\n   * Represents the sub queue that is applicable for any queue or subscription.\n   * Valid values are \"deadLetter\" and \"transferDeadLetter\". To learn more about dead letter queues,\n   * see https://learn.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues\n   */\n  subQueueType?: \"deadLetter\" | \"transferDeadLetter\";\n\n  /**\n   * The maximum duration, in milliseconds, that the lock on the message will be renewed automatically by the client.\n   * This auto renewal stops once the message is settled.\n   *\n   * - **Default**: `300 * 1000` milliseconds (5 minutes).\n   * - **To disable autolock renewal**, set this to `0`.\n   *\n   * **Example:**\n   *\n   *    If the message lock expires in 2 minutes and your message processing time is 8 minutes...\n   *\n   *    Set maxAutoLockRenewalDurationInMs to 10 minutes, and the message lock will be automatically renewed for 4 times\n   *    (equivalent to having the message locked for 4 times its lock duration by leveraging the lock renewals).\n   */\n  maxAutoLockRenewalDurationInMs?: number;\n  /**\n   * Option to disable the client from running JSON.parse() on the message body when receiving the message.\n   * Not applicable if the message was sent with AMQP body type value or sequence. Use this option when you\n   * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.\n   */\n  skipParsingBodyAsJson?: boolean;\n  /**\n   * Whether to skip converting Date type on properties of message annotations\n   * or application properties into numbers when receiving the message. By\n   * default, properties of Date type is converted into UNIX epoch number for\n   * compatibility.\n   */\n  skipConvertingDate?: boolean;\n  /**\n   * Sets the name to identify the receiver. This can be used to correlate logs and exceptions.\n   * If not specified or empty, a random unique one will be used.\n   */\n  identifier?: string;\n}\n\n/**\n * Options to use when creating a sender.\n */\nexport interface ServiceBusSenderOptions {\n  /**\n   * Sets the name to identify the sender. This can be used to correlate logs and exceptions.\n   * If not specified or empty, a random unique one will be used.\n   */\n  identifier?: string;\n}\n\n/**\n * Options to configure the `createBatch` method on the `Sender`.\n * - `maxSizeInBytes`: The upper limit for the size of batch.\n *\n * Example usage:\n * ```ts snippet:ignore\n * {\n *     maxSizeInBytes: 1024 * 1024 // 1 MB\n * }\n * ```\n */\nexport interface CreateMessageBatchOptions extends OperationOptionsBase {\n  /**\n   * The upper limit for the size of batch. The `tryAdd` function will return `false` after this limit is reached.\n   */\n  maxSizeInBytes?: number;\n}\n\n/**\n * Options when receiving a batch of messages from Service Bus.\n */\nexport interface ReceiveMessagesOptions extends OperationOptionsBase {\n  /**\n   * The maximum amount of time to wait for messages to arrive.\n   *  **Default**: `60000` milliseconds.\n   */\n  maxWaitTimeInMs?: number;\n}\n\n/**\n * Options when getting an iterable iterator from Service Bus.\n */\nexport interface GetMessageIteratorOptions extends OperationOptionsBase {}\n\n/**\n * Options used when subscribing to a Service Bus queue or subscription.\n */\nexport interface SubscribeOptions extends OperationOptionsBase {\n  /**\n   * Indicates whether the message should be settled automatically based on the result from the\n   * user provided `processMessage` callback.\n   *\n   * - If an error is thrown from the `processMessage` callback the message will be abandoned\n   *   using `receiver.abandonMessage()`. Doing so will make the message available again from the\n   *   queue/subscription and the delivery count will be incremented.\n   * - If NO error is thrown from `processMessage` the message will be completed\n   *   using `receiver.completeMessage()`. Doing so removes the message from the queue/subscription.\n   *\n   * This option is ignored if messages are received in the `receiveAndDelete` receive mode or if\n   * the message is already settled in the user provided message callback.\n   *\n   * - **Default**: `true`.\n   */\n  autoCompleteMessages?: boolean;\n  /**\n   * The maximum number of concurrent calls that the library\n   * can make to the user's message handler. Once this limit has been reached, more messages will\n   * not be received until at least one of the calls to the user's message handler has completed.\n   * - **Default**: `1`.\n   */\n  maxConcurrentCalls?: number;\n}\n\n/**\n * Describes the options passed to the `acceptSession` and `acceptNextSession` methods\n * when using a Queue/Subscription that has sessions enabled.\n */\nexport interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {\n  /**\n   * Represents the receive mode for the receiver.\n   *\n   * In receiveAndDelete mode, messages are deleted from Service Bus as they are received.\n   *\n   * In peekLock mode, the receiver has a lock on the message for the duration specified on the\n   * queue/subscription.\n   *\n   * Messages that are not settled within the lock duration will be redelivered as many times as\n   * the max delivery count set on the queue/subscription, after which they get sent to a separate\n   * dead letter queue.\n   *\n   * You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on\n   * the message.\n   *\n   * More information about how peekLock and message settlement works here:\n   * https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock\n   *\n   */\n  receiveMode?: \"peekLock\" | \"receiveAndDelete\";\n  /**\n   * The maximum duration, in milliseconds, that the lock on the session will be renewed automatically by the client.\n   *\n   * - **Default**: `300000` milliseconds (5 minutes).\n   * - **To disable autolock renewal**, set this to `0`.\n   *\n   * **Example:**\n   *\n   *    If the lock expires in 2 minutes and your processing time is 8 minutes...\n   *\n   *    Set maxAutoLockRenewalDurationInMs to 10 minutes, and the lock will be automatically renewed about 4 times\n   *    (equivalent to having the session locked for 4 times its lock duration by leveraging the lock renewals).\n   */\n  maxAutoLockRenewalDurationInMs?: number;\n  /**\n   * Option to disable the client from running JSON.parse() on the message body when receiving the message.\n   * Not applicable if the message was sent with AMQP body type value or sequence. Use this option when you\n   * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.\n   */\n  skipParsingBodyAsJson?: boolean;\n  /**\n   * Whether to skip converting Date type on properties of message annotations\n   * or application properties into numbers when receiving the message. By\n   * default, properties of Date type is converted into UNIX epoch number for\n   * compatibility.\n   */\n  skipConvertingDate?: boolean;\n  /**\n   * Sets the name to identify the session receiver. This can be used to correlate logs and exceptions.\n   * If not specified or empty, a random unique one will be used.\n   */\n  identifier?: string;\n}\n\n/**\n * Describes the options passed to the `peekMessages` method on a receiver.\n */\nexport interface PeekMessagesOptions extends OperationOptionsBase {\n  /**\n   * The sequence number to start peeking messages from (inclusive).\n   */\n  fromSequenceNumber?: Long;\n}\n\n/**\n * Options to configure messages deletion.\n */\nexport interface DeleteMessagesOptions extends OperationOptionsBase {\n  /**\n   * If specified, only messages enqueued before this time are deleted.\n   */\n  beforeEnqueueTime?: Date;\n  /**\n   * Up to `maxMessageCount` messages will be deleted.\n   */\n  maxMessageCount: number;\n}\n\n/**\n * Options to configure deletion of all messages in an entity.\n */\nexport interface PurgeMessagesOptions extends OperationOptionsBase {\n  /**\n   * If specified, only messages enqueued before this time are deleted.\n   */\n  beforeEnqueueTime?: Date;\n}\n"]}

package/dist/browser/modelsToBeSharedWithEventHubs.d.ts

@@ -0,0 +1,18 @@
+import type { OperationTracingOptions } from "@azure/core-tracing";
+import type { OperationOptions } from "@azure/core-client";
+/**
+ * NOTE: This type is intended to mirror the relevant fields and structure from `@azure/core-client` OperationOptions
+ *
+ * Options for configuring tracing and the abortSignal.
+ */
+export type OperationOptionsBase = Pick<OperationOptions, "abortSignal" | "tracingOptions">;
+/**
+ * The set of options to manually propagate `Span` context for distributed tracing.
+ */
+export interface TryAddOptions {
+    /**
+     * The options to use when creating Spans for tracing.
+     */
+    tracingOptions?: OperationTracingOptions;
+}
+//# sourceMappingURL=modelsToBeSharedWithEventHubs.d.ts.map

package/dist/browser/modelsToBeSharedWithEventHubs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsToBeSharedWithEventHubs.d.ts","sourceRoot":"","sources":["../../src/modelsToBeSharedWithEventHubs.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAC;CAC1C"}

package/dist/browser/modelsToBeSharedWithEventHubs.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=modelsToBeSharedWithEventHubs.js.map

package/dist/browser/modelsToBeSharedWithEventHubs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsToBeSharedWithEventHubs.js","sourceRoot":"","sources":["../../src/modelsToBeSharedWithEventHubs.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n// TODO: this code is a straight-copy from EventHubs. Need to merge.\n\nimport type { OperationTracingOptions } from \"@azure/core-tracing\";\nimport type { OperationOptions } from \"@azure/core-client\";\n\n/**\n * NOTE: This type is intended to mirror the relevant fields and structure from `@azure/core-client` OperationOptions\n *\n * Options for configuring tracing and the abortSignal.\n */\nexport type OperationOptionsBase = Pick<OperationOptions, \"abortSignal\" | \"tracingOptions\">;\n\n/**\n * The set of options to manually propagate `Span` context for distributed tracing.\n */\nexport interface TryAddOptions {\n  /**\n   * The options to use when creating Spans for tracing.\n   */\n  tracingOptions?: OperationTracingOptions;\n}\n"]}

package/dist/browser/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}