@azure/storage-queue 12.23.1-alpha.20240807.2 → 12.24.0-beta.1

package/dist/index.js

@@ -329,8 +329,8 @@ function ipRangeToString(ipRange) {
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "12.23.1";
-const SERVICE_VERSION = "2024-08-04";
+const SDK_VERSION = "12.24.0-beta.1";
+const SERVICE_VERSION = "2024-11-04";
 /**
  * The OAuth scope to use with Azure Storage.
  */
@@ -760,6 +760,10 @@ class SASQueryParameters {
  * @param sharedKeyCredential - Shared key credential.
  */
 function generateAccountSASQueryParameters(accountSASSignatureValues, sharedKeyCredential) {
+    return generateAccountSASQueryParametersInternal(accountSASSignatureValues, sharedKeyCredential)
+        .sasQueryParameters;
+}
+function generateAccountSASQueryParametersInternal(accountSASSignatureValues, sharedKeyCredential) {
     const version = accountSASSignatureValues.version
         ? accountSASSignatureValues.version
         : SERVICE_VERSION;
@@ -801,7 +805,10 @@ function generateAccountSASQueryParameters(accountSASSignatureValues, sharedKeyC
         ].join("\n");
     }
     const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
-    return new SASQueryParameters(version, signature, parsedPermissions, parsedServices, parsedResourceTypes, accountSASSignatureValues.protocol, accountSASSignatureValues.startsOn, accountSASSignatureValues.expiresOn, accountSASSignatureValues.ipRange);
+    return {
+        sasQueryParameters: new SASQueryParameters(version, signature, parsedPermissions, parsedServices, parsedResourceTypes, accountSASSignatureValues.protocol, accountSASSignatureValues.startsOn, accountSASSignatureValues.expiresOn, accountSASSignatureValues.ipRange),
+        stringToSign: stringToSign,
+    };
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -4118,7 +4125,7 @@ const timeoutInSeconds = {
 const version = {
     parameterPath: "version",
     mapper: {
-        defaultValue: "2024-08-04",
+        defaultValue: "2024-11-04",
         isConstant: true,
         serializedName: "x-ms-version",
         type: {
@@ -5059,7 +5066,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.23.0`;
+        const packageDetails = `azsdk-js-azure-storage-queue/12.24.0-beta.1`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -5070,7 +5077,7 @@ let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.Exte
         // Parameter assignments
         this.url = url;
         // Assigning values to Constant parameters
-        this.version = options.version || "2024-08-04";
+        this.version = options.version || "2024-11-04";
         this.service = new ServiceImpl(this);
         this.queue = new QueueImpl(this);
         this.messages = new MessagesImpl(this);
@@ -5245,6 +5252,10 @@ class QueueSASPermissions {
  * @param sharedKeyCredential -
  */
 function generateQueueSASQueryParameters(queueSASSignatureValues, sharedKeyCredential) {
+    return generateQueueSASQueryParametersInternal(queueSASSignatureValues, sharedKeyCredential)
+        .sasQueryParameters;
+}
+function generateQueueSASQueryParametersInternal(queueSASSignatureValues, sharedKeyCredential) {
     if (!queueSASSignatureValues.identifier &&
         !(queueSASSignatureValues.permissions && queueSASSignatureValues.expiresOn)) {
         throw new RangeError("Must provide 'permissions' and 'expiresOn' for Queue SAS generation when 'identifier' is not provided.");
@@ -5273,7 +5284,10 @@ function generateQueueSASQueryParameters(queueSASSignatureValues, sharedKeyCrede
         version,
     ].join("\n");
     const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
-    return new SASQueryParameters(version, signature, verifiedPermissions, undefined, undefined, queueSASSignatureValues.protocol, queueSASSignatureValues.startsOn, queueSASSignatureValues.expiresOn, queueSASSignatureValues.ipRange, queueSASSignatureValues.identifier);
+    return {
+        sasQueryParameters: new SASQueryParameters(version, signature, verifiedPermissions, undefined, undefined, queueSASSignatureValues.protocol, queueSASSignatureValues.startsOn, queueSASSignatureValues.expiresOn, queueSASSignatureValues.ipRange, queueSASSignatureValues.identifier),
+        stringToSign: stringToSign,
+    };
 }
 function getCanonicalName(accountName, queueName) {
     // Queue: "/queue/account/queueName"
@@ -5816,6 +5830,24 @@ class QueueClient extends StorageClient {
         const sas = generateQueueSASQueryParameters(Object.assign({ queueName: this.name }, options), this.credential).toString();
         return appendToURLQuery(this.url, sas);
     }
+    /**
+     * Only available for QueueClient constructed with a shared key credential.
+     *
+     * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     *
+     * @param options - Optional parameters.
+     * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+    generateSasStringToSign(options) {
+        if (!(this.credential instanceof StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+        }
+        return generateQueueSASQueryParametersInternal(Object.assign({ queueName: this.name }, options), this.credential).stringToSign;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -6177,6 +6209,32 @@ class QueueServiceClient extends StorageClient {
             resourceTypes, services: AccountSASServices.parse("q").toString() }, options), this.credential).toString();
         return appendToURLQuery(this.url, sas);
     }
+    /**
+     * Only available for QueueServiceClient constructed with a shared key credential.
+     *
+     * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     *
+     * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
+     * @param permissions - Specifies the list of permissions to be associated with the SAS.
+     * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+     * @param options - Optional parameters.
+     * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateSasStringToSign(expiresOn, permissions = AccountSASPermissions.parse("r"), resourceTypes = "sco", options = {}) {
+        if (!(this.credential instanceof StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+        }
+        if (expiresOn === undefined) {
+            const now = new Date();
+            expiresOn = new Date(now.getTime() + 3600 * 1000);
+        }
+        return generateAccountSASQueryParametersInternal(Object.assign({ permissions,
+            expiresOn,
+            resourceTypes, services: AccountSASServices.parse("q").toString() }, options), this.credential).stringToSign;
+    }
 }
 
 Object.defineProperty(exports, "RestError", {