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

package/dist/commonjs/session/messageSession.d.ts

@@ -0,0 +1,236 @@
+import type { RetryOptions } from "@azure/core-amqp";
+import type { AmqpError, OnAmqpEvent, Receiver, ReceiverOptions } from "rhea-promise";
+import type { ConnectionContext } from "../connectionContext.js";
+import { LinkEntity } from "../core/linkEntity.js";
+import type { DispositionStatusOptions } from "../core/managementClient.js";
+import type { OnAmqpEventAsPromise, OnError, OnMessage } from "../core/messageReceiver.js";
+import { DispositionType, ServiceBusMessageImpl } from "../serviceBusMessage.js";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import { ReceiverHelper } from "../core/receiverHelper.js";
+import type { ServiceBusSessionReceiverOptions, ReceiveMode, SubscribeOptions } from "../models.js";
+import type { OperationOptionsBase } from "../modelsToBeSharedWithEventHubs.js";
+/**
+ * Describes the options that need to be provided while creating a message session receiver link.
+ * @internal
+ */
+export interface CreateMessageSessionReceiverLinkOptions {
+    onClose: OnAmqpEventAsPromise;
+    onSessionClose: OnAmqpEventAsPromise;
+    onError: OnAmqpEvent;
+    onSessionError: OnAmqpEvent;
+    onSettled: OnAmqpEvent;
+    sessionId?: string;
+}
+/**
+ * @internal
+ * Describes all the options that can be set while instantiating a MessageSession object.
+ */
+export type MessageSessionOptions = Pick<ServiceBusSessionReceiverOptions, "maxAutoLockRenewalDurationInMs" | "abortSignal"> & {
+    receiveMode?: ReceiveMode;
+    retryOptions: RetryOptions | undefined;
+    skipParsingBodyAsJson: boolean;
+    skipConvertingDate: boolean;
+};
+/**
+ * @internal
+ * Describes the receiver for a Message Session.
+ */
+export declare class MessageSession extends LinkEntity<Receiver> {
+    identifier: string;
+    private _providedSessionId;
+    /**
+     * Provides the duration until which the session is locked.
+     */
+    sessionLockedUntilUtc: Date;
+    /**
+     * The sessionId for the message session. Empty string is valid sessionId.
+     */
+    sessionId: string;
+    /**
+     * The maximum number of concurrent sessions that the
+     * client should initiate.
+     * - **Default**: `1`.
+     */
+    maxConcurrentSessions?: number;
+    /**
+     * The maximum number of messages that should be
+     * processed concurrently in a session while in streaming mode. Once this limit has been reached,
+     * more messages will not be received until the user's message handler has completed processing current message.
+     * - **Default**: `1` (message in a session at a time).
+     */
+    maxConcurrentCalls: number;
+    /**
+     * The mode in which messages should be received.
+     * Default: ReceiveMode.peekLock
+     */
+    receiveMode: ReceiveMode;
+    /**
+     * Indicates whether `Message.complete()` should be called
+     * automatically after the message processing is complete while receiving messages with handlers.
+     * Default: false.
+     */
+    autoComplete: boolean;
+    /**
+     * The maximum duration within which the
+     * lock will be renewed automatically. This value should be greater than the longest message
+     * lock duration; for example, the `lockDuration` property on the received message.
+     *
+     * Default: `300 * 1000` (5 minutes);
+     */
+    maxAutoRenewDurationInMs: number;
+    /**
+     * Should lock renewal happen automatically.
+     */
+    autoRenewLock: boolean;
+    /**
+     * Denotes if we are currently receiving messages
+     */
+    get isReceivingMessages(): boolean;
+    private _batchingReceiverLite;
+    private _isReceivingMessagesForSubscriber;
+    /**
+     * Maintains a map of deliveries that
+     * are being actively disposed. It acts as a store for correlating the responses received for
+     * active dispositions.
+     */
+    private _deliveryDispositionMap;
+    /**
+     * The message handler provided by the user that will
+     * be wrapped inside _onAmqpMessage.
+     */
+    private _onMessage;
+    /**
+     * The error handler provided by the user that will be wrapped
+     * inside _onAmqpError.
+     */
+    private _onError?;
+    /**
+     * If the user provided error handler is present then it will
+     * notify the user's error handler about the error.
+     */
+    private _notifyError;
+    /**
+     * The message handler that will be set as the handler on the
+     * underlying rhea receiver for the "receiver_close" event.
+     */
+    private _onAmqpClose;
+    /**
+     * The message handler that will be set as the handler on
+     * the underlying rhea receiver's session for the "session_error" event.
+     */
+    private _onSessionError;
+    /**
+     * The message handler that will be set as the handler on
+     * the underlying rhea receiver's session for the "session_close" event.
+     */
+    private _onSessionClose;
+    /**
+     * The message handler that will be set as the handler on the
+     * underlying rhea receiver for the "receiver_error" event.
+     */
+    private _onAmqpError;
+    /**
+     * The message handler that will be set as the handler on the
+     * underlying rhea receiver for the "settled" event.
+     */
+    private _onSettled;
+    /**
+     * The session lock renewal timer that keeps
+     * track of when the MessageSession is due for session lock renewal.
+     */
+    private _sessionLockRenewalTimer?;
+    private _totalAutoLockRenewDuration;
+    /**
+     * Whether to prevent the client from running JSON.parse() on the message body when receiving the message.
+     */
+    private skipParsingBodyAsJson;
+    /**
+     * 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.
+     */
+    private skipConvertingDate;
+    get receiverHelper(): ReceiverHelper;
+    private _receiverHelper;
+    /**
+     * Ensures that the session lock is renewed before it expires. The lock will not be renewed for
+     * more than the configured totalAutoLockRenewDuration.
+     */
+    private _ensureSessionLockRenewal;
+    protected createRheaLink(options: ReceiverOptions, _abortSignal?: AbortSignalLike): Promise<Receiver>;
+    /**
+     * Creates a new AMQP receiver under a new AMQP session.
+     */
+    private _init;
+    /**
+     * Creates the options that need to be specified while creating an AMQP receiver link.
+     */
+    private _createMessageSessionOptions;
+    private _retryOptions;
+    private _lastSBError;
+    private _intermediateLink;
+    /**
+     * Constructs a MessageSession instance which lets you receive messages as batches
+     * or via callbacks using subscribe.
+     *
+     * @param _providedSessionId - The sessionId provided by the user. This can be the
+     * name of a session ID to open (empty string is also valid) or it can be undefined,
+     * to indicate we want the next unlocked non-empty session.
+     */
+    constructor(identifier: string, connectionContext: ConnectionContext, entityPath: string, _providedSessionId: string | undefined, options: MessageSessionOptions);
+    /**
+     * Closes the underlying AMQP receiver link.
+     */
+    close(error?: Error | AmqpError): Promise<void>;
+    /**
+     * Determines whether the AMQP receiver link is open. If open then returns true else returns false.
+     */
+    isOpen(): boolean;
+    /**
+     * Registers handlers to deal with the incoming stream of messages over an AMQP receiver link
+     * from a Queue/Subscription.
+     * To stop receiving messages, call `close()` on the SessionReceiver or set the property
+     * `newMessageWaitTimeoutInMs` in the options to provide a timeout.
+     *
+     * @param onMessage - Handler for processing each incoming message.
+     * @param onError - Handler for any error that occurs while receiving or processing messages.
+     * @param options - Options to control whether messages should be automatically completed. You can
+     * also provide a timeout in milliseconds to denote the amount of time to wait for a new message
+     * before closing the receiver.
+     */
+    subscribe(onMessage: OnMessage, onError: OnError, options: SubscribeOptions): void;
+    private _subscribeImpl;
+    private processCreditError;
+    /**
+     * Returns a batch of messages based on given count and timeout over an AMQP receiver link
+     * from a Queue/Subscription.
+     *
+     * @param maxMessageCount - The maximum number of messages to receive from Queue/Subscription.
+     * @param maxWaitTimeInMs - The total wait time in milliseconds until which the receiver will attempt to receive specified number of messages.
+     * If this time elapses before the `maxMessageCount` is reached, then messages collected till then will be returned to the user.
+     * @returns A promise that resolves with an array of Message objects.
+     */
+    receiveMessages(maxMessageCount: number, maxWaitTimeInMs: number, maxTimeAfterFirstMessageInMs: number, options: OperationOptionsBase): Promise<ServiceBusMessageImpl[]>;
+    /**
+     * To be called when connection is disconnected to gracefully close ongoing receive request.
+     * @param connectionError - The connection error if any.
+     */
+    onDetached(connectionError: AmqpError | Error): Promise<void>;
+    /**
+     * Settles the message with the specified disposition.
+     * @param message - The ServiceBus Message that needs to be settled.
+     * @param operation - The disposition type.
+     * @param options - Optional parameters that can be provided while disposing the message.
+     */
+    settleMessage(message: ServiceBusMessageImpl, operation: DispositionType, options: DispositionStatusOptions): Promise<any>;
+    /**
+     * Creates a new instance of the MessageSession based on the provided parameters.
+     * @param identifier - name to identify the message session
+     * @param context - The client entity context
+     * @param options - Options that can be provided while creating the MessageSession.
+     */
+    static create(identifier: string, context: ConnectionContext, entityPath: string, sessionId: string | undefined, options: MessageSessionOptions): Promise<MessageSession>;
+    protected removeLinkFromContext(): void;
+}
+//# sourceMappingURL=messageSession.d.ts.map

package/dist/commonjs/session/messageSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageSession.d.ts","sourceRoot":"","sources":["../../../src/session/messageSession.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkB,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,KAAK,EAAE,SAAS,EAAgB,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE3F,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAOjF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EACV,gCAAgC,EAEhC,WAAW,EACX,gBAAgB,EACjB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAKhF;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD,OAAO,EAAE,oBAAoB,CAAC;IAC9B,cAAc,EAAE,oBAAoB,CAAC;IACrC,OAAO,EAAE,WAAW,CAAC;IACrB,cAAc,EAAE,WAAW,CAAC;IAC5B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACtC,gCAAgC,EAChC,gCAAgC,GAAG,aAAa,CACjD,GAAG;IACF,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IACvC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,qBAAa,cAAe,SAAQ,UAAU,CAAC,QAAQ,CAAC;IA2V7C,UAAU,EAAE,MAAM;IAGzB,OAAO,CAAC,kBAAkB;IA7V5B;;OAEG;IACH,qBAAqB,EAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAG,MAAM,CAAC;IACnB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAK;IAC/B;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;;OAIG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;;OAMG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,iCAAiC,CAAU;IAEnD;;;;OAIG;IACH,OAAO,CAAC,uBAAuB,CAG3B;IACJ;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAa;IAC/B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAU;IAC9B;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAuB;IAC3C;;;OAGG;IACH,OAAO,CAAC,eAAe,CAAc;IACrC;;;OAGG;IACH,OAAO,CAAC,eAAe,CAAuB;IAC9C;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAc;IAClC;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAc;IAChC;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAAC,CAAiB;IAElD,OAAO,CAAC,2BAA2B,CAAS;IAE5C;;OAEG;IACH,OAAO,CAAC,qBAAqB,CAAU;IAEvC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAAU;IAEpC,IAAW,cAAc,IAAI,cAAc,CAE1C;IACD,OAAO,CAAC,eAAe,CAAiB;IAExC;;;OAGG;IACH,OAAO,CAAC,yBAAyB;cAqDjB,cAAc,CAC5B,OAAO,EAAE,eAAe,EACxB,YAAY,CAAC,EAAE,eAAe,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAwDpB;;OAEG;YACW,KAAK;IAsDnB;;OAEG;IACH,OAAO,CAAC,4BAA4B;IA4BpC,OAAO,CAAC,aAAa,CAA2B;IAChD,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,iBAAiB,CAAuB;IAEhD;;;;;;;OAOG;gBAEM,UAAU,EAAE,MAAM,EACzB,iBAAiB,EAAE,iBAAiB,EACpC,UAAU,EAAE,MAAM,EACV,kBAAkB,EAAE,MAAM,GAAG,SAAS,EAC9C,OAAO,EAAE,qBAAqB;IAsLhC;;OAEG;IACG,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBrD;;OAEG;IACH,MAAM,IAAI,OAAO;IAWjB;;;;;;;;;;;OAWG;IACI,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAKzF,OAAO,CAAC,cAAc;YA8KR,kBAAkB;IAuBhC;;;;;;;;OAQG;IACG,eAAe,CACnB,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,MAAM,EACvB,4BAA4B,EAAE,MAAM,EACpC,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAcnC;;;OAGG;IACG,UAAU,CAAC,eAAe,EAAE,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BnE;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,qBAAqB,EAC9B,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,GAAG,CAAC;IAyDf;;;;;OAKG;WACU,MAAM,CACjB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,cAAc,CAAC;IAyC1B,SAAS,CAAC,qBAAqB,IAAI,IAAI;CAGxC"}