@azure/storage-blob-changefeed 12.0.0-preview.3 → 12.0.0-preview.5

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

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { AvroReadableFromStream } from "../../../storage-internal-avro/src";
+// Licensed under the MIT License.
+import { AvroReadableFromStream } from "@azure/storage-internal-avro";
 /**
  * Read body from downloading operation methods to string.
  * Works in both Node.js and browsers.

package/dist/browser/utils/utils.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.node.js","sourceRoot":"","sources":["../../../src/utils/utils.node.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAGC,EACD,MAAe;IAEf,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC7C,QAAQ,CAAC,kBAAmB,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,kBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxD,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,kBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACjD,QAAQ,CAAC,kBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAC1C,OAAO,CAAC,EAAE,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,cAAqC;IACxE,OAAO,IAAI,sBAAsB,CAAC,cAAc,CAAC,CAAC;AACpD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AvroReadable } from \"@azure/storage-internal-avro\";\nimport { AvroReadableFromStream } from \"@azure/storage-internal-avro\";\n\n/**\n * Read body from downloading operation methods to string.\n * Works in both Node.js and browsers.\n *\n * @param response - Convenience layer methods response with downloaded body\n * @param length - Length of Readable stream, needed for Node.js environment\n */\nexport async function bodyToString(\n  response: {\n    readableStreamBody?: NodeJS.ReadableStream;\n    blobBody?: Promise<Blob>;\n  },\n  length?: number,\n): Promise<string> {\n  return new Promise<string>((resolve, reject) => {\n    response.readableStreamBody!.on(\"readable\", () => {\n      const chunk = response.readableStreamBody!.read(length);\n      if (chunk) {\n        resolve(chunk.toString());\n      }\n    });\n\n    response.readableStreamBody!.on(\"error\", reject);\n    response.readableStreamBody!.on(\"end\", () => {\n      resolve(\"\");\n    });\n  });\n}\n\nexport function streamToAvroReadable(readableStream: NodeJS.ReadableStream): AvroReadable {\n  return new AvroReadableFromStream(readableStream);\n}\n"]}

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

@@ -1,4 +1,5 @@
-import { AvroReadable, 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/commonjs/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/commonjs/AvroReaderFactory.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvroReaderFactory = void 0;
+const storage_internal_avro_1 = require("@azure/storage-internal-avro");
+/**
+ * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
+ */
+class AvroReaderFactory {
+    create(dataStream, headerStream, blockOffset, eventIndex) {
+        if (headerStream) {
+            return new storage_internal_avro_1.AvroReader(dataStream, headerStream, blockOffset, eventIndex);
+        }
+        else {
+            return new storage_internal_avro_1.AvroReader(dataStream);
+        }
+    }
+}
+exports.AvroReaderFactory = AvroReaderFactory;
+//# sourceMappingURL=AvroReaderFactory.js.map

package/dist/commonjs/AvroReaderFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.js","sourceRoot":"","sources":["../../src/AvroReaderFactory.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,wEAA0D;AAE1D;;GAEG;AACH,MAAa,iBAAiB;IAUrB,MAAM,CACX,UAAwB,EACxB,YAA2B,EAC3B,WAAoB,EACpB,UAAmB;QAEnB,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,kCAAU,CAAC,UAAU,EAAE,YAAY,EAAE,WAAY,EAAE,UAAW,CAAC,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,kCAAU,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;CACF;AAtBD,8CAsBC","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/dist/commonjs/BlobChangeFeedClient.d.ts

@@ -0,0 +1,201 @@
+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.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.
+ */
+export declare class BlobChangeFeedEventPage {
+    /**
+     * Array of {@link BlobChangeFeedEvent}.
+     */
+    events: BlobChangeFeedEvent[];
+    /**
+     * The token that keeps track of where to continue the iterator.
+     */
+    continuationToken: string;
+    constructor();
+}
+/**
+ * Creates a new Pipeline object with Credential provided.
+ *
+ * @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.
+ * @param pipelineOptions - Optional. Options.
+ * @returns A new Pipeline object.
+ */
+export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
+/**
+ * Blob Change Feed client options.
+ */
+export interface BlobChangeFeedClientOptions {
+    /**
+     * The maximum length of an transfer in bytes.
+     */
+    maximumTransferSize?: number;
+}
+/**
+ * BlobChangeFeedClient.
+ * @see https://learn.microsoft.com/azure/storage/blobs/storage-blob-change-feed?tabs=azure-portal
+ */
+export declare class BlobChangeFeedClient {
+    /**
+     * blobServiceClient provided by `@azure/storage-blob` package.
+     */
+    private blobServiceClient;
+    private changeFeedFactory;
+    private changeFeedClientOptions;
+    /**
+     *
+     * Creates an instance of BlobChangeFeedClient from connection string.
+     *
+     * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
+     *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
+     *                                  Account connection string example -
+     *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
+     *                                  SAS connection string example -
+     *                                  `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`
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    static fromConnectionString(connectionString: string, options?: StoragePipelineOptions, changeFeedClientOptions?: BlobChangeFeedClientOptions): BlobChangeFeedClient;
+    /**
+     * Creates an instance of BlobChangeFeedClient.
+     *
+     * @param url - A Client string pointing to Azure Storage blob service, such as
+     *                     "https://myaccount.blob.core.windows.net". You can append a SAS
+     *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
+     * @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.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     *
+     * Example using DefaultAzureCredential from `@azure/identity`:
+     *
+     * ```ts snippet:ReadmeSampleCreateClient_TokenCredential
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
+     *
+     * // 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`,
+     *   credential,
+     * );
+     * ```
+     *
+     * Example using an account name/key:
+     *
+     * ```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,
+     * );
+     * ```
+     */
+    constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions, changeFeedClientOptions?: BlobChangeFeedClientOptions);
+    /**
+     * Creates an instance of BlobChangeFeedClient.
+     *
+     * @param url - A Client string pointing to Azure Storage blob service, such as
+     *                     "https://myaccount.blob.core.windows.net". You can append a SAS
+     *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
+     * @param pipeline - Call newPipeline() to create a default
+     *                            pipeline, or provide a customized pipeline.
+     */
+    constructor(url: string, pipeline: Pipeline);
+    private getChange;
+    private getPage;
+    /**
+     * Returns an async iterable iterator to list all the change feed events
+     * in the specified account.
+     *
+     * .byPage() returns an async iterable iterator to list the change feed events in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListChanges
+     * 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,
+     * );
+     *
+     * // 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)}`);
+     * }
+     *
+     * // 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:
+     *
+     * ```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,
+     * );
+     *
+     * 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)}`);
+     *   }
+     * }
+     * ```
+     *
+     * @param options - Options to list change feed events.
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listChanges(options?: BlobChangeFeedListChangesOptions): PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage>;
+}
+//# sourceMappingURL=BlobChangeFeedClient.d.ts.map

package/dist/commonjs/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/commonjs/BlobChangeFeedClient.js

@@ -0,0 +1,248 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlobChangeFeedClient = exports.BlobChangeFeedEventPage = void 0;
+exports.newPipeline = newPipeline;
+const storage_blob_1 = require("@azure/storage-blob");
+const ChangeFeedFactory_js_1 = require("./ChangeFeedFactory.js");
+const constants_js_1 = require("./utils/constants.js");
+/**
+ * Contains paged response data for the {@link BlobChangeFeedClient.listChanges} operation.
+ */
+class BlobChangeFeedEventPage {
+    /**
+     * Array of {@link BlobChangeFeedEvent}.
+     */
+    events;
+    /**
+     * The token that keeps track of where to continue the iterator.
+     */
+    continuationToken;
+    constructor() {
+        this.events = [];
+        this.continuationToken = "";
+    }
+}
+exports.BlobChangeFeedEventPage = BlobChangeFeedEventPage;
+/**
+ * Creates a new Pipeline object with Credential provided.
+ *
+ * @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.
+ * @param pipelineOptions - Optional. Options.
+ * @returns A new Pipeline object.
+ */
+function newPipeline(credential, pipelineOptions = {}) {
+    return newPipeline(credential, appendUserAgentPrefix(pipelineOptions));
+}
+function appendUserAgentPrefix(options) {
+    if (!options) {
+        options = {};
+    }
+    if (options.userAgentOptions === undefined) {
+        options.userAgentOptions = {};
+    }
+    if (options.userAgentOptions.userAgentPrefix === undefined) {
+        options.userAgentOptions.userAgentPrefix = "";
+    }
+    else if (options.userAgentOptions.userAgentPrefix !== "") {
+        options.userAgentOptions.userAgentPrefix += " ";
+    }
+    options.userAgentOptions.userAgentPrefix += `changefeed-js/${constants_js_1.SDK_VERSION}`;
+    return options;
+}
+/**
+ * BlobChangeFeedClient.
+ * @see https://learn.microsoft.com/azure/storage/blobs/storage-blob-change-feed?tabs=azure-portal
+ */
+class BlobChangeFeedClient {
+    /**
+     * blobServiceClient provided by `@azure/storage-blob` package.
+     */
+    blobServiceClient;
+    changeFeedFactory;
+    changeFeedClientOptions;
+    /**
+     *
+     * Creates an instance of BlobChangeFeedClient from connection string.
+     *
+     * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
+     *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
+     *                                  Account connection string example -
+     *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
+     *                                  SAS connection string example -
+     *                                  `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`
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    static fromConnectionString(connectionString, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options, 
+    // Static method to construct an object, the option is for the object not for the method.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    changeFeedClientOptions) {
+        const blobServiceClient = storage_blob_1.BlobServiceClient.fromConnectionString(connectionString, options);
+        return new BlobChangeFeedClient(blobServiceClient.url, blobServiceClient.credential, appendUserAgentPrefix(options), changeFeedClientOptions);
+    }
+    constructor(urlOrClient, credentialOrPipeline, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options, changeFeedClientOptions) {
+        this.changeFeedClientOptions = changeFeedClientOptions || {};
+        this.changeFeedFactory = new ChangeFeedFactory_js_1.ChangeFeedFactory(this.changeFeedClientOptions.maximumTransferSize);
+        if (credentialOrPipeline instanceof storage_blob_1.Pipeline) {
+            this.blobServiceClient = new storage_blob_1.BlobServiceClient(urlOrClient, credentialOrPipeline);
+        }
+        else {
+            this.blobServiceClient = new storage_blob_1.BlobServiceClient(urlOrClient, credentialOrPipeline, appendUserAgentPrefix(options));
+        }
+    }
+    async *getChange(options = {}) {
+        const changeFeed = await this.changeFeedFactory.create(this.blobServiceClient, undefined, options);
+        while (changeFeed.hasNext()) {
+            const event = await changeFeed.getChange({
+                abortSignal: options.abortSignal,
+                tracingOptions: options.tracingOptions,
+            });
+            if (event) {
+                yield event;
+            }
+            else {
+                return;
+            }
+        }
+    }
+    // start in ChangeFeedListChangesOptions will be ignored when continuationToken is specified.
+    async *getPage(continuationToken, maxPageSize, options = {}) {
+        const changeFeed = await this.changeFeedFactory.create(this.blobServiceClient, continuationToken, options);
+        if (!maxPageSize || maxPageSize > constants_js_1.CHANGE_FEED_MAX_PAGE_SIZE) {
+            maxPageSize = constants_js_1.CHANGE_FEED_MAX_PAGE_SIZE;
+        }
+        while (changeFeed.hasNext()) {
+            const eventPage = new BlobChangeFeedEventPage();
+            while (changeFeed.hasNext() && eventPage.events.length < maxPageSize) {
+                const event = await changeFeed.getChange({
+                    abortSignal: options.abortSignal,
+                    tracingOptions: options.tracingOptions,
+                });
+                if (event) {
+                    eventPage.events.push(event);
+                }
+            }
+            if (changeFeed.hasNext()) {
+                eventPage.continuationToken = JSON.stringify(changeFeed.getCursor());
+            }
+            if (eventPage.events.length > 0) {
+                yield eventPage;
+            }
+            else {
+                return;
+            }
+        }
+    }
+    /**
+     * Returns an async iterable iterator to list all the change feed events
+     * in the specified account.
+     *
+     * .byPage() returns an async iterable iterator to list the change feed events in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListChanges
+     * 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,
+     * );
+     *
+     * // 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)}`);
+     * }
+     *
+     * // 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:
+     *
+     * ```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,
+     * );
+     *
+     * 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)}`);
+     *   }
+     * }
+     * ```
+     *
+     * @param options - Options to list change feed events.
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listChanges(options = {}) {
+        const iter = this.getChange(options);
+        return {
+            /**
+             * The next method, part of the iteration protocol
+             */
+            async next() {
+                return iter.next();
+            },
+            /**
+             * The connection to the async iterator, part of the iteration protocol
+             */
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            /**
+             * Return an AsyncIterableIterator that works a page at a time
+             */
+            byPage: (settings = {}) => {
+                return this.getPage(settings.continuationToken, settings.maxPageSize, options);
+            },
+        };
+    }
+}
+exports.BlobChangeFeedClient = BlobChangeFeedClient;
+//# sourceMappingURL=BlobChangeFeedClient.js.map

package/dist/commonjs/BlobChangeFeedClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobChangeFeedClient.js","sourceRoot":"","sources":["../../src/BlobChangeFeedClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AA2ClC,kCAKC;AAzCD,sDAAkE;AAGlE,iEAA2D;AAE3D,uDAA8E;AAI9E;;GAEG;AACH,MAAa,uBAAuB;IAClC;;OAEG;IACI,MAAM,CAAwB;IAErC;;OAEG;IACI,iBAAiB,CAAS;IAEjC;QACE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;CACF;AAfD,0DAeC;AAED;;;;;;GAMG;AACH,SAAgB,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,0BAAW,EAAE,CAAC;IAC3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAYD;;;GAGG;AACH,MAAa,oBAAoB;IAC/B;;OAEG;IACK,iBAAiB,CAAoB;IACrC,iBAAiB,CAAoB;IACrC,uBAAuB,CAA8B;IAE7D;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,oBAAoB,CAChC,gBAAwB;IACxB,2FAA2F;IAC3F,iEAAiE;IACjE,OAAgC;IAChC,yFAAyF;IACzF,iEAAiE;IACjE,uBAAqD;QAErD,MAAM,iBAAiB,GAAG,gCAAiB,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,wCAAiB,CAC5C,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CACjD,CAAC;QAEF,IAAI,oBAAoB,YAAY,uBAAQ,EAAE,CAAC;YAC7C,IAAI,CAAC,iBAAiB,GAAG,IAAI,gCAAiB,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,iBAAiB,GAAG,IAAI,gCAAiB,CAC5C,WAAW,EACX,oBAAoB,EACpB,qBAAqB,CAAC,OAAO,CAAC,CAC/B,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,CAAC,SAAS,CACtB,UAA4C,EAAE;QAE9C,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAChE,IAAI,CAAC,iBAAiB,EACtB,SAAS,EACT,OAAO,CACR,CAAC;QAEF,OAAO,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC;gBACvC,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;aACvC,CAAC,CAAC;YACH,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO;YACT,CAAC;QACH,CAAC;IACH,CAAC;IAED,6FAA6F;IACrF,KAAK,CAAC,CAAC,OAAO,CACpB,iBAA0B,EAC1B,WAAoB,EACpB,UAA4C,EAAE;QAE9C,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAChE,IAAI,CAAC,iBAAiB,EACtB,iBAAiB,EACjB,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,WAAW,IAAI,WAAW,GAAG,wCAAyB,EAAE,CAAC;YAC5D,WAAW,GAAG,wCAAyB,CAAC;QAC1C,CAAC;QACD,OAAO,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,IAAI,uBAAuB,EAAE,CAAC;YAChD,OAAO,UAAU,CAAC,OAAO,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;gBACrE,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC;oBACvC,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;iBACvC,CAAC,CAAC;gBACH,IAAI,KAAK,EAAE,CAAC;oBACV,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;YACD,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;gBACzB,SAAS,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChC,MAAM,SAAS,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,OAAO;YACT,CAAC;QACH,CAAC;IACH,CAAC;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;AArSD,oDAqSC","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/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/commonjs}/ChangeFeed.d.ts

@@ -1,9 +1,9 @@
-import { ContainerClient, CommonOptions } from "@azure/storage-blob";
-import { Segment } from "./Segment";
-import { SegmentFactory } from "./SegmentFactory";
-import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
-import { ChangeFeedCursor } from "./models/ChangeFeedCursor";
-import { AbortSignalLike } from "@azure/core-http";
+import type { ContainerClient, CommonOptions } from "@azure/storage-blob";
+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/commonjs/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"}