@azure/storage-blob 12.27.0 → 12.28.0-beta.2

package/README.md

@@ -144,14 +144,14 @@ Blob storage offers three types of resources:
 
 To use the clients, import the package into your file:
 
-```javascript
-const AzureStorageBlob = require("@azure/storage-blob");
+```ts snippet:ignore
+import * as AzureStorageBlob from "@azure/storage-blob";
 ```
 
 Alternatively, selectively import only the types you need:
 
-```javascript
-const { BlobServiceClient, StorageSharedKeyCredential } = require("@azure/storage-blob");
+```ts snippet:ignore
+import { BlobServiceClient, StorageSharedKeyCredential } from "@azure/storage-blob";
 ```
 
 ### Create the blob service client
@@ -179,9 +179,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 { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential
+import { DefaultAzureCredential } from "@azure/identity";
+import { BlobServiceClient } from "@azure/storage-blob";
 
 // Enter your storage account name
 const account = "<account>";
@@ -201,8 +201,8 @@ See the [Azure AD Auth sample](https://github.com/Azure/azure-sdk-for-js/blob/ma
 
 Alternatively, you can instantiate a `BlobServiceClient` 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 { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
+import { BlobServiceClient } from "@azure/storage-blob";
 
 const connStr = "<connection string>";
 
@@ -214,10 +214,9 @@ const blobServiceClient = BlobServiceClient.fromConnectionString(connStr);
 Alternatively, you instantiate a `BlobServiceClient` 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 { BlobServiceClient, StorageSharedKeyCredential } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential
+import { StorageSharedKeyCredential, BlobServiceClient } from "@azure/storage-blob";
 
-// Enter your storage account name and shared key
 const account = "<account>";
 const accountKey = "<accountkey>";
 
@@ -234,8 +233,8 @@ const blobServiceClient = new BlobServiceClient(
 
 Also, You can instantiate a `BlobServiceClient` with a shared access signatures (SAS). You can get the SAS token from the Azure Portal or generate one using `generateAccountSASQueryParameters()`.
 
-```javascript
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateClient_SASToken
+import { BlobServiceClient } from "@azure/storage-blob";
 
 const account = "<account name>";
 const sas = "<service Shared Access Signature Token>";
@@ -247,27 +246,21 @@ const blobServiceClient = new BlobServiceClient(`https://${account}.blob.core.wi
 
 Use `BlobServiceClient.getContainerClient()` to get a container client instance then create a new container resource.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateContainer
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  // Create a container
-  const containerName = `newcontainer${new Date().getTime()}`;
-  const containerClient = blobServiceClient.getContainerClient(containerName);
-  const createContainerResponse = await containerClient.create();
-  console.log(`Create container ${containerName} successfully`, createContainerResponse.requestId);
-}
-
-main();
+// Create a container
+const containerName = `newcontainer${new Date().getTime()}`;
+const containerClient = blobServiceClient.getContainerClient(containerName);
+const createContainerResponse = await containerClient.create();
+console.log(`Create container ${containerName} successfully`, createContainerResponse.requestId);
 ```
 
 ### List the containers
@@ -275,233 +268,183 @@ main();
 Use `BlobServiceClient.listContainers()` function to iterate the containers,
 with the new `for-await-of` syntax:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleListContainers
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  let i = 1;
-  const containers = blobServiceClient.listContainers();
-  for await (const container of containers) {
-    console.log(`Container ${i++}: ${container.name}`);
-  }
+let i = 1;
+const containers = blobServiceClient.listContainers();
+for await (const container of containers) {
+  console.log(`Container ${i++}: ${container.name}`);
 }
-
-main();
 ```
 
 Alternatively without using `for-await-of`:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleListContainers_WithoutForAwait
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  let i = 1;
-  const iter = blobServiceClient.listContainers();
-  let containerItem = await iter.next();
-  while (!containerItem.done) {
-    console.log(`Container ${i++}: ${containerItem.value.name}`);
-    containerItem = await iter.next();
-  }
+let i = 1;
+const iter = blobServiceClient.listContainers();
+let { value, done } = await iter.next();
+while (!done) {
+  console.log(`Container ${i++}: ${value.name}`);
+  ({ value, done } = await iter.next());
 }
-
-main();
 ```
 
 In addition, pagination is supported for listing too via `byPage()`:
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleListContainers_ByPage
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
-async function main() {
-  let i = 1;
-  for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
-    if (response.containerItems) {
-      for (const container of response.containerItems) {
-        console.log(`Container ${i++}: ${container.name}`);
-      }
-    }
+let i = 1;
+for await (const page of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
+  for (const container of page.containerItems) {
+    console.log(`Container ${i++}: ${container.name}`);
   }
 }
-
-main();
 ```
 
 For a complete sample on iterating containers please see [samples/v12/typescript/src/listContainers.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/samples/v12/typescript/src/listContainers.ts).
 
 ### Create a blob by uploading data
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleCreateBlob
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
 const containerName = "<container name>";
-
-async function main() {
-  const containerClient = blobServiceClient.getContainerClient(containerName);
-
-  const content = "Hello world!";
-  const blobName = "newblob" + new Date().getTime();
-  const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-  const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
-  console.log(`Upload block blob ${blobName} successfully`, uploadBlobResponse.requestId);
-}
-
-main();
+const containerClient = blobServiceClient.getContainerClient(containerName);
+
+const content = "Hello world!";
+const blobName = `newblob ${+new Date()}`;
+const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
+console.log(
+  `Upload block blob ${blobName} successfully with request ID: ${uploadBlobResponse.requestId}`,
+);
 ```
 
 ### List blobs inside a container
 
 Similar to listing containers.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleListBlobs
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
 const containerName = "<container name>";
+const containerClient = blobServiceClient.getContainerClient(containerName);
 
-async function main() {
-  const containerClient = blobServiceClient.getContainerClient(containerName);
-
-  let i = 1;
-  const blobs = containerClient.listBlobsFlat();
-  for await (const blob of blobs) {
-    console.log(`Blob ${i++}: ${blob.name}`);
-  }
+let i = 1;
+const blobs = containerClient.listBlobsFlat();
+for await (const blob of blobs) {
+  console.log(`Blob ${i++}: ${blob.name}`);
 }
-
-main();
 ```
 
 For a complete sample on iterating blobs please see [samples/v12/typescript/src/listBlobsFlat.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/samples/v12/typescript/src/listBlobsFlat.ts).
 
 ### Download a blob and convert it to a string (Node.js)
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleDownloadBlob_Node
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const account = "<account>";
-const defaultAzureCredential = new DefaultAzureCredential();
-
 const blobServiceClient = new BlobServiceClient(
   `https://${account}.blob.core.windows.net`,
-  defaultAzureCredential,
+  new DefaultAzureCredential(),
 );
 
 const containerName = "<container name>";
 const blobName = "<blob name>";
+const containerClient = blobServiceClient.getContainerClient(containerName);
+const blobClient = containerClient.getBlobClient(blobName);
+
+// Get blob content from position 0 to the end
+// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
+const downloadBlockBlobResponse = await blobClient.download();
+if (downloadBlockBlobResponse.readableStreamBody) {
+  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
+  console.log(`Downloaded blob content: ${downloaded}`);
+}
 
-async function main() {
-  const containerClient = blobServiceClient.getContainerClient(containerName);
-  const blobClient = containerClient.getBlobClient(blobName);
-
-  // Get blob content from position 0 to the end
-  // In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
-  const downloadBlockBlobResponse = await blobClient.download();
-  const downloaded = (
-    await streamToBuffer(downloadBlockBlobResponse.readableStreamBody)
-  ).toString();
-  console.log("Downloaded blob content:", downloaded);
-
-  // [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
-  async function streamToBuffer(readableStream) {
-    return new Promise((resolve, reject) => {
-      const chunks = [];
-      readableStream.on("data", (data) => {
-        chunks.push(typeof data === "string" ? Buffer.from(data) : data);
-      });
-      readableStream.on("end", () => {
-        resolve(Buffer.concat(chunks));
-      });
-      readableStream.on("error", reject);
+async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
+  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
+    const chunks: Buffer[] = [];
+    stream.on("data", (data) => {
+      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
     });
-  }
+    stream.on("end", () => {
+      resolve(Buffer.concat(chunks));
+    });
+    stream.on("error", reject);
+  });
+  return result.toString();
 }
-
-main();
 ```
 
 ### Download a blob 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 { BlobServiceClient } = require("@azure/storage-blob");
+```ts snippet:ReadmeSampleDownloadBlob_Browser
+import { BlobServiceClient } from "@azure/storage-blob";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const account = "<account>";
+const blobServiceClient = new BlobServiceClient(
+  `https://${account}.blob.core.windows.net`,
+  new DefaultAzureCredential(),
+);
 
-const account = "<account name>";
-const sas = "<service Shared Access Signature Token>";
 const containerName = "<container name>";
 const blobName = "<blob name>";
-
-const blobServiceClient = new BlobServiceClient(`https://${account}.blob.core.windows.net?${sas}`);
-
-async function main() {
-  const containerClient = blobServiceClient.getContainerClient(containerName);
-  const blobClient = containerClient.getBlobClient(blobName);
-
-  // Get blob content from position 0 to the end
-  // In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
-  const downloadBlockBlobResponse = await blobClient.download();
-  const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
-  console.log("Downloaded blob content", downloaded);
-
-  // [Browsers 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 containerClient = blobServiceClient.getContainerClient(containerName);
+const blobClient = containerClient.getBlobClient(blobName);
+
+// Get blob content from position 0 to the end
+// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
+const downloadBlockBlobResponse = await blobClient.download();
+const blobBody = await downloadBlockBlobResponse.blobBody;
+if (blobBody) {
+  const downloaded = await blobBody.text();
+  console.log(`Downloaded blob content: ${downloaded}`);
 }
-
-main();
 ```
 
 A complete example of simple scenarios is at [samples/v12/typescript/src/sharedKeyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/samples/v12/typescript/src/sharedKeyAuth.ts).
@@ -510,8 +453,8 @@ A complete example of simple scenarios is at [samples/v12/typescript/src/sharedK
 
 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/BatchResponse.d.ts

@@ -0,0 +1,49 @@
+import type { BatchSubRequest } from "./BlobBatch.js";
+import type { HttpHeadersLike } from "@azure/core-http-compat";
+/**
+ * The response data associated with a single request within a batch operation.
+ */
+export interface BatchSubResponse {
+    /**
+     * The status code of the sub operation.
+     */
+    status: number;
+    /**
+     * The status message of the sub operation.
+     */
+    statusMessage: string;
+    /**
+     * The error code of the sub operation, if the sub operation failed.
+     */
+    errorCode?: string;
+    /**
+     * The HTTP response headers.
+     */
+    headers: HttpHeadersLike;
+    /**
+     * The body as text.
+     */
+    bodyAsText?: string;
+    /**
+     * The batch sub request corresponding to the sub response.
+     */
+    _request: BatchSubRequest;
+}
+/**
+ * The multipart/mixed response which contains the response for each subrequest.
+ */
+export interface ParsedBatchResponse {
+    /**
+     * The parsed sub responses.
+     */
+    subResponses: BatchSubResponse[];
+    /**
+     * The succeeded executed sub responses' count;
+     */
+    subResponsesSucceededCount: number;
+    /**
+     * The failed executed sub responses' count;
+     */
+    subResponsesFailedCount: number;
+}
+//# sourceMappingURL=BatchResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BatchResponse.d.ts","sourceRoot":"","sources":["../../src/BatchResponse.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,gBAAgB,EAAE,CAAC;IAEjC;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;CACjC"}

package/dist/browser/BatchResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BatchResponse.js","sourceRoot":"","sources":["../../src/BatchResponse.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { BatchSubRequest } from \"./BlobBatch.js\";\nimport type { HttpHeadersLike } from \"@azure/core-http-compat\";\n\n/**\n * The response data associated with a single request within a batch operation.\n */\nexport interface BatchSubResponse {\n  /**\n   * The status code of the sub operation.\n   */\n  status: number;\n\n  /**\n   * The status message of the sub operation.\n   */\n  statusMessage: string;\n\n  /**\n   * The error code of the sub operation, if the sub operation failed.\n   */\n  errorCode?: string;\n\n  /**\n   * The HTTP response headers.\n   */\n  headers: HttpHeadersLike;\n\n  /**\n   * The body as text.\n   */\n  bodyAsText?: string;\n\n  /**\n   * The batch sub request corresponding to the sub response.\n   */\n  _request: BatchSubRequest;\n}\n\n/**\n * The multipart/mixed response which contains the response for each subrequest.\n */\nexport interface ParsedBatchResponse {\n  /**\n   * The parsed sub responses.\n   */\n  subResponses: BatchSubResponse[];\n\n  /**\n   * The succeeded executed sub responses' count;\n   */\n  subResponsesSucceededCount: number;\n\n  /**\n   * The failed executed sub responses' count;\n   */\n  subResponsesFailedCount: number;\n}\n"]}

package/dist/browser/BatchResponseParser.d.ts

@@ -0,0 +1,16 @@
+import type { ServiceSubmitBatchResponseModel } from "./generatedModels.js";
+import type { BatchSubRequest } from "./BlobBatch.js";
+import type { ParsedBatchResponse } from "./BatchResponse.js";
+/**
+ * Util class for parsing batch response.
+ */
+export declare class BatchResponseParser {
+    private readonly batchResponse;
+    private readonly responseBatchBoundary;
+    private readonly perResponsePrefix;
+    private readonly batchResponseEnding;
+    private readonly subRequests;
+    constructor(batchResponse: ServiceSubmitBatchResponseModel, subRequests: Map<number, BatchSubRequest>);
+    parseBatchResponse(): Promise<ParsedBatchResponse>;
+}
+//# sourceMappingURL=BatchResponseParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BatchResponseParser.d.ts","sourceRoot":"","sources":["../../src/BatchResponseParser.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAC;AAQ5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAoB,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAOhF;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAChE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAC7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;gBAGzD,aAAa,EAAE,+BAA+B,EAC9C,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC;IAoB9B,kBAAkB,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAgIhE"}