@azure/eventhubs-checkpointstore-blob 1.1.0-alpha.20241121.1 → 1.1.0-alpha.20241204.2

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.11"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/eventhubs-checkpointstore-blob",
   "sdk-type": "client",
-  "version": "1.1.0-alpha.20241121.1",
+  "version": "1.1.0-alpha.20241204.2",
   "description": "An Azure Storage Blob solution to store checkpoints when using Event Hubs.",
   "author": "Microsoft Corporation",
   "license": "MIT",

package/dist/eventhubs-checkpointstore-blob.d.ts

@@ -1,124 +0,0 @@
-import { AzureLogger } from '@azure/logger';
-import type { BlobItem } from '@azure/storage-blob';
-import type { BlobSetMetadataOptions } from '@azure/storage-blob';
-import type { BlockBlobUploadOptions } from '@azure/storage-blob';
-import type { BlockBlobUploadResponse } from '@azure/storage-blob';
-import type { Checkpoint } from '@azure/event-hubs';
-import type { CheckpointStore } from '@azure/event-hubs';
-import type { ContainerListBlobFlatSegmentResponse } from '@azure/storage-blob';
-import type { ContainerListBlobsOptions } from '@azure/storage-blob';
-import type { ContainerSetMetadataResponse } from '@azure/storage-blob';
-import type { HttpRequestBody } from '@azure/storage-blob';
-import type { Metadata } from '@azure/storage-blob';
-import type { OperationOptions } from '@azure/event-hubs';
-import type { PagedAsyncIterableIterator } from '@azure/core-paging';
-import type { PartitionOwnership } from '@azure/event-hubs';
-
-/**
- * An implementation of CheckpointStore that uses Azure Blob Storage to persist checkpoint data.
- */
-export declare class BlobCheckpointStore implements CheckpointStore {
-    private _containerClient;
-    /**
-     * Constructs a new instance of {@link BlobCheckpointStore}
-     * @param containerClient - An instance of a storage blob ContainerClient.
-     */
-    constructor(containerClient: ContainerClientLike);
-    /**
-     * Get the list of all existing partition ownership from the underlying data store. May return empty
-     * results if there are is no existing ownership information.
-     * Partition Ownership contains the information on which `EventHubConsumerClient` subscribe call is currently processing the partition.
-     *
-     * @param fullyQualifiedNamespace - The fully qualified Event Hubs namespace. This is likely to be similar to
-     * <yournamespace>.servicebus.windows.net.
-     * @param eventHubName - The event hub name.
-     * @param consumerGroup - The consumer group name.
-     * @param options - A set of options that can be specified to influence the behavior of this method.
-     *  - `abortSignal`: A signal used to request operation cancellation.
-     *  - `tracingOptions`: Options for configuring tracing.
-     * @returns Partition ownership details of all the partitions that have had an owner.
-     */
-    listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>;
-    /**
-     * Claim ownership of a list of partitions. This will return the list of partitions that were
-     * successfully claimed.
-     *
-     * @param partitionOwnership - The list of partition ownership this instance is claiming to own.
-     * @param options - A set of options that can be specified to influence the behavior of this method.
-     *  - `abortSignal`: A signal used to request operation cancellation.
-     *  - `tracingOptions`: Options for configuring tracing.
-     * @returns A list partitions this instance successfully claimed ownership.
-     */
-    claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>;
-    /**
-     * Lists all the checkpoints in a data store for a given namespace, eventhub and consumer group.
-     *
-     * @param fullyQualifiedNamespace - The fully qualified Event Hubs namespace. This is likely to be similar to
-     * <yournamespace>.servicebus.windows.net.
-     * @param eventHubName - The event hub name.
-     * @param consumerGroup - The consumer group name.
-     * @param options - A set of options that can be specified to influence the behavior of this method.
-     *  - `abortSignal`: A signal used to request operation cancellation.
-     *  - `tracingOptions`: Options for configuring tracing.
-     */
-    listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>;
-    /**
-     * Updates the checkpoint in the data store for a partition.
-     *
-     * @param checkpoint - The checkpoint.
-     * @param options - A set of options that can be specified to influence the behavior of this method.
-     *  - `abortSignal`: A signal used to request operation cancellation.
-     *  - `tracingOptions`: Options for configuring tracing.
-     * @returns The new etag on successful update.
-     */
-    updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>;
-    private static getBlobPrefix;
-    private _setBlobMetadata;
-}
-
-/**
- * An interface compatible with an instance of {@link BlobClient}.
- */
-export declare interface BlobClientLike {
-    /**
-     * Creates a BlockBlobClient object.
-     */
-    getBlockBlobClient(): BlockBlobClientLike;
-}
-
-/**
- * An interface compatible with Storage Blob's BlockBlobClient class.
- */
-export declare interface BlockBlobClientLike {
-    /**
-     * Creates a new block blob, or updated the content of an existing block blob.
-     */
-    upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>;
-    /**
-     * Sets user-defined metadata for the specified blob as one or more name-value pairs.
-     */
-    setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<ContainerSetMetadataResponse>;
-}
-
-/**
- * An interface compatible with Storage Blob's ContainerClient class.
- */
-export declare interface ContainerClientLike {
-    /**
-     * Creates a {@link BlobClient}
-     */
-    getBlobClient(blobName: string): BlobClientLike;
-    /**
-     * Returns an async iterable iterator to list all the blobs
-     * under the specified account.
-     */
-    listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>;
-}
-
-/**
- * The `@azure/logger` configuration for this package.
- * This will output logs using the `azure:eventhubs-checkpointstore-blob` namespace prefix.
- */
-export declare const logger: AzureLogger;
-
-export { }