@azure/storage-queue 12.26.0 → 12.27.0-alpha.20250520.6

package/README.md

@@ -114,14 +114,14 @@ Key data types in our library related to these services are:
 
 To use the clients, import the package into your file:
 
-```javascript
-const AzureStorageQueue = require("@azure/storage-queue");
+```ts snippet:ignore
+import * as AzureStorageQueue from "@azure/storage-queue";
 ```
 
 Alternatively, selectively import only the types you need:
 
-```javascript
-const { QueueServiceClient, StorageSharedKeyCredential } = require("@azure/storage-queue");
+```ts snippet:ignore
+import { QueueServiceClient, StorageSharedKeyCredential } from "@azure/storage-queue";
 ```
 
 ### Create the queue service client
@@ -149,9 +149,9 @@ Setup : Reference - Authorize access to blobs and queues with Azure Active Direc
   - From the overview page of your AAD Application, note down the `CLIENT ID` and `TENANT ID`. In the "Certificates & Secrets" tab, create a secret and note that down.
   - Make sure you have `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET` as environment variables to successfully execute the sample (can leverage process.env).
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential
+import { DefaultAzureCredential } from "@azure/identity";
+import { QueueServiceClient } from "@azure/storage-queue";
 
 const account = "<account>";
 const credential = new DefaultAzureCredential();
@@ -168,12 +168,12 @@ const queueServiceClient = new QueueServiceClient(
 
 Alternatively, you can instantiate a `QueueServiceClient` using the `fromConnectionString()` static method with the full connection string as the argument. (The connection string can be obtained from the azure portal.) [ONLY AVAILABLE IN NODE.JS RUNTIME]
 
-```javascript
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
+import { QueueServiceClient } from "@azure/storage-queue";
 
-const connStr = "<connection string>";
+const connectionString = "<connection string>";
 
-const queueServiceClient = QueueServiceClient.fromConnectionString(connStr);
+const queueServiceClient = QueueServiceClient.fromConnectionString(connectionString);
 ```
 
 #### with `StorageSharedKeyCredential`
@@ -181,8 +181,8 @@ const queueServiceClient = QueueServiceClient.fromConnectionString(connStr);
 Alternatively, you instantiate a `QueueServiceClient` with a `StorageSharedKeyCredential` by passing account-name and account-key as arguments. (The account-name and account-key can be obtained from the azure portal.)
 [ONLY AVAILABLE IN NODE.JS RUNTIME]
 
-```javascript
-const { QueueServiceClient, StorageSharedKeyCredential } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential
+import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";
 
 // Enter your storage account name and shared key
 const account = "<account>";
@@ -197,7 +197,9 @@ const queueServiceClient = new QueueServiceClient(
   sharedKeyCredential,
   {
     retryOptions: { maxTries: 4 }, // Retry options
-    telemetry: { value: "BasicSample/V11.0.0" }, // Customized telemetry string
+    userAgentOptions: {
+      userAgentPrefix: "BasicSample V10.0.0",
+    }, // Customized telemetry string
   },
 );
 ```
@@ -206,11 +208,14 @@ const queueServiceClient = new QueueServiceClient(
 
 Also, You can instantiate a `QueueServiceClient` with a shared access signatures (SAS). You can get the SAS token from the Azure Portal or generate one using `generateAccountSASQueryParameters()`.
 
-```javascript
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleCreateClient_SASToken
+import { QueueServiceClient } from "@azure/storage-queue";
+
 const account = "<account name>";
 const sas = "<service Shared Access Signature Token>";
-const queueServiceClient = new QueueServiceClient(`https://${account}.queue.core.windows.net?${sas}`);
+const queueServiceClient = new QueueServiceClient(
+  `https://${account}.queue.core.windows.net?${sas}`,
+);
 ```
 
 ### List queues in this account
@@ -218,55 +223,41 @@ const queueServiceClient = new QueueServiceClient(`https://${account}.queue.core
 Use `QueueServiceClient.listQueues()` function to iterate the queues,
 with the new `for-await-of` syntax:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleListQueues
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  const iter1 = queueServiceClient.listQueues();
-  let i = 1;
-  for await (const item of iter1) {
-    console.log(`Queue${i}: ${item.name}`);
-    i++;
-  }
+let i = 1;
+for await (const item of queueServiceClient.listQueues()) {
+  console.log(`Queue${i++}: ${item.name}`);
 }
-
-main();
 ```
 
 Alternatively without `for-await-of`:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleListQueues_Iterator
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  const iter2 = queueServiceClient.listQueues();
-  let i = 1;
-  let item = await iter2.next();
-  while (!item.done) {
-    console.log(`Queue ${i++}: ${item.value.name}`);
-    item = await iter2.next();
-  }
+let i = 1;
+const iterator = queueServiceClient.listQueues();
+let { done, value } = await iterator.next();
+while (!done) {
+  console.log(`Queue${i++}: ${value.name}`);
+  ({ done, value } = await iterator.next());
 }
-
-main();
 ```
 
 For a complete sample on iterating queues please see [samples/v12/typescript/listQueues.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-queue/samples/v12/typescript/src/listQueues.ts).
@@ -275,59 +266,45 @@ For a complete sample on iterating queues please see [samples/v12/typescript/lis
 
 Use `QueueServiceClient.getQueueClient()` function to create a new queue.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleCreateQueue
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
 const queueName = "<valid queue name>";
-
-async function main() {
-  const queueClient = queueServiceClient.getQueueClient(queueName);
-  const createQueueResponse = await queueClient.create();
-  console.log(
-    `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
-  );
-}
-
-main();
+const queueClient = queueServiceClient.getQueueClient(queueName);
+const createQueueResponse = await queueClient.create();
+console.log(
+  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
+);
 ```
 
 ### Send a message to the queue
 
 Use `sendMessage()` to add a message to the queue:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleSendMessage
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
 const queueName = "<valid queue name>";
-
-async function main() {
-  const queueClient = queueServiceClient.getQueueClient(queueName);
-  // Send a message into the queue using the sendMessage method.
-  const sendMessageResponse = await queueClient.sendMessage("Hello World!");
-  console.log(
-    `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
-  );
-}
-
-main();
+const queueClient = queueServiceClient.getQueueClient(queueName);
+// Send a message into the queue using the sendMessage method.
+const sendMessageResponse = await queueClient.sendMessage("Hello World!");
+console.log(
+  `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
+);
 ```
 
 ### Peek a message
@@ -335,27 +312,20 @@ main();
 `QueueClient.peekMessages()` allows looking at one or more messages in front of the queue. This call
 doesn't prevent other code from accessing peeked messages.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSamplePeekMessage
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
 const queueName = "<valid queue name>";
-
-async function main() {
-  const queueClient = queueServiceClient.getQueueClient(queueName);
-  const peekMessagesResponse = await queueClient.peekMessages();
-  console.log(`The peeked message is: ${peekMessagesResponse.peekedMessageItems[0].messageText}`);
-}
-
-main();
+const queueClient = queueServiceClient.getQueueClient(queueName);
+const peekMessagesResponse = await queueClient.peekMessages();
+console.log(`The peeked message is: ${peekMessagesResponse.peekedMessageItems[0].messageText}`);
 ```
 
 ### Processing a message
@@ -367,64 +337,50 @@ Messages are processed in two steps.
 
 If your code fails to process a message due to hardware or software failure, this two-step process ensures that another instance of your code can get the same message and try again.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleReceiveMessage
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
 const queueName = "<valid queue name>";
-
-async function main() {
-  const queueClient = queueServiceClient.getQueueClient(queueName);
-  const response = await queueClient.receiveMessages();
-  if (response.receivedMessageItems.length === 1) {
-    const receivedMessageItem = response.receivedMessageItems[0];
-    console.log(`Processing & deleting message with content: ${receivedMessageItem.messageText}`);
-    const deleteMessageResponse = await queueClient.deleteMessage(
-      receivedMessageItem.messageId,
-      receivedMessageItem.popReceipt,
-    );
-    console.log(
-      `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`,
-    );
-  }
+const queueClient = queueServiceClient.getQueueClient(queueName);
+const response = await queueClient.receiveMessages();
+if (response.receivedMessageItems.length === 1) {
+  const receivedMessageItem = response.receivedMessageItems[0];
+  console.log(`Processing & deleting message with content: ${receivedMessageItem.messageText}`);
+  const deleteMessageResponse = await queueClient.deleteMessage(
+    receivedMessageItem.messageId,
+    receivedMessageItem.popReceipt,
+  );
+  console.log(
+    `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`,
+  );
 }
-
-main();
 ```
 
 ### Delete a queue
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { QueueServiceClient } = require("@azure/storage-queue");
+```ts snippet:ReadmeSampleDeleteQueue
+import { QueueServiceClient } from "@azure/storage-queue";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const credential = new DefaultAzureCredential();
-
 const queueServiceClient = new QueueServiceClient(
   `https://${account}.queue.core.windows.net`,
-  credential,
+  new DefaultAzureCredential(),
 );
 
 const queueName = "<valid queue name>";
-
-async function main() {
-  const queueClient = queueServiceClient.getQueueClient(queueName);
-  const deleteQueueResponse = await queueClient.delete();
-  console.log(
-    `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
-  );
-}
-
-main();
+const queueClient = queueServiceClient.getQueueClient(queueName);
+const deleteQueueResponse = await queueClient.delete();
+console.log(
+  `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
+);
 ```
 
 A complete example of simple `QueueServiceClient` scenarios is at [samples/v12/typescript/src/queueClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-queue/samples/v12/typescript/src/queueClient.ts).
@@ -433,8 +389,8 @@ A complete example of simple `QueueServiceClient` scenarios is at [samples/v12/t
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/dist/browser/AccountSASPermissions.d.ts

@@ -0,0 +1,61 @@
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the
+ * values are set, this should be serialized with toString and set as the permissions field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
+ */
+export declare class AccountSASPermissions {
+    /**
+     * Parse initializes the AccountSASPermissions fields from a string.
+     *
+     * @param permissions -
+     */
+    static parse(permissions: string): AccountSASPermissions;
+    /**
+     * Permission to read resources granted.
+     */
+    read: boolean;
+    /**
+     * Permission to write resources granted.
+     */
+    write: boolean;
+    /**
+     * Permission to delete queues and messages granted.
+     */
+    delete: boolean;
+    /**
+     * Permission to list queues granted.
+     */
+    list: boolean;
+    /**
+     * Permission to add messages, table entities, and append to blobs granted.
+     */
+    add: boolean;
+    /**
+     * Permission to create queues, blobs and files granted.
+     */
+    create: boolean;
+    /**
+     * Permissions to update messages and table entities granted.
+     */
+    update: boolean;
+    /**
+     * Permission to get and delete messages granted.
+     */
+    process: boolean;
+    /**
+     * Produces the SAS permissions string for an Azure Storage account.
+     * Call this method to set AccountSASSignatureValues Permissions field.
+     *
+     * Using this method will guarantee the resource types are in
+     * an order accepted by the service.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+     *
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AccountSASPermissions.d.ts.map

package/dist/browser/AccountSASPermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASPermissions.d.ts","sourceRoot":"","sources":["../../src/AccountSASPermissions.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,qBAAa,qBAAqB;IAChC;;;;OAIG;WACW,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,qBAAqB;IAqC/D;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,KAAK,EAAE,OAAO,CAAS;IAE9B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,GAAG,EAAE,OAAO,CAAS;IAE5B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,OAAO,EAAE,OAAO,CAAS;IAEhC;;;;;;;;;OASG;IACI,QAAQ,IAAI,MAAM;CA+B1B"}

package/dist/browser/AccountSASPermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASPermissions.js","sourceRoot":"","sources":["../../src/AccountSASPermissions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,qBAAqB;IAAlC;QA2CE;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;QAE9B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,QAAG,GAAY,KAAK,CAAC;QAE5B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;IA2ClC,CAAC;IA3HC;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAE1D,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,KAAK,GAAG,IAAI,CAAC;oBACnC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,GAAG,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACrC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IA0CD;;;;;;;;;OASG;IACI,QAAQ;QACb,iFAAiF;QACjF,yFAAyF;QACzF,iFAAiF;QACjF,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the\n * values are set, this should be serialized with toString and set as the permissions field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but\n * the order of the permissions is particular and this class guarantees correctness.\n */\nexport class AccountSASPermissions {\n  /**\n   * Parse initializes the AccountSASPermissions fields from a string.\n   *\n   * @param permissions -\n   */\n  public static parse(permissions: string): AccountSASPermissions {\n    const accountSASPermissions = new AccountSASPermissions();\n\n    for (const c of permissions) {\n      switch (c) {\n        case \"r\":\n          accountSASPermissions.read = true;\n          break;\n        case \"w\":\n          accountSASPermissions.write = true;\n          break;\n        case \"d\":\n          accountSASPermissions.delete = true;\n          break;\n        case \"l\":\n          accountSASPermissions.list = true;\n          break;\n        case \"a\":\n          accountSASPermissions.add = true;\n          break;\n        case \"c\":\n          accountSASPermissions.create = true;\n          break;\n        case \"u\":\n          accountSASPermissions.update = true;\n          break;\n        case \"p\":\n          accountSASPermissions.process = true;\n          break;\n        default:\n          throw new RangeError(`Invalid permission character: ${c}`);\n      }\n    }\n\n    return accountSASPermissions;\n  }\n\n  /**\n   * Permission to read resources granted.\n   */\n  public read: boolean = false;\n\n  /**\n   * Permission to write resources granted.\n   */\n  public write: boolean = false;\n\n  /**\n   * Permission to delete queues and messages granted.\n   */\n  public delete: boolean = false;\n\n  /**\n   * Permission to list queues granted.\n   */\n  public list: boolean = false;\n\n  /**\n   * Permission to add messages, table entities, and append to blobs granted.\n   */\n  public add: boolean = false;\n\n  /**\n   * Permission to create queues, blobs and files granted.\n   */\n  public create: boolean = false;\n\n  /**\n   * Permissions to update messages and table entities granted.\n   */\n  public update: boolean = false;\n\n  /**\n   * Permission to get and delete messages granted.\n   */\n  public process: boolean = false;\n\n  /**\n   * Produces the SAS permissions string for an Azure Storage account.\n   * Call this method to set AccountSASSignatureValues Permissions field.\n   *\n   * Using this method will guarantee the resource types are in\n   * an order accepted by the service.\n   *\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas\n   *\n   */\n  public toString(): string {\n    // The order of the characters should be as specified here to ensure correctness:\n    // https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas\n    // Use a string array instead of string concatenating += operator for performance\n    const permissions: string[] = [];\n    if (this.read) {\n      permissions.push(\"r\");\n    }\n    if (this.write) {\n      permissions.push(\"w\");\n    }\n    if (this.delete) {\n      permissions.push(\"d\");\n    }\n    if (this.list) {\n      permissions.push(\"l\");\n    }\n    if (this.add) {\n      permissions.push(\"a\");\n    }\n    if (this.create) {\n      permissions.push(\"c\");\n    }\n    if (this.update) {\n      permissions.push(\"u\");\n    }\n    if (this.process) {\n      permissions.push(\"p\");\n    }\n    return permissions.join(\"\");\n  }\n}\n"]}

package/dist/browser/AccountSASResourceTypes.d.ts

@@ -0,0 +1,38 @@
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the
+ * values are set, this should be serialized with toString and set as the resources field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but
+ * the order of the resources is particular and this class guarantees correctness.
+ */
+export declare class AccountSASResourceTypes {
+    /**
+     * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an
+     * Error if it encounters a character that does not correspond to a valid resource type.
+     *
+     * @param resourceTypes -
+     */
+    static parse(resourceTypes: string): AccountSASResourceTypes;
+    /**
+     * Permission to access service level APIs granted.
+     */
+    service: boolean;
+    /**
+     * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
+     */
+    container: boolean;
+    /**
+     * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
+     */
+    object: boolean;
+    /**
+     * Converts the given resource types to a string.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+     *
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AccountSASResourceTypes.d.ts.map

package/dist/browser/AccountSASResourceTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASResourceTypes.d.ts","sourceRoot":"","sources":["../../src/AccountSASResourceTypes.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,qBAAa,uBAAuB;IAClC;;;;;OAKG;WACW,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,uBAAuB;IAsBnE;;OAEG;IACI,OAAO,EAAE,OAAO,CAAS;IAEhC;;OAEG;IACI,SAAS,EAAE,OAAO,CAAS;IAElC;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;;;;OAKG;IACI,QAAQ,IAAI,MAAM;CAa1B"}

package/dist/browser/AccountSASResourceTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASResourceTypes.js","sourceRoot":"","sources":["../../src/AccountSASResourceTypes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,uBAAuB;IAApC;QA6BE;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;QAEhC;;WAEG;QACI,cAAS,GAAY,KAAK,CAAC;QAElC;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;IAqBjC,CAAC;IA9DC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAqB;QACvC,MAAM,uBAAuB,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAE9D,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;YAC9B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,uBAAuB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACvC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;oBACzC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACtC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAiBD;;;;;OAKG;IACI,QAAQ;QACb,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the\n * values are set, this should be serialized with toString and set as the resources field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but\n * the order of the resources is particular and this class guarantees correctness.\n */\nexport class AccountSASResourceTypes {\n  /**\n   * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an\n   * Error if it encounters a character that does not correspond to a valid resource type.\n   *\n   * @param resourceTypes -\n   */\n  public static parse(resourceTypes: string): AccountSASResourceTypes {\n    const accountSASResourceTypes = new AccountSASResourceTypes();\n\n    for (const c of resourceTypes) {\n      switch (c) {\n        case \"s\":\n          accountSASResourceTypes.service = true;\n          break;\n        case \"c\":\n          accountSASResourceTypes.container = true;\n          break;\n        case \"o\":\n          accountSASResourceTypes.object = true;\n          break;\n        default:\n          throw new RangeError(`Invalid resource type: ${c}`);\n      }\n    }\n\n    return accountSASResourceTypes;\n  }\n\n  /**\n   * Permission to access service level APIs granted.\n   */\n  public service: boolean = false;\n\n  /**\n   * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.\n   */\n  public container: boolean = false;\n\n  /**\n   * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.\n   */\n  public object: boolean = false;\n\n  /**\n   * Converts the given resource types to a string.\n   *\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas\n   *\n   */\n  public toString(): string {\n    const resourceTypes: string[] = [];\n    if (this.service) {\n      resourceTypes.push(\"s\");\n    }\n    if (this.container) {\n      resourceTypes.push(\"c\");\n    }\n    if (this.object) {\n      resourceTypes.push(\"o\");\n    }\n    return resourceTypes.join(\"\");\n  }\n}\n"]}

package/dist/browser/AccountSASServices.d.ts

@@ -0,0 +1,40 @@
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant access to that service. Once all the
+ * values are set, this should be serialized with toString and set as the services field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but
+ * the order of the services is particular and this class guarantees correctness.
+ */
+export declare class AccountSASServices {
+    /**
+     * Creates an {@link AccountSASServices} from the specified services string. This method will throw an
+     * Error if it encounters a character that does not correspond to a valid service.
+     *
+     * @param services -
+     */
+    static parse(services: string): AccountSASServices;
+    /**
+     * Permission to access blob resources granted.
+     */
+    blob: boolean;
+    /**
+     * Permission to access file resources granted.
+     */
+    file: boolean;
+    /**
+     * Permission to access queue resources granted.
+     */
+    queue: boolean;
+    /**
+     * Permission to access table resources granted.
+     */
+    table: boolean;
+    /**
+     * Converts the given services to a string.
+     *
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AccountSASServices.d.ts.map

package/dist/browser/AccountSASServices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASServices.d.ts","sourceRoot":"","sources":["../../src/AccountSASServices.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B;;;;;OAKG;WACW,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB;IAyBzD;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,KAAK,EAAE,OAAO,CAAS;IAE9B;;OAEG;IACI,KAAK,EAAE,OAAO,CAAS;IAE9B;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAgB1B"}

package/dist/browser/AccountSASServices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASServices.js","sourceRoot":"","sources":["../../src/AccountSASServices.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAA/B;QAgCE;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;QAE9B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;IAsBhC,CAAC;IAvEC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,QAAgB;QAClC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAEpD,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAC/B,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAC/B,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;oBAChC,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;oBAChC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAsBD;;;OAGG;IACI,QAAQ;QACb,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant access to that service. Once all the\n * values are set, this should be serialized with toString and set as the services field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but\n * the order of the services is particular and this class guarantees correctness.\n */\nexport class AccountSASServices {\n  /**\n   * Creates an {@link AccountSASServices} from the specified services string. This method will throw an\n   * Error if it encounters a character that does not correspond to a valid service.\n   *\n   * @param services -\n   */\n  public static parse(services: string): AccountSASServices {\n    const accountSASServices = new AccountSASServices();\n\n    for (const c of services) {\n      switch (c) {\n        case \"b\":\n          accountSASServices.blob = true;\n          break;\n        case \"f\":\n          accountSASServices.file = true;\n          break;\n        case \"q\":\n          accountSASServices.queue = true;\n          break;\n        case \"t\":\n          accountSASServices.table = true;\n          break;\n        default:\n          throw new RangeError(`Invalid service character: ${c}`);\n      }\n    }\n\n    return accountSASServices;\n  }\n\n  /**\n   * Permission to access blob resources granted.\n   */\n  public blob: boolean = false;\n\n  /**\n   * Permission to access file resources granted.\n   */\n  public file: boolean = false;\n\n  /**\n   * Permission to access queue resources granted.\n   */\n  public queue: boolean = false;\n\n  /**\n   * Permission to access table resources granted.\n   */\n  public table: boolean = false;\n\n  /**\n   * Converts the given services to a string.\n   *\n   */\n  public toString(): string {\n    const services: string[] = [];\n    if (this.blob) {\n      services.push(\"b\");\n    }\n    if (this.table) {\n      services.push(\"t\");\n    }\n    if (this.queue) {\n      services.push(\"q\");\n    }\n    if (this.file) {\n      services.push(\"f\");\n    }\n    return services.join(\"\");\n  }\n}\n"]}

package/dist/browser/AccountSASSignatureValues.d.ts

@@ -0,0 +1,74 @@
+import { AccountSASPermissions } from "./AccountSASPermissions.js";
+import type { StorageSharedKeyCredential } from "@azure/storage-blob";
+import type { SasIPRange } from "./SasIPRange.js";
+import type { SASProtocol } from "./SASQueryParameters.js";
+import { SASQueryParameters } from "./SASQueryParameters.js";
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once
+ * all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS
+ * which can actually be applied to queue urls. Note: that both this class and {@link SASQueryParameters} exist because
+ * the former is mutable and a logical representation while the latter is immutable and used to generate actual REST
+ * requests.
+ *
+ * @see https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
+ * for more conceptual information on SAS
+ *
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ * for descriptions of the parameters, including which are required
+ */
+export interface AccountSASSignatureValues {
+    /**
+     * If not provided, this defaults to the service version targeted by this version of the library.
+     */
+    version?: string;
+    /**
+     * Optional. SAS protocols allowed.
+     */
+    protocol?: SASProtocol;
+    /**
+     * Optional. When the SAS will take effect.
+     */
+    startsOn?: Date;
+    /**
+     * The time after which the SAS will no longer work.
+     */
+    expiresOn: Date;
+    /**
+     * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help
+     * constructing the permissions string.
+     */
+    permissions: AccountSASPermissions;
+    /**
+     * Optional. IP range allowed.
+     */
+    ipRange?: SasIPRange;
+    /**
+     * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to
+     * construct this value.
+     */
+    services: string;
+    /**
+     * The values that indicate the resource types accessible with this SAS. Please refer
+     * to {@link AccountSASResourceTypes} to construct this value.
+     */
+    resourceTypes: string;
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
+ * REST request.
+ *
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ *
+ * @param accountSASSignatureValues - SAS Signature values of the account
+ * @param sharedKeyCredential - Shared key credential.
+ */
+export declare function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters;
+export declare function generateAccountSASQueryParametersInternal(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): {
+    sasQueryParameters: SASQueryParameters;
+    stringToSign: string;
+};
+//# sourceMappingURL=AccountSASSignatureValues.d.ts.map

package/dist/browser/AccountSASSignatureValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSASSignatureValues.d.ts","sourceRoot":"","sources":["../../src/AccountSASSignatureValues.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGnE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAI7D;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAEhB;;;OAGG;IACH,WAAW,EAAE,qBAAqB,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iCAAiC,CAC/C,yBAAyB,EAAE,yBAAyB,EACpD,mBAAmB,EAAE,0BAA0B,GAC9C,kBAAkB,CAGpB;AAED,wBAAgB,yCAAyC,CACvD,yBAAyB,EAAE,yBAAyB,EACpD,mBAAmB,EAAE,0BAA0B,GAC9C;IAAE,kBAAkB,EAAE,kBAAkB,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAgElE"}