@azure/storage-queue 12.22.0-beta.1 → 12.22.0

package/dist/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var coreRestPipeline = require('@azure/core-rest-pipeline');
 var crypto = require('crypto');
 var coreUtil = require('@azure/core-util');
@@ -11,7 +13,6 @@ var coreAuth = require('@azure/core-auth');
 var logger$2 = require('@azure/logger');
 var abortController = require('@azure/abort-controller');
 var coreTracing = require('@azure/core-tracing');
-require('@azure/core-paging');
 
 function _interopNamespaceDefault(e) {
     var n = Object.create(null);
@@ -328,11 +329,62 @@ function ipRangeToString(ipRange) {
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION$1 = "12.22.0-beta.1";
-const SERVICE_VERSION = "2021-10-04";
+const SDK_VERSION = "12.22.0";
+const SERVICE_VERSION = "2024-05-04";
+/**
+ * The OAuth scope to use with Azure Storage.
+ */
+const StorageOAuthScopes = "https://storage.azure.com/.default";
 const DevelopmentConnectionString = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;
   AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;
   QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;`;
+const StorageQueueLoggingAllowedHeaderNames = [
+    "Access-Control-Allow-Origin",
+    "Cache-Control",
+    "Content-Length",
+    "Content-Type",
+    "Date",
+    "Request-Id",
+    "traceparent",
+    "Transfer-Encoding",
+    "User-Agent",
+    "x-ms-client-request-id",
+    "x-ms-date",
+    "x-ms-error-code",
+    "x-ms-request-id",
+    "x-ms-return-client-request-id",
+    "x-ms-version",
+    "x-ms-approximate-messages-count",
+    "x-ms-popreceipt",
+    "x-ms-time-next-visible",
+];
+const StorageQueueLoggingAllowedQueryParameters = [
+    "comp",
+    "maxresults",
+    "rscc",
+    "rscd",
+    "rsce",
+    "rscl",
+    "rsct",
+    "se",
+    "si",
+    "sip",
+    "sp",
+    "spr",
+    "sr",
+    "srt",
+    "ss",
+    "st",
+    "sv",
+    "include",
+    "marker",
+    "prefix",
+    "messagettl",
+    "numofmessages",
+    "peekonly",
+    "popreceipt",
+    "visibilitytimeout",
+];
 /// List of ports used for path style addressing.
 /// Path style addressing means that storage account is put in URI's Path segment in instead of in host.
 const PathStylePorts = [
@@ -728,7 +780,7 @@ function generateAccountSASQueryParameters(accountSASSignatureValues, sharedKeyC
             accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : "",
             accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : "",
             version,
-            "",
+            "", // Reserved for encryption scope
             "", // Account SAS requires an additional newline character
         ].join("\n");
     }
@@ -879,11 +931,6 @@ class AnonymousCredential extends Credential {
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "12.23.0-beta.1";
-/**
- * The OAuth scope to use with Azure Storage.
- */
-const StorageOAuthScopes = "https://storage.azure.com/.default";
 const URLConstants = {
     Parameters: {
         FORCE_BROWSER_NO_CACHE: "_",
@@ -918,137 +965,6 @@ const HeaderConstants = {
     X_MS_ERROR_CODE: "x-ms-error-code",
     X_MS_VERSION: "x-ms-version",
 };
-const StorageBlobLoggingAllowedHeaderNames = [
-    "Access-Control-Allow-Origin",
-    "Cache-Control",
-    "Content-Length",
-    "Content-Type",
-    "Date",
-    "Request-Id",
-    "traceparent",
-    "Transfer-Encoding",
-    "User-Agent",
-    "x-ms-client-request-id",
-    "x-ms-date",
-    "x-ms-error-code",
-    "x-ms-request-id",
-    "x-ms-return-client-request-id",
-    "x-ms-version",
-    "Accept-Ranges",
-    "Content-Disposition",
-    "Content-Encoding",
-    "Content-Language",
-    "Content-MD5",
-    "Content-Range",
-    "ETag",
-    "Last-Modified",
-    "Server",
-    "Vary",
-    "x-ms-content-crc64",
-    "x-ms-copy-action",
-    "x-ms-copy-completion-time",
-    "x-ms-copy-id",
-    "x-ms-copy-progress",
-    "x-ms-copy-status",
-    "x-ms-has-immutability-policy",
-    "x-ms-has-legal-hold",
-    "x-ms-lease-state",
-    "x-ms-lease-status",
-    "x-ms-range",
-    "x-ms-request-server-encrypted",
-    "x-ms-server-encrypted",
-    "x-ms-snapshot",
-    "x-ms-source-range",
-    "If-Match",
-    "If-Modified-Since",
-    "If-None-Match",
-    "If-Unmodified-Since",
-    "x-ms-access-tier",
-    "x-ms-access-tier-change-time",
-    "x-ms-access-tier-inferred",
-    "x-ms-account-kind",
-    "x-ms-archive-status",
-    "x-ms-blob-append-offset",
-    "x-ms-blob-cache-control",
-    "x-ms-blob-committed-block-count",
-    "x-ms-blob-condition-appendpos",
-    "x-ms-blob-condition-maxsize",
-    "x-ms-blob-content-disposition",
-    "x-ms-blob-content-encoding",
-    "x-ms-blob-content-language",
-    "x-ms-blob-content-length",
-    "x-ms-blob-content-md5",
-    "x-ms-blob-content-type",
-    "x-ms-blob-public-access",
-    "x-ms-blob-sequence-number",
-    "x-ms-blob-type",
-    "x-ms-copy-destination-snapshot",
-    "x-ms-creation-time",
-    "x-ms-default-encryption-scope",
-    "x-ms-delete-snapshots",
-    "x-ms-delete-type-permanent",
-    "x-ms-deny-encryption-scope-override",
-    "x-ms-encryption-algorithm",
-    "x-ms-if-sequence-number-eq",
-    "x-ms-if-sequence-number-le",
-    "x-ms-if-sequence-number-lt",
-    "x-ms-incremental-copy",
-    "x-ms-lease-action",
-    "x-ms-lease-break-period",
-    "x-ms-lease-duration",
-    "x-ms-lease-id",
-    "x-ms-lease-time",
-    "x-ms-page-write",
-    "x-ms-proposed-lease-id",
-    "x-ms-range-get-content-md5",
-    "x-ms-rehydrate-priority",
-    "x-ms-sequence-number-action",
-    "x-ms-sku-name",
-    "x-ms-source-content-md5",
-    "x-ms-source-if-match",
-    "x-ms-source-if-modified-since",
-    "x-ms-source-if-none-match",
-    "x-ms-source-if-unmodified-since",
-    "x-ms-tag-count",
-    "x-ms-encryption-key-sha256",
-    "x-ms-if-tags",
-    "x-ms-source-if-tags",
-];
-const StorageBlobLoggingAllowedQueryParameters = [
-    "comp",
-    "maxresults",
-    "rscc",
-    "rscd",
-    "rsce",
-    "rscl",
-    "rsct",
-    "se",
-    "si",
-    "sip",
-    "sp",
-    "spr",
-    "sr",
-    "srt",
-    "ss",
-    "st",
-    "sv",
-    "include",
-    "marker",
-    "prefix",
-    "copyid",
-    "restype",
-    "blockid",
-    "blocklisttype",
-    "delimiter",
-    "prevsnapshot",
-    "ske",
-    "skoid",
-    "sks",
-    "skt",
-    "sktid",
-    "skv",
-    "snapshot",
-];
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -1344,7 +1260,14 @@ class StorageSharedKeyCredential extends Credential {
 /**
  * The `@azure/logger` configuration for this package.
  */
-const logger$1 = logger$2.createClientLogger("storage-blob");
+const logger$1 = logger$2.createClientLogger("storage-queue");
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * The `@azure/logger` configuration for this package.
+ */
+const logger = logger$2.createClientLogger("storage-blob");
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -1442,7 +1365,7 @@ class StorageRetryPolicy extends BaseRequestPolicy {
         }
         let response;
         try {
-            logger$1.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
+            logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
             response = await this._nextPolicy.sendRequest(newRequest);
             if (!this.shouldRetry(isPrimaryRetry, attempt, response)) {
                 return response;
@@ -1450,7 +1373,7 @@ class StorageRetryPolicy extends BaseRequestPolicy {
             secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
         }
         catch (err) {
-            logger$1.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);
+            logger.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);
             if (!this.shouldRetry(isPrimaryRetry, attempt, response, err)) {
                 throw err;
             }
@@ -1468,7 +1391,7 @@ class StorageRetryPolicy extends BaseRequestPolicy {
      */
     shouldRetry(isPrimaryRetry, attempt, response, err) {
         if (attempt >= this.retryOptions.maxTries) {
-            logger$1.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions
+            logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions
                 .maxTries}, no further try.`);
             return false;
         }
@@ -1490,7 +1413,7 @@ class StorageRetryPolicy extends BaseRequestPolicy {
                 if (err.name.toUpperCase().includes(retriableError) ||
                     err.message.toUpperCase().includes(retriableError) ||
                     (err.code && err.code.toString().toUpperCase() === retriableError)) {
-                    logger$1.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
+                    logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
                     return true;
                 }
             }
@@ -1501,17 +1424,17 @@ class StorageRetryPolicy extends BaseRequestPolicy {
         if (response || err) {
             const statusCode = response ? response.status : err ? err.statusCode : 0;
             if (!isPrimaryRetry && statusCode === 404) {
-                logger$1.info(`RetryPolicy: Secondary access with 404, will retry.`);
+                logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
                 return true;
             }
             // Server internal error or server timeout
             if (statusCode === 503 || statusCode === 500) {
-                logger$1.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
+                logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
                 return true;
             }
         }
         if ((err === null || err === void 0 ? void 0 : err.code) === "PARSE_ERROR" && (err === null || err === void 0 ? void 0 : err.message.startsWith(`Error "Error: Unclosed root tag`))) {
-            logger$1.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
+            logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
             return true;
         }
         return false;
@@ -1538,7 +1461,7 @@ class StorageRetryPolicy extends BaseRequestPolicy {
         else {
             delayTimeInMs = Math.random() * 1000;
         }
-        logger$1.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
+        logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
         return delay(delayTimeInMs, abortSignal, RETRY_ABORT_ERROR$1);
     }
 }
@@ -1660,7 +1583,7 @@ function storageRetryPolicy(options = {}) {
     function shouldRetry({ isPrimaryRetry, attempt, response, error, }) {
         var _a, _b;
         if (attempt >= maxTries) {
-            logger$1.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${maxTries}, no further try.`);
+            logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${maxTries}, no further try.`);
             return false;
         }
         if (error) {
@@ -1668,13 +1591,13 @@ function storageRetryPolicy(options = {}) {
                 if (error.name.toUpperCase().includes(retriableError) ||
                     error.message.toUpperCase().includes(retriableError) ||
                     (error.code && error.code.toString().toUpperCase() === retriableError)) {
-                    logger$1.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
+                    logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
                     return true;
                 }
             }
             if ((error === null || error === void 0 ? void 0 : error.code) === "PARSE_ERROR" &&
                 (error === null || error === void 0 ? void 0 : error.message.startsWith(`Error "Error: Unclosed root tag`))) {
-                logger$1.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
+                logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
                 return true;
             }
         }
@@ -1684,12 +1607,12 @@ function storageRetryPolicy(options = {}) {
         if (response || error) {
             const statusCode = (_b = (_a = response === null || response === void 0 ? void 0 : response.status) !== null && _a !== void 0 ? _a : error === null || error === void 0 ? void 0 : error.statusCode) !== null && _b !== void 0 ? _b : 0;
             if (!isPrimaryRetry && statusCode === 404) {
-                logger$1.info(`RetryPolicy: Secondary access with 404, will retry.`);
+                logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
                 return true;
             }
             // Server internal error or server timeout
             if (statusCode === 503 || statusCode === 500) {
-                logger$1.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
+                logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
                 return true;
             }
         }
@@ -1710,7 +1633,7 @@ function storageRetryPolicy(options = {}) {
         else {
             delayTimeInMs = Math.random() * 1000;
         }
-        logger$1.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
+        logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
         return delayTimeInMs;
     }
     return {
@@ -1736,17 +1659,17 @@ function storageRetryPolicy(options = {}) {
                 response = undefined;
                 error = undefined;
                 try {
-                    logger$1.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
+                    logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
                     response = await next(request);
                     secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
                 }
                 catch (e) {
                     if (coreRestPipeline.isRestError(e)) {
-                        logger$1.error(`RetryPolicy: Caught error, message: ${e.message}, code: ${e.code}`);
+                        logger.error(`RetryPolicy: Caught error, message: ${e.message}, code: ${e.code}`);
                         error = e;
                     }
                     else {
-                        logger$1.error(`RetryPolicy: Caught error, message: ${coreUtil.getErrorMessage(e)}`);
+                        logger.error(`RetryPolicy: Caught error, message: ${coreUtil.getErrorMessage(e)}`);
                         throw e;
                     }
                 }
@@ -2055,8 +1978,8 @@ function getCoreClientOptions(pipeline) {
             ? `${restOptions.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
         corePipeline = coreClient.createClientPipeline(Object.assign(Object.assign({}, restOptions), { loggingOptions: {
-                additionalAllowedHeaderNames: StorageBlobLoggingAllowedHeaderNames,
-                additionalAllowedQueryParameters: StorageBlobLoggingAllowedQueryParameters,
+                additionalAllowedHeaderNames: StorageQueueLoggingAllowedHeaderNames,
+                additionalAllowedQueryParameters: StorageQueueLoggingAllowedQueryParameters,
                 logger: logger$1.info,
             }, userAgentOptions: {
                 userAgentPrefix,
@@ -2103,7 +2026,7 @@ function getCoreClientOptions(pipeline) {
         }
         pipeline._corePipeline = corePipeline;
     }
-    return Object.assign(Object.assign({}, restOptions), { httpClient, pipeline: corePipeline });
+    return Object.assign(Object.assign({}, restOptions), { allowInsecureConnection: true, httpClient, pipeline: corePipeline });
 }
 function getCredentialFromPipeline(pipeline) {
     // see if we squirreled one away on the type itself
@@ -2192,6 +2115,25 @@ function isCoreHttpPolicyFactory(factory) {
     });
 }
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Defines the known cloud audiences for Storage.
+ */
+exports.StorageQueueAudience = void 0;
+(function (StorageQueueAudience) {
+    /**
+     * The OAuth scope to use to retrieve an AAD token for Azure Storage.
+     */
+    StorageQueueAudience["StorageOAuthScopes"] = "https://storage.azure.com/.default";
+})(exports.StorageQueueAudience || (exports.StorageQueueAudience = {}));
+/**
+ * To get OAuth audience for a storage account for queue service.
+ */
+function getQueueServiceAccountAudience(storageAccountName) {
+    return `https://${storageAccountName}.queue.core.windows.net/.default`;
+}
+
 /*
  * Copyright (c) Microsoft Corporation.
  * Licensed under the MIT License.
@@ -4038,7 +3980,7 @@ const timeoutInSeconds = {
 const version = {
     parameterPath: "version",
     mapper: {
-        defaultValue: "2023-01-03",
+        defaultValue: "2024-05-04",
         isConstant: true,
         serializedName: "x-ms-version",
         type: {
@@ -4979,7 +4921,7 @@ let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.Exte
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-azure-storage-queue/12.22.0-beta.1`;
+        const packageDetails = `azsdk-js-azure-storage-queue/12.22.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -4990,7 +4932,7 @@ let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.Exte
         // Parameter assignments
         this.url = url;
         // Assigning values to Constant parameters
-        this.version = options.version || "2023-01-03";
+        this.version = options.version || "2024-05-04";
         this.service = new ServiceImpl(this);
         this.queue = new QueueImpl(this);
         this.messages = new MessagesImpl(this);
@@ -5061,7 +5003,7 @@ function getStorageClientContext(url, pipeline) {
  */
 const tracingClient = coreTracing.createTracingClient({
     packageName: "@azure/storage-queue",
-    packageVersion: SDK_VERSION$1,
+    packageVersion: SDK_VERSION,
     namespace: "Microsoft.Storage",
 });
 
@@ -5219,7 +5161,7 @@ class QueueClient extends StorageClient {
         options = options || {};
         let pipeline;
         let url;
-        if (credentialOrPipelineOrQueueName instanceof Pipeline) {
+        if (isPipelineLike(credentialOrPipelineOrQueueName)) {
             // (url: string, pipeline: Pipeline)
             url = urlOrConnectionString;
             pipeline = credentialOrPipelineOrQueueName;
@@ -5789,7 +5731,7 @@ class QueueServiceClient extends StorageClient {
     /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
     options) {
         let pipeline;
-        if (credentialOrPipeline instanceof Pipeline) {
+        if (isPipelineLike(credentialOrPipeline)) {
             pipeline = credentialOrPipeline;
         }
         else if ((coreUtil.isNode && credentialOrPipeline instanceof StorageSharedKeyCredential) ||
@@ -5854,8 +5796,8 @@ class QueueServiceClient extends StorageClient {
      *                        items. The marker value is opaque to the client.
      * @param options - Options to list queues operation.
      */
-    listSegments(marker, options = {}) {
-        return tslib.__asyncGenerator(this, arguments, function* listSegments_1() {
+    listSegments(marker_1) {
+        return tslib.__asyncGenerator(this, arguments, function* listSegments_1(marker, options = {}) {
             if (options.prefix === "") {
                 options.prefix = undefined;
             }
@@ -5872,8 +5814,8 @@ class QueueServiceClient extends StorageClient {
      *
      * @param options - Options to list queues operation.
      */
-    listItems(options = {}) {
-        return tslib.__asyncGenerator(this, arguments, function* listItems_1() {
+    listItems() {
+        return tslib.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
             var _a, e_1, _b, _c;
             if (options.prefix === "") {
                 options.prefix = undefined;
@@ -6099,14 +6041,7 @@ class QueueServiceClient extends StorageClient {
     }
 }
 
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The `@azure/logger` configuration for this package.
- */
-const logger = logger$2.createClientLogger("storage-queue");
-
-Object.defineProperty(exports, 'RestError', {
+Object.defineProperty(exports, "RestError", {
     enumerable: true,
     get: function () { return coreRestPipeline.RestError; }
 });
@@ -6132,7 +6067,8 @@ exports.StorageSharedKeyCredential = StorageSharedKeyCredential;
 exports.StorageSharedKeyCredentialPolicy = StorageSharedKeyCredentialPolicy;
 exports.generateAccountSASQueryParameters = generateAccountSASQueryParameters;
 exports.generateQueueSASQueryParameters = generateQueueSASQueryParameters;
+exports.getQueueServiceAccountAudience = getQueueServiceAccountAudience;
 exports.isPipelineLike = isPipelineLike;
-exports.logger = logger;
+exports.logger = logger$1;
 exports.newPipeline = newPipeline;
 //# sourceMappingURL=index.js.map