@azure/storage-blob-changefeed 12.0.0-alpha.20220105.6 → 12.0.0-alpha.20220119.1

package/README.md

@@ -12,6 +12,7 @@ Use the client libraries in this package to:
 - Resuming reading events from a saved position
 
 Key links:
+
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed)
 - [Package (npm)](https://www.npmjs.com/package/@azure/storage-blob-changefeed/)
 - [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-blob-changefeed)
@@ -29,7 +30,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 
 ### Prerequisites
 
-- An [Azure subscription](https://azure.microsoft.com/free/) 
+- An [Azure subscription](https://azure.microsoft.com/free/)
 - A [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal)
 
 ### Install the package
@@ -166,8 +167,8 @@ setLogLevel("info");
 
 More code samples:
 
-- [Blob Storage Change Feed Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/samples/javascript)
-- [Blob Storage Change Feed Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/samples/typescript)
+- [Blob Storage Change Feed Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/samples/v12-beta/javascript)
+- [Blob Storage Change Feed Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/samples/v12-beta/typescript)
 - [Blob Storage Change Feed Test Cases](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/test/)
 
 ## Contributing

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/storage-blob-changefeed",
   "sdk-type": "client",
-  "version": "12.0.0-alpha.20220105.6",
+  "version": "12.0.0-alpha.20220119.1",
   "description": "Microsoft Azure Storage SDK for JavaScript - Blob Change Feed",
   "main": "./dist/index.js",
   "module": "./dist-esm/storage-blob-changefeed/src/index.js",
@@ -12,11 +12,11 @@
     "os": false,
     "process": false
   },
-  "types": "./typings/latest/storage-blob-changefeed.d.ts",
+  "types": "./types/latest/storage-blob-changefeed.d.ts",
   "typesVersions": {
     "<3.6": {
       "*": [
-        "./typings/3.1/storage-blob-changefeed.d.ts"
+        "./types/3.1/storage-blob-changefeed.d.ts"
       ]
     }
   },
@@ -26,17 +26,17 @@
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
     "build:es6": "tsc -p tsconfig.json",
-    "build:samples": "cross-env ONLY_NODE=true npm run build && npm run build:prep-samples",
+    "build:samples": "echo Obsolete.",
     "build:prep-samples": "dev-tool samples prep && cd dist-samples && tsc",
     "build:test": "npm run build:es6 && rollup -c 2>&1",
-    "build:types": "downlevel-dts typings/latest typings/3.1",
+    "build:types": "downlevel-dts types/latest types/3.1",
     "build": "npm run clean && npm run build:es6 && rollup -c 2>&1 && api-extractor run --local && npm run build:types",
-    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
-    "clean": "rimraf dist dist-* typings temp statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
-    "clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-* types temp statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "clean:samples": "rimraf samples/v12-beta/javascript/node_modules samples/v12-beta/typescript/node_modules samples/v12-beta/typescript/dist samples/v12-beta/typescript/package-lock.json samples/v12-beta/javascript/package-lock.json",
     "extract-api": "tsc -p . && api-extractor run --local",
-    "execute:samples": "npm run build:samples && dev-tool samples run dist-samples/javascript dist-samples/typescript/dist/storage-blob-changefeed/dist-samples/typescript/src/",
-    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "execute:samples": "dev-tool samples run samples-dev",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "integration-test:browser": "karma start --single-run",
     "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000  \"dist-esm/storage-blob-changefeed/test/*.spec.js\" \"dist-esm/storage-blob-changefeed/test/node/*.spec.js\"",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
@@ -58,8 +58,8 @@
     "dist-browser/",
     "dist-esm/storage-blob-changefeed/src/",
     "dist-esm/storage-internal-avro/src/",
-    "typings/latest/storage-blob-changefeed.d.ts",
-    "typings/3.1/storage-blob-changefeed.d.ts",
+    "types/latest/storage-blob-changefeed.d.ts",
+    "types/3.1/storage-blob-changefeed.d.ts",
     "README.md",
     "LICENSE"
   ],
@@ -116,7 +116,7 @@
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
-    "downlevel-dts": "~0.4.0",
+    "downlevel-dts": "^0.8.0",
     "es6-promise": "^4.2.5",
     "eslint": "^7.15.0",
     "esm": "^3.2.18",
@@ -154,6 +154,14 @@
     "sinon": "^9.0.2"
   },
   "//sampleConfiguration": {
-    "skipFolder": true
+    "skipFolder": true,
+    "productName": "Azure Storage Blob Change Feed",
+    "productSlugs": [
+      "azure",
+      "azure-storage"
+    ],
+    "requiredResources": {
+      "Azure Storage Account": "https://docs.microsoft.com/azure/storage/common/storage-account-overview"
+    }
   }
 }

package/types/3.1/storage-blob-changefeed/samples-dev/blobChangeFeedClient.d.ts

@@ -0,0 +1,2 @@
+export declare function main(): Promise<void>;
+//# sourceMappingURL=blobChangeFeedClient.d.ts.map

package/types/3.1/storage-blob-changefeed/samples-dev/resumeListChanges.d.ts

@@ -0,0 +1,2 @@
+export declare function main(): Promise<void>;
+//# sourceMappingURL=resumeListChanges.d.ts.map

package/types/3.1/storage-blob-changefeed/src/AvroReaderFactory.d.ts

@@ -0,0 +1,9 @@
+import { AvroReadable, AvroReader } from "../../storage-internal-avro/src";
+/**
+ * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
+ */
+export declare class AvroReaderFactory {
+    create(headerAndDataStream: AvroReadable): AvroReader;
+    create(dataStream: AvroReadable, headerStream: AvroReadable, blockOffset: number, eventIndex: number): AvroReader;
+}
+//# sourceMappingURL=AvroReaderFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/BlobChangeFeedClient.d.ts

@@ -0,0 +1,172 @@
+import { StoragePipelineOptions, StorageSharedKeyCredential, AnonymousCredential, Pipeline } from "@azure/storage-blob";
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
+import { BlobChangeFeedListChangesOptions } from "./models/models";
+import { TokenCredential } from "@azure/core-http";
+/**
+ * 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;
+/**
+ * BlobChangeFeedClient.
+ * @see https://docs.microsoft.com/en-us/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;
+    /**
+     *
+     * 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): 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`:
+     *
+     * ```js
+     * const account = "<storage account name>";
+     *
+     * const defaultAzureCredential = new DefaultAzureCredential();
+     *
+     * const blobChangeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   defaultAzureCredential
+     * );
+     * ```
+     *
+     * Example using an account name/key:
+     *
+     * ```js
+     * const account = "<storage account name>"
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
+     *
+     * const blobChangeFeedClient = new BlobChangeFeedClient(
+     *   `https://${account}.blob.core.windows.net`,
+     *   sharedKeyCredential
+     * );
+     * ```
+     */
+    constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
+    /**
+     * 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:
+     *
+     * ```js
+     * let i = 1;
+     * for await (const event of blobChangeFeedClient.listChanges()) {
+     *   console.log(`Event ${i++}, type: ${event.eventType}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```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();
+     * }
+     * ```
+     *
+     * 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}`);
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```js
+     * let i = 1;
+     * let iterator = blobChangeFeedClient.listChanges().byPage({ maxPageSize: 2 });
+     * let eventPage = (await iterator.next()).value;
+     *
+     * if (eventPage.events) {
+     *   for (const container of eventPage.events) {
+     *     console.log(`Event ${i++}, type: ${event.eventType}`);
+     *   }
+     * }
+     *
+     * // Gets next marker
+     * let marker = eventPage.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}`);
+     *   }
+     * }
+     * ```
+     *
+     * @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/types/3.1/storage-blob-changefeed/src/ChangeFeed.d.ts

@@ -0,0 +1,37 @@
+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";
+/**
+ * Options to configure {@link ChangeFeed.getChange} operation.
+ */
+export interface ChangeFeedGetChangeOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class ChangeFeed {
+    /**
+     * BlobContainerClient for making List Blob requests and creating Segments.
+     */
+    private readonly containerClient?;
+    private readonly segmentFactory?;
+    private readonly years;
+    private segments;
+    private currentSegment?;
+    private lastConsumable?;
+    private startTime?;
+    private endTime?;
+    private end?;
+    constructor();
+    constructor(containerClient: ContainerClient, segmentFactory: SegmentFactory, years: number[], segments: string[], currentSegment: Segment, lastConsumable: Date, startTime?: Date, endTime?: Date);
+    private advanceSegmentIfNecessary;
+    hasNext(): boolean;
+    getChange(options?: ChangeFeedGetChangeOptions): Promise<BlobChangeFeedEvent | undefined>;
+    getCursor(): ChangeFeedCursor;
+}
+//# sourceMappingURL=ChangeFeed.d.ts.map

package/types/3.1/storage-blob-changefeed/src/ChangeFeedFactory.d.ts

@@ -0,0 +1,12 @@
+import { BlobServiceClient } from "@azure/storage-blob";
+import { ChangeFeed } from "./ChangeFeed";
+import { SegmentFactory } from "./SegmentFactory";
+import { BlobChangeFeedListChangesOptions } from "./models/models";
+export declare class ChangeFeedFactory {
+    private readonly segmentFactory;
+    constructor();
+    constructor(segmentFactory: SegmentFactory);
+    private static validateCursor;
+    create(blobServiceClient: BlobServiceClient, continuationToken?: string, options?: BlobChangeFeedListChangesOptions): Promise<ChangeFeed>;
+}
+//# sourceMappingURL=ChangeFeedFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/Chunk.d.ts

@@ -0,0 +1,28 @@
+import { AvroReader } from "../../storage-internal-avro/src";
+import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
+import { CommonOptions } from "@azure/storage-blob";
+import { AbortSignalLike } from "@azure/core-http";
+import { AvroParseOptions } from "../../storage-internal-avro/src/AvroReader";
+/**
+ * Options to configure {@link Chunk.getChange} operation.
+ */
+export interface ChunkGetChangeOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class Chunk {
+    readonly chunkPath: string;
+    private readonly avroReader;
+    private readonly iter;
+    private _blockOffset;
+    readonly blockOffset: number;
+    private _eventIndex;
+    readonly eventIndex: number;
+    constructor(avroReader: AvroReader, blockOffset: number, eventIndex: number, chunkPath: string, avroOptions?: AvroParseOptions);
+    hasNext(): boolean;
+    getChange(): Promise<BlobChangeFeedEvent | undefined>;
+}
+//# sourceMappingURL=Chunk.d.ts.map

package/types/3.1/storage-blob-changefeed/src/ChunkFactory.d.ts

@@ -0,0 +1,22 @@
+import { AvroReaderFactory } from "./AvroReaderFactory";
+import { ContainerClient, CommonOptions } from "@azure/storage-blob";
+import { Chunk } from "./Chunk";
+import { AbortSignalLike } from "@azure/core-http";
+import { LazyLoadingBlobStreamFactory } from "./LazyLoadingBlobStreamFactory";
+/**
+ * Options to configure {@link ChunkFactory.create} operation.
+ */
+export interface CreateChunkOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class ChunkFactory {
+    private readonly avroReaderFactory;
+    private readonly lazyLoadingBlobStreamFactory;
+    constructor(avroReaderFactory: AvroReaderFactory, lazyLoadingBlobStreamFactory: LazyLoadingBlobStreamFactory);
+    create(containerClient: ContainerClient, chunkPath: string, blockOffset?: number, eventIndex?: number, options?: CreateChunkOptions): Promise<Chunk>;
+}
+//# sourceMappingURL=ChunkFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/LazyLoadingBlobStream.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+import { Readable, ReadableOptions } from "stream";
+import { BlobClient, CommonOptions } from "@azure/storage-blob";
+import { AbortSignalLike } from "@azure/core-http";
+/**
+ * Options to configure the LazyLoadingBlobStream.
+ */
+export interface LazyLoadingBlobStreamOptions extends ReadableOptions, CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+/**
+ * This class generates a readable stream from a blobClient's data.
+ */
+export declare class LazyLoadingBlobStream extends Readable {
+    /**
+     * BlobClient to make download calls with.
+     */
+    private readonly blobClient;
+    /**
+     * The offset within the blob of the next block we will download.
+     */
+    private offset;
+    private readonly blockSize;
+    private lastDownloadBytes;
+    private lastDownloadData?;
+    private blobLength;
+    private options?;
+    /**
+     * Creates an instance of LazyLoadingBlobStream.
+     *
+     * @param byteLength - The total length of data contained in the buffers
+     */
+    constructor(blobClient: BlobClient, offset: number, blockSize: number, options?: LazyLoadingBlobStreamOptions);
+    private downloadBlock;
+    /**
+     * Internal _read() that will be called when the stream wants to pull more data in.
+     *
+     * @param size - Optional. The size of data to be read
+     */
+    _read(size?: number): Promise<void>;
+}
+//# sourceMappingURL=LazyLoadingBlobStream.d.ts.map

package/types/3.1/storage-blob-changefeed/src/LazyLoadingBlobStreamFactory.d.ts

@@ -0,0 +1,6 @@
+import { BlobClient } from "@azure/storage-blob";
+import { LazyLoadingBlobStreamOptions, LazyLoadingBlobStream } from "./LazyLoadingBlobStream";
+export declare class LazyLoadingBlobStreamFactory {
+    create(blobClient: BlobClient, offset: number, blockSize: number, options?: LazyLoadingBlobStreamOptions): LazyLoadingBlobStream;
+}
+//# sourceMappingURL=LazyLoadingBlobStreamFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/Segment.d.ts

@@ -0,0 +1,29 @@
+import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
+import { Shard } from "./Shard";
+import { SegmentCursor } from "./models/ChangeFeedCursor";
+import { CommonOptions } from "@azure/storage-blob";
+import { AbortSignalLike } from "@azure/core-http";
+/**
+ * Options to configure {@link Segment.getChange} operation.
+ */
+export interface SegmentGetChangeOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class Segment {
+    private readonly manifestPath;
+    private readonly shards;
+    private shardDone;
+    private shardDoneCount;
+    private shardIndex;
+    private _dateTime;
+    readonly dateTime: Date;
+    constructor(shards: Shard[], shardIndex: number, dateTime: Date, manifestPath: string);
+    hasNext(): boolean;
+    getChange(options?: SegmentGetChangeOptions): Promise<BlobChangeFeedEvent | undefined>;
+    getCursor(): SegmentCursor;
+}
+//# sourceMappingURL=Segment.d.ts.map

package/types/3.1/storage-blob-changefeed/src/SegmentFactory.d.ts

@@ -0,0 +1,29 @@
+import { ShardFactory } from "./ShardFactory";
+import { ContainerClient, CommonOptions } from "@azure/storage-blob";
+import { Segment } from "./Segment";
+import { SegmentCursor } from "./models/ChangeFeedCursor";
+import { AbortSignalLike } from "@azure/core-http";
+export interface SegmentManifest {
+    version?: number;
+    begin?: Date;
+    intervalSecs?: number;
+    status: string;
+    config?: any;
+    chunkFilePaths: string[];
+}
+/**
+ * Options to configure {@link SegmentFactory.create} operation.
+ */
+export interface CreateSegmentOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class SegmentFactory {
+    private readonly shardFactory;
+    constructor(shardFactory: ShardFactory);
+    create(containerClient: ContainerClient, manifestPath: string, cursor?: SegmentCursor, options?: CreateSegmentOptions): Promise<Segment>;
+}
+//# sourceMappingURL=SegmentFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/Shard.d.ts

@@ -0,0 +1,28 @@
+import { ContainerClient, CommonOptions } from "@azure/storage-blob";
+import { ChunkFactory } from "./ChunkFactory";
+import { Chunk } from "./Chunk";
+import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
+import { ShardCursor } from "./models/ChangeFeedCursor";
+import { AbortSignalLike } from "@azure/core-http";
+/**
+ * Options to configure {@link Shard.getChange} operation.
+ */
+export interface ShardGetChangeOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class Shard {
+    readonly shardPath: string;
+    private readonly containerClient;
+    private readonly chunkFactory;
+    private readonly chunks;
+    private currentChunk;
+    constructor(containerClient: ContainerClient, chunkFactory: ChunkFactory, chunks: string[], currentChunk: Chunk | undefined, shardPath: string);
+    hasNext(): boolean;
+    getChange(options?: ShardGetChangeOptions): Promise<BlobChangeFeedEvent | undefined>;
+    getCursor(): ShardCursor | undefined;
+}
+//# sourceMappingURL=Shard.d.ts.map

package/types/3.1/storage-blob-changefeed/src/ShardFactory.d.ts

@@ -0,0 +1,21 @@
+import { ChunkFactory } from "./ChunkFactory";
+import { ShardCursor } from "./models/ChangeFeedCursor";
+import { Shard } from "./Shard";
+import { ContainerClient, CommonOptions } from "@azure/storage-blob";
+import { AbortSignalLike } from "@azure/core-http";
+/**
+ * Options to configure {@link ShardFactory.create} operation.
+ */
+export interface CreateShardOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+export declare class ShardFactory {
+    private readonly chunkFactory;
+    constructor(chunkFactory: ChunkFactory);
+    create(containerClient: ContainerClient, shardPath: string, shardCursor?: ShardCursor, options?: CreateShardOptions): Promise<Shard>;
+}
+//# sourceMappingURL=ShardFactory.d.ts.map

package/types/3.1/storage-blob-changefeed/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./BlobChangeFeedClient";
+export * from "./models/BlobChangeFeedEvent";
+export * from "./models/models";
+//# sourceMappingURL=index.d.ts.map

package/types/3.1/storage-blob-changefeed/src/log.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The `@azure/logger` configuration for this package.
+ */
+export declare const logger: import("@azure/logger").AzureLogger;
+//# sourceMappingURL=log.d.ts.map