@azure/storage-blob-changefeed 12.0.0-alpha.20250407.1 → 12.0.0-alpha.20250516.2

package/README.md

@@ -67,9 +67,9 @@ This library offers a client you can use to fetch the change events.
 
 The `BlobChangeFeedClient` requires almost the same parameters as `BlobServiceClient` to initialize. Refer to [storage-blob](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob#create-the-blob-service-client) for how to create the blob service client. Here is an example using `StorageSharedKeyCredential`.
 
-```javascript
-const { StorageSharedKeyCredential } = require("@azure/storage-blob");
-const { BlobChangeFeedClient } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleCreateClient
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
 // Enter your storage account name and shared key
 const account = "<account>";
@@ -88,45 +88,71 @@ const changeFeedClient = new BlobChangeFeedClient(
 
 Use `BlobChangeFeedClient.listChanges()` to get iterators to iterate through the change events.
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChanges
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
-let changeFeedEvents = [];
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
+
+// Use for await to iterate through the change feed
 for await (const event of changeFeedClient.listChanges()) {
-  changeFeedEvents.push(event);
+  console.log(`Event: ${event.eventType}`);
+  console.log(`Event time: ${event.eventTime}`);
+  console.log(`Event data: ${JSON.stringify(event.data)}`);
 }
-```
 
-By page.
-
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
-
-let changeFeedEvents = [];
-for await (const eventPage of changeFeedClient.listChanges().byPage()) {
-  for (const event of eventPage.events) {
-    changeFeedEvents.push(event);
+// Use `byPage` to iterate through the change feed
+for await (const page of changeFeedClient.listChanges().byPage()) {
+  console.log(`Page: ${JSON.stringify(page)}`);
+  for (const event of page.events) {
+    console.log(`Event: ${event.eventType}`);
+    console.log(`Event time: ${event.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(event.data)}`);
   }
 }
 ```
 
 ### Resuming reading events with a continuationToken
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChanges_Continuation
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
-let changeFeedEvents = [];
-const firstPage = await changeFeedClient.listChanges().byPage({ maxPageSize: 10 }).next();
-for (const event of firstPage.value.events) {
-  changeFeedEvents.push(event);
-}
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
 
-// Resume iterating from the previous position with the continuationToken.
-for await (const eventPage of changeFeedClient
-  .listChanges()
-  .byPage({ continuationToken: firstPage.value.continuationToken })) {
-  for (const event of eventPage.events) {
-    changeFeedEvents.push(event);
+let iterator = changeFeedClient.listChanges().byPage({ maxPageSize: 2 });
+let response = (await iterator.next()).value;
+// Prints 2 page ranges
+if (response.pageRange) {
+  for (const pageRange of response.pageRange) {
+    console.log(`Event: ${pageRange.eventType}`);
+    console.log(`Event time: ${pageRange.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
+  }
+}
+// Gets next marker
+let marker = response.continuationToken;
+// Passing next marker as continuationToken
+iterator = changeFeedClient.listChanges().byPage({ continuationToken: marker, maxPageSize: 10 });
+response = (await iterator.next()).value;
+// Prints 10 page ranges
+if (response.pageRange) {
+  for (const pageRange of response.pageRange) {
+    console.log(`Event: ${pageRange.eventType}`);
+    console.log(`Event time: ${pageRange.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
   }
 }
 ```
@@ -137,16 +163,35 @@ Pass start time and end time to `BlobChangeFeedClient.listChanges()` to fetch ev
 
 Note that for now, the change feed client will round start time down to the nearest hour, and round end time up to the next hour.
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChangesTimeRange
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
+
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
 
 const start = new Date(Date.UTC(2020, 1, 21, 22, 30, 0)); // will be rounded down to 22:00
 const end = new Date(Date.UTC(2020, 4, 8, 21, 10, 0)); // will be rounded up to 22:00
-
-let changeFeedEvents = [];
-// You can also provide just a start or end time.
+// Use for await to iterate through the change feed
 for await (const event of changeFeedClient.listChanges({ start, end })) {
-  changeFeedEvents.push(event);
+  console.log(`Event: ${event.eventType}`);
+  console.log(`Event time: ${event.eventTime}`);
+  console.log(`Event data: ${JSON.stringify(event.data)}`);
+}
+
+// Use `byPage` to iterate through the change feed
+for await (const page of changeFeedClient.listChanges({ start, end }).byPage()) {
+  console.log(`Page: ${JSON.stringify(page)}`);
+  for (const event of page.events) {
+    console.log(`Event: ${event.eventType}`);
+    console.log(`Event time: ${event.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(event.data)}`);
+  }
 }
 ```
 
@@ -154,7 +199,7 @@ for await (const event of changeFeedClient.listChanges({ start, end })) {
 
 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
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");

package/{types/latest/storage-blob-changefeed/src → dist/browser}/AvroReaderFactory.d.ts

@@ -1,5 +1,5 @@
-import type { AvroReadable } from "../../storage-internal-avro/src";
-import { AvroReader } from "../../storage-internal-avro/src";
+import type { AvroReadable } from "@azure/storage-internal-avro";
+import { AvroReader } from "@azure/storage-internal-avro";
 /**
  * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
  */

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

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.d.ts","sourceRoot":"","sources":["../../src/AvroReaderFactory.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,qBAAa,iBAAiB;IACrB,MAAM,CAAC,mBAAmB,EAAE,YAAY,GAAG,UAAU;IAErD,MAAM,CACX,UAAU,EAAE,YAAY,EACxB,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,UAAU;CAcd"}

package/{dist-esm/storage-blob-changefeed/src → dist/browser}/AvroReaderFactory.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { AvroReader } from "../../storage-internal-avro/src";
+import { AvroReader } from "@azure/storage-internal-avro";
 /**
  * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
  */

package/dist/browser/AvroReaderFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.js","sourceRoot":"","sources":["../../src/AvroReaderFactory.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAUrB,MAAM,CACX,UAAwB,EACxB,YAA2B,EAC3B,WAAoB,EACpB,UAAmB;QAEnB,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,YAAY,EAAE,WAAY,EAAE,UAAW,CAAC,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AvroReadable } from \"@azure/storage-internal-avro\";\nimport { AvroReader } from \"@azure/storage-internal-avro\";\n\n/**\n * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.\n */\nexport class AvroReaderFactory {\n  public create(headerAndDataStream: AvroReadable): AvroReader;\n\n  public create(\n    dataStream: AvroReadable,\n    headerStream: AvroReadable,\n    blockOffset: number,\n    eventIndex: number,\n  ): AvroReader;\n\n  public create(\n    dataStream: AvroReadable,\n    headerStream?: AvroReadable,\n    blockOffset?: number,\n    eventIndex?: number,\n  ): AvroReader {\n    if (headerStream) {\n      return new AvroReader(dataStream, headerStream, blockOffset!, eventIndex!);\n    } else {\n      return new AvroReader(dataStream);\n    }\n  }\n}\n"]}

package/{types/latest/storage-blob-changefeed/src → dist/browser}/BlobChangeFeedClient.d.ts

@@ -1,8 +1,8 @@
 import type { StoragePipelineOptions, StorageSharedKeyCredential, AnonymousCredential } from "@azure/storage-blob";
 import { Pipeline } from "@azure/storage-blob";
 import type { PagedAsyncIterableIterator } from "@azure/core-paging";
-import type { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
-import type { BlobChangeFeedListChangesOptions } from "./models/models";
+import type { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent.js";
+import type { BlobChangeFeedListChangesOptions } from "./models/models.js";
 import type { TokenCredential } from "@azure/core-auth";
 /**
  * Contains paged response data for the {@link BlobChangeFeedClient.listChanges} operation.
@@ -70,26 +70,36 @@ export declare class BlobChangeFeedClient {
      *
      * Example using DefaultAzureCredential from `@azure/identity`:
      *
-     * ```js
-     * const account = "<storage account name>";
+     * ```ts snippet:ReadmeSampleCreateClient_TokenCredential
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
      *
-     * const defaultAzureCredential = new DefaultAzureCredential();
-     *
-     * const blobChangeFeedClient = new BlobChangeFeedClient(
+     * // Enter your storage account name and shared key
+     * const account = "<account>";
+     * const credential = new DefaultAzureCredential();
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   // When using AnonymousCredential, following url should include a valid SAS or support public access
      *   `https://${account}.blob.core.windows.net`,
-     *   defaultAzureCredential
+     *   credential,
      * );
      * ```
      *
      * Example using an account name/key:
      *
-     * ```js
-     * const account = "<storage account name>"
-     * const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
-     *
-     * const blobChangeFeedClient = new BlobChangeFeedClient(
+     * ```ts snippet:ReadmeSampleCreateClient
+     * import { StorageSharedKeyCredential } from "@azure/storage-blob";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
+     *
+     * // Enter your storage account name and shared key
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     * // Use StorageSharedKeyCredential with storage account and account key
+     * // StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   // When using AnonymousCredential, following url should include a valid SAS or support public access
      *   `https://${account}.blob.core.windows.net`,
-     *   sharedKeyCredential
+     *   sharedKeyCredential,
      * );
      * ```
      */
@@ -114,63 +124,71 @@ export declare class BlobChangeFeedClient {
      *
      * Example using `for await` syntax:
      *
-     * ```js
-     * let i = 1;
-     * for await (const event of blobChangeFeedClient.listChanges()) {
-     *   console.log(`Event ${i++}, type: ${event.eventType}`);
-     * }
-     * ```
+     * ```ts snippet:ReadmeSampleListChanges
+     * import { StorageSharedKeyCredential } from "@azure/storage-blob";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
      *
-     * Example using `iter.next()`:
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   sharedKeyCredential,
+     * );
      *
-     * ```js
-     * let i = 1;
-     * const iter = blobChangeFeedClient.listChanges();
-     * let eventItem = await iter.next();
-     * while (!eventItem.done) {
-     *   console.log(`Event ${i++}, type: ${eventItem.eventType}`);
-     *   eventItem = await iter.next();
+     * // Use for await to iterate through the change feed
+     * for await (const event of changeFeedClient.listChanges()) {
+     *   console.log(`Event: ${event.eventType}`);
+     *   console.log(`Event time: ${event.eventTime}`);
+     *   console.log(`Event data: ${JSON.stringify(event.data)}`);
      * }
-     * ```
-     *
-     * Example using `byPage()`:
      *
-     * ```js
-     * // passing optional maxPageSize in the page settings
-     * let i = 1;
-     * for await (const eventPage of blobChangeFeedClient.listChanges().byPage({ maxPageSize: 20 })) {
-     *   if (eventPage.events) {
-     *     for (const event of eventPage.events) {
-     *       console.log(`Event ${i++}, type: ${event.eventType}`);
-     *     }
+     * // Use `byPage` to iterate through the change feed
+     * for await (const page of changeFeedClient.listChanges().byPage()) {
+     *   console.log(`Page: ${JSON.stringify(page)}`);
+     *   for (const event of page.events) {
+     *     console.log(`Event: ${event.eventType}`);
+     *     console.log(`Event time: ${event.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(event.data)}`);
      *   }
      * }
      * ```
      *
      * Example using paging with a marker:
      *
-     * ```js
-     * let i = 1;
-     * let iterator = blobChangeFeedClient.listChanges().byPage({ maxPageSize: 2 });
-     * let eventPage = (await iterator.next()).value;
+     * ```ts snippet:ReadmeSampleListChanges_Continuation
+     * import { StorageSharedKeyCredential } from "@azure/storage-blob";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
+     *
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   sharedKeyCredential,
+     * );
      *
-     * if (eventPage.events) {
-     *   for (const container of eventPage.events) {
-     *     console.log(`Event ${i++}, type: ${event.eventType}`);
+     * let iterator = changeFeedClient.listChanges().byPage({ maxPageSize: 2 });
+     * let response = (await iterator.next()).value;
+     * // Prints 2 page ranges
+     * if (response.pageRange) {
+     *   for (const pageRange of response.pageRange) {
+     *     console.log(`Event: ${pageRange.eventType}`);
+     *     console.log(`Event time: ${pageRange.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
      *   }
      * }
-     *
      * // Gets next marker
-     * let marker = eventPage.continuationToken;
+     * let marker = response.continuationToken;
      * // Passing next marker as continuationToken
-     * iterator = blobChangeFeedClient
-     *   .listChanges()
-     *   .byPage({ continuationToken: marker, maxPageSize: 10 });
-     * eventPage = (await iterator.next()).value;
-     *
-     * if (eventPage.events) {
-     *   for (const container of eventPage.events) {
-     *      console.log(`Event ${i++}, type: ${event.eventType}`);
+     * iterator = changeFeedClient.listChanges().byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await iterator.next()).value;
+     * // Prints 10 page ranges
+     * if (response.pageRange) {
+     *   for (const pageRange of response.pageRange) {
+     *     console.log(`Event: ${pageRange.eventType}`);
+     *     console.log(`Event time: ${pageRange.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
      *   }
      * }
      * ```

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

@@ -0,0 +1 @@
+{"version":3,"file":"BlobChangeFeedClient.d.ts","sourceRoot":"","sources":["../../src/BlobChangeFeedClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,sBAAsB,EACtB,0BAA0B,EAC1B,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAqB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAgB,MAAM,oBAAoB,CAAC;AACnF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAI3E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;GAEG;AACH,qBAAa,uBAAuB;IAClC;;OAEG;IACI,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAErC;;OAEG;IACI,iBAAiB,EAAE,MAAM,CAAC;;CAMlC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAC/E,eAAe,GAAE,sBAA2B,GAC3C,QAAQ,CAEV;AAmBD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,uBAAuB,CAA8B;IAE7D;;;;;;;;;;;OAWG;WACW,oBAAoB,CAChC,gBAAgB,EAAE,MAAM,EAGxB,OAAO,CAAC,EAAE,sBAAsB,EAGhC,uBAAuB,CAAC,EAAE,2BAA2B,GACpD,oBAAoB;IAUvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAG/E,OAAO,CAAC,EAAE,sBAAsB,EAChC,uBAAuB,CAAC,EAAE,2BAA2B;IAGvD;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;YA6B5B,SAAS;YAuBT,OAAO;IAoCtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+EG;IACI,WAAW,CAChB,OAAO,GAAE,gCAAqC,GAC7C,0BAA0B,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;CAuB5E"}

package/{dist-esm/storage-blob-changefeed/src → dist/browser}/BlobChangeFeedClient.js

@@ -2,8 +2,8 @@
 // Licensed under the MIT License.
 import { __asyncGenerator, __await } from "tslib";
 import { BlobServiceClient, Pipeline } from "@azure/storage-blob";
-import { ChangeFeedFactory } from "./ChangeFeedFactory";
-import { CHANGE_FEED_MAX_PAGE_SIZE, SDK_VERSION } from "./utils/constants";
+import { ChangeFeedFactory } from "./ChangeFeedFactory.js";
+import { CHANGE_FEED_MAX_PAGE_SIZE, SDK_VERSION } from "./utils/constants.js";
 /**
  * Contains paged response data for the {@link BlobChangeFeedClient.listChanges} operation.
  */
@@ -134,63 +134,71 @@ export class BlobChangeFeedClient {
      *
      * Example using `for await` syntax:
      *
-     * ```js
-     * let i = 1;
-     * for await (const event of blobChangeFeedClient.listChanges()) {
-     *   console.log(`Event ${i++}, type: ${event.eventType}`);
-     * }
-     * ```
+     * ```ts snippet:ReadmeSampleListChanges
+     * import { StorageSharedKeyCredential } from "@azure/storage-blob";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
      *
-     * Example using `iter.next()`:
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   sharedKeyCredential,
+     * );
      *
-     * ```js
-     * let i = 1;
-     * const iter = blobChangeFeedClient.listChanges();
-     * let eventItem = await iter.next();
-     * while (!eventItem.done) {
-     *   console.log(`Event ${i++}, type: ${eventItem.eventType}`);
-     *   eventItem = await iter.next();
+     * // Use for await to iterate through the change feed
+     * for await (const event of changeFeedClient.listChanges()) {
+     *   console.log(`Event: ${event.eventType}`);
+     *   console.log(`Event time: ${event.eventTime}`);
+     *   console.log(`Event data: ${JSON.stringify(event.data)}`);
      * }
-     * ```
-     *
-     * Example using `byPage()`:
      *
-     * ```js
-     * // passing optional maxPageSize in the page settings
-     * let i = 1;
-     * for await (const eventPage of blobChangeFeedClient.listChanges().byPage({ maxPageSize: 20 })) {
-     *   if (eventPage.events) {
-     *     for (const event of eventPage.events) {
-     *       console.log(`Event ${i++}, type: ${event.eventType}`);
-     *     }
+     * // Use `byPage` to iterate through the change feed
+     * for await (const page of changeFeedClient.listChanges().byPage()) {
+     *   console.log(`Page: ${JSON.stringify(page)}`);
+     *   for (const event of page.events) {
+     *     console.log(`Event: ${event.eventType}`);
+     *     console.log(`Event time: ${event.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(event.data)}`);
      *   }
      * }
      * ```
      *
      * Example using paging with a marker:
      *
-     * ```js
-     * let i = 1;
-     * let iterator = blobChangeFeedClient.listChanges().byPage({ maxPageSize: 2 });
-     * let eventPage = (await iterator.next()).value;
+     * ```ts snippet:ReadmeSampleListChanges_Continuation
+     * import { StorageSharedKeyCredential } from "@azure/storage-blob";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
      *
-     * if (eventPage.events) {
-     *   for (const container of eventPage.events) {
-     *     console.log(`Event ${i++}, type: ${event.eventType}`);
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     * const changeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   sharedKeyCredential,
+     * );
+     *
+     * let iterator = changeFeedClient.listChanges().byPage({ maxPageSize: 2 });
+     * let response = (await iterator.next()).value;
+     * // Prints 2 page ranges
+     * if (response.pageRange) {
+     *   for (const pageRange of response.pageRange) {
+     *     console.log(`Event: ${pageRange.eventType}`);
+     *     console.log(`Event time: ${pageRange.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
      *   }
      * }
-     *
      * // Gets next marker
-     * let marker = eventPage.continuationToken;
+     * let marker = response.continuationToken;
      * // Passing next marker as continuationToken
-     * iterator = blobChangeFeedClient
-     *   .listChanges()
-     *   .byPage({ continuationToken: marker, maxPageSize: 10 });
-     * eventPage = (await iterator.next()).value;
-     *
-     * if (eventPage.events) {
-     *   for (const container of eventPage.events) {
-     *      console.log(`Event ${i++}, type: ${event.eventType}`);
+     * iterator = changeFeedClient.listChanges().byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await iterator.next()).value;
+     * // Prints 10 page ranges
+     * if (response.pageRange) {
+     *   for (const pageRange of response.pageRange) {
+     *     console.log(`Event: ${pageRange.eventType}`);
+     *     console.log(`Event time: ${pageRange.eventTime}`);
+     *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
      *   }
      * }
      * ```

package/dist/browser/BlobChangeFeedClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobChangeFeedClient.js","sourceRoot":"","sources":["../../src/BlobChangeFeedClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAOlC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGlE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAI9E;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAWlC;QACE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,UAA+E,EAC/E,kBAA0C,EAAE;IAE5C,OAAO,WAAW,CAAC,UAAU,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAgC;IAC7D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,EAAE,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC3C,OAAO,CAAC,gBAAgB,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QAC3D,OAAO,CAAC,gBAAgB,CAAC,eAAe,GAAG,EAAE,CAAC;IAChD,CAAC;SAAM,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe,KAAK,EAAE,EAAE,CAAC;QAC3D,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,GAAG,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,iBAAiB,WAAW,EAAE,CAAC;IAC3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAYD;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAQ/B;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,oBAAoB,CAChC,gBAAwB;IACxB,2FAA2F;IAC3F,iEAAiE;IACjE,OAAgC;IAChC,yFAAyF;IACzF,iEAAiE;IACjE,uBAAqD;QAErD,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC5F,OAAO,IAAI,oBAAoB,CAC7B,iBAAiB,CAAC,GAAG,EACrB,iBAAiB,CAAC,UAAU,EAC5B,qBAAqB,CAAC,OAAO,CAAC,EAC9B,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAiED,YACE,WAAmB,EACnB,oBAIY;IACZ,2FAA2F;IAC3F,iEAAiE;IACjE,OAAgC,EAChC,uBAAqD;QAErD,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,IAAI,EAAE,CAAC;QAC7D,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAC5C,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CACjD,CAAC;QAEF,IAAI,oBAAoB,YAAY,QAAQ,EAAE,CAAC;YAC7C,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAC5C,WAAW,EACX,oBAAoB,EACpB,qBAAqB,CAAC,OAAO,CAAC,CAC/B,CAAC;QACJ,CAAC;IACH,CAAC;IAEc,SAAS;uEACtB,UAA4C,EAAE;YAE9C,MAAM,UAAU,GAAe,cAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAChE,IAAI,CAAC,iBAAiB,EACtB,SAAS,EACT,OAAO,CACR,CAAA,CAAC;YAEF,OAAO,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,cAAM,UAAU,CAAC,SAAS,CAAC;oBACvC,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;iBACvC,CAAC,CAAA,CAAC;gBACH,IAAI,KAAK,EAAE,CAAC;oBACV,oBAAM,KAAK,CAAA,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,6BAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAED,6FAA6F;IAC9E,OAAO;qEACpB,iBAA0B,EAC1B,WAAoB,EACpB,UAA4C,EAAE;YAE9C,MAAM,UAAU,GAAe,cAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAChE,IAAI,CAAC,iBAAiB,EACtB,iBAAiB,EACjB,OAAO,CACR,CAAA,CAAC;YAEF,IAAI,CAAC,WAAW,IAAI,WAAW,GAAG,yBAAyB,EAAE,CAAC;gBAC5D,WAAW,GAAG,yBAAyB,CAAC;YAC1C,CAAC;YACD,OAAO,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC5B,MAAM,SAAS,GAAG,IAAI,uBAAuB,EAAE,CAAC;gBAChD,OAAO,UAAU,CAAC,OAAO,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;oBACrE,MAAM,KAAK,GAAG,cAAM,UAAU,CAAC,SAAS,CAAC;wBACvC,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;qBACvC,CAAC,CAAA,CAAC;oBACH,IAAI,KAAK,EAAE,CAAC;wBACV,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBACD,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;oBACzB,SAAS,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;gBACvE,CAAC;gBACD,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChC,oBAAM,SAAS,CAAA,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACN,6BAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+EG;IACI,WAAW,CAChB,UAA4C,EAAE;QAE9C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACrC,OAAO;YACL;;eAEG;YACH,KAAK,CAAC,IAAI;gBACR,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YACD;;eAEG;YACH,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD;;eAEG;YACH,MAAM,EAAE,CAAC,WAAyB,EAAE,EAAE,EAAE;gBACtC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACjF,CAAC;SACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  StoragePipelineOptions,\n  StorageSharedKeyCredential,\n  AnonymousCredential,\n} from \"@azure/storage-blob\";\nimport { BlobServiceClient, Pipeline } from \"@azure/storage-blob\";\nimport type { PagedAsyncIterableIterator, PageSettings } from \"@azure/core-paging\";\nimport type { BlobChangeFeedEvent } from \"./models/BlobChangeFeedEvent.js\";\nimport { ChangeFeedFactory } from \"./ChangeFeedFactory.js\";\nimport type { ChangeFeed } from \"./ChangeFeed.js\";\nimport { CHANGE_FEED_MAX_PAGE_SIZE, SDK_VERSION } from \"./utils/constants.js\";\nimport type { BlobChangeFeedListChangesOptions } from \"./models/models.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\n\n/**\n * Contains paged response data for the {@link BlobChangeFeedClient.listChanges} operation.\n */\nexport class BlobChangeFeedEventPage {\n  /**\n   * Array of {@link BlobChangeFeedEvent}.\n   */\n  public events: BlobChangeFeedEvent[];\n\n  /**\n   * The token that keeps track of where to continue the iterator.\n   */\n  public continuationToken: string;\n\n  constructor() {\n    this.events = [];\n    this.continuationToken = \"\";\n  }\n}\n\n/**\n * Creates a new Pipeline object with Credential provided.\n *\n * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.\n * @param pipelineOptions - Optional. Options.\n * @returns A new Pipeline object.\n */\nexport function newPipeline(\n  credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential,\n  pipelineOptions: StoragePipelineOptions = {},\n): Pipeline {\n  return newPipeline(credential, appendUserAgentPrefix(pipelineOptions));\n}\n\nfunction appendUserAgentPrefix(options?: StoragePipelineOptions): StoragePipelineOptions {\n  if (!options) {\n    options = {};\n  }\n  if (options.userAgentOptions === undefined) {\n    options.userAgentOptions = {};\n  }\n\n  if (options.userAgentOptions.userAgentPrefix === undefined) {\n    options.userAgentOptions.userAgentPrefix = \"\";\n  } else if (options.userAgentOptions.userAgentPrefix !== \"\") {\n    options.userAgentOptions.userAgentPrefix += \" \";\n  }\n  options.userAgentOptions.userAgentPrefix += `changefeed-js/${SDK_VERSION}`;\n  return options;\n}\n\n/**\n * Blob Change Feed client options.\n */\nexport interface BlobChangeFeedClientOptions {\n  /**\n   * The maximum length of an transfer in bytes.\n   */\n  maximumTransferSize?: number;\n}\n\n/**\n * BlobChangeFeedClient.\n * @see https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-change-feed?tabs=azure-portal\n */\nexport class BlobChangeFeedClient {\n  /**\n   * blobServiceClient provided by `@azure/storage-blob` package.\n   */\n  private blobServiceClient: BlobServiceClient;\n  private changeFeedFactory: ChangeFeedFactory;\n  private changeFeedClientOptions: BlobChangeFeedClientOptions;\n\n  /**\n   *\n   * Creates an instance of BlobChangeFeedClient from connection string.\n   *\n   * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.\n   *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]\n   *                                  Account connection string example -\n   *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`\n   *                                  SAS connection string example -\n   *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  public static fromConnectionString(\n    connectionString: string,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n    // Static method to construct an object, the option is for the object not for the method.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    changeFeedClientOptions?: BlobChangeFeedClientOptions,\n  ): BlobChangeFeedClient {\n    const blobServiceClient = BlobServiceClient.fromConnectionString(connectionString, options);\n    return new BlobChangeFeedClient(\n      blobServiceClient.url,\n      blobServiceClient.credential,\n      appendUserAgentPrefix(options),\n      changeFeedClientOptions,\n    );\n  }\n\n  /**\n   * Creates an instance of BlobChangeFeedClient.\n   *\n   * @param url - A Client string pointing to Azure Storage blob service, such as\n   *                     \"https://myaccount.blob.core.windows.net\". You can append a SAS\n   *                     if using AnonymousCredential, such as \"https://myaccount.blob.core.windows.net?sasString\".\n   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   *\n   * Example using DefaultAzureCredential from `@azure/identity`:\n   *\n   * ```ts snippet:ReadmeSampleCreateClient_TokenCredential\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   * import { BlobChangeFeedClient } from \"@azure/storage-blob-changefeed\";\n   *\n   * // Enter your storage account name and shared key\n   * const account = \"<account>\";\n   * const credential = new DefaultAzureCredential();\n   * const changeFeedClient = new BlobChangeFeedClient(\n   *   // When using AnonymousCredential, following url should include a valid SAS or support public access\n   *   `https://${account}.blob.core.windows.net`,\n   *   credential,\n   * );\n   * ```\n   *\n   * Example using an account name/key:\n   *\n   * ```ts snippet:ReadmeSampleCreateClient\n   * import { StorageSharedKeyCredential } from \"@azure/storage-blob\";\n   * import { BlobChangeFeedClient } from \"@azure/storage-blob-changefeed\";\n   *\n   * // Enter your storage account name and shared key\n   * const account = \"<account>\";\n   * const accountKey = \"<accountkey>\";\n   * // Use StorageSharedKeyCredential with storage account and account key\n   * // StorageSharedKeyCredential is only available in Node.js runtime, not in browsers\n   * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);\n   * const changeFeedClient = new BlobChangeFeedClient(\n   *   // When using AnonymousCredential, following url should include a valid SAS or support public access\n   *   `https://${account}.blob.core.windows.net`,\n   *   sharedKeyCredential,\n   * );\n   * ```\n   */\n  constructor(\n    url: string,\n    credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n    changeFeedClientOptions?: BlobChangeFeedClientOptions,\n  );\n\n  /**\n   * Creates an instance of BlobChangeFeedClient.\n   *\n   * @param url - A Client string pointing to Azure Storage blob service, such as\n   *                     \"https://myaccount.blob.core.windows.net\". You can append a SAS\n   *                     if using AnonymousCredential, such as \"https://myaccount.blob.core.windows.net?sasString\".\n   * @param pipeline - Call newPipeline() to create a default\n   *                            pipeline, or provide a customized pipeline.\n   */\n  constructor(url: string, pipeline: Pipeline);\n  constructor(\n    urlOrClient: string,\n    credentialOrPipeline?:\n      | StorageSharedKeyCredential\n      | AnonymousCredential\n      | TokenCredential\n      | Pipeline,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n    changeFeedClientOptions?: BlobChangeFeedClientOptions,\n  ) {\n    this.changeFeedClientOptions = changeFeedClientOptions || {};\n    this.changeFeedFactory = new ChangeFeedFactory(\n      this.changeFeedClientOptions.maximumTransferSize,\n    );\n\n    if (credentialOrPipeline instanceof Pipeline) {\n      this.blobServiceClient = new BlobServiceClient(urlOrClient, credentialOrPipeline);\n    } else {\n      this.blobServiceClient = new BlobServiceClient(\n        urlOrClient,\n        credentialOrPipeline,\n        appendUserAgentPrefix(options),\n      );\n    }\n  }\n\n  private async *getChange(\n    options: BlobChangeFeedListChangesOptions = {},\n  ): AsyncIterableIterator<BlobChangeFeedEvent> {\n    const changeFeed: ChangeFeed = await this.changeFeedFactory.create(\n      this.blobServiceClient,\n      undefined,\n      options,\n    );\n\n    while (changeFeed.hasNext()) {\n      const event = await changeFeed.getChange({\n        abortSignal: options.abortSignal,\n        tracingOptions: options.tracingOptions,\n      });\n      if (event) {\n        yield event;\n      } else {\n        return;\n      }\n    }\n  }\n\n  // start in ChangeFeedListChangesOptions will be ignored when continuationToken is specified.\n  private async *getPage(\n    continuationToken?: string,\n    maxPageSize?: number,\n    options: BlobChangeFeedListChangesOptions = {},\n  ): AsyncIterableIterator<BlobChangeFeedEventPage> {\n    const changeFeed: ChangeFeed = await this.changeFeedFactory.create(\n      this.blobServiceClient,\n      continuationToken,\n      options,\n    );\n\n    if (!maxPageSize || maxPageSize > CHANGE_FEED_MAX_PAGE_SIZE) {\n      maxPageSize = CHANGE_FEED_MAX_PAGE_SIZE;\n    }\n    while (changeFeed.hasNext()) {\n      const eventPage = new BlobChangeFeedEventPage();\n      while (changeFeed.hasNext() && eventPage.events.length < maxPageSize) {\n        const event = await changeFeed.getChange({\n          abortSignal: options.abortSignal,\n          tracingOptions: options.tracingOptions,\n        });\n        if (event) {\n          eventPage.events.push(event);\n        }\n      }\n      if (changeFeed.hasNext()) {\n        eventPage.continuationToken = JSON.stringify(changeFeed.getCursor());\n      }\n      if (eventPage.events.length > 0) {\n        yield eventPage;\n      } else {\n        return;\n      }\n    }\n  }\n\n  /**\n   * Returns an async iterable iterator to list all the change feed events\n   * in the specified account.\n   *\n   * .byPage() returns an async iterable iterator to list the change feed events in pages.\n   *\n   * Example using `for await` syntax:\n   *\n   * ```ts snippet:ReadmeSampleListChanges\n   * import { StorageSharedKeyCredential } from \"@azure/storage-blob\";\n   * import { BlobChangeFeedClient } from \"@azure/storage-blob-changefeed\";\n   *\n   * const account = \"<account>\";\n   * const accountKey = \"<accountkey>\";\n   * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);\n   * const changeFeedClient = new BlobChangeFeedClient(\n   *   `https://${account}.blob.core.windows.net`,\n   *   sharedKeyCredential,\n   * );\n   *\n   * // Use for await to iterate through the change feed\n   * for await (const event of changeFeedClient.listChanges()) {\n   *   console.log(`Event: ${event.eventType}`);\n   *   console.log(`Event time: ${event.eventTime}`);\n   *   console.log(`Event data: ${JSON.stringify(event.data)}`);\n   * }\n   *\n   * // Use `byPage` to iterate through the change feed\n   * for await (const page of changeFeedClient.listChanges().byPage()) {\n   *   console.log(`Page: ${JSON.stringify(page)}`);\n   *   for (const event of page.events) {\n   *     console.log(`Event: ${event.eventType}`);\n   *     console.log(`Event time: ${event.eventTime}`);\n   *     console.log(`Event data: ${JSON.stringify(event.data)}`);\n   *   }\n   * }\n   * ```\n   *\n   * Example using paging with a marker:\n   *\n   * ```ts snippet:ReadmeSampleListChanges_Continuation\n   * import { StorageSharedKeyCredential } from \"@azure/storage-blob\";\n   * import { BlobChangeFeedClient } from \"@azure/storage-blob-changefeed\";\n   *\n   * const account = \"<account>\";\n   * const accountKey = \"<accountkey>\";\n   * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);\n   * const changeFeedClient = new BlobChangeFeedClient(\n   *   `https://${account}.blob.core.windows.net`,\n   *   sharedKeyCredential,\n   * );\n   *\n   * let iterator = changeFeedClient.listChanges().byPage({ maxPageSize: 2 });\n   * let response = (await iterator.next()).value;\n   * // Prints 2 page ranges\n   * if (response.pageRange) {\n   *   for (const pageRange of response.pageRange) {\n   *     console.log(`Event: ${pageRange.eventType}`);\n   *     console.log(`Event time: ${pageRange.eventTime}`);\n   *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);\n   *   }\n   * }\n   * // Gets next marker\n   * let marker = response.continuationToken;\n   * // Passing next marker as continuationToken\n   * iterator = changeFeedClient.listChanges().byPage({ continuationToken: marker, maxPageSize: 10 });\n   * response = (await iterator.next()).value;\n   * // Prints 10 page ranges\n   * if (response.pageRange) {\n   *   for (const pageRange of response.pageRange) {\n   *     console.log(`Event: ${pageRange.eventType}`);\n   *     console.log(`Event time: ${pageRange.eventTime}`);\n   *     console.log(`Event data: ${JSON.stringify(pageRange.data)}`);\n   *   }\n   * }\n   * ```\n   *\n   * @param options - Options to list change feed events.\n   * @returns An asyncIterableIterator that supports paging.\n   */\n  public listChanges(\n    options: BlobChangeFeedListChangesOptions = {},\n  ): PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage> {\n    const iter = this.getChange(options);\n    return {\n      /**\n       * The next method, part of the iteration protocol\n       */\n      async next() {\n        return iter.next();\n      },\n      /**\n       * The connection to the async iterator, part of the iteration protocol\n       */\n      [Symbol.asyncIterator]() {\n        return this;\n      },\n      /**\n       * Return an AsyncIterableIterator that works a page at a time\n       */\n      byPage: (settings: PageSettings = {}) => {\n        return this.getPage(settings.continuationToken, settings.maxPageSize, options);\n      },\n    };\n  }\n}\n"]}

package/{types/latest/storage-blob-changefeed/src → dist/browser}/ChangeFeed.d.ts

@@ -1,8 +1,8 @@
 import type { ContainerClient, CommonOptions } from "@azure/storage-blob";
-import type { Segment } from "./Segment";
-import type { SegmentFactory } from "./SegmentFactory";
-import type { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
-import type { ChangeFeedCursor } from "./models/ChangeFeedCursor";
+import type { Segment } from "./Segment.js";
+import type { SegmentFactory } from "./SegmentFactory.js";
+import type { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent.js";
+import type { ChangeFeedCursor } from "./models/ChangeFeedCursor.js";
 import type { AbortSignalLike } from "@azure/abort-controller";
 /**
  * Options to configure {@link ChangeFeed.getChange} operation.

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeFeed.d.ts","sourceRoot":"","sources":["../../src/ChangeFeed.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG/D;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAkB;IAEnD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAiB;IAEjD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IAEjC,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,cAAc,CAAC,CAAU;IAEjC,OAAO,CAAC,cAAc,CAAC,CAAO;IAE9B,OAAO,CAAC,SAAS,CAAC,CAAO;IAEzB,OAAO,CAAC,OAAO,CAAC,CAAO;IAEvB,OAAO,CAAC,GAAG,CAAC,CAAO;;gBAIjB,eAAe,EAAE,eAAe,EAChC,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,MAAM,EAAE,EAClB,cAAc,EAAE,OAAO,EACvB,cAAc,EAAE,IAAI,EACpB,SAAS,CAAC,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,IAAI;YA0BF,yBAAyB;IA0DhC,OAAO,IAAI,OAAO;IAaZ,SAAS,CACpB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAiBpC,SAAS,IAAI,gBAAgB;CAYrC"}

package/{dist-esm/storage-blob-changefeed/src → dist/browser}/ChangeFeed.js

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { getSegmentsInYear, minDate, getHost } from "./utils/utils.common";
-import { tracingClient } from "./utils/tracing";
+import { getSegmentsInYear, minDate, getHost } from "./utils/utils.common.js";
+import { tracingClient } from "./utils/tracing.js";
 export class ChangeFeed {
     constructor(containerClient, segmentFactory, years, segments, currentSegment, lastConsumable, startTime, endTime) {
         this.containerClient = containerClient;

package/dist/browser/ChangeFeed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeFeed.js","sourceRoot":"","sources":["../../src/ChangeFeed.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAOlC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAanD,MAAM,OAAO,UAAU;IAkCrB,YACE,eAAiC,EACjC,cAA+B,EAC/B,KAAgB,EAChB,QAAmB,EACnB,cAAwB,EACxB,cAAqB,EACrB,SAAgB,EAChB,OAAc;QAEd,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,UAAsC,EAAE;QAC9E,OAAO,aAAa,CAAC,QAAQ,CAC3B,sCAAsC,EACtC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,CAAC;YAED,wEAAwE;YACxE,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,iDAAiD;YACjD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,cAAc,GAAG,MAAM,IAAI,CAAC,cAAe,CAAC,MAAM,CACrD,IAAI,CAAC,eAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAG,EACtB,SAAS,EACT;oBACE,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,cAAc,CAAC,cAAc;iBAC9C,CACF,CAAC;YACJ,CAAC;YACD,kCAAkC;iBAC7B,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,GAAG,MAAM,iBAAiB,CACrC,IAAI,CAAC,eAAgB,EACrB,IAAK,EACL,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,GAAG,EACR;oBACE,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,cAAc,CAAC,cAAc;iBAC9C,CACF,CAAC;gBAEF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,cAAc,GAAG,MAAM,IAAI,CAAC,cAAe,CAAC,MAAM,CACrD,IAAI,CAAC,eAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAG,EACtB,SAAS,EACT;wBACE,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,cAAc,EAAE,cAAc,CAAC,cAAc;qBAC9C,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,OAAO;QACZ,2DAA2D;QAC3D,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5F,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAI,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,UAAsC,EAAE;QAExC,OAAO,aAAa,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACtF,IAAI,KAAK,GAAoC,SAAS,CAAC;YACvD,OAAO,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC7C,KAAK,GAAG,MAAM,IAAI,CAAC,cAAe,CAAC,SAAS,CAAC;oBAC3C,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,cAAc,CAAC,cAAc;iBAC9C,CAAC,CAAC;gBACH,MAAM,IAAI,CAAC,yBAAyB,CAAC;oBACnC,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,cAAc,CAAC,cAAc;iBAC9C,CAAC,CAAC;YACL,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,SAAS;;QACd,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,OAAO;YACL,aAAa,EAAE,CAAC;YAChB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,eAAgB,CAAC,GAAG,CAAE;YAC5C,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,EAAE;YAC/B,oBAAoB,EAAE,IAAI,CAAC,cAAe,CAAC,SAAS,EAAE;SACvD,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ContainerClient, CommonOptions } from \"@azure/storage-blob\";\nimport type { Segment } from \"./Segment.js\";\nimport type { SegmentFactory } from \"./SegmentFactory.js\";\nimport type { BlobChangeFeedEvent } from \"./models/BlobChangeFeedEvent.js\";\nimport type { ChangeFeedCursor } from \"./models/ChangeFeedCursor.js\";\nimport { getSegmentsInYear, minDate, getHost } from \"./utils/utils.common.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { tracingClient } from \"./utils/tracing.js\";\n\n/**\n * Options to configure {@link ChangeFeed.getChange} operation.\n */\nexport interface ChangeFeedGetChangeOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n}\n\nexport class ChangeFeed {\n  /**\n   * BlobContainerClient for making List Blob requests and creating Segments.\n   */\n  private readonly containerClient?: ContainerClient;\n\n  private readonly segmentFactory?: SegmentFactory;\n\n  private readonly years: number[];\n\n  private segments: string[];\n\n  private currentSegment?: Segment;\n\n  private lastConsumable?: Date;\n\n  private startTime?: Date;\n\n  private endTime?: Date;\n\n  private end?: Date;\n\n  constructor();\n  constructor(\n    containerClient: ContainerClient,\n    segmentFactory: SegmentFactory,\n    years: number[],\n    segments: string[],\n    currentSegment: Segment,\n    lastConsumable: Date,\n    startTime?: Date,\n    endTime?: Date,\n  );\n\n  constructor(\n    containerClient?: ContainerClient,\n    segmentFactory?: SegmentFactory,\n    years?: number[],\n    segments?: string[],\n    currentSegment?: Segment,\n    lastConsumable?: Date,\n    startTime?: Date,\n    endTime?: Date,\n  ) {\n    this.containerClient = containerClient;\n    this.segmentFactory = segmentFactory;\n    this.years = years || [];\n    this.segments = segments || [];\n    this.currentSegment = currentSegment;\n    this.lastConsumable = lastConsumable;\n    this.startTime = startTime;\n    this.endTime = endTime;\n    if (this.lastConsumable) {\n      this.end = minDate(this.lastConsumable, this.endTime);\n    }\n  }\n\n  private async advanceSegmentIfNecessary(options: ChangeFeedGetChangeOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\n      \"ChangeFeed-advanceSegmentIfNecessary\",\n      options,\n      async (updatedOptions) => {\n        if (!this.currentSegment) {\n          throw new Error(\"Empty Change Feed shouldn't call this function.\");\n        }\n\n        // If the current segment has more Events, we don't need to do anything.\n        if (this.currentSegment.hasNext()) {\n          return;\n        }\n\n        // If the current segment is completed, remove it\n        if (this.segments.length > 0) {\n          this.currentSegment = await this.segmentFactory!.create(\n            this.containerClient!,\n            this.segments.shift()!,\n            undefined,\n            {\n              abortSignal: options.abortSignal,\n              tracingOptions: updatedOptions.tracingOptions,\n            },\n          );\n        }\n        // If segments is empty, refill it\n        else if (this.segments.length === 0 && this.years.length > 0) {\n          const year = this.years.shift();\n          this.segments = await getSegmentsInYear(\n            this.containerClient!,\n            year!,\n            this.startTime,\n            this.end,\n            {\n              abortSignal: options.abortSignal,\n              tracingOptions: updatedOptions.tracingOptions,\n            },\n          );\n\n          if (this.segments.length > 0) {\n            this.currentSegment = await this.segmentFactory!.create(\n              this.containerClient!,\n              this.segments.shift()!,\n              undefined,\n              {\n                abortSignal: options.abortSignal,\n                tracingOptions: updatedOptions.tracingOptions,\n              },\n            );\n          } else {\n            this.currentSegment = undefined;\n          }\n        }\n      },\n    );\n  }\n\n  public hasNext(): boolean {\n    // Empty ChangeFeed, using currentSegment as the indicator.\n    if (!this.currentSegment) {\n      return false;\n    }\n\n    if (this.segments.length === 0 && this.years.length === 0 && !this.currentSegment.hasNext()) {\n      return false;\n    }\n\n    return this.currentSegment.dateTime < this.end!;\n  }\n\n  public async getChange(\n    options: ChangeFeedGetChangeOptions = {},\n  ): Promise<BlobChangeFeedEvent | undefined> {\n    return tracingClient.withSpan(\"ChangeFeed-getChange\", options, async (updatedOptions) => {\n      let event: BlobChangeFeedEvent | undefined = undefined;\n      while (event === undefined && this.hasNext()) {\n        event = await this.currentSegment!.getChange({\n          abortSignal: options.abortSignal,\n          tracingOptions: updatedOptions.tracingOptions,\n        });\n        await this.advanceSegmentIfNecessary({\n          abortSignal: options.abortSignal,\n          tracingOptions: updatedOptions.tracingOptions,\n        });\n      }\n      return event;\n    });\n  }\n\n  public getCursor(): ChangeFeedCursor {\n    if (!this.currentSegment) {\n      throw new Error(\"Empty Change Feed shouldn't call this function.\");\n    }\n\n    return {\n      CursorVersion: 1,\n      UrlHost: getHost(this.containerClient!.url)!,\n      EndTime: this.endTime?.toJSON(),\n      CurrentSegmentCursor: this.currentSegment!.getCursor(),\n    };\n  }\n}\n"]}

package/{types/latest/storage-blob-changefeed/src → dist/browser}/ChangeFeedFactory.d.ts

@@ -1,7 +1,7 @@
 import type { BlobServiceClient } from "@azure/storage-blob";
-import { ChangeFeed } from "./ChangeFeed";
-import { SegmentFactory } from "./SegmentFactory";
-import type { BlobChangeFeedListChangesOptions } from "./models/models";
+import { ChangeFeed } from "./ChangeFeed.js";
+import { SegmentFactory } from "./SegmentFactory.js";
+import type { BlobChangeFeedListChangesOptions } from "./models/models.js";
 export declare class ChangeFeedFactory {
     private readonly segmentFactory;
     private readonly maxTransferSize?;

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeFeedFactory.d.ts","sourceRoot":"","sources":["../../src/ChangeFeedFactory.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAmB,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAa7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAKrD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAe3E,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAS;gBAE9B,eAAe,CAAC,EAAE,MAAM;gBACxB,cAAc,EAAE,cAAc;IA0B1C,OAAO,CAAC,MAAM,CAAC,cAAc;IAShB,MAAM,CACjB,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,CAAC,EAAE,MAAM,EAC1B,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,UAAU,CAAC;CA0GvB"}