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

package/dist/esm/util/errors.js

@@ -0,0 +1,220 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import Long from "long";
+import { logger, receiverLogger } from "../log.js";
+import { isAmqpAnnotatedMessage, isServiceBusMessage } from "../serviceBusMessage.js";
+import { isDefined } from "@azure/core-util";
+/**
+ * Error message to use when EntityPath in connection string does not match the
+ * queue or topic name passed to the methods in the ServiceBusClient that create
+ * senders and receivers.
+ *
+ * @internal
+ */
+export const entityPathMisMatchError = "The queue or topic name provided does not match the EntityPath in the connection string passed to the ServiceBusClient constructor.";
+/**
+ * Error message for when maxMessageCount provided is invalid.
+ *
+ * @internal
+ */
+export const InvalidMaxMessageCountError = "'maxMessageCount' must be a number greater than 0.";
+/**
+ * @internal
+ * Logs and throws Error if the current AMQP connection is closed.
+ * @param context - The ConnectionContext associated with the current AMQP connection.
+ */
+export function throwErrorIfConnectionClosed(context) {
+    if (context && context.wasConnectionCloseCalled) {
+        const errorMessage = "The underlying AMQP connection is closed.";
+        const error = new Error(errorMessage);
+        logger.warning(`[${context.connectionId}] %O`, error);
+        throw error;
+    }
+}
+/**
+ * @internal
+ * Gets the error message when a sender is used when its already closed
+ * @param entityPath - Value of the `entityPath` property on the client which denotes its name
+ */
+export function getSenderClosedErrorMsg(entityPath) {
+    return (`The sender for "${entityPath}" has been closed and can no longer be used. ` +
+        `Please create a new sender using the "createSender" method on the ServiceBusClient.`);
+}
+/**
+ * @internal
+ * Gets the error message when a receiver is used when its already closed
+ * @param entityPath - Value of the `entityPath` property on the client which denotes its name
+ * @param sessionId - If using session receiver, then the id of the session
+ */
+export function getReceiverClosedErrorMsg(entityPath, sessionId) {
+    if (!isDefined(sessionId)) {
+        return (`The receiver for "${entityPath}" has been closed and can no longer be used. ` +
+            `Please create a new receiver using the "createReceiver" method on the ServiceBusClient.`);
+    }
+    return (`The receiver for session "${sessionId}" in "${entityPath}" has been closed and can no ` +
+        `longer be used. Please create a new receiver using the "acceptSession" or "acceptNextSession" method on the ServiceBusClient.`);
+}
+/**
+ * @internal
+ * @param entityPath - Value of the `entityPath` property on the client which denotes its name
+ * @param sessionId - If using session receiver, then the id of the session
+ */
+export function getAlreadyReceivingErrorMsg(entityPath, sessionId) {
+    if (!isDefined(sessionId)) {
+        return `The receiver for "${entityPath}" is already receiving messages.`;
+    }
+    return `The receiver for session "${sessionId}" for "${entityPath}" is already receiving messages.`;
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is undefined or null
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to check
+ * @param parameterValue - Value of the parameter to check
+ */
+export function throwTypeErrorIfParameterMissing(connectionId, parameterName, parameterValue) {
+    if (parameterValue === undefined || parameterValue === null) {
+        const error = new TypeError(`Missing parameter "${parameterName}"`);
+        logger.warning(`[${connectionId}] %O`, error);
+        throw error;
+    }
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is not an instance of expected type
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to type check
+ * @param parameterValue - Value of the parameter to type check
+ * @param constructor - Constructor function of the expected parameter type
+ */
+export function throwTypeErrorIfNotInstanceOfParameterType(connectionId, parameterName, parameterValue, 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+constructor) {
+    if (!(parameterValue instanceof constructor)) {
+        const error = new TypeError(`The parameter "${parameterName}" should be an instance of "${constructor.name}"`);
+        logger.warning(`[${connectionId}] %O`, error);
+        throw error;
+    }
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is not of expected type
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to type check
+ * @param parameterValue - Value of the parameter to type check
+ * @param expectedType - Expected type of the parameter
+ */
+export function throwTypeErrorIfParameterTypeMismatch(connectionId, parameterName, parameterValue, expectedType) {
+    if (typeof parameterValue !== expectedType) {
+        const error = new TypeError(`The parameter "${parameterName}" should be of type "${expectedType}"`);
+        logger.warning(`[${connectionId}] %O`, error);
+        throw error;
+    }
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is not of type `Long` or an array of type `Long`
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to type check
+ * @param parameterValue - Value of the parameter to type check
+ */
+export function throwTypeErrorIfParameterNotLong(connectionId, parameterName, parameterValue) {
+    if (Array.isArray(parameterValue)) {
+        return throwTypeErrorIfParameterNotLongArray(connectionId, parameterName, parameterValue);
+    }
+    if (Long.isLong(parameterValue)) {
+        return;
+    }
+    const error = new TypeError(`The parameter "${parameterName}" should be of type "Long"`);
+    logger.warning(`[${connectionId}] %O`, error);
+    throw error;
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is not an array of type `Long`
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to type check
+ * @param parameterValue - Value of the parameter to type check
+ */
+export function throwTypeErrorIfParameterNotLongArray(connectionId, parameterName, parameterValue) {
+    if (parameterValue.every((item) => Long.isLong(item))) {
+        return;
+    }
+    const error = new TypeError(`The parameter "${parameterName}" should be an array of type "Long"`);
+    logger.warning(`[${connectionId}] %O`, error);
+    throw error;
+}
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is an empty string
+ * @param connectionId - Id of the underlying AMQP connection used for logging
+ * @param parameterName - Name of the parameter to type check
+ * @param parameterValue - Value of the parameter to type check
+ */
+export function throwTypeErrorIfParameterIsEmptyString(connectionId, parameterName, parameterValue) {
+    if (parameterValue !== "") {
+        return;
+    }
+    const error = new TypeError(`Empty string not allowed in parameter "${parameterName}"`);
+    logger.warning(`[${connectionId}] %O`, error);
+    throw error;
+}
+/**
+ * @internal
+ * The error message for operations on the receiver that are invalid for a message received in receiveAndDelete mode.
+ */
+export const InvalidOperationInReceiveAndDeleteMode = "The operation is not supported in 'receiveAndDelete' receive mode.";
+/**
+ * @internal
+ * The error message for operations on the receiver that are invalid for a peeked message.
+ */
+export const InvalidOperationForPeekedMessage = "This operation is not supported for peeked messages. Only messages received using 'receiveMessages()', 'subscribe()' and 'getMessageIterator()' methods on the receiver in 'peekLock' receive mode can be settled.";
+/**
+ * @internal
+ * The error message for when one attempts to settle an already settled message.
+ */
+export const MessageAlreadySettled = "The message has either been deleted or already settled";
+/**
+ * Throws error if the ServiceBusReceivedMessage cannot be settled.
+ * @internal
+ */
+export function throwErrorIfInvalidOperationOnMessage(message, receiveMode, connectionId) {
+    let error;
+    if (receiveMode === "receiveAndDelete") {
+        error = new Error(InvalidOperationInReceiveAndDeleteMode);
+    }
+    else if (!message.lockToken) {
+        error = new Error(InvalidOperationForPeekedMessage);
+    }
+    if (error) {
+        receiverLogger.logError(error, "[%s] An error occurred for message with id '%s'", connectionId, message.messageId);
+        throw error;
+    }
+}
+/**
+ * Error message for when the ServiceBusMessage provided by the user has different values
+ * for partitionKey and sessionId.
+ * @internal
+ */
+export const PartitionKeySessionIdMismatchError = "The fields 'partitionKey' and 'sessionId' cannot have different values.";
+/**
+ * Throws error if the given object is not a valid ServiceBusMessage
+ * @internal
+ * @param msg - The object that needs to be validated as a ServiceBusMessage
+ * @param errorMessageForWrongType - The error message to use when given object is not a ServiceBusMessage
+ */
+export function throwIfNotValidServiceBusMessage(msg, errorMessageForWrongType) {
+    if (!isServiceBusMessage(msg) && !isAmqpAnnotatedMessage(msg)) {
+        throw new TypeError(errorMessageForWrongType);
+    }
+    if (isServiceBusMessage(msg)) {
+        if (msg.partitionKey && msg.sessionId && msg.partitionKey !== msg.sessionId) {
+            throw new TypeError(PartitionKeySessionIdMismatchError);
+        }
+    }
+}
+/** @internal */
+export const errorInvalidMessageTypeSingleOrArray = "Provided value for 'messages' must be of type: ServiceBusMessage, AmqpAnnotatedMessage, ServiceBusMessageBatch or an array of type ServiceBusMessage or AmqpAnnotatedMessage.";
+/** @internal */
+export const errorInvalidMessageTypeSingle = "Provided value for 'message' must be of type: ServiceBusMessage or AmqpAnnotatedMessage.";
+//# sourceMappingURL=errors.js.map

package/dist/esm/util/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/util/errors.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAClC,qIAAqI,CAAC;AAExI;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,oDAAoD,CAAC;AAEhG;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,OAA0B;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QAChD,MAAM,YAAY,GAAG,2CAA2C,CAAC;QACjE,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,UAAkB;IACxD,OAAO,CACL,mBAAmB,UAAU,+CAA+C;QAC5E,qFAAqF,CACtF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,UAAkB,EAAE,SAAkB;IAC9E,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,OAAO,CACL,qBAAqB,UAAU,+CAA+C;YAC9E,yFAAyF,CAC1F,CAAC;IACJ,CAAC;IACD,OAAO,CACL,6BAA6B,SAAS,SAAS,UAAU,+BAA+B;QACxF,+HAA+H,CAChI,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,UAAkB,EAAE,SAAkB;IAChF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,OAAO,qBAAqB,UAAU,kCAAkC,CAAC;IAC3E,CAAC;IACD,OAAO,6BAA6B,SAAS,UAAU,UAAU,kCAAkC,CAAC;AACtG,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAC9C,YAAoB,EACpB,aAAqB,EACrB,cAAuB;IAEvB,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,sBAAsB,aAAa,GAAG,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,0CAA0C,CACxD,YAAoB,EACpB,aAAqB,EACrB,cAAuB;AACvB,sEAAsE;AACtE,WAAqB;IAErB,IAAI,CAAC,CAAC,cAAc,YAAY,WAAW,CAAC,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,SAAS,CACzB,kBAAkB,aAAa,+BAA+B,WAAW,CAAC,IAAI,GAAG,CAClF,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qCAAqC,CACnD,YAAoB,EACpB,aAAqB,EACrB,cAAuB,EACvB,YAAoB;IAEpB,IAAI,OAAO,cAAc,KAAK,YAAY,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,SAAS,CACzB,kBAAkB,aAAa,wBAAwB,YAAY,GAAG,CACvE,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAC9C,YAAoB,EACpB,aAAqB,EACrB,cAAuB;IAEvB,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAClC,OAAO,qCAAqC,CAAC,YAAY,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,kBAAkB,aAAa,4BAA4B,CAAC,CAAC;IACzF,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,KAAK,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qCAAqC,CACnD,YAAoB,EACpB,aAAqB,EACrB,cAAqB;IAErB,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,kBAAkB,aAAa,qCAAqC,CAAC,CAAC;IAClG,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,KAAK,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sCAAsC,CACpD,YAAoB,EACpB,aAAqB,EACrB,cAAsB;IAEtB,IAAI,cAAc,KAAK,EAAE,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,0CAA0C,aAAa,GAAG,CAAC,CAAC;IACxF,MAAM,CAAC,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,KAAK,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,sCAAsC,GACjD,oEAAoE,CAAC;AAEvE;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAC3C,oNAAoN,CAAC;AAEvN;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,wDAAwD,CAAC;AAE9F;;;GAGG;AACH,MAAM,UAAU,qCAAqC,CACnD,OAAkC,EAClC,WAAwB,EACxB,YAAoB;IAEpB,IAAI,KAAwB,CAAC;IAE7B,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;QACvC,KAAK,GAAG,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC5D,CAAC;SAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QAC9B,KAAK,GAAG,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACV,cAAc,CAAC,QAAQ,CACrB,KAAK,EACL,iDAAiD,EACjD,YAAY,EACZ,OAAO,CAAC,SAAS,CAClB,CAAC;QACF,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAC7C,yEAAyE,CAAC;AAC5E;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAC9C,GAAY,EACZ,wBAAgC;IAEhC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;YAC5E,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;AACH,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAC/C,+KAA+K,CAAC;AAElL,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GACxC,0FAA0F,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport Long from \"long\";\nimport type { ConnectionContext } from \"../connectionContext.js\";\nimport { logger, receiverLogger } from \"../log.js\";\nimport type { ReceiveMode } from \"../models.js\";\nimport type { ServiceBusReceivedMessage } from \"../serviceBusMessage.js\";\nimport { isAmqpAnnotatedMessage, isServiceBusMessage } from \"../serviceBusMessage.js\";\nimport { isDefined } from \"@azure/core-util\";\n\n/**\n * Error message to use when EntityPath in connection string does not match the\n * queue or topic name passed to the methods in the ServiceBusClient that create\n * senders and receivers.\n *\n * @internal\n */\nexport const entityPathMisMatchError =\n  \"The queue or topic name provided does not match the EntityPath in the connection string passed to the ServiceBusClient constructor.\";\n\n/**\n * Error message for when maxMessageCount provided is invalid.\n *\n * @internal\n */\nexport const InvalidMaxMessageCountError = \"'maxMessageCount' must be a number greater than 0.\";\n\n/**\n * @internal\n * Logs and throws Error if the current AMQP connection is closed.\n * @param context - The ConnectionContext associated with the current AMQP connection.\n */\nexport function throwErrorIfConnectionClosed(context: ConnectionContext): void {\n  if (context && context.wasConnectionCloseCalled) {\n    const errorMessage = \"The underlying AMQP connection is closed.\";\n    const error = new Error(errorMessage);\n    logger.warning(`[${context.connectionId}] %O`, error);\n    throw error;\n  }\n}\n\n/**\n * @internal\n * Gets the error message when a sender is used when its already closed\n * @param entityPath - Value of the `entityPath` property on the client which denotes its name\n */\nexport function getSenderClosedErrorMsg(entityPath: string): string {\n  return (\n    `The sender for \"${entityPath}\" has been closed and can no longer be used. ` +\n    `Please create a new sender using the \"createSender\" method on the ServiceBusClient.`\n  );\n}\n\n/**\n * @internal\n * Gets the error message when a receiver is used when its already closed\n * @param entityPath - Value of the `entityPath` property on the client which denotes its name\n * @param sessionId - If using session receiver, then the id of the session\n */\nexport function getReceiverClosedErrorMsg(entityPath: string, sessionId?: string): string {\n  if (!isDefined(sessionId)) {\n    return (\n      `The receiver for \"${entityPath}\" has been closed and can no longer be used. ` +\n      `Please create a new receiver using the \"createReceiver\" method on the ServiceBusClient.`\n    );\n  }\n  return (\n    `The receiver for session \"${sessionId}\" in \"${entityPath}\" has been closed and can no ` +\n    `longer be used. Please create a new receiver using the \"acceptSession\" or \"acceptNextSession\" method on the ServiceBusClient.`\n  );\n}\n\n/**\n * @internal\n * @param entityPath - Value of the `entityPath` property on the client which denotes its name\n * @param sessionId - If using session receiver, then the id of the session\n */\nexport function getAlreadyReceivingErrorMsg(entityPath: string, sessionId?: string): string {\n  if (!isDefined(sessionId)) {\n    return `The receiver for \"${entityPath}\" is already receiving messages.`;\n  }\n  return `The receiver for session \"${sessionId}\" for \"${entityPath}\" is already receiving messages.`;\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is undefined or null\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to check\n * @param parameterValue - Value of the parameter to check\n */\nexport function throwTypeErrorIfParameterMissing(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: unknown,\n): void {\n  if (parameterValue === undefined || parameterValue === null) {\n    const error = new TypeError(`Missing parameter \"${parameterName}\"`);\n    logger.warning(`[${connectionId}] %O`, error);\n    throw error;\n  }\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is not an instance of expected type\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to type check\n * @param parameterValue - Value of the parameter to type check\n * @param constructor - Constructor function of the expected parameter type\n */\nexport function throwTypeErrorIfNotInstanceOfParameterType(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: unknown,\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\n  constructor: Function,\n): void {\n  if (!(parameterValue instanceof constructor)) {\n    const error = new TypeError(\n      `The parameter \"${parameterName}\" should be an instance of \"${constructor.name}\"`,\n    );\n    logger.warning(`[${connectionId}] %O`, error);\n    throw error;\n  }\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is not of expected type\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to type check\n * @param parameterValue - Value of the parameter to type check\n * @param expectedType - Expected type of the parameter\n */\nexport function throwTypeErrorIfParameterTypeMismatch(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: unknown,\n  expectedType: string,\n): void {\n  if (typeof parameterValue !== expectedType) {\n    const error = new TypeError(\n      `The parameter \"${parameterName}\" should be of type \"${expectedType}\"`,\n    );\n    logger.warning(`[${connectionId}] %O`, error);\n    throw error;\n  }\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is not of type `Long` or an array of type `Long`\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to type check\n * @param parameterValue - Value of the parameter to type check\n */\nexport function throwTypeErrorIfParameterNotLong(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: unknown,\n): TypeError | undefined {\n  if (Array.isArray(parameterValue)) {\n    return throwTypeErrorIfParameterNotLongArray(connectionId, parameterName, parameterValue);\n  }\n  if (Long.isLong(parameterValue)) {\n    return;\n  }\n  const error = new TypeError(`The parameter \"${parameterName}\" should be of type \"Long\"`);\n  logger.warning(`[${connectionId}] %O`, error);\n  throw error;\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is not an array of type `Long`\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to type check\n * @param parameterValue - Value of the parameter to type check\n */\nexport function throwTypeErrorIfParameterNotLongArray(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: any[],\n): TypeError | undefined {\n  if (parameterValue.every((item) => Long.isLong(item))) {\n    return;\n  }\n  const error = new TypeError(`The parameter \"${parameterName}\" should be an array of type \"Long\"`);\n  logger.warning(`[${connectionId}] %O`, error);\n  throw error;\n}\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is an empty string\n * @param connectionId - Id of the underlying AMQP connection used for logging\n * @param parameterName - Name of the parameter to type check\n * @param parameterValue - Value of the parameter to type check\n */\nexport function throwTypeErrorIfParameterIsEmptyString(\n  connectionId: string,\n  parameterName: string,\n  parameterValue: string,\n): TypeError | undefined {\n  if (parameterValue !== \"\") {\n    return;\n  }\n  const error = new TypeError(`Empty string not allowed in parameter \"${parameterName}\"`);\n  logger.warning(`[${connectionId}] %O`, error);\n  throw error;\n}\n\n/**\n * @internal\n * The error message for operations on the receiver that are invalid for a message received in receiveAndDelete mode.\n */\nexport const InvalidOperationInReceiveAndDeleteMode =\n  \"The operation is not supported in 'receiveAndDelete' receive mode.\";\n\n/**\n * @internal\n * The error message for operations on the receiver that are invalid for a peeked message.\n */\nexport const InvalidOperationForPeekedMessage =\n  \"This operation is not supported for peeked messages. Only messages received using 'receiveMessages()', 'subscribe()' and 'getMessageIterator()' methods on the receiver in 'peekLock' receive mode can be settled.\";\n\n/**\n * @internal\n * The error message for when one attempts to settle an already settled message.\n */\nexport const MessageAlreadySettled = \"The message has either been deleted or already settled\";\n\n/**\n * Throws error if the ServiceBusReceivedMessage cannot be settled.\n * @internal\n */\nexport function throwErrorIfInvalidOperationOnMessage(\n  message: ServiceBusReceivedMessage,\n  receiveMode: ReceiveMode,\n  connectionId: string,\n): void {\n  let error: Error | undefined;\n\n  if (receiveMode === \"receiveAndDelete\") {\n    error = new Error(InvalidOperationInReceiveAndDeleteMode);\n  } else if (!message.lockToken) {\n    error = new Error(InvalidOperationForPeekedMessage);\n  }\n\n  if (error) {\n    receiverLogger.logError(\n      error,\n      \"[%s] An error occurred for message with id '%s'\",\n      connectionId,\n      message.messageId,\n    );\n    throw error;\n  }\n}\n\n/**\n * Error message for when the ServiceBusMessage provided by the user has different values\n * for partitionKey and sessionId.\n * @internal\n */\nexport const PartitionKeySessionIdMismatchError =\n  \"The fields 'partitionKey' and 'sessionId' cannot have different values.\";\n/**\n * Throws error if the given object is not a valid ServiceBusMessage\n * @internal\n * @param msg - The object that needs to be validated as a ServiceBusMessage\n * @param errorMessageForWrongType - The error message to use when given object is not a ServiceBusMessage\n */\nexport function throwIfNotValidServiceBusMessage(\n  msg: unknown,\n  errorMessageForWrongType: string,\n): void {\n  if (!isServiceBusMessage(msg) && !isAmqpAnnotatedMessage(msg)) {\n    throw new TypeError(errorMessageForWrongType);\n  }\n\n  if (isServiceBusMessage(msg)) {\n    if (msg.partitionKey && msg.sessionId && msg.partitionKey !== msg.sessionId) {\n      throw new TypeError(PartitionKeySessionIdMismatchError);\n    }\n  }\n}\n\n/** @internal */\nexport const errorInvalidMessageTypeSingleOrArray =\n  \"Provided value for 'messages' must be of type: ServiceBusMessage, AmqpAnnotatedMessage, ServiceBusMessageBatch or an array of type ServiceBusMessage or AmqpAnnotatedMessage.\";\n\n/** @internal */\nexport const errorInvalidMessageTypeSingle =\n  \"Provided value for 'message' must be of type: ServiceBusMessage or AmqpAnnotatedMessage.\";\n"]}

package/dist/esm/util/parseUrl.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ */
+export declare const parseURL: (rawUrl: string) => URL;
+//# sourceMappingURL=parseUrl.d.ts.map

package/dist/esm/util/parseUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseUrl.d.ts","sourceRoot":"","sources":["../../../src/util/parseUrl.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,MAAM,KAAG,GAEzC,CAAC"}

package/{dist-esm/src → dist/esm}/util/parseUrl.js

@@ -1,11 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-/**
- * @internal
- */
-import { URL } from "url";
 /**
  * @internal
  */

package/dist/esm/util/parseUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseUrl.js","sourceRoot":"","sources":["../../../src/util/parseUrl.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAO,EAAE;IAC9C,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/**\n * @internal\n */\nexport const parseURL = (rawUrl: string): URL => {\n  return new URL(rawUrl);\n};\n"]}

package/dist/esm/util/runtimeInfo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns information about the platform this function is being run on.
+ * @hidden
+ * @internal
+ */
+export declare function getRuntimeInfo(): string;
+//# sourceMappingURL=runtimeInfo.d.ts.map

package/dist/esm/util/runtimeInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeInfo.d.ts","sourceRoot":"","sources":["../../../src/util/runtimeInfo.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAYvC"}

package/{dist-esm/src → dist/esm}/util/runtimeInfo.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import * as os from "os";
+// Licensed under the MIT License.
+import os from "node:os";
 /**
  * Returns information about the platform this function is being run on.
  * @hidden

package/dist/esm/util/runtimeInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeInfo.js","sourceRoot":"","sources":["../../../src/util/runtimeInfo.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,WAAW,GAAG;QAClB,GAAG,EAAE,MAAM;QACX,KAAK,EAAE,OAAO,CAAC,OAAO;KACvB,CAAC;IAEF,MAAM,MAAM,GAAG;QACb,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG;KACrD,CAAC;IAEF,OAAO,GAAG,WAAW,CAAC,GAAG,IAAI,WAAW,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;AACjF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport os from \"node:os\";\n\n/**\n * Returns information about the platform this function is being run on.\n * @hidden\n * @internal\n */\nexport function getRuntimeInfo(): string {\n  const runtimeInfo = {\n    key: \"Node\",\n    value: process.version,\n  };\n\n  const osInfo = {\n    key: \"OS\",\n    value: `(${os.arch()}-${os.type()}-${os.release()})`,\n  };\n\n  return `${runtimeInfo.key}/${runtimeInfo.value} ${osInfo.key}/${osInfo.value}`;\n}\n"]}

package/dist/esm/util/sasServiceClientCredentials.d.ts

@@ -0,0 +1,31 @@
+import type { AccessToken, NamedKeyCredential } from "@azure/core-auth";
+import type { PipelineRequest } from "@azure/core-rest-pipeline";
+/**
+ * @internal
+ */
+export declare class SasServiceClientCredentials {
+    /**
+     * The NamedKeyCredential containing the key name and secret key value.
+     */
+    private _credential;
+    /**
+     * A SasTokenProvider provides a method to retrieve an `AccessToken`.
+     */
+    private _tokenProvider;
+    /**
+     * Creates a new sasServiceClientCredentials object.
+     *
+     * @param credential - The NamedKeyCredential containing the key name and secret key value.
+     */
+    constructor(credential: NamedKeyCredential);
+    private _generateSignature;
+    /**
+     * Signs a request with the Authentication header.
+     *
+     * @param request - The {@link PipelineRequest} to be signed.
+     * @returns The signed request object.
+     */
+    signRequest(request: PipelineRequest): Promise<PipelineRequest>;
+    getToken(audience: string): Promise<AccessToken>;
+}
+//# sourceMappingURL=sasServiceClientCredentials.d.ts.map

package/dist/esm/util/sasServiceClientCredentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sasServiceClientCredentials.d.ts","sourceRoot":"","sources":["../../../src/util/sasServiceClientCredentials.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAMjE;;GAEG;AACH,qBAAa,2BAA2B;IACtC;;OAEG;IACH,OAAO,CAAC,WAAW,CAAqB;IAExC;;OAEG;IACH,OAAO,CAAC,cAAc,CAAmB;IACzC;;;;OAIG;gBACS,UAAU,EAAE,kBAAkB;YAK5B,kBAAkB;IAMhC;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAiBrE,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAGjD"}

package/dist/esm/util/sasServiceClientCredentials.js

@@ -0,0 +1,52 @@
+import { createHttpHeaders } from "@azure/core-rest-pipeline";
+import { generateKey } from "./crypto.js";
+import { createSasTokenProvider } from "@azure/core-amqp";
+/**
+ * @internal
+ */
+export class SasServiceClientCredentials {
+    /**
+     * The NamedKeyCredential containing the key name and secret key value.
+     */
+    _credential;
+    /**
+     * A SasTokenProvider provides a method to retrieve an `AccessToken`.
+     */
+    _tokenProvider;
+    /**
+     * Creates a new sasServiceClientCredentials object.
+     *
+     * @param credential - The NamedKeyCredential containing the key name and secret key value.
+     */
+    constructor(credential) {
+        this._credential = credential;
+        this._tokenProvider = createSasTokenProvider(credential);
+    }
+    async _generateSignature(targetUri, expirationDate) {
+        const stringToSign = `${targetUri}\n${expirationDate}`;
+        const result = await generateKey(this._credential.key, stringToSign);
+        return result;
+    }
+    /**
+     * Signs a request with the Authentication header.
+     *
+     * @param request - The {@link PipelineRequest} to be signed.
+     * @returns The signed request object.
+     */
+    async signRequest(request) {
+        if (!request.headers)
+            request.headers = createHttpHeaders();
+        const targetUri = encodeURIComponent(request.url.toLowerCase()).toLowerCase();
+        const date = new Date();
+        date.setMinutes(date.getMinutes() + 5);
+        const expirationDate = Math.round(date.getTime() / 1000);
+        const signature = await this._generateSignature(targetUri, expirationDate);
+        request.headers.set("authorization", `SharedAccessSignature sig=${signature}&se=${expirationDate}&skn=${this._credential.name}&sr=${targetUri}`);
+        request.withCredentials = true;
+        return request;
+    }
+    getToken(audience) {
+        return this._tokenProvider.getToken(audience);
+    }
+}
+//# sourceMappingURL=sasServiceClientCredentials.js.map

package/dist/esm/util/sasServiceClientCredentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sasServiceClientCredentials.js","sourceRoot":"","sources":["../../../src/util/sasServiceClientCredentials.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,2BAA2B;IACtC;;OAEG;IACK,WAAW,CAAqB;IAExC;;OAEG;IACK,cAAc,CAAmB;IACzC;;;;OAIG;IACH,YAAY,UAA8B;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC3D,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,SAAiB,EAAE,cAAsB;QACxE,MAAM,YAAY,GAAG,GAAG,SAAS,KAAK,cAAc,EAAE,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QACrE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,OAAwB;QACxC,IAAI,CAAC,OAAO,CAAC,OAAO;YAAE,OAAO,CAAC,OAAO,GAAG,iBAAiB,EAAE,CAAC;QAE5D,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9E,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC3E,OAAO,CAAC,OAAO,CAAC,GAAG,CACjB,eAAe,EACf,6BAA6B,SAAS,OAAO,cAAc,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,OAAO,SAAS,EAAE,CAC3G,CAAC;QACF,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,QAAgB;QACvB,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { AccessToken, NamedKeyCredential } from \"@azure/core-auth\";\nimport type { PipelineRequest } from \"@azure/core-rest-pipeline\";\nimport { createHttpHeaders } from \"@azure/core-rest-pipeline\";\nimport { generateKey } from \"./crypto.js\";\nimport type { SasTokenProvider } from \"@azure/core-amqp\";\nimport { createSasTokenProvider } from \"@azure/core-amqp\";\n\n/**\n * @internal\n */\nexport class SasServiceClientCredentials {\n  /**\n   * The NamedKeyCredential containing the key name and secret key value.\n   */\n  private _credential: NamedKeyCredential;\n\n  /**\n   * A SasTokenProvider provides a method to retrieve an `AccessToken`.\n   */\n  private _tokenProvider: SasTokenProvider;\n  /**\n   * Creates a new sasServiceClientCredentials object.\n   *\n   * @param credential - The NamedKeyCredential containing the key name and secret key value.\n   */\n  constructor(credential: NamedKeyCredential) {\n    this._credential = credential;\n    this._tokenProvider = createSasTokenProvider(credential);\n  }\n\n  private async _generateSignature(targetUri: string, expirationDate: number): Promise<string> {\n    const stringToSign = `${targetUri}\\n${expirationDate}`;\n    const result = await generateKey(this._credential.key, stringToSign);\n    return result;\n  }\n\n  /**\n   * Signs a request with the Authentication header.\n   *\n   * @param request - The {@link PipelineRequest} to be signed.\n   * @returns The signed request object.\n   */\n  async signRequest(request: PipelineRequest): Promise<PipelineRequest> {\n    if (!request.headers) request.headers = createHttpHeaders();\n\n    const targetUri = encodeURIComponent(request.url.toLowerCase()).toLowerCase();\n\n    const date = new Date();\n    date.setMinutes(date.getMinutes() + 5);\n    const expirationDate = Math.round(date.getTime() / 1000);\n    const signature = await this._generateSignature(targetUri, expirationDate);\n    request.headers.set(\n      \"authorization\",\n      `SharedAccessSignature sig=${signature}&se=${expirationDate}&skn=${this._credential.name}&sr=${targetUri}`,\n    );\n    request.withCredentials = true;\n    return request;\n  }\n\n  getToken(audience: string): Promise<AccessToken> {\n    return this._tokenProvider.getToken(audience);\n  }\n}\n"]}

package/dist/esm/util/semaphore.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @internal
+ * A simple Semaphore
+ */
+export declare class Semaphore {
+    /**
+     * The number of concurrent calls that can be made.
+     */
+    limit: number;
+    private _queue;
+    private _used;
+    constructor(limit: number);
+    /**
+     * Acquires a lock from the semaphore, returns a Promise that resolves when the caller holds
+     * a lock.
+     */
+    acquire(): Promise<void>;
+    /**
+     * Releases a lock back to the semaphore.
+     */
+    release(): void;
+    /**
+     * Aquires a lock from the semaphore and then execute the fn. If the fn returns a Promise,
+     * wait for that promise to settle and then release the lock back to the semaphore.
+     * @param fn - The function that needs to be executed in the ciritical region.
+     * @returns A Promise that will settle with the return value of fn.
+     */
+    use<T>(fn: () => T | PromiseLike<T>): Promise<T>;
+    /**
+     * Provides the number of locks currently held.
+     */
+    currentLockCount(): number;
+    /**
+     * Provides the number of tasks waiting to acquire a lock.
+     */
+    awaitedTaskCount(): number;
+}
+//# sourceMappingURL=semaphore.d.ts.map

package/dist/esm/util/semaphore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semaphore.d.ts","sourceRoot":"","sources":["../../../src/util/semaphore.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,MAAM,CAAkE;IAChF,OAAO,CAAC,KAAK,CAAa;gBACd,KAAK,EAAE,MAAM;IAWzB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAWxB;;OAEG;IACH,OAAO,IAAI,IAAI;IAWf;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAahD;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,gBAAgB,IAAI,MAAM;CAG3B"}

package/dist/esm/util/semaphore.js

@@ -0,0 +1,81 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * @internal
+ * A simple Semaphore
+ */
+export class Semaphore {
+    /**
+     * The number of concurrent calls that can be made.
+     */
+    limit;
+    _queue = [];
+    _used = 0;
+    constructor(limit) {
+        if (typeof limit !== "number") {
+            throw new TypeError(`Expected limit to be a number, got ${typeof limit}`);
+        }
+        if (limit < 1) {
+            throw new Error("limit cannot be less than 1");
+        }
+        this.limit = limit;
+    }
+    /**
+     * Acquires a lock from the semaphore, returns a Promise that resolves when the caller holds
+     * a lock.
+     */
+    acquire() {
+        if (this._used < this.limit) {
+            this._used += 1;
+            return Promise.resolve();
+        }
+        return new Promise((resolve) => {
+            this._queue.push(resolve);
+        });
+    }
+    /**
+     * Releases a lock back to the semaphore.
+     */
+    release() {
+        if (this._queue.length) {
+            const item = this._queue.shift();
+            if (item) {
+                item();
+            }
+        }
+        else {
+            this._used -= 1;
+        }
+    }
+    /**
+     * Aquires a lock from the semaphore and then execute the fn. If the fn returns a Promise,
+     * wait for that promise to settle and then release the lock back to the semaphore.
+     * @param fn - The function that needs to be executed in the ciritical region.
+     * @returns A Promise that will settle with the return value of fn.
+     */
+    use(fn) {
+        return this.acquire()
+            .then(fn)
+            .then((val) => {
+            this.release();
+            return val;
+        })
+            .catch((err) => {
+            this.release();
+            throw err;
+        });
+    }
+    /**
+     * Provides the number of locks currently held.
+     */
+    currentLockCount() {
+        return this._used;
+    }
+    /**
+     * Provides the number of tasks waiting to acquire a lock.
+     */
+    awaitedTaskCount() {
+        return this._queue.length;
+    }
+}
+//# sourceMappingURL=semaphore.js.map

package/dist/esm/util/semaphore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semaphore.js","sourceRoot":"","sources":["../../../src/util/semaphore.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,OAAO,SAAS;IACpB;;OAEG;IACH,KAAK,CAAS;IACN,MAAM,GAA+D,EAAE,CAAC;IACxE,KAAK,GAAW,CAAC,CAAC;IAC1B,YAAY,KAAa;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,SAAS,CAAC,sCAAsC,OAAO,KAAK,EAAE,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;YAChB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,EAAE,CAAC;YACT,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAI,EAA4B;QACjC,OAAO,IAAI,CAAC,OAAO,EAAE;aAClB,IAAI,CAAC,EAAE,CAAC;aACR,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACZ,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * @internal\n * A simple Semaphore\n */\nexport class Semaphore {\n  /**\n   * The number of concurrent calls that can be made.\n   */\n  limit: number;\n  private _queue: ((value?: void | PromiseLike<void> | undefined) => void)[] = [];\n  private _used: number = 0;\n  constructor(limit: number) {\n    if (typeof limit !== \"number\") {\n      throw new TypeError(`Expected limit to be a number, got ${typeof limit}`);\n    }\n\n    if (limit < 1) {\n      throw new Error(\"limit cannot be less than 1\");\n    }\n    this.limit = limit;\n  }\n\n  /**\n   * Acquires a lock from the semaphore, returns a Promise that resolves when the caller holds\n   * a lock.\n   */\n  acquire(): Promise<void> {\n    if (this._used < this.limit) {\n      this._used += 1;\n      return Promise.resolve();\n    }\n\n    return new Promise((resolve) => {\n      this._queue.push(resolve);\n    });\n  }\n\n  /**\n   * Releases a lock back to the semaphore.\n   */\n  release(): void {\n    if (this._queue.length) {\n      const item = this._queue.shift();\n      if (item) {\n        item();\n      }\n    } else {\n      this._used -= 1;\n    }\n  }\n\n  /**\n   * Aquires a lock from the semaphore and then execute the fn. If the fn returns a Promise,\n   * wait for that promise to settle and then release the lock back to the semaphore.\n   * @param fn - The function that needs to be executed in the ciritical region.\n   * @returns A Promise that will settle with the return value of fn.\n   */\n  use<T>(fn: () => T | PromiseLike<T>): Promise<T> {\n    return this.acquire()\n      .then(fn)\n      .then((val) => {\n        this.release();\n        return val;\n      })\n      .catch((err) => {\n        this.release();\n        throw err;\n      });\n  }\n\n  /**\n   * Provides the number of locks currently held.\n   */\n  currentLockCount(): number {\n    return this._used;\n  }\n\n  /**\n   * Provides the number of tasks waiting to acquire a lock.\n   */\n  awaitedTaskCount(): number {\n    return this._queue.length;\n  }\n}\n"]}

package/dist/esm/util/typeGuards.d.ts

@@ -0,0 +1,8 @@
+import type { NamedKeyCredential, SASCredential, TokenCredential } from "@azure/core-auth";
+/**
+ * Typeguard that checks if the input is a credential type the clients accept.
+ * @param thing - Any object.
+ * @internal
+ */
+export declare function isCredential(thing: unknown): thing is TokenCredential | NamedKeyCredential | SASCredential;
+//# sourceMappingURL=typeGuards.d.ts.map

package/dist/esm/util/typeGuards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.d.ts","sourceRoot":"","sources":["../../../src/util/typeGuards.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAG3F;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,eAAe,GAAG,kBAAkB,GAAG,aAAa,CAE/D"}

package/dist/esm/util/typeGuards.js

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { isNamedKeyCredential, isSASCredential, isTokenCredential } from "@azure/core-auth";
+/**
+ * Typeguard that checks if the input is a credential type the clients accept.
+ * @param thing - Any object.
+ * @internal
+ */
+export function isCredential(thing) {
+    return isTokenCredential(thing) || isNamedKeyCredential(thing) || isSASCredential(thing);
+}
+//# sourceMappingURL=typeGuards.js.map

package/dist/esm/util/typeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../../src/util/typeGuards.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE5F;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAc;IAEd,OAAO,iBAAiB,CAAC,KAAK,CAAC,IAAI,oBAAoB,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;AAC3F,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { NamedKeyCredential, SASCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isNamedKeyCredential, isSASCredential, isTokenCredential } from \"@azure/core-auth\";\n\n/**\n * Typeguard that checks if the input is a credential type the clients accept.\n * @param thing - Any object.\n * @internal\n */\nexport function isCredential(\n  thing: unknown,\n): thing is TokenCredential | NamedKeyCredential | SASCredential {\n  return isTokenCredential(thing) || isNamedKeyCredential(thing) || isSASCredential(thing);\n}\n"]}