@azure/storage-blob-changefeed 12.0.0-alpha.20220111.2 → 12.0.0-alpha.20220113.3

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

@@ -0,0 +1,94 @@
+/**
+ * Change feed event record types.
+ */
+export declare type BlobChangeFeedEventType = "UnspecifiedEventType" | "BlobCreated" | "BlobDeleted" | "BlobPropertiesUpdated" | "BlobSnapshotCreated" | "Control" | "BlobTierChanged" | "BlobAsyncOperationInitiated" | "BlobMetadataUpdated";
+/**
+ * Change feed event record. Contains response data for the {@link BlobChangeFeedClient.listChanges} operation.
+ * @see https://docs.microsoft.com/en-us/azure/event-grid/event-schema-blob-storage?toc=/azure/storage/blobs/toc.json#event-properties
+ */
+export interface BlobChangeFeedEvent {
+    /**
+     * Full resource path to the event source. This field is not writeable. Event Grid provides this value.
+     */
+    topic: string;
+    /**
+     * Publisher-defined path to the event subject.
+     */
+    subject: string;
+    /**
+     * One of the registered event types for this event source.
+     */
+    eventType: BlobChangeFeedEventType;
+    /**
+     * The time the event is generated based on the provider's UTC time.
+     */
+    eventTime: Date;
+    /**
+     * Unique identifier for the event.
+     */
+    id: string;
+    /**
+     * Blob storage event data.
+     */
+    data: BlobChangeFeedEventData;
+    /**
+     * The schema version of the data object. The publisher defines the schema version.
+     */
+    dataVersion?: string;
+    /**
+     * The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.
+     */
+    metadataVersion: string;
+}
+/**
+ * The type of blob.
+ */
+export declare type BlobType = "BlockBlob" | "AppendBlob" | "PageBlob";
+/**
+ * Change feed Blob storage event data.
+ */
+export interface BlobChangeFeedEventData {
+    /**
+     * The operation that triggered the event.
+     */
+    api: string;
+    /**
+     * A client-provided request id for the storage API operation. This id can be used to
+     * correlate to Azure Storage diagnostic logs using the "client-request-id" field in the logs,
+     * and can be provided in client requests using the "x-ms-client-request-id" header.
+     */
+    clientRequestId: string;
+    /**
+     * Service-generated request id for the storage API operation. Can be used to correlate to Azure Storage
+     * diagnostic logs using the "request-id-header" field in the logs and is returned from initiating API call
+     * in the 'x-ms-request-id' header.
+     */
+    requestId: string;
+    /**
+     * The value that you can use to perform operations conditionally.
+     */
+    etag: string;
+    /**
+     * The content type specified for the blob.
+     */
+    contentType: string;
+    /**
+     * The size of the blob in bytes.
+     */
+    contentLength: number;
+    /**
+     * The type of blob.
+     */
+    blobType: BlobType;
+    /**
+     * The path to the blob. If the client uses a Blob REST API, then the url has this structure:
+     * <storage-account-name>.blob.core.windows.net/<container-name>/<file-name>.
+     */
+    url: string;
+    /**
+     * An opaque string value representing the logical sequence of events for any particular blob name.
+     * Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
+     */
+    sequencer: string;
+}
+//# sourceMappingURL=BlobChangeFeedEvent.d.ts.map

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

@@ -0,0 +1,17 @@
+export interface ChangeFeedCursor {
+    CursorVersion: number;
+    UrlHost: string;
+    EndTime?: string;
+    CurrentSegmentCursor: SegmentCursor;
+}
+export interface SegmentCursor {
+    ShardCursors: ShardCursor[];
+    CurrentShardPath: string;
+    SegmentPath: string;
+}
+export interface ShardCursor {
+    CurrentChunkPath: string;
+    BlockOffset: number;
+    EventIndex: number;
+}
+//# sourceMappingURL=ChangeFeedCursor.d.ts.map

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

@@ -0,0 +1,23 @@
+import { CommonOptions } from "@azure/storage-blob";
+import { AbortSignalLike } from "@azure/core-http";
+/**
+ * Options to configure {@link BlobChangeFeedClient.listChanges} operation.
+ */
+export interface BlobChangeFeedListChangesOptions 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;
+    /**
+     * Specify the start of the time range during which the change feed records will be fetched.
+     * Note that for now the change feed client will round start time down to the nearest hour.
+     */
+    start?: Date;
+    /**
+     * Specify the end of the time range during which the change feed records will be fetched.
+     * Note that for now the change feed client will round end time up to the nearest hour.
+     */
+    end?: Date;
+}
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1,9 @@
+export declare const SDK_VERSION: string;
+export declare const CHANGE_FEED_CONTAINER_NAME: string;
+export declare const CHANGE_FEED_META_SEGMENT_PATH: string;
+export declare const CHANGE_FEED_STATUS_FINALIZED: string;
+export declare const CHANGE_FEED_SEGMENT_PREFIX: string;
+export declare const CHANGE_FEED_INITIALIZATION_SEGMENT: string;
+export declare const CHANGE_FEED_MAX_PAGE_SIZE: number;
+export declare const CHANGE_FEED_CHUNK_BLOCK_DOWNLOAD_SIZE: number;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1,11 @@
+/**
+ * Creates a span using the global tracer.
+ * @internal
+ */
+export declare const createSpan: <T extends {
+    tracingOptions?: import("@azure/core-tracing").OperationTracingOptions | undefined;
+}>(operationName: string, operationOptions: T | undefined) => {
+    span: import("@azure/core-tracing").Span;
+    updatedOptions: T;
+};
+//# sourceMappingURL=tracing.d.ts.map

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

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+/**
+ * Read body from downloading operation methods to string.
+ * Works in both Node.js and browsers.
+ *
+ * @param response - Convenience layer methods response with downloaded body
+ * @param length - Length of Readable stream, needed for Node.js environment
+ */
+export declare function bodyToString(response: {
+    readableStreamBody?: NodeJS.ReadableStream;
+    blobBody?: Promise<Blob>;
+}, _length?: number): Promise<string>;
+export declare function blobToString(blob: Blob): Promise<string>;
+export declare function bodyToAvroReadable(): void;
+//# sourceMappingURL=utils.browser.d.ts.map

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

@@ -0,0 +1,42 @@
+import { AbortSignalLike } from "@azure/core-http";
+import { ContainerClient, CommonOptions } from "@azure/storage-blob";
+export declare function ceilToNearestHour(date: Date | undefined): Date | undefined;
+export declare function floorToNearestHour(date: Date | undefined): Date | undefined;
+/**
+ * Get host from an URL string.
+ *
+ * @param url - Source URL string
+ */
+export declare function getHost(url: string): string | undefined;
+/**
+ * Get URI from an URL string.
+ *
+ * @param url - Source URL string
+ */
+export declare function getURI(url: string): string;
+export declare function hashString(str: string): number;
+/**
+ * Options to configure {@link getYearsPaths} operation.
+ */
+export interface GetYearsPathsOptions 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 function getYearsPaths(containerClient: ContainerClient, options?: GetYearsPathsOptions): Promise<number[]>;
+/**
+ * Options to configure {@link getSegmentsInYear} operation.
+ */
+export interface GetSegmentsInYearOptions extends 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;
+}
+export declare function getSegmentsInYear(containerClient: ContainerClient, year: number, startTime?: Date, endTime?: Date, options?: GetSegmentsInYearOptions): Promise<string[]>;
+export declare function parseDateFromSegmentPath(segmentPath: string): Date;
+export declare function minDate(dateA: Date, dateB?: Date): Date;
+//# sourceMappingURL=utils.common.d.ts.map

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

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { AvroReadable } from "../../../storage-internal-avro/src";
+/**
+ * Read body from downloading operation methods to string.
+ * Works in both Node.js and browsers.
+ *
+ * @param response - Convenience layer methods response with downloaded body
+ * @param length - Length of Readable stream, needed for Node.js environment
+ */
+export declare function bodyToString(response: {
+    readableStreamBody?: NodeJS.ReadableStream;
+    blobBody?: Promise<Blob>;
+}, length?: number): Promise<string>;
+export declare function streamToAvroReadable(readableStream: NodeJS.ReadableStream): AvroReadable;
+//# sourceMappingURL=utils.node.d.ts.map

package/types/3.1/storage-blob-changefeed/test/blobchangefeedclient.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=blobchangefeedclient.spec.d.ts.map

package/types/3.1/storage-blob-changefeed/test/changefeed.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=changefeed.spec.d.ts.map

package/types/3.1/storage-blob-changefeed/test/chunk.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=chunk.spec.d.ts.map

package/types/3.1/storage-blob-changefeed/test/segment.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=segment.spec.d.ts.map

package/types/3.1/storage-blob-changefeed/test/shard.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shard.spec.d.ts.map

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

@@ -0,0 +1,13 @@
+import { StorageSharedKeyCredential, BlobServiceClient } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "../../src";
+import { TokenCredential } from "@azure/core-http";
+export * from "./testutils.common";
+export declare function getGenericCredential(accountType: string): StorageSharedKeyCredential;
+export declare function getGenericBSU(accountType: string, accountNameSuffix?: string): BlobServiceClient;
+export declare function getTokenCredential(): TokenCredential;
+export declare function getTokenBSU(): BlobServiceClient;
+export declare function getBSU(): BlobServiceClient;
+export declare function getAlternateBSU(): BlobServiceClient;
+export declare function getConnectionStringFromEnvironment(): string;
+export declare function getBlobChangeFeedClient(accountType?: string, accountNameSuffix?: string): BlobChangeFeedClient;
+//# sourceMappingURL=index.d.ts.map

package/types/3.1/storage-blob-changefeed/test/utils/testutils.common.d.ts

@@ -0,0 +1,56 @@
+import { TokenCredential, GetTokenOptions, AccessToken } from "@azure/core-http";
+import { RecorderEnvironmentSetup } from "@azure-tools/test-recorder";
+export declare const testPollerProperties: {
+    intervalInMs: number | undefined;
+};
+export declare const recorderEnvSetup: RecorderEnvironmentSetup;
+/**
+ * A TokenCredential that always returns the given token. This class can be
+ * used when the access token is already known or can be retrieved from an
+ * outside source.
+ */
+export declare class SimpleTokenCredential implements TokenCredential {
+    /**
+     * The raw token string.  Can be changed when the token needs to be updated.
+     */
+    token: string;
+    /**
+     * The Date at which the token expires.  Can be changed to update the expiration time.
+     */
+    expiresOn: Date;
+    /**
+     * Creates an instance of TokenCredential.
+     * @param token -
+     */
+    constructor(token: string, expiresOn?: Date);
+    /**
+     * Retrieves the token stored in this RawTokenCredential.
+     *
+     * @param _scopes - Ignored since token is already known.
+     * @param _options - Ignored since token is already known.
+     * @returns The access token details.
+     */
+    getToken(_scopes: string | string[], _options?: GetTokenOptions): Promise<AccessToken | null>;
+}
+export declare function isBrowser(): boolean;
+export declare function getUniqueName(prefix: string): string;
+export declare function base64encode(content: string): string;
+export declare function base64decode(encodedString: string): string;
+declare type BlobMetadata = {
+    [propertyName: string]: string;
+};
+/**
+ * Validate if m1 is super set of m2.
+ *
+ * @param m1 - BlobMetadata
+ * @param m2 - BlobMetadata
+ */
+export declare function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean;
+/**
+ * Sleep for seconds.
+ *
+ * @param seconds -
+ */
+export declare function sleep(seconds: number): Promise<void>;
+export {};
+//# sourceMappingURL=testutils.common.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroConstants.d.ts

@@ -0,0 +1,5 @@
+export declare const AVRO_SYNC_MARKER_SIZE: number;
+export declare const AVRO_INIT_BYTES: Uint8Array;
+export declare const AVRO_CODEC_KEY: string;
+export declare const AVRO_SCHEMA_KEY: string;
+//# sourceMappingURL=AvroConstants.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroParser.d.ts

@@ -0,0 +1,57 @@
+import { AvroReadable } from "./AvroReadable";
+import { AbortSignalLike } from "@azure/abort-controller";
+/**
+ * Options to configure the AvroParser read methods.
+ * See {@link AvroParser.readFixedBytes}, {@link AvroParser.readMap} and etc.
+ */
+interface AvroParserReadOptions {
+    /**
+     * 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 AvroParser {
+    /**
+     * Reads a fixed number of bytes from the stream.
+     *
+     * @param stream -
+     * @param length -
+     * @param options -
+     */
+    static readFixedBytes(stream: AvroReadable, length: number, options?: AvroParserReadOptions): Promise<Uint8Array>;
+    /**
+     * Reads a single byte from the stream.
+     *
+     * @param stream -
+     * @param options -
+     */
+    private static readByte;
+    private static readZigZagLong;
+    static readLong(stream: AvroReadable, options?: AvroParserReadOptions): Promise<number>;
+    static readInt(stream: AvroReadable, options?: AvroParserReadOptions): Promise<number>;
+    static readNull(): Promise<null>;
+    static readBoolean(stream: AvroReadable, options?: AvroParserReadOptions): Promise<boolean>;
+    static readFloat(stream: AvroReadable, options?: AvroParserReadOptions): Promise<number>;
+    static readDouble(stream: AvroReadable, options?: AvroParserReadOptions): Promise<number>;
+    static readBytes(stream: AvroReadable, options?: AvroParserReadOptions): Promise<Uint8Array>;
+    static readString(stream: AvroReadable, options?: AvroParserReadOptions): Promise<string>;
+    private static readMapPair;
+    static readMap<T>(stream: AvroReadable, readItemMethod: (s: AvroReadable, options?: AvroParserReadOptions) => Promise<T>, options?: AvroParserReadOptions): Promise<Record<string, T>>;
+    private static readArray;
+}
+export declare abstract class AvroType {
+    /**
+     * Reads an object from the stream.
+     */
+    abstract read(stream: AvroReadable, options?: AvroParserReadOptions): Promise<Object | null>;
+    /**
+     * Determines the AvroType from the Avro Schema.
+     */
+    static fromSchema(schema: string | Object): AvroType;
+    private static fromStringSchema;
+    private static fromArraySchema;
+    private static fromObjectSchema;
+}
+export {};
+//# sourceMappingURL=AvroParser.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroReadable.d.ts

@@ -0,0 +1,16 @@
+import { AbortSignalLike } from "@azure/abort-controller";
+/**
+ * Options to configure the {@link AvroReadable.read} operation.
+ */
+export interface AvroReadableReadOptions {
+    /**
+     * 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 abstract class AvroReadable {
+    abstract readonly position: number;
+    abstract read(size: number, options?: AvroReadableReadOptions): Promise<Uint8Array>;
+}
+//# sourceMappingURL=AvroReadable.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroReadableFromBlob.d.ts

@@ -0,0 +1,9 @@
+import { AvroReadable, AvroReadableReadOptions } from "./AvroReadable";
+export declare class AvroReadableFromBlob extends AvroReadable {
+    private _position;
+    private _blob;
+    constructor(blob: Blob);
+    readonly position: number;
+    read(size: number, options?: AvroReadableReadOptions): Promise<Uint8Array>;
+}
+//# sourceMappingURL=AvroReadableFromBlob.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroReadableFromStream.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { AvroReadable, AvroReadableReadOptions } from "./AvroReadable";
+export declare class AvroReadableFromStream extends AvroReadable {
+    private _position;
+    private _readable;
+    private toUint8Array;
+    constructor(readable: NodeJS.ReadableStream);
+    readonly position: number;
+    read(size: number, options?: AvroReadableReadOptions): Promise<Uint8Array>;
+}
+//# sourceMappingURL=AvroReadableFromStream.d.ts.map

package/types/3.1/storage-internal-avro/src/AvroReader.d.ts

@@ -0,0 +1,33 @@
+import { AvroReadable } from "./AvroReadable";
+import "@azure/core-paging";
+import { AbortSignalLike } from "@azure/abort-controller";
+/**
+ * Options to configure the {@link AvroReader.parseObjects} operation.
+ */
+export interface AvroParseOptions {
+    /**
+     * 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 AvroReader {
+    private readonly _dataStream;
+    private readonly _headerStream;
+    private _syncMarker?;
+    private _metadata?;
+    private _itemType?;
+    private _itemsRemainingInBlock?;
+    private readonly _initialBlockOffset;
+    private _blockOffset;
+    readonly blockOffset: number;
+    private _objectIndex;
+    readonly objectIndex: number;
+    private _initialized;
+    constructor(dataStream: AvroReadable);
+    constructor(dataStream: AvroReadable, headerStream: AvroReadable, currentBlockOffset: number, indexWithinCurrentBlock: number);
+    private initialize;
+    hasNext(): boolean;
+    parseObjects(options?: AvroParseOptions): AsyncIterableIterator<Record<string, any> | null>;
+}
+//# sourceMappingURL=AvroReader.d.ts.map

package/types/3.1/storage-internal-avro/src/index.browser.d.ts

@@ -0,0 +1,4 @@
+export { AvroReader } from "./AvroReader";
+export { AvroReadable } from "./AvroReadable";
+export { AvroReadableFromBlob } from "./AvroReadableFromBlob";
+//# sourceMappingURL=index.browser.d.ts.map

package/types/3.1/storage-internal-avro/src/index.d.ts

@@ -0,0 +1,4 @@
+export { AvroReader } from "./AvroReader";
+export { AvroReadable } from "./AvroReadable";
+export { AvroReadableFromStream } from "./AvroReadableFromStream";
+//# sourceMappingURL=index.d.ts.map

package/types/3.1/storage-internal-avro/src/utils/utils.common.d.ts

@@ -0,0 +1,6 @@
+export interface KeyValuePair<T> {
+    key: string;
+    value: T;
+}
+export declare function arraysEqual(a: Uint8Array, b: Uint8Array): boolean;
+//# sourceMappingURL=utils.common.d.ts.map

package/types/3.1/storage-internal-avro/test/browser/avroreadable.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=avroreadable.spec.d.ts.map

package/types/3.1/storage-internal-avro/test/node/avroreadable.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=avroreadable.spec.d.ts.map

package/types/3.1/storage-internal-avro/test/node/avroreader.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=avroreader.spec.d.ts.map

package/types/latest/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/latest/storage-blob-changefeed/samples-dev/blobChangeFeedClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobChangeFeedClient.d.ts","sourceRoot":"","sources":["../../../../samples-dev/blobChangeFeedClient.ts"],"names":[],"mappings":"AAcA,wBAAsB,IAAI,kBAsBzB"}

package/types/latest/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/latest/storage-blob-changefeed/samples-dev/resumeListChanges.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resumeListChanges.d.ts","sourceRoot":"","sources":["../../../../samples-dev/resumeListChanges.ts"],"names":[],"mappings":"AAcA,wBAAsB,IAAI,kBA4BzB"}

package/types/latest/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/latest/storage-blob-changefeed/src/AvroReaderFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.d.ts","sourceRoot":"","sources":["../../../../src/AvroReaderFactory.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE3E;;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"}