@azure/storage-file-share 12.27.0 → 12.28.0-beta.1

package/README.md

@@ -133,14 +133,14 @@ The following components and their corresponding client libraries make up the Az
 
 To use the clients, import the package into your file:
 
-```javascript
-const AzureStorageFileShare = require("@azure/storage-file-share");
+```ts snippet:ignore
+import * as AzureStorageFileShare from "@azure/storage-file-share";
 ```
 
 Alternative, selectively import only the types you need:
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ignore
+import { ShareServiceClient, StorageSharedKeyCredential } from "@azure/storage-file-share";
 ```
 
 ### Create the share service client
@@ -151,20 +151,20 @@ The `ShareServiceClient` requires an URL to the file share service and an access
 
 Alternatively, you can instantiate a `ShareServiceClient` using the `fromConnectionString()` static method with the full connection string as the argument. (The connection string can be obtained from the azure portal.)
 
-```javascript
-const { ShareServiceClient } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
+import { ShareServiceClient } from "@azure/storage-file-share";
 
-const connStr = "<connection string>";
+const connectionString = "<connection string>";
 
-const shareServiceClient = ShareServiceClient.fromConnectionString(connStr);
+const shareServiceClient = ShareServiceClient.fromConnectionString(connectionString);
 ```
 
 #### with `StorageSharedKeyCredential`
 
 Pass in a `StorageSharedKeyCredential` with your account name and account key. (The account-name and account-key can be obtained from the azure portal.)
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 // Enter your storage account name and shared key
 const account = "<account>";
@@ -184,13 +184,15 @@ const serviceClient = new ShareServiceClient(
 
 Also, You can instantiate a `ShareServiceClient` with a shared access signatures (SAS). You can get the SAS token from the Azure Portal or generate one using `generateAccountSASQueryParameters()`.
 
-```javascript
-const { ShareServiceClient } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleCreateClient_SASToken
+import { ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account name>";
 const sas = "<service Shared Access Signature Token>";
 
-const serviceClientWithSAS = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);
+const serviceClientWithSAS = new ShareServiceClient(
+  `https://${account}.file.core.windows.net?${sas}`,
+);
 ```
 
 ### List shares in the account
@@ -198,8 +200,8 @@ const serviceClientWithSAS = new ShareServiceClient(`https://${account}.file.cor
 Use `ShareServiceClient.listShares()` to iterator shares in this account,
 with the new `for-await-of` syntax:
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleListShares
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -210,22 +212,16 @@ const serviceClient = new ShareServiceClient(
   credential,
 );
 
-async function main() {
-  const shareIter = serviceClient.listShares();
-  let i = 1;
-  for await (const share of shareIter) {
-    console.log(`Share${i}: ${share.name}`);
-    i++;
-  }
+let i = 1;
+for await (const share of serviceClient.listShares()) {
+  console.log(`Share${i++}: ${share.name}`);
 }
-
-main();
 ```
 
 Alternatively without `for-await-of`:
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleListShares_Iterator
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -236,23 +232,19 @@ const serviceClient = new ShareServiceClient(
   credential,
 );
 
-async function main() {
-  const shareIter = serviceClient.listShares();
-  let i = 1;
-  let shareItem = await shareIter.next();
-  while (!shareItem.done) {
-    console.log(`Share ${i++}: ${shareItem.value.name}`);
-    shareItem = await shareIter.next();
-  }
+const shareIter = serviceClient.listShares();
+let i = 1;
+let { value, done } = await shareIter.next();
+while (!done) {
+  console.log(`Share ${i++}: ${value.name}`);
+  ({ value, done } = await shareIter.next());
 }
-
-main();
 ```
 
 ### Create a new share and a directory
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleCreateShareAndDirectory
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -263,25 +255,21 @@ const serviceClient = new ShareServiceClient(
   credential,
 );
 
-async function main() {
-  const shareName = `newshare${new Date().getTime()}`;
-  const shareClient = serviceClient.getShareClient(shareName);
-  await shareClient.create();
-  console.log(`Create share ${shareName} successfully`);
-
-  const directoryName = `newdirectory${new Date().getTime()}`;
-  const directoryClient = shareClient.getDirectoryClient(directoryName);
-  await directoryClient.create();
-  console.log(`Create directory ${directoryName} successfully`);
-}
+const shareName = `newshare${+new Date()}`;
+const shareClient = serviceClient.getShareClient(shareName);
+await shareClient.create();
+console.log(`Create share ${shareName} successfully`);
 
-main();
+const directoryName = `newdirectory${+new Date()}`;
+const directoryClient = shareClient.getDirectoryClient(directoryName);
+await directoryClient.create();
+console.log(`Create directory ${directoryName} successfully`);
 ```
 
 ### Create an azure file then upload to it
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleCreateFileAndUpload
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -294,22 +282,17 @@ const serviceClient = new ShareServiceClient(
 
 const shareName = "<share name>";
 const directoryName = "<directory name>";
+const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
 
-async function main() {
-  const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
+const content = "Hello World!";
+const fileName = `newdirectory${+new Date()}`;
+const fileClient = directoryClient.getFileClient(fileName);
+await fileClient.create(content.length);
+console.log(`Create file ${fileName} successfully`);
 
-  const content = "Hello World!";
-  const fileName = "newfile" + new Date().getTime();
-  const fileClient = directoryClient.getFileClient(fileName);
-  await fileClient.create(content.length);
-  console.log(`Create file ${fileName} successfully`);
-
-  // Upload file range
-  await fileClient.uploadRange(content, 0, content.length);
-  console.log(`Upload file range "${content}" to ${fileName} successfully`);
-}
-
-main();
+// Upload file range
+await fileClient.uploadRange(content, 0, content.length);
+console.log(`Upload file range "${content}" to ${fileName} successfully`);
 ```
 
 ### List files and directories under a directory
@@ -318,8 +301,8 @@ Use `DirectoryClient.listFilesAndDirectories()` to iterator over files and direc
 with the new `for-await-of` syntax. The `kind` property can be used to identify whether
 a iterm is a directory or a file.
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleListFilesAndDirectories
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -332,29 +315,23 @@ const serviceClient = new ShareServiceClient(
 
 const shareName = "<share name>";
 const directoryName = "<directory name>";
-
-async function main() {
-  const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
-
-  const dirIter = directoryClient.listFilesAndDirectories();
-  let i = 1;
-  for await (const item of dirIter) {
-    if (item.kind === "directory") {
-      console.log(`${i} - directory\t: ${item.name}`);
-    } else {
-      console.log(`${i} - file\t: ${item.name}`);
-    }
-    i++;
+const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
+
+let i = 1;
+for await (const item of directoryClient.listFilesAndDirectories()) {
+  if (item.kind === "directory") {
+    console.log(`${i} - directory\t: ${item.name}`);
+  } else {
+    console.log(`${i} - file\t: ${item.name}`);
   }
+  i++;
 }
-
-main();
 ```
 
 Alternatively without using `for-await-of`:
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleListFilesAndDirectories_Iterator
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -367,33 +344,28 @@ const serviceClient = new ShareServiceClient(
 
 const shareName = "<share name>";
 const directoryName = "<directory name>";
-
-async function main() {
-  const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
-
-  const dirIter = directoryClient.listFilesAndDirectories();
-  let i = 1;
-  let item = await dirIter.next();
-  while (!item.done) {
-    if (item.value.kind === "directory") {
-      console.log(`${i} - directory\t: ${item.value.name}`);
-    } else {
-      console.log(`${i} - file\t: ${item.value.name}`);
-    }
-    i++;
-    item = await dirIter.next();
+const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
+
+let i = 1;
+const iter = directoryClient.listFilesAndDirectories();
+let { value, done } = await iter.next();
+while (!done) {
+  if (value.kind === "directory") {
+    console.log(`${i} - directory\t: ${value.name}`);
+  } else {
+    console.log(`${i} - file\t: ${value.name}`);
   }
+  ({ value, done } = await iter.next());
+  i++;
 }
-
-main();
 ```
 
 For a complete sample on iterating please see [samples/v12/typescript/src/listFilesAndDirectories.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-file-share/samples/v12/typescript/src/listFilesAndDirectories.ts).
 
 ### Download a file and convert it to a string (Node.js)
 
-```javascript
-const { ShareServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleDownloadFileAndConvertToString_Node
+import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account>";
 const accountKey = "<accountkey>";
@@ -406,13 +378,24 @@ const serviceClient = new ShareServiceClient(
 
 const shareName = "<share name>";
 const fileName = "<file name>";
+const fileClient = serviceClient
+  .getShareClient(shareName)
+  .rootDirectoryClient.getFileClient(fileName);
+
+// Get file content from position 0 to the end
+// In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
+const downloadFileResponse = await fileClient.download();
+if (downloadFileResponse.readableStreamBody) {
+  const buffer = await streamToBuffer(downloadFileResponse.readableStreamBody);
+  console.log(`Downloaded file content: ${buffer.toString()}`);
+}
 
 // [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
-async function streamToBuffer(readableStream) {
+async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
   return new Promise((resolve, reject) => {
-    const chunks = [];
+    const chunks: Buffer[] = [];
     readableStream.on("data", (data) => {
-      chunks.push(typeof data === "string" ? Buffer.from(data) : data);
+      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
     });
     readableStream.on("end", () => {
       resolve(Buffer.concat(chunks));
@@ -420,65 +403,32 @@ async function streamToBuffer(readableStream) {
     readableStream.on("error", reject);
   });
 }
-
-async function main() {
-  const fileClient = serviceClient
-    .getShareClient(shareName)
-    .rootDirectoryClient.getFileClient(fileName);
-
-  // Get file content from position 0 to the end
-  // In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
-  const downloadFileResponse = await fileClient.download();
-  console.log(
-    `Downloaded file content: ${(
-      await streamToBuffer(downloadFileResponse.readableStreamBody)
-    ).toString()}`,
-  );
-}
-
-main();
 ```
 
 ### Download a file and convert it to a string (Browsers)
 
 Please refer to the [JavaScript Bundle](#javascript-bundle) section for more information on using this library in the browser.
 
-```javascript
-const { ShareServiceClient } = require("@azure/storage-file-share");
+```ts snippet:ReadmeSampleDownloadFileAndConvertToString_Browser
+import { ShareServiceClient } from "@azure/storage-file-share";
 
 const account = "<account name>";
 const sas = "<service Shared Access Signature Token>";
-const shareName = "<share name>";
-const fileName = "<file name>";
 
 const serviceClient = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);
 
-async function main() {
-  const fileClient = serviceClient
-    .getShareClient(shareName)
-    .rootDirectoryClient.getFileClient(fileName);
-
-  // Get file content from position 0 to the end
-  // In browsers, get downloaded data by accessing downloadFileResponse.blobBody
-  const downloadFileResponse = await fileClient.download(0);
-  console.log(
-    `Downloaded file content: ${await blobToString(await downloadFileResponse.blobBody)}`,
-  );
-}
-
-// [Browser only] A helper method used to convert a browser Blob into string.
-async function blobToString(blob) {
-  const fileReader = new FileReader();
-  return new Promise((resolve, reject) => {
-    fileReader.onloadend = (ev) => {
-      resolve(ev.target.result);
-    };
-    fileReader.onerror = reject;
-    fileReader.readAsText(blob);
-  });
+const shareName = "<share name>";
+const fileName = "<file name>";
+const fileClient = serviceClient
+  .getShareClient(shareName)
+  .rootDirectoryClient.getFileClient(fileName);
+
+// Get file content from position 0 to the end
+// In browsers, get downloaded data by accessing downloadFileResponse.blobBody
+const downloadFileResponse = await fileClient.download(0);
+if (downloadFileResponse.blobBody) {
+  console.log(`Downloaded file content: ${(await downloadFileResponse.blobBody).text()}`);
 }
-
-main();
 ```
 
 A complete example of simple `ShareServiceClient` scenarios is at [samples/v12/typescript/src/shareSerivceClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-file-share/samples/v12/typescript/src/shareServiceClient.ts).
@@ -487,8 +437,8 @@ A complete example of simple `ShareServiceClient` 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 and list queues and tables granted.
+     */
+    read: boolean;
+    /**
+     * Permission to write resources granted.
+     */
+    write: boolean;
+    /**
+     * Permission to delete blobs and files granted.
+     */
+    delete: boolean;
+    /**
+     * Permission to list blob containers, blobs, shares, directories, and files granted.
+     */
+    list: boolean;
+    /**
+     * Permission to add messages, table entities, and append to blobs granted.
+     */
+    add: boolean;
+    /**
+     * Permission to create 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 and list queues and tables 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 blobs and files granted.\n   */\n  public delete: boolean = false;\n\n  /**\n   * Permission to list blob containers, blobs, shares, directories, and files 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 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"]}