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

package/dist/browser/receivers/receiver.d.ts

@@ -0,0 +1,299 @@
+import type { PeekMessagesOptions, GetMessageIteratorOptions, MessageHandlers, ReceiveMessagesOptions, SubscribeOptions, DeleteMessagesOptions, PurgeMessagesOptions } from "../models.js";
+import type { OperationOptionsBase } from "../modelsToBeSharedWithEventHubs.js";
+import type { ServiceBusReceivedMessage } from "../serviceBusMessage.js";
+import type { ConnectionContext } from "../connectionContext.js";
+import type Long from "long";
+import type { DeadLetterOptions } from "../serviceBusMessage.js";
+import type { RetryOptions } from "@azure/core-amqp";
+/**
+ * The default time to wait for messages _after_ the first message
+ * has been received.
+ *
+ * This timeout only applies to receiveMessages()
+ *
+ * @internal
+ */
+export declare const defaultMaxTimeAfterFirstMessageForBatchingMs = 1000;
+/**
+ * The maximum number of messages to delete in a single batch.  This cap is established and enforced by the service.
+ * @internal
+ */
+export declare const MaxDeleteMessageCount = 500;
+/**
+ * A receiver that does not handle sessions.
+ */
+export interface ServiceBusReceiver {
+    /**
+     * A name used to identify the receiver. This can be used to correlate logs and exceptions.
+     * If not specified or empty, a random unique one will be generated.
+     */
+    identifier: string;
+    /**
+     * Streams messages to message handlers.
+     * @param handlers - A handler that gets called for messages and errors.
+     * @param options - Options for subscribe.
+     * @returns An object that can be closed, sending any remaining messages to `handlers` and
+     * stopping new messages from arriving.
+     */
+    subscribe(handlers: MessageHandlers, options?: SubscribeOptions): {
+        /**
+         * Causes the subscriber to stop receiving new messages.
+         */
+        close(): Promise<void>;
+    };
+    /**
+     * Returns an iterator that can be used to receive messages from Service Bus.
+     *
+     * @param options - A set of options to control the receive operation.
+     * - `abortSignal`: The signal to use to abort the ongoing operation.
+     *
+     * @throws Error if the underlying connection, client or receiver is closed.
+     * @throws Error if current receiver is already in state of receiving messages.
+     * @throws `ServiceBusError` if the service returns an error while receiving messages.
+     */
+    getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>;
+    /**
+     * Returns a promise that resolves to an array of messages received from Service Bus.
+     *
+     * @param maxMessageCount - The maximum number of messages to receive.
+     * @param options - A set of options to control the receive operation.
+     * - `maxWaitTimeInMs`: The maximum time to wait for the first message before returning an empty array if no messages are available.
+     * - `abortSignal`: The signal to use to abort the ongoing operation.
+     * @returns A promise that resolves with an array of messages.
+     * @throws Error if the underlying connection, client or receiver is closed.
+     * @throws Error if current receiver is already in state of receiving messages.
+     * @throws `ServiceBusError` if the service returns an error while receiving messages.
+     */
+    receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>;
+    /**
+     * Returns a promise that resolves to an array of deferred messages identified by given `sequenceNumbers`.
+     * @param sequenceNumbers - The sequence number or an array of sequence numbers for the messages that need to be received.
+     * @param options - Options bag to pass an abort signal or tracing options.
+     * @returns A list of messages identified by the given sequenceNumbers or an empty list if no messages are found.
+     * @throws Error if the underlying connection or receiver is closed.
+     * @throws `ServiceBusError` if the service returns an error while receiving deferred messages.
+     */
+    receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>;
+    /**
+     * Peek the next batch of active messages (including deferred but not deadlettered messages) on the
+     * queue or subscription without modifying them.
+     * - The first call to `peekMessages()` fetches the first active message. Each subsequent call fetches the
+     * subsequent message.
+     * - Unlike a "received" message, "peeked" message is a read-only version of the message.
+     * It cannot be `Completed/Abandoned/Deferred/Deadlettered`.
+     * @param maxMessageCount - The maximum number of messages to peek.
+     * @param options - Options that allow to specify the maximum number of messages to peek,
+     * the sequenceNumber to start peeking from or an abortSignal to abort the operation.
+     */
+    peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>;
+    /**
+     * Delete messages. If no option is specified, all messages will be deleted.
+     *
+     * @param options - Options to configure the operation.
+     * @returns number of messages that have been deleted.
+     */
+    deleteMessages(options: DeleteMessagesOptions): Promise<number>;
+    /**
+     * Attempts to purge all messages from an entity.  Locked messages are not eligible for removal and
+     * will remain in the entity.
+     *
+     * @param options - Options that allow to specify the cutoff time for deletion. Only messages that were enqueued
+     *                  before this time will be deleted.  If not specified, current time will be used.
+     * @returns number of messages deleted.
+     */
+    purgeMessages(options?: PurgeMessagesOptions): Promise<number>;
+    /**
+     * Path of the entity for which the receiver has been created.
+     */
+    entityPath: string;
+    /**
+     * The receive mode used to create the receiver.
+     */
+    receiveMode: "peekLock" | "receiveAndDelete";
+    /**
+     * Returns `true` if either the receiver or the client that created it has been closed.
+     * @readonly
+     */
+    isClosed: boolean;
+    /**
+     * Closes the receiver.
+     * Once closed, the receiver cannot be used for any further operations.
+     * Use the `createReceiver()` method on the ServiceBusClient to create a new Receiver.
+     */
+    close(): Promise<void>;
+    /**
+     * Removes the message from Service Bus.
+     *
+     * @throws Error with name `SessionLockLostError` (for messages from a Queue/Subscription with sessions enabled)
+     * if the AMQP link with which the message was received is no longer alive. This can
+     * happen either because the lock on the session expired or the receiver was explicitly closed by
+     * the user or the AMQP link is closed by the library due to network loss or service error.
+     * @throws Error with name `MessageLockLostError` (for messages from a Queue/Subscription with sessions not enabled)
+     * if the lock on the message has expired or the AMQP link with which the message was received is
+     * no longer alive. The latter can happen if the receiver was explicitly closed by the user or the
+     * AMQP link got closed by the library due to network loss or service error.
+     * @throws Error if the message is already settled.
+     * property on the message if you are not sure whether the message is settled.
+     * @throws Error if used in `receiveAndDelete` mode because all messages received in this mode
+     * are pre-settled. To avoid this error, update your code to not settle a message which is received
+     * in this mode.
+     * @throws Error with name `ServiceUnavailableError` if Service Bus does not acknowledge the request to settle
+     * the message in time. The message may or may not have been settled successfully.
+     */
+    completeMessage(message: ServiceBusReceivedMessage): Promise<void>;
+    /**
+     * The lock held on the message by the receiver is let go, making the message available again in
+     * Service Bus for another receive operation.
+     *
+     * @throws `ServiceBusError` with the code `SessionLockLost` (for messages from a Queue/Subscription with sessions enabled)
+     * if the AMQP link with which the message was received is no longer alive. This can
+     * happen either because the lock on the session expired or the receiver was explicitly closed by
+     * the user or the AMQP link is closed by the library due to network loss or service error.
+     * @throws `ServiceBusError` with the code `MessageLockLost` (for messages from a Queue/Subscription with sessions not enabled)
+     * if the lock on the message has expired or the AMQP link with which the message was received is
+     * no longer alive. The latter can happen if the receiver was explicitly closed by the user or the
+     * AMQP link got closed by the library due to network loss or service error.
+     * @throws Error if the message is already settled.
+     * property on the message if you are not sure whether the message is settled.
+     * @throws Error if used in `receiveAndDelete` mode because all messages received in this mode
+     * are pre-settled. To avoid this error, update your code to not settle a message which is received
+     * in this mode.
+     * @throws `ServiceBusError` with the code `ServiceTimeout` if Service Bus does not acknowledge the request to settle
+     * the message in time. The message may or may not have been settled successfully.
+     *
+     * @param propertiesToModify - The properties of the message to modify while abandoning the message.
+     */
+    abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    /**
+     * Defers the processing of the message. Save the `sequenceNumber` of the message, in order to
+     * receive it message again in the future using the `receiveDeferredMessage` method.
+     *
+     * @throws `ServiceBusError` with the code `SessionLockLost` (for messages from a Queue/Subscription with sessions enabled)
+     * if the AMQP link with which the message was received is no longer alive. This can
+     * happen either because the lock on the session expired or the receiver was explicitly closed by
+     * the user or the AMQP link is closed by the library due to network loss or service error.
+     * @throws `ServiceBusError` with the code `MessageLockLost` (for messages from a Queue/Subscription with sessions not enabled)
+     * if the lock on the message has expired or the AMQP link with which the message was received is
+     * no longer alive. The latter can happen if the receiver was explicitly closed by the user or the
+     * AMQP link got closed by the library due to network loss or service error.
+     * @throws Error if the message is already settled.
+     * property on the message if you are not sure whether the message is settled.
+     * @throws Error if used in `receiveAndDelete` mode because all messages received in this mode
+     * are pre-settled. To avoid this error, update your code to not settle a message which is received
+     * in this mode.
+     * @throws `ServiceBusError` with the code `ServiceTimeout` if Service Bus does not acknowledge the request to settle
+     * the message in time. The message may or may not have been settled successfully.
+     *
+     * @param propertiesToModify - The properties of the message to modify while deferring the message
+     */
+    deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    /**
+     * Moves the message to the deadletter sub-queue. To receive a deadletted message, create a new
+     * QueueClient/SubscriptionClient using the path for the deadletter sub-queue.
+     *
+     * @throws `ServiceBusError` with the code `SessionLockLost` (for messages from a Queue/Subscription with sessions enabled)
+     * if the AMQP link with which the message was received is no longer alive. This can
+     * happen either because the lock on the session expired or the receiver was explicitly closed by
+     * the user or the AMQP link is closed by the library due to network loss or service error.
+     * @throws `ServiceBusError` with the code `MessageLockLost` (for messages from a Queue/Subscription with sessions not enabled)
+     * if the lock on the message has expired or the AMQP link with which the message was received is
+     * no longer alive. The latter can happen if the receiver was explicitly closed by the user or the
+     * AMQP link got closed by the library due to network loss or service error.
+     * @throws Error if the message is already settled.
+     * property on the message if you are not sure whether the message is settled.
+     * @throws Error if used in `receiveAndDelete` mode because all messages received in this mode
+     * are pre-settled. To avoid this error, update your code to not settle a message which is received
+     * in this mode.
+     * @throws `ServiceBusError` with the code `ServiceTimeout` if Service Bus does not acknowledge the request to settle
+     * the message in time. The message may or may not have been settled successfully.
+     *
+     * @param options - The DeadLetter options that can be provided while
+     * rejecting the message.
+     */
+    deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    /**
+     * Renews the lock on the message for the duration as specified during the Queue/Subscription
+     * creation.
+     * - Check the `lockedUntilUtc` property on the message for the time when the lock expires.
+     * - If a message is not settled (using either `complete()`, `defer()` or `deadletter()`,
+     * before its lock expires, then the message lands back in the Queue/Subscription for the next
+     * receive operation.
+     *
+     * @returns New lock token expiry date and time in UTC format.
+     * @throws Error if the underlying connection, client or receiver is closed.
+     * @throws ServiceBusError if the service returns an error while renewing message lock.
+     */
+    renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>;
+}
+/**
+ * @internal
+ */
+export declare class ServiceBusReceiverImpl implements ServiceBusReceiver {
+    private _context;
+    entityPath: string;
+    receiveMode: "peekLock" | "receiveAndDelete";
+    private skipParsingBodyAsJson;
+    private skipConvertingDate;
+    identifier: string;
+    private _retryOptions;
+    /**
+     * Denotes if close() was called on this receiver
+     */
+    private _isClosed;
+    /**
+     * Instance of the BatchingReceiver class to use to receive messages in pull mode.
+     */
+    private _batchingReceiver?;
+    /**
+     * Instance of the StreamingReceiver class to use to receive messages in push mode.
+     */
+    private _streamingReceiver?;
+    private _lockRenewer;
+    private get logPrefix();
+    /**
+     * @throws Error if the underlying connection is closed.
+     */
+    constructor(_context: ConnectionContext, entityPath: string, receiveMode: "peekLock" | "receiveAndDelete", maxAutoRenewLockDurationInMs: number, skipParsingBodyAsJson: boolean, skipConvertingDate?: boolean, retryOptions?: RetryOptions, identifier?: string);
+    private _throwIfAlreadyReceiving;
+    private _throwIfReceiverOrConnectionClosed;
+    get isClosed(): boolean;
+    receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>;
+    getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>;
+    receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>;
+    deleteMessages(options: DeleteMessagesOptions): Promise<number>;
+    purgeMessages(options?: PurgeMessagesOptions): Promise<number>;
+    peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>;
+    subscribe(handlers: MessageHandlers, options?: SubscribeOptions): {
+        close(): Promise<void>;
+    };
+    completeMessage(message: ServiceBusReceivedMessage): Promise<void>;
+    abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {
+        [key: string]: number | boolean | string | Date | null;
+    }): Promise<void>;
+    renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>;
+    close(): Promise<void>;
+    /**
+     * Indicates whether the receiver is currently receiving messages or not.
+     * When this returns true, new `registerMessageHandler()` or `receiveMessages()` calls cannot be made.
+     */
+    private _isReceivingMessages;
+    private _createBatchingReceiver;
+    /**
+     * Helper function to retrieve any active receiver name, regardless of streaming or
+     * batching if it exists. This is used for optimization on the service side
+     */
+    private _getAssociatedReceiverName;
+}
+//# sourceMappingURL=receiver.d.ts.map

package/dist/browser/receivers/receiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receiver.d.ts","sourceRoot":"","sources":["../../../src/receivers/receiver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAsBjE,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAyB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACxF,OAAO,KAAK,EAAe,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAUlE;;;;;;;GAOG;AACH,eAAO,MAAM,4CAA4C,OAAO,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CACP,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,gBAAgB,GACzB;QACD;;WAEG;QACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACxB,CAAC;IAEF;;;;;;;;;OASG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,eAAe,CACb,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,uBAAuB,CACrB,eAAe,EAAE,IAAI,GAAG,IAAI,EAAE,EAC9B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAExC;;;;;;;;;;OAUG;IACH,YAAY,CACV,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAExC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhE;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,UAAU,GAAG,kBAAkB,CAAC;IAC7C;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CACZ,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAC9E,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAC9E,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,iBAAiB,CACf,OAAO,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,iBAAiB,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GACvF,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,qBAAa,sBAAuB,YAAW,kBAAkB;IA2B7D,OAAO,CAAC,QAAQ;IACT,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,UAAU,GAAG,kBAAkB;IAEnD,OAAO,CAAC,qBAAqB;IAC7B,OAAO,CAAC,kBAAkB;IA/BrB,UAAU,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,aAAa,CAAe;IACpC;;OAEG;IACH,OAAO,CAAC,SAAS,CAAkB;IAEnC;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAE7C;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAC,CAAoB;IAC/C,OAAO,CAAC,YAAY,CAA0B;IAE9C,OAAO,KAAK,SAAS,GAEpB;IAED;;OAEG;gBAEO,QAAQ,EAAE,iBAAiB,EAC5B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,UAAU,GAAG,kBAAkB,EACnD,4BAA4B,EAAE,MAAM,EAC5B,qBAAqB,EAAE,OAAO,EAC9B,kBAAkB,GAAE,OAAe,EAC3C,YAAY,GAAE,YAAiB,EAC/B,UAAU,CAAC,EAAE,MAAM;IAYrB,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,kCAAkC;IAU1C,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEK,eAAe,CACnB,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAyDvC,kBAAkB,CAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,qBAAqB,CAAC,yBAAyB,CAAC;IAI7C,uBAAuB,CAC3B,eAAe,EAAE,IAAI,GAAG,IAAI,EAAE,EAC9B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAyCjC,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB/D,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IA6B9D,YAAY,CAChB,eAAe,EAAE,MAAM,EACvB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,yBAAyB,EAAE,CAAC;IA2CvC,SAAS,CACP,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,gBAAgB,GACzB;QACD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACxB;IAmDK,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlE,cAAc,CAClB,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAC9E,OAAO,CAAC,IAAI,CAAC;IAaV,YAAY,CAChB,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAC9E,OAAO,CAAC,IAAI,CAAC;IAaV,iBAAiB,CACrB,OAAO,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,iBAAiB,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GACvF,OAAO,CAAC,IAAI,CAAC;IAOV,gBAAgB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCnE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB5B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,uBAAuB;IAa/B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;CAanC"}

package/{dist-esm/src → dist/browser}/receivers/receiver.js

@@ -1,16 +1,16 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { getAlreadyReceivingErrorMsg, getReceiverClosedErrorMsg, InvalidMaxMessageCountError, throwErrorIfConnectionClosed, throwTypeErrorIfParameterMissing, throwTypeErrorIfParameterNotLong, throwErrorIfInvalidOperationOnMessage, throwTypeErrorIfParameterTypeMismatch, } from "../util/errors";
-import { StreamingReceiver } from "../core/streamingReceiver";
-import { BatchingReceiver } from "../core/batchingReceiver";
-import { abandonMessage, assertValidMessageHandlers, completeMessage, deadLetterMessage, deferMessage, getMessageIterator, } from "./receiverCommon";
+// Licensed under the MIT License.
+import { getAlreadyReceivingErrorMsg, getReceiverClosedErrorMsg, InvalidMaxMessageCountError, throwErrorIfConnectionClosed, throwTypeErrorIfParameterMissing, throwTypeErrorIfParameterNotLong, throwErrorIfInvalidOperationOnMessage, throwTypeErrorIfParameterTypeMismatch, } from "../util/errors.js";
+import { StreamingReceiver } from "../core/streamingReceiver.js";
+import { BatchingReceiver } from "../core/batchingReceiver.js";
+import { abandonMessage, assertValidMessageHandlers, completeMessage, deadLetterMessage, deferMessage, getMessageIterator, } from "./receiverCommon.js";
 import { Constants, RetryOperationType, retry } from "@azure/core-amqp";
-import { LockRenewer } from "../core/autoLockRenewer";
-import { receiverLogger as logger } from "../log";
-import { translateServiceBusError } from "../serviceBusError";
-import { ensureValidIdentifier } from "../util/utils";
-import { toSpanOptions, tracingClient } from "../diagnostics/tracing";
-import { extractSpanContextFromServiceBusMessage } from "../diagnostics/instrumentServiceBusMessage";
+import { LockRenewer } from "../core/autoLockRenewer.js";
+import { receiverLogger as logger } from "../log.js";
+import { translateServiceBusError } from "../serviceBusError.js";
+import { ensureValidIdentifier } from "../util/utils.js";
+import { toSpanOptions, tracingClient } from "../diagnostics/tracing.js";
+import { extractSpanContextFromServiceBusMessage } from "../diagnostics/instrumentServiceBusMessage.js";
 /**
  * The default time to wait for messages _after_ the first message
  * has been received.
@@ -24,7 +24,7 @@ export const defaultMaxTimeAfterFirstMessageForBatchingMs = 1000;
  * The maximum number of messages to delete in a single batch.  This cap is established and enforced by the service.
  * @internal
  */
-export const MaxDeleteMessageCount = 4000;
+export const MaxDeleteMessageCount = 500;
 /**
  * @internal
  */
@@ -79,6 +79,7 @@ export class ServiceBusReceiverImpl {
             throw new TypeError(InvalidMaxMessageCountError);
         }
         const receiveMessages = async () => {
+            var _a;
             if (!this._batchingReceiver || !this._context.messageReceivers[this._batchingReceiver.name]) {
                 const receiveOptions = {
                     maxConcurrentCalls: 0,
@@ -89,7 +90,7 @@ export class ServiceBusReceiverImpl {
                 };
                 this._batchingReceiver = this._createBatchingReceiver(this._context, this.entityPath, receiveOptions);
             }
-            const receivedMessages = await this._batchingReceiver.receive(maxMessageCount, options?.maxWaitTimeInMs ?? Constants.defaultOperationTimeoutInMs, defaultMaxTimeAfterFirstMessageForBatchingMs, options ?? {});
+            const receivedMessages = await this._batchingReceiver.receive(maxMessageCount, (_a = options === null || options === void 0 ? void 0 : options.maxWaitTimeInMs) !== null && _a !== void 0 ? _a : Constants.defaultOperationTimeoutInMs, defaultMaxTimeAfterFirstMessageForBatchingMs, options !== null && options !== void 0 ? options : {});
             return receivedMessages;
         };
         const config = {
@@ -97,7 +98,7 @@ export class ServiceBusReceiverImpl {
             connectionId: this._context.connectionId,
             operation: receiveMessages,
             operationType: RetryOperationType.receiveMessage,
-            abortSignal: options?.abortSignal,
+            abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
             retryOptions: this._retryOptions,
         };
         return retry(config).catch((err) => {
@@ -117,14 +118,7 @@ export class ServiceBusReceiverImpl {
         const receiveDeferredMessagesOperationPromise = async () => {
             const deferredMessages = await this._context
                 .getManagementClient(this.entityPath)
-                .receiveDeferredMessages(deferredSequenceNumbers, this.receiveMode, undefined, {
-                ...options,
-                associatedLinkName: this._getAssociatedReceiverName(),
-                requestName: "receiveDeferredMessages",
-                timeoutInMs: this._retryOptions.timeoutInMs,
-                skipParsingBodyAsJson: this.skipParsingBodyAsJson,
-                skipConvertingDate: this.skipConvertingDate,
-            });
+                .receiveDeferredMessages(deferredSequenceNumbers, this.receiveMode, undefined, Object.assign(Object.assign({}, options), { associatedLinkName: this._getAssociatedReceiverName(), requestName: "receiveDeferredMessages", timeoutInMs: this._retryOptions.timeoutInMs, skipParsingBodyAsJson: this.skipParsingBodyAsJson, skipConvertingDate: this.skipConvertingDate }));
             return deferredMessages;
         };
         const config = {
@@ -132,7 +126,7 @@ export class ServiceBusReceiverImpl {
             connectionId: this._context.connectionId,
             operationType: RetryOperationType.management,
             retryOptions: this._retryOptions,
-            abortSignal: options?.abortSignal,
+            abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
         };
         return retry(config);
     }
@@ -141,34 +135,29 @@ export class ServiceBusReceiverImpl {
         const deleteMessagesOperationPromise = () => {
             return this._context
                 .getManagementClient(this.entityPath)
-                .deleteMessages(options.maxMessageCount, options?.beforeEnqueueTime, undefined, {
-                ...options,
-                associatedLinkName: this._getAssociatedReceiverName(),
-                requestName: "deleteMessages",
-                timeoutInMs: this._retryOptions.timeoutInMs,
-            });
+                .deleteMessages(options.maxMessageCount, options === null || options === void 0 ? void 0 : options.beforeEnqueueTime, undefined, Object.assign(Object.assign({}, options), { associatedLinkName: this._getAssociatedReceiverName(), requestName: "deleteMessages", timeoutInMs: this._retryOptions.timeoutInMs }));
         };
         const config = {
             operation: deleteMessagesOperationPromise,
             connectionId: this._context.connectionId,
             operationType: RetryOperationType.management,
             retryOptions: this._retryOptions,
-            abortSignal: options?.abortSignal,
+            abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
         };
         return retry(config);
     }
     async purgeMessages(options) {
         let deletedCount = await this.deleteMessages({
             maxMessageCount: MaxDeleteMessageCount,
-            beforeEnqueueTime: options?.beforeEnqueueTime,
+            beforeEnqueueTime: options === null || options === void 0 ? void 0 : options.beforeEnqueueTime,
         });
         logger.verbose(`${this.logPrefix} receiver '${this.identifier}' deleted ${deletedCount} messages.`);
-        if (deletedCount > 0) {
-            let batchCount = deletedCount;
-            while (batchCount > 0) {
+        if (deletedCount === MaxDeleteMessageCount) {
+            let batchCount = MaxDeleteMessageCount;
+            while (batchCount === MaxDeleteMessageCount) {
                 batchCount = await this.deleteMessages({
                     maxMessageCount: MaxDeleteMessageCount,
-                    beforeEnqueueTime: options?.beforeEnqueueTime,
+                    beforeEnqueueTime: options === null || options === void 0 ? void 0 : options.beforeEnqueueTime,
                 });
                 logger.verbose(`${this.logPrefix} receiver '${this.identifier}' deleted ${batchCount} messages.`);
                 deletedCount += batchCount;
@@ -179,25 +168,21 @@ export class ServiceBusReceiverImpl {
     }
     // ManagementClient methods # Begin
     async peekMessages(maxMessageCount, options = {}) {
+        var _a;
         this._throwIfReceiverOrConnectionClosed();
-        const managementRequestOptions = {
-            ...options,
-            associatedLinkName: this._getAssociatedReceiverName(),
-            requestName: "peekMessages",
-            timeoutInMs: this._retryOptions?.timeoutInMs,
-            skipParsingBodyAsJson: this.skipParsingBodyAsJson,
-            skipConvertingDate: this.skipConvertingDate,
-        };
+        const managementRequestOptions = Object.assign(Object.assign({}, options), { associatedLinkName: this._getAssociatedReceiverName(), requestName: "peekMessages", timeoutInMs: (_a = this._retryOptions) === null || _a === void 0 ? void 0 : _a.timeoutInMs, skipParsingBodyAsJson: this.skipParsingBodyAsJson, skipConvertingDate: this.skipConvertingDate });
+        // omitMessageBody is available at runtime, but only exported in experimental subpath
+        const { fromSequenceNumber, omitMessageBody } = options;
         const peekOperationPromise = async () => {
-            if (options.fromSequenceNumber !== undefined) {
+            if (fromSequenceNumber !== undefined) {
                 return this._context
                     .getManagementClient(this.entityPath)
-                    .peekBySequenceNumber(options.fromSequenceNumber, maxMessageCount, undefined, options.omitMessageBody, managementRequestOptions);
+                    .peekBySequenceNumber(fromSequenceNumber, maxMessageCount, undefined, omitMessageBody, managementRequestOptions);
             }
             else {
                 return this._context
                     .getManagementClient(this.entityPath)
-                    .peek(maxMessageCount, options.omitMessageBody, managementRequestOptions);
+                    .peek(maxMessageCount, omitMessageBody, managementRequestOptions);
             }
         };
         const config = {
@@ -205,19 +190,17 @@ export class ServiceBusReceiverImpl {
             connectionId: this._context.connectionId,
             operationType: RetryOperationType.management,
             retryOptions: this._retryOptions,
-            abortSignal: options?.abortSignal,
+            abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
         };
         return retry(config);
     }
     subscribe(handlers, options) {
+        var _a, _b;
         assertValidMessageHandlers(handlers);
         throwErrorIfConnectionClosed(this._context);
         this._throwIfReceiverOrConnectionClosed();
         this._throwIfAlreadyReceiving();
-        options = {
-            ...(options ?? {}),
-            autoCompleteMessages: options?.autoCompleteMessages ?? true,
-        };
+        options = Object.assign(Object.assign({}, (options !== null && options !== void 0 ? options : {})), { autoCompleteMessages: (_a = options === null || options === void 0 ? void 0 : options.autoCompleteMessages) !== null && _a !== void 0 ? _a : true });
         // When the user "stops" a streaming receiver (via the returned instance from 'subscribe' we just suspend
         // it, leaving the link open). This allows users to stop the flow of messages but still be able to settle messages
         // since the link itself hasn't been shut down.
@@ -228,15 +211,7 @@ export class ServiceBusReceiverImpl {
         // 2. subscription.stop()
         // 3. receiver.subscribe()
         this._streamingReceiver =
-            this._streamingReceiver ??
-                new StreamingReceiver(this.identifier, this._context, this.entityPath, {
-                    ...options,
-                    receiveMode: this.receiveMode,
-                    retryOptions: this._retryOptions,
-                    lockRenewer: this._lockRenewer,
-                    skipParsingBodyAsJson: this.skipParsingBodyAsJson,
-                    skipConvertingDate: this.skipConvertingDate,
-                });
+            (_b = this._streamingReceiver) !== null && _b !== void 0 ? _b : new StreamingReceiver(this.identifier, this._context, this.entityPath, Object.assign(Object.assign({}, options), { receiveMode: this.receiveMode, retryOptions: this._retryOptions, lockRenewer: this._lockRenewer, skipParsingBodyAsJson: this.skipParsingBodyAsJson, skipConvertingDate: this.skipConvertingDate }));
         // this ensures that if the outer service bus client is closed that  this receiver is cleaned up.
         // this mostly affects us if we're in the middle of init() - the connection (and receiver) are not yet
         // open but we do need to close the receiver to exit the init() loop.
@@ -249,7 +224,8 @@ export class ServiceBusReceiverImpl {
         });
         return {
             close: async () => {
-                return this._streamingReceiver?.stopReceivingMessages();
+                var _a;
+                return (_a = this._streamingReceiver) === null || _a === void 0 ? void 0 : _a.stopReceivingMessages();
             },
         };
     }
@@ -287,7 +263,7 @@ export class ServiceBusReceiverImpl {
             let associatedLinkName;
             if (msgImpl.delivery.link) {
                 const associatedReceiver = this._context.getReceiverFromCache(msgImpl.delivery.link.name);
-                associatedLinkName = associatedReceiver?.name;
+                associatedLinkName = associatedReceiver === null || associatedReceiver === void 0 ? void 0 : associatedReceiver.name;
             }
             return this._context
                 .getManagementClient(this.entityPath)
@@ -296,10 +272,7 @@ export class ServiceBusReceiverImpl {
                 message.lockedUntilUtc = lockedUntil;
                 return lockedUntil;
             });
-        }, {
-            spanLinks,
-            ...toSpanOptions({ entityPath: this.entityPath, host: this._context.config.host }, "receive", "client"),
-        });
+        }, Object.assign({ spanLinks }, toSpanOptions({ entityPath: this.entityPath, host: this._context.config.host }, "receive", "client")));
     }
     async close() {
         try {