@azure/core-amqp 2.2.0-alpha.20210326.1 → 3.0.0

package/types/3.1/core-amqp.d.ts

@@ -1,18 +1,39 @@
 /// <reference types="node" />
 import { AbortSignalLike } from '@azure/abort-controller';
+import { AccessToken } from '@azure/core-auth';
 import { AmqpError } from 'rhea-promise';
-import AsyncLock from 'async-lock';
 import { Connection } from 'rhea-promise';
 import { Message } from 'rhea-promise';
 import { MessageHeader } from 'rhea-promise';
 import { MessageProperties } from 'rhea-promise';
+import { NamedKeyCredential } from '@azure/core-auth';
 import { Receiver } from 'rhea-promise';
 import { ReceiverOptions } from 'rhea-promise';
 import { ReqResLink } from 'rhea-promise';
+import { SASCredential } from '@azure/core-auth';
 import { Sender } from 'rhea-promise';
 import { SenderOptions } from 'rhea-promise';
 import { Session } from 'rhea-promise';
 import { WebSocketImpl } from 'rhea-promise';
+/**
+ * Describes the properties that must be provided while acquiring a lock.
+ */
+export declare interface AcquireLockProperties {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.
+     * This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`
+     * can no longer be cancelled.
+     * This does not cancel running the task passed to `acquire()` if the lock has been acquired,
+     * but will prevent it from running if cancelled before the task is invoked.
+     */
+    abortSignal: AbortSignalLike | undefined;
+    /**
+     * The allowed amount of time in milliseconds to acquire a lock.
+     * If a lock isn't acquired within this time, the promise returned
+     * by `acquire()` will be rejected with an Error.
+     */
+    timeoutInMs: number | undefined;
+}
 /**
  * Describes the AmqpAnnotatedMessage, part of the ServiceBusReceivedMessage(as `amqpAnnotatedMessage` property).
  */
@@ -54,6 +75,10 @@ export declare interface AmqpAnnotatedMessage {
      * The message body.
      */
     body: any;
+    /**
+     * The AMQP section where the data was decoded from.
+     */
+    bodyType?: "data" | "sequence" | "value";
 }
 /**
  * Describes the operations that can be performed on(or to get) the AmqpAnnotatedMessage.
@@ -63,6 +88,10 @@ export declare const AmqpAnnotatedMessage: {
      * Takes RheaMessage(`Message` type from "rhea") and returns it in the AmqpAnnotatedMessage format.
      */
     fromRheaMessage(msg: Message): AmqpAnnotatedMessage;
+    /**
+     * Takes AmqpAnnotatedMessage and returns it in the RheaMessage(`Message` type from "rhea") format.
+     */
+    toRheaMessage(msg: AmqpAnnotatedMessage): Message;
 };
 /**
  * Describes the defined set of standard header properties of the message.
@@ -184,7 +213,32 @@ export declare const AmqpMessageProperties: {
      */
     fromRheaMessageProperties(props: MessageProperties): AmqpMessageProperties;
 };
-export { AsyncLock };
+/**
+ * CancellableAsyncLock provides a mechanism for forcing tasks using the same
+ * 'key' to be executed serially.
+ *
+ * Pending tasks can be manually cancelled via an abortSignal or automatically
+ * cancelled by reach a provided timeout value.
+ */
+export declare interface CancellableAsyncLock {
+    /**
+     * Returns a promise that resolves to the value returned by the provided task function.
+     * Only 1 task can be invoked at a time for a given `key` value.
+     *
+     * An acquire call can be cancelled via an `abortSignal`.
+     * If cancelled, the promise will be rejected with an `AbortError`.
+     *
+     * `acquireTimeoutInMs` can also be provided to properties.
+     * If the timeout is reached before the provided `task` is invoked,
+     * then the promise will be rejected with an Error stating the task
+     * timed out waiting to acquire a lock.
+     *
+     * @param key - All `acquire` calls are grouped by the provided `key`.
+     * @param task - The function to invoke once the lock has been acquired.
+     * @param properties - Additional properties to control the behavior of `acquire`.
+     */
+    acquire<T = void>(key: string, task: (...args: any[]) => Promise<T>, properties: AcquireLockProperties): Promise<T>;
+}
 /**
  * Describes the EventHub/ServiceBus Cbs client that talks to the $cbs endpoint over AMQP connection.
  */
@@ -229,6 +283,7 @@ export declare class CbsClient {
      */
     init(options?: {
         abortSignal?: AbortSignalLike;
+        timeoutInMs?: number;
     }): Promise<void>;
     /**
      * Negotiates the CBS claim with the EventHub/ServiceBus Service.
@@ -267,6 +322,7 @@ export declare class CbsClient {
      */
     negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: {
         abortSignal?: AbortSignalLike;
+        timeoutInMs?: number;
     }): Promise<CbsResponse>;
     /**
      * Closes the AMQP cbs session to the EventHub/ServiceBus for this client,
@@ -283,7 +339,7 @@ export declare class CbsClient {
      * Indicates whether the cbs sender receiver link is open or closed.
      * @returns `true` open, `false` closed.
      */
-    private _isCbsSenderReceiverLinkOpen;
+    isOpen(): boolean;
     private _fromRheaMessageResponse;
 }
 /**
@@ -804,9 +860,20 @@ export declare interface CreateConnectionContextBaseParameters {
     operationTimeoutInMs?: number;
 }
 /**
- * The async lock instance with default settings.
+ * Creates a token provider from the provided shared access data.
+ * @param data - The sharedAccessKeyName/sharedAccessKey pair or the sharedAccessSignature.
+ * @hidden
+ */
+export declare function createSasTokenProvider(data: {
+    sharedAccessKeyName: string;
+    sharedAccessKey: string;
+} | {
+    sharedAccessSignature: string;
+} | NamedKeyCredential | SASCredential): SasTokenProvider;
+/**
+ * The cancellable async lock instance.
  */
-export declare const defaultLock: AsyncLock;
+export declare const defaultCancellableLock: CancellableAsyncLock;
 /**
  * A wrapper for setTimeout that resolves a promise after t milliseconds.
  * @param delayInMs - The number of milliseconds to be delayed.
@@ -1018,6 +1085,12 @@ export declare enum ErrorNameConditionMapper {
  * @param error - An error that can either be an Error or a MessagingError.
  */
 export declare function isMessagingError(error: Error | MessagingError): error is MessagingError;
+/**
+ * Typeguard that checks if the input is a SasTokenProvider.
+ * @param thing - Any object.
+ * @hidden
+ */
+export declare function isSasTokenProvider(thing: unknown): thing is SasTokenProvider;
 /**
  * Checks whether the provided error is a node.js SystemError.
  * @param err - An object that may contain error information.
@@ -1245,7 +1318,8 @@ export declare enum RetryOperationType {
     senderLink = "senderLink",
     sendMessage = "sendMessage",
     receiveMessage = "receiveMessage",
-    session = "session"
+    session = "session",
+    messageSettlement = "settlement"
 }
 /**
  * Retry policy options that determine the mode, number of retries, retry interval etc.
@@ -1278,6 +1352,24 @@ export declare interface RetryOptions {
      */
     maxRetryDelayInMs?: number;
 }
+/**
+ * A SasTokenProvider provides an alternative to TokenCredential for providing an `AccessToken`.
+ * @hidden
+ */
+export declare interface SasTokenProvider {
+    /**
+     * Property used to distinguish SasTokenProvider from TokenCredential.
+     */
+    isSasTokenProvider: true;
+    /**
+     * Gets the token provided by this provider.
+     *
+     * This method is called automatically by Azure SDK client libraries.
+     *
+     * @param audience - The audience for which the token is desired.
+     */
+    getToken(audience: string): AccessToken;
+}
 /**
  * Describes the options that can be specified while sending a request.
  */
@@ -1296,6 +1388,11 @@ export declare interface SendRequestOptions {
      */
     requestName?: string;
 }
+/**
+ * The standard error message accompanying an AbortError.
+ * @hidden
+ */
+export declare const StandardAbortMessage = "The operation was aborted.";
 /**
  * Maps some SystemErrors to amqp error conditions
  */

package/types/latest/core-amqp.d.ts

@@ -1,19 +1,41 @@
 /// <reference types="node" />
 import { AbortSignalLike } from '@azure/abort-controller';
+import { AccessToken } from '@azure/core-auth';
 import { AmqpError } from 'rhea-promise';
-import AsyncLock from 'async-lock';
 import { Connection } from 'rhea-promise';
 import { Message } from 'rhea-promise';
 import { MessageHeader } from 'rhea-promise';
 import { MessageProperties } from 'rhea-promise';
+import { NamedKeyCredential } from '@azure/core-auth';
 import { Receiver } from 'rhea-promise';
 import { ReceiverOptions } from 'rhea-promise';
 import { ReqResLink } from 'rhea-promise';
+import { SASCredential } from '@azure/core-auth';
 import { Sender } from 'rhea-promise';
 import { SenderOptions } from 'rhea-promise';
 import { Session } from 'rhea-promise';
 import { WebSocketImpl } from 'rhea-promise';
 
+/**
+ * Describes the properties that must be provided while acquiring a lock.
+ */
+export declare interface AcquireLockProperties {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.
+     * This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`
+     * can no longer be cancelled.
+     * This does not cancel running the task passed to `acquire()` if the lock has been acquired,
+     * but will prevent it from running if cancelled before the task is invoked.
+     */
+    abortSignal: AbortSignalLike | undefined;
+    /**
+     * The allowed amount of time in milliseconds to acquire a lock.
+     * If a lock isn't acquired within this time, the promise returned
+     * by `acquire()` will be rejected with an Error.
+     */
+    timeoutInMs: number | undefined;
+}
+
 /**
  * Describes the AmqpAnnotatedMessage, part of the ServiceBusReceivedMessage(as `amqpAnnotatedMessage` property).
  */
@@ -55,6 +77,10 @@ export declare interface AmqpAnnotatedMessage {
      * The message body.
      */
     body: any;
+    /**
+     * The AMQP section where the data was decoded from.
+     */
+    bodyType?: "data" | "sequence" | "value";
 }
 
 /**
@@ -65,6 +91,10 @@ export declare const AmqpAnnotatedMessage: {
      * Takes RheaMessage(`Message` type from "rhea") and returns it in the AmqpAnnotatedMessage format.
      */
     fromRheaMessage(msg: Message): AmqpAnnotatedMessage;
+    /**
+     * Takes AmqpAnnotatedMessage and returns it in the RheaMessage(`Message` type from "rhea") format.
+     */
+    toRheaMessage(msg: AmqpAnnotatedMessage): Message;
 };
 
 /**
@@ -190,7 +220,33 @@ export declare const AmqpMessageProperties: {
      */
     fromRheaMessageProperties(props: MessageProperties): AmqpMessageProperties;
 };
-export { AsyncLock }
+
+/**
+ * CancellableAsyncLock provides a mechanism for forcing tasks using the same
+ * 'key' to be executed serially.
+ *
+ * Pending tasks can be manually cancelled via an abortSignal or automatically
+ * cancelled by reach a provided timeout value.
+ */
+export declare interface CancellableAsyncLock {
+    /**
+     * Returns a promise that resolves to the value returned by the provided task function.
+     * Only 1 task can be invoked at a time for a given `key` value.
+     *
+     * An acquire call can be cancelled via an `abortSignal`.
+     * If cancelled, the promise will be rejected with an `AbortError`.
+     *
+     * `acquireTimeoutInMs` can also be provided to properties.
+     * If the timeout is reached before the provided `task` is invoked,
+     * then the promise will be rejected with an Error stating the task
+     * timed out waiting to acquire a lock.
+     *
+     * @param key - All `acquire` calls are grouped by the provided `key`.
+     * @param task - The function to invoke once the lock has been acquired.
+     * @param properties - Additional properties to control the behavior of `acquire`.
+     */
+    acquire<T = void>(key: string, task: (...args: any[]) => Promise<T>, properties: AcquireLockProperties): Promise<T>;
+}
 
 /**
  * Describes the EventHub/ServiceBus Cbs client that talks to the $cbs endpoint over AMQP connection.
@@ -236,6 +292,7 @@ export declare class CbsClient {
      */
     init(options?: {
         abortSignal?: AbortSignalLike;
+        timeoutInMs?: number;
     }): Promise<void>;
     /**
      * Negotiates the CBS claim with the EventHub/ServiceBus Service.
@@ -274,6 +331,7 @@ export declare class CbsClient {
      */
     negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: {
         abortSignal?: AbortSignalLike;
+        timeoutInMs?: number;
     }): Promise<CbsResponse>;
     /**
      * Closes the AMQP cbs session to the EventHub/ServiceBus for this client,
@@ -290,7 +348,7 @@ export declare class CbsClient {
      * Indicates whether the cbs sender receiver link is open or closed.
      * @returns `true` open, `false` closed.
      */
-    private _isCbsSenderReceiverLinkOpen;
+    isOpen(): boolean;
     private _fromRheaMessageResponse;
 }
 
@@ -822,9 +880,21 @@ export declare interface CreateConnectionContextBaseParameters {
 }
 
 /**
- * The async lock instance with default settings.
+ * Creates a token provider from the provided shared access data.
+ * @param data - The sharedAccessKeyName/sharedAccessKey pair or the sharedAccessSignature.
+ * @hidden
+ */
+export declare function createSasTokenProvider(data: {
+    sharedAccessKeyName: string;
+    sharedAccessKey: string;
+} | {
+    sharedAccessSignature: string;
+} | NamedKeyCredential | SASCredential): SasTokenProvider;
+
+/**
+ * The cancellable async lock instance.
  */
-export declare const defaultLock: AsyncLock;
+export declare const defaultCancellableLock: CancellableAsyncLock;
 
 /**
  * A wrapper for setTimeout that resolves a promise after t milliseconds.
@@ -1040,6 +1110,13 @@ export declare enum ErrorNameConditionMapper {
  */
 export declare function isMessagingError(error: Error | MessagingError): error is MessagingError;
 
+/**
+ * Typeguard that checks if the input is a SasTokenProvider.
+ * @param thing - Any object.
+ * @hidden
+ */
+export declare function isSasTokenProvider(thing: unknown): thing is SasTokenProvider;
+
 /**
  * Checks whether the provided error is a node.js SystemError.
  * @param err - An object that may contain error information.
@@ -1282,7 +1359,8 @@ export declare enum RetryOperationType {
     senderLink = "senderLink",
     sendMessage = "sendMessage",
     receiveMessage = "receiveMessage",
-    session = "session"
+    session = "session",
+    messageSettlement = "settlement"
 }
 
 /**
@@ -1317,6 +1395,25 @@ export declare interface RetryOptions {
     maxRetryDelayInMs?: number;
 }
 
+/**
+ * A SasTokenProvider provides an alternative to TokenCredential for providing an `AccessToken`.
+ * @hidden
+ */
+export declare interface SasTokenProvider {
+    /**
+     * Property used to distinguish SasTokenProvider from TokenCredential.
+     */
+    isSasTokenProvider: true;
+    /**
+     * Gets the token provided by this provider.
+     *
+     * This method is called automatically by Azure SDK client libraries.
+     *
+     * @param audience - The audience for which the token is desired.
+     */
+    getToken(audience: string): AccessToken;
+}
+
 /**
  * Describes the options that can be specified while sending a request.
  */
@@ -1336,6 +1433,12 @@ export declare interface SendRequestOptions {
     requestName?: string;
 }
 
+/**
+ * The standard error message accompanying an AbortError.
+ * @hidden
+ */
+export declare const StandardAbortMessage = "The operation was aborted.";
+
 /**
  * Maps some SystemErrors to amqp error conditions
  */