@azure/eventhubs-checkpointstore-blob 1.1.0-beta.1 → 2.0.0-alpha.20250129.1

package/README.md

@@ -3,9 +3,10 @@
 An Azure Blob storage based solution to store checkpoints and to aid in load balancing when using `EventHubConsumerClient` from the [@azure/event-hubs](https://www.npmjs.com/package/@azure/event-hubs) library
 
 Key links:
+
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventhub/eventhubs-checkpointstore-blob)
 - [Package (npm)](https://www.npmjs.com/package/@azure/eventhubs-checkpointstore-blob)
-- [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/)
+- [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventhub/eventhubs-checkpointstore-blob/samples)
 
 ## Getting started
@@ -20,8 +21,8 @@ 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 [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/)
-- A [Storage account](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction)
+- An [Event Hubs Namespace](https://learn.microsoft.com/azure/event-hubs/)
+- A [Storage account](https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction)
 
 ### Install the package
 
@@ -57,7 +58,7 @@ You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your t
   and to provide resiliency if a failover between readers running on different machines occurs. It is possible to return to older data by specifying a lower offset from this checkpointing process.
   Through this mechanism, checkpointing enables both failover resiliency and event stream replay.
 
-  A [BlobCheckpointStore](https://docs.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore)
+  A [BlobCheckpointStore](https://learn.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore)
   is a class that implements key methods required by the EventHubConsumerClient to balance load and update checkpoints.
 
 ## Examples
@@ -79,16 +80,16 @@ if (!containerClient.exists()) {
   await containerClient.create(); // This can be skipped if the container already exists
 }
 
-const checkpointStore =  new BlobCheckpointStore(containerClient);
+const checkpointStore = new BlobCheckpointStore(containerClient);
 ```
 
 ### Checkpoint events using Azure Blob storage
 
 To checkpoint events received using Azure Blob Storage, you will need to pass an object
-that is compatible with the [SubscriptionEventHandlers](https://docs.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers)
+that is compatible with the [SubscriptionEventHandlers](https://learn.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers)
 interface along with code to call the `updateCheckpoint()` method.
 
-In this example, `SubscriptionHandlers` implements [SubscriptionEventHandlers](https://docs.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers) and also handles checkpointing.
+In this example, `SubscriptionHandlers` implements [SubscriptionEventHandlers](https://learn.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers) and also handles checkpointing.
 
 ```javascript
 const { EventHubConsumerClient } = require("@azure/event-hubs");
@@ -113,7 +114,7 @@ async function main() {
     consumerGroup,
     eventHubConnectionString,
     eventHubName,
-    checkpointStore
+    checkpointStore,
   );
 
   const subscription = consumerClient.subscribe({
@@ -136,7 +137,7 @@ async function main() {
       // handle any errors that occur during the course of
       // this subscription
       console.log(`Errors in subscription to partition ${context.partitionId}: ${err}`);
-    }
+    },
   });
 
   // Wait for a few seconds to receive events before closing

package/{typings/eventhubs-checkpointstore-blob.d.ts → dist/browser/blobCheckpointStore.d.ts}

@@ -1,124 +1,68 @@
-import { AzureLogger } from '@azure/logger';
-import { BlobItem } from '@azure/storage-blob';
-import { BlobSetMetadataOptions } from '@azure/storage-blob';
-import { BlockBlobUploadOptions } from '@azure/storage-blob';
-import { BlockBlobUploadResponse } from '@azure/storage-blob';
-import { Checkpoint } from '@azure/event-hubs';
-import { CheckpointStore } from '@azure/event-hubs';
-import { ContainerListBlobFlatSegmentResponse } from '@azure/storage-blob';
-import { ContainerListBlobsOptions } from '@azure/storage-blob';
-import { ContainerSetMetadataResponse } from '@azure/storage-blob';
-import { HttpRequestBody } from '@azure/storage-blob';
-import { Metadata } from '@azure/storage-blob';
-import { OperationOptions } from '@azure/event-hubs';
-import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { 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 { }
+import type { CheckpointStore, PartitionOwnership, Checkpoint, OperationOptions } from "@azure/event-hubs";
+import type { ContainerClientLike } from "./storageBlobInterfaces.js";
+/**
+ * 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;
+}
+/**
+ * @internal
+ */
+export declare function parseIntOrThrow(blobName: string, fieldName: string, numStr: string | undefined): number;
+//# sourceMappingURL=blobCheckpointStore.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"blobCheckpointStore.d.ts","sourceRoot":"","sources":["../../src/blobCheckpointStore.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGtE;;GAEG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACzD,OAAO,CAAC,gBAAgB,CAAsB;IAE9C;;;OAGG;gBACS,eAAe,EAAE,mBAAmB;IAGhD;;;;;;;;;;;;;OAaG;IACG,aAAa,CACjB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAoDhC;;;;;;;;;OASG;IACG,cAAc,CAClB,kBAAkB,EAAE,kBAAkB,EAAE,EACxC,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAiDhC;;;;;;;;;;OAUG;IACG,eAAe,CACnB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,UAAU,EAAE,CAAC;IA+CxB;;;;;;;;OAQG;IACG,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwC7F,OAAO,CAAC,MAAM,CAAC,aAAa;YAoBd,gBAAgB;CA+C/B;AAUD;;GAEG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,MAAM,CAcR"}

package/{dist-esm/src → dist/browser}/blobCheckpointStore.js

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 import { __asyncValues } from "tslib";
-import { logger, logErrorStackTrace } from "./log";
-import { throwTypeErrorIfParameterMissing } from "./util/error";
+import { logger, logErrorStackTrace } from "./log.js";
+import { throwTypeErrorIfParameterMissing } from "./util/error.js";
 /**
  * An implementation of CheckpointStore that uses Azure Blob Storage to persist checkpoint data.
  */
@@ -165,7 +165,7 @@ export class BlobCheckpointStore {
                 const checkpointMetadata = (_d = blob.metadata) !== null && _d !== void 0 ? _d : {};
                 const offset = checkpointMetadata.offset;
                 if (offset == null) {
-                    throw new Error(`Missing metadata property 'offset' on blob '${blobName}'`);
+                    throw new Error(`Missing metadata property 'offset' on blob '${blob.name}'`);
                 }
                 const sequenceNumber = parseIntOrThrow(blob.name, "sequencenumber", checkpointMetadata.sequencenumber);
                 checkpoints.push({
@@ -209,11 +209,11 @@ export class BlobCheckpointStore {
             return;
         }
         catch (err) {
-            logger.warning(`Error occurred while upating the checkpoint for partition: ${checkpoint.partitionId}.`, err.message);
+            logger.warning(`Error occurred while updating the checkpoint for partition: ${checkpoint.partitionId}.`, err.message);
             logErrorStackTrace(err);
             if ((err === null || err === void 0 ? void 0 : err.name) === "AbortError")
                 throw err;
-            throw new Error(`Error occurred while upating the checkpoint for partition: ${checkpoint.partitionId}, ${err}`);
+            throw err;
         }
     }
     static getBlobPrefix(params) {

package/dist/browser/blobCheckpointStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobCheckpointStore.js","sourceRoot":"","sources":["../../src/blobCheckpointStore.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AASlC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEtD,OAAO,EAAE,gCAAgC,EAAE,MAAM,iBAAiB,CAAC;AAEnE;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAG9B;;;OAGG;IACH,YAAY,eAAoC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CACjB,uBAA+B,EAC/B,YAAoB,EACpB,aAAqB,EACrB,UAA4B,EAAE;;;QAE9B,MAAM,uBAAuB,GAAyB,EAAE,CAAC;QACzD,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEhD,MAAM,UAAU,GAAG,mBAAmB,CAAC,aAAa,CAAC;YACnD,IAAI,EAAE,WAAW;YACjB,uBAAuB;YACvB,YAAY;YACZ,aAAa,EAAE,aAAa;SAC7B,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC;gBAChD,WAAW;gBACX,eAAe,EAAE,IAAI;gBACrB,MAAM,EAAE,UAAU;gBAClB,cAAc;aACf,CAAC,CAAC;;gBAEH,KAAyB,eAAA,UAAA,cAAA,KAAK,CAAA,WAAA,yEAAE,CAAC;oBAAR,qBAAK;oBAAL,WAAK;oBAAnB,MAAM,IAAI,KAAA,CAAA;oBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAE/C,MAAM,iBAAiB,GAAG,MAAC,IAAI,CAAC,QAA8B,mCAAI,EAAE,CAAC;oBAErE,IAAI,iBAAiB,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;wBACtC,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;oBACvE,CAAC;oBAED,MAAM,kBAAkB,GAAuB;wBAC7C,uBAAuB;wBACvB,YAAY;wBACZ,aAAa,EAAE,aAAa;wBAC5B,OAAO,EAAE,iBAAiB,CAAC,OAAO;wBAClC,WAAW,EAAE,QAAQ;wBACrB,oBAAoB,EAClB,IAAI,CAAC,UAAU,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,EAAE;wBACxE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;qBAC3B,CAAC;oBACF,uBAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBACnD,CAAC;;;;;;;;;YACD,OAAO,uBAAuB,CAAC;QACjC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,OAAO,CAAC,iDAAiD,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC/E,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAExB,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,YAAY;gBAAE,MAAM,GAAG,CAAC;YAE1C,MAAM,IAAI,KAAK,CAAC,sDAAsD,GAAG,EAAE,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAClB,kBAAwC,EACxC,UAA4B,EAAE;QAE9B,MAAM,uBAAuB,GAAyB,EAAE,CAAC;QACzD,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,aAAa,iBAAG,IAAI,EAAE,WAAW,IAAK,SAAS,EAAG,CAAC;YACxF,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CACrD,QAAQ,EACR;oBACE,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC3B,EACD,SAAS,CAAC,IAAI,EACd,OAAO,CACR,CAAC;gBAEF,IAAI,mBAAmB,CAAC,YAAY,EAAE,CAAC;oBACrC,SAAS,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC9E,CAAC;gBAED,SAAS,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;gBAC1C,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxC,MAAM,CAAC,IAAI,CACT,IAAI,SAAS,CAAC,OAAO,mDAAmD,SAAS,CAAC,WAAW,EAAE,EAC/F,qBAAqB,SAAS,CAAC,oBAAoB,WAAW,SAAS,CAAC,IAAI,EAAE,CAC/E,CAAC;YACJ,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,MAAM,SAAS,GAAG,GAAgB,CAAC;gBAEnC,IAAI,SAAS,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;oBACjC,wEAAwE;oBACxE,6EAA6E;oBAC7E,6BAA6B;oBAC7B,MAAM,CAAC,OAAO,CACZ,IAAI,SAAS,CAAC,OAAO,6BAA6B,SAAS,CAAC,WAAW,6CAA6C,CACrH,CAAC;oBACF,SAAS;gBACX,CAAC;gBAED,MAAM,CAAC,OAAO,CACZ,0DAA0D,SAAS,CAAC,WAAW,EAAE,EACjF,GAAG,CAAC,OAAO,CACZ,CAAC;gBACF,kBAAkB,CAAC,GAAG,CAAC,CAAC;gBAExB,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACnB,uBAA+B,EAC/B,YAAoB,EACpB,aAAqB,EACrB,UAA4B,EAAE;;;QAE9B,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAChD,MAAM,UAAU,GAAG,mBAAmB,CAAC,aAAa,CAAC;YACnD,IAAI,EAAE,YAAY;YAClB,uBAAuB;YACvB,YAAY;YACZ,aAAa;SACd,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC;YAChD,WAAW;YACX,eAAe,EAAE,IAAI;YACrB,MAAM,EAAE,UAAU;YAClB,cAAc;SACf,CAAC,CAAC;QAEH,MAAM,WAAW,GAAiB,EAAE,CAAC;;YAErC,KAAyB,eAAA,UAAA,cAAA,KAAK,CAAA,WAAA,yEAAE,CAAC;gBAAR,qBAAK;gBAAL,WAAK;gBAAnB,MAAM,IAAI,KAAA,CAAA;gBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAE/C,MAAM,kBAAkB,GAAG,MAAC,IAAI,CAAC,QAA+B,mCAAI,EAAE,CAAC;gBAEvE,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC;gBACzC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;gBAC/E,CAAC;gBACD,MAAM,cAAc,GAAG,eAAe,CACpC,IAAI,CAAC,IAAI,EACT,gBAAgB,EAChB,kBAAkB,CAAC,cAAc,CAClC,CAAC;gBAEF,WAAW,CAAC,IAAI,CAAC;oBACf,aAAa;oBACb,YAAY;oBACZ,uBAAuB;oBACvB,WAAW,EAAE,QAAQ;oBACrB,MAAM;oBACN,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;;;;;;;;;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAsB,EAAE,UAA4B,EAAE;QAC3E,gCAAgC,CAC9B,kBAAkB,EAClB,gBAAgB,EAChB,UAAU,CAAC,cAAc,CAC1B,CAAC;QACF,gCAAgC,CAAC,kBAAkB,EAAE,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAElF,MAAM,QAAQ,GAAG,mBAAmB,CAAC,aAAa,iBAAG,IAAI,EAAE,YAAY,IAAK,UAAU,EAAG,CAAC;QAC1F,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAClD,QAAQ,EACR;gBACE,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE;gBACpD,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE;aACrC,EACD,SAAS,EACT,OAAO,CACR,CAAC;YAEF,MAAM,CAAC,OAAO,CACZ,kDAAkD,UAAU,CAAC,WAAW,EAAE,EAC1E,qBAAqB,gBAAgB,CAAC,YAAa,CAAC,WAAW,EAAE,WAC/D,gBAAgB,CAAC,IACnB,EAAE,CACH,CAAC;YACF,OAAO;QACT,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,OAAO,CACZ,+DAA+D,UAAU,CAAC,WAAW,GAAG,EACxF,GAAG,CAAC,OAAO,CACZ,CAAC;YACF,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAExB,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,YAAY;gBAAE,MAAM,GAAG,CAAC;YAE1C,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,MAM5B;QACC,oGAAoG;QACpG,4DAA4D;QAC5D,MAAM,iBAAiB,GAAG,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QACvD,MAAM,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC,WAAW,EAAE,CAAC;QAE7E,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,OAAO,GAAG,uBAAuB,IAAI,YAAY,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QAChH,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,uBAAuB,IAAI,YAAY,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;QAC3F,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC5B,QAAgB,EAChB,QAAgD,EAChD,IAAwB,EACxB,UAA4B,EAAE;QAE9B,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAChD,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,kBAAkB,EAAE,CAAC;QAE3F,kDAAkD;QAClD,2CAA2C;QAC3C,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,eAAe,CAAC,WAAW,CAAC,QAAoB,EAAE;gBACvD,WAAW;gBACX,UAAU,EAAE;oBACV,OAAO,EAAE,IAAI;iBACd;gBACD,cAAc;aACf,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,qFAAqF;gBACrF,gGAAgG;gBAChG,yDAAyD;gBACzD,OAAO,MAAM,eAAe,CAAC,WAAW,CAAC,QAAoB,EAAE;oBAC7D,WAAW;oBACX,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,0EAA0E;gBAC1E,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,WAAW,EAAE,CAAC;oBAC9B,MAAM,GAAG,CAAC;gBACZ,CAAC;gBACD,MAAM,YAAY,GAAI,GAAiB,CAAC,OAAkD,CAAC;gBAC3F,MAAM,SAAS,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,SAAS,CAAC;gBAC1C,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,cAAc,EAAE,CAAC;oBAC/C,MAAM,GAAG,CAAC;gBACZ,CAAC;gBAED,OAAO,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE;oBACnC,WAAW;oBACX,QAAQ,EAAE,QAAoB;oBAC9B,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAUD;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAgB,EAChB,SAAiB,EACjB,MAA0B;IAE1B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,SAAS,cAAc,QAAQ,GAAG,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEjC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,sCAAsC,SAAS,cAAc,QAAQ,eAAe,CACrF,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  CheckpointStore,\n  PartitionOwnership,\n  Checkpoint,\n  OperationOptions,\n} from \"@azure/event-hubs\";\nimport type { Metadata, RestError, BlobSetMetadataResponse } from \"@azure/storage-blob\";\nimport { logger, logErrorStackTrace } from \"./log.js\";\nimport type { ContainerClientLike } from \"./storageBlobInterfaces.js\";\nimport { throwTypeErrorIfParameterMissing } from \"./util/error.js\";\n\n/**\n * An implementation of CheckpointStore that uses Azure Blob Storage to persist checkpoint data.\n */\nexport class BlobCheckpointStore implements CheckpointStore {\n  private _containerClient: ContainerClientLike;\n\n  /**\n   * Constructs a new instance of {@link BlobCheckpointStore}\n   * @param containerClient - An instance of a storage blob ContainerClient.\n   */\n  constructor(containerClient: ContainerClientLike) {\n    this._containerClient = containerClient;\n  }\n  /**\n   * Get the list of all existing partition ownership from the underlying data store. May return empty\n   * results if there are is no existing ownership information.\n   * Partition Ownership contains the information on which `EventHubConsumerClient` subscribe call is currently processing the partition.\n   *\n   * @param fullyQualifiedNamespace - The fully qualified Event Hubs namespace. This is likely to be similar to\n   * <yournamespace>.servicebus.windows.net.\n   * @param eventHubName - The event hub name.\n   * @param consumerGroup - The consumer group name.\n   * @param options - A set of options that can be specified to influence the behavior of this method.\n   *  - `abortSignal`: A signal used to request operation cancellation.\n   *  - `tracingOptions`: Options for configuring tracing.\n   * @returns Partition ownership details of all the partitions that have had an owner.\n   */\n  async listOwnership(\n    fullyQualifiedNamespace: string,\n    eventHubName: string,\n    consumerGroup: string,\n    options: OperationOptions = {},\n  ): Promise<PartitionOwnership[]> {\n    const partitionOwnershipArray: PartitionOwnership[] = [];\n    const { abortSignal, tracingOptions } = options;\n\n    const blobPrefix = BlobCheckpointStore.getBlobPrefix({\n      type: \"ownership\",\n      fullyQualifiedNamespace,\n      eventHubName,\n      consumerGroup: consumerGroup,\n    });\n\n    try {\n      const blobs = this._containerClient.listBlobsFlat({\n        abortSignal,\n        includeMetadata: true,\n        prefix: blobPrefix,\n        tracingOptions,\n      });\n\n      for await (const blob of blobs) {\n        const blobPath = blob.name.split(\"/\");\n        const blobName = blobPath[blobPath.length - 1];\n\n        const ownershipMetadata = (blob.metadata as OwnershipMetadata) ?? {};\n\n        if (ownershipMetadata.ownerid == null) {\n          throw new Error(`Missing ownerid in metadata for blob ${blob.name}`);\n        }\n\n        const partitionOwnership: PartitionOwnership = {\n          fullyQualifiedNamespace,\n          eventHubName,\n          consumerGroup: consumerGroup,\n          ownerId: ownershipMetadata.ownerid,\n          partitionId: blobName,\n          lastModifiedTimeInMs:\n            blob.properties.lastModified && blob.properties.lastModified.getTime(),\n          etag: blob.properties.etag,\n        };\n        partitionOwnershipArray.push(partitionOwnership);\n      }\n      return partitionOwnershipArray;\n    } catch (err: any) {\n      logger.warning(`Error occurred while fetching the list of blobs`, err.message);\n      logErrorStackTrace(err);\n\n      if (err?.name === \"AbortError\") throw err;\n\n      throw new Error(`Error occurred while fetching the list of blobs. \\n${err}`);\n    }\n  }\n\n  /**\n   * Claim ownership of a list of partitions. This will return the list of partitions that were\n   * successfully claimed.\n   *\n   * @param partitionOwnership - The list of partition ownership this instance is claiming to own.\n   * @param options - A set of options that can be specified to influence the behavior of this method.\n   *  - `abortSignal`: A signal used to request operation cancellation.\n   *  - `tracingOptions`: Options for configuring tracing.\n   * @returns A list partitions this instance successfully claimed ownership.\n   */\n  async claimOwnership(\n    partitionOwnership: PartitionOwnership[],\n    options: OperationOptions = {},\n  ): Promise<PartitionOwnership[]> {\n    const partitionOwnershipArray: PartitionOwnership[] = [];\n    for (const ownership of partitionOwnership) {\n      const blobName = BlobCheckpointStore.getBlobPrefix({ type: \"ownership\", ...ownership });\n      try {\n        const updatedBlobResponse = await this._setBlobMetadata(\n          blobName,\n          {\n            ownerid: ownership.ownerId,\n          },\n          ownership.etag,\n          options,\n        );\n\n        if (updatedBlobResponse.lastModified) {\n          ownership.lastModifiedTimeInMs = updatedBlobResponse.lastModified.getTime();\n        }\n\n        ownership.etag = updatedBlobResponse.etag;\n        partitionOwnershipArray.push(ownership);\n        logger.info(\n          `[${ownership.ownerId}] Claimed ownership successfully for partition: ${ownership.partitionId}`,\n          `LastModifiedTime: ${ownership.lastModifiedTimeInMs}, ETag: ${ownership.etag}`,\n        );\n      } catch (err: any) {\n        const restError = err as RestError;\n\n        if (restError.statusCode === 412) {\n          // etag failures (precondition not met) aren't fatal errors. They happen\n          // as multiple consumers attempt to claim the same partition (first one wins)\n          // and losers get this error.\n          logger.verbose(\n            `[${ownership.ownerId}] Did not claim partition ${ownership.partitionId}. Another processor has already claimed it.`,\n          );\n          continue;\n        }\n\n        logger.warning(\n          `Error occurred while claiming ownership for partition: ${ownership.partitionId}`,\n          err.message,\n        );\n        logErrorStackTrace(err);\n\n        throw err;\n      }\n    }\n    return partitionOwnershipArray;\n  }\n\n  /**\n   * Lists all the checkpoints in a data store for a given namespace, eventhub and consumer group.\n   *\n   * @param fullyQualifiedNamespace - The fully qualified Event Hubs namespace. This is likely to be similar to\n   * <yournamespace>.servicebus.windows.net.\n   * @param eventHubName - The event hub name.\n   * @param consumerGroup - The consumer group name.\n   * @param options - A set of options that can be specified to influence the behavior of this method.\n   *  - `abortSignal`: A signal used to request operation cancellation.\n   *  - `tracingOptions`: Options for configuring tracing.\n   */\n  async listCheckpoints(\n    fullyQualifiedNamespace: string,\n    eventHubName: string,\n    consumerGroup: string,\n    options: OperationOptions = {},\n  ): Promise<Checkpoint[]> {\n    const { abortSignal, tracingOptions } = options;\n    const blobPrefix = BlobCheckpointStore.getBlobPrefix({\n      type: \"checkpoint\",\n      fullyQualifiedNamespace,\n      eventHubName,\n      consumerGroup,\n    });\n\n    const blobs = this._containerClient.listBlobsFlat({\n      abortSignal,\n      includeMetadata: true,\n      prefix: blobPrefix,\n      tracingOptions,\n    });\n\n    const checkpoints: Checkpoint[] = [];\n\n    for await (const blob of blobs) {\n      const blobPath = blob.name.split(\"/\");\n      const blobName = blobPath[blobPath.length - 1];\n\n      const checkpointMetadata = (blob.metadata as CheckpointMetadata) ?? {};\n\n      const offset = checkpointMetadata.offset;\n      if (offset == null) {\n        throw new Error(`Missing metadata property 'offset' on blob '${blob.name}'`);\n      }\n      const sequenceNumber = parseIntOrThrow(\n        blob.name,\n        \"sequencenumber\",\n        checkpointMetadata.sequencenumber,\n      );\n\n      checkpoints.push({\n        consumerGroup,\n        eventHubName,\n        fullyQualifiedNamespace,\n        partitionId: blobName,\n        offset,\n        sequenceNumber,\n      });\n    }\n\n    return checkpoints;\n  }\n\n  /**\n   * Updates the checkpoint in the data store for a partition.\n   *\n   * @param checkpoint - The checkpoint.\n   * @param options - A set of options that can be specified to influence the behavior of this method.\n   *  - `abortSignal`: A signal used to request operation cancellation.\n   *  - `tracingOptions`: Options for configuring tracing.\n   * @returns The new etag on successful update.\n   */\n  async updateCheckpoint(checkpoint: Checkpoint, options: OperationOptions = {}): Promise<void> {\n    throwTypeErrorIfParameterMissing(\n      \"updateCheckpoint\",\n      \"sequenceNumber\",\n      checkpoint.sequenceNumber,\n    );\n    throwTypeErrorIfParameterMissing(\"updateCheckpoint\", \"offset\", checkpoint.offset);\n\n    const blobName = BlobCheckpointStore.getBlobPrefix({ type: \"checkpoint\", ...checkpoint });\n    try {\n      const metadataResponse = await this._setBlobMetadata(\n        blobName,\n        {\n          sequencenumber: checkpoint.sequenceNumber.toString(),\n          offset: checkpoint.offset.toString(),\n        },\n        undefined,\n        options,\n      );\n\n      logger.verbose(\n        `Updated checkpoint successfully for partition: ${checkpoint.partitionId}`,\n        `LastModifiedTime: ${metadataResponse.lastModified!.toISOString()}, ETag: ${\n          metadataResponse.etag\n        }`,\n      );\n      return;\n    } catch (err: any) {\n      logger.warning(\n        `Error occurred while updating the checkpoint for partition: ${checkpoint.partitionId}.`,\n        err.message,\n      );\n      logErrorStackTrace(err);\n\n      if (err?.name === \"AbortError\") throw err;\n\n      throw err;\n    }\n  }\n\n  private static getBlobPrefix(params: {\n    type: \"ownership\" | \"checkpoint\";\n    fullyQualifiedNamespace: string;\n    eventHubName: string;\n    consumerGroup: string;\n    partitionId?: string;\n  }): string {\n    // none of these are case-sensitive in eventhubs so we need to make sure we don't accidentally allow\n    // the user to create a case-sensitive blob for their state!\n    const consumerGroupName = params.consumerGroup.toLowerCase();\n    const eventHubName = params.eventHubName.toLowerCase();\n    const fullyQualifiedNamespace = params.fullyQualifiedNamespace.toLowerCase();\n\n    if (params.partitionId) {\n      return `${fullyQualifiedNamespace}/${eventHubName}/${consumerGroupName}/${params.type}/${params.partitionId}`;\n    } else {\n      return `${fullyQualifiedNamespace}/${eventHubName}/${consumerGroupName}/${params.type}/`;\n    }\n  }\n\n  private async _setBlobMetadata(\n    blobName: string,\n    metadata: OwnershipMetadata | CheckpointMetadata,\n    etag: string | undefined,\n    options: OperationOptions = {},\n  ): Promise<BlobSetMetadataResponse> {\n    const { abortSignal, tracingOptions } = options;\n    const blockBlobClient = this._containerClient.getBlobClient(blobName).getBlockBlobClient();\n\n    // When we have an etag, we know the blob existed.\n    // If we encounter an error we should fail.\n    if (etag) {\n      return blockBlobClient.setMetadata(metadata as Metadata, {\n        abortSignal,\n        conditions: {\n          ifMatch: etag,\n        },\n        tracingOptions,\n      });\n    } else {\n      try {\n        // Attempt to set metadata, and fallback to upload if the blob doesn't already exist.\n        // This avoids poor performance in storage accounts with soft-delete or blob versioning enabled.\n        // https://github.com/Azure/azure-sdk-for-js/issues/10132\n        return await blockBlobClient.setMetadata(metadata as Metadata, {\n          abortSignal,\n          tracingOptions,\n        });\n      } catch (err: any) {\n        // Check if the error is `BlobNotFound` and fallback to `upload` if it is.\n        if (err?.name !== \"RestError\") {\n          throw err;\n        }\n        const errorDetails = (err as RestError).details as { [field: string]: string } | undefined;\n        const errorCode = errorDetails?.errorCode;\n        if (!errorCode || errorCode !== \"BlobNotFound\") {\n          throw err;\n        }\n\n        return blockBlobClient.upload(\"\", 0, {\n          abortSignal,\n          metadata: metadata as Metadata,\n          tracingOptions,\n        });\n      }\n    }\n  }\n}\n\ntype OwnershipMetadata = {\n  [k in \"ownerid\"]: string | undefined;\n};\n\ntype CheckpointMetadata = {\n  [k in \"sequencenumber\" | \"offset\"]: string | undefined;\n};\n\n/**\n * @internal\n */\nexport function parseIntOrThrow(\n  blobName: string,\n  fieldName: string,\n  numStr: string | undefined,\n): number {\n  if (numStr == null) {\n    throw new Error(`Missing metadata property '${fieldName}' on blob '${blobName}'`);\n  }\n\n  const num = parseInt(numStr, 10);\n\n  if (isNaN(num)) {\n    throw new Error(\n      `Failed to parse metadata property '${fieldName}' on blob '${blobName}' as a number`,\n    );\n  }\n\n  return num;\n}\n"]}

package/dist/browser/index.d.ts

@@ -0,0 +1,4 @@
+export { BlobCheckpointStore } from "./blobCheckpointStore.js";
+export { ContainerClientLike, BlobClientLike, BlockBlobClientLike, } from "./storageBlobInterfaces.js";
+export { logger } from "./log.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,mBAAmB,GACpB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/dist/browser/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export { BlobCheckpointStore } from "./blobCheckpointStore.js";
+export { logger } from "./log.js";
+//# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAM/D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport { BlobCheckpointStore } from \"./blobCheckpointStore.js\";\nexport {\n  ContainerClientLike,\n  BlobClientLike,\n  BlockBlobClientLike,\n} from \"./storageBlobInterfaces.js\";\nexport { logger } from \"./log.js\";\n"]}

package/dist/browser/log.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The `@azure/logger` configuration for this package.
+ * This will output logs using the `azure:eventhubs-checkpointstore-blob` namespace prefix.
+ */
+export declare const logger: import("@azure/logger").AzureLogger;
+/**
+ * Logs the error's stack trace to "verbose" if a stack trace is available.
+ * @param error - Error containing a stack trace.
+ * @internal
+ */
+export declare function logErrorStackTrace(error: unknown): void;
+//# sourceMappingURL=log.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/log.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,eAAO,MAAM,MAAM,qCAAuD,CAAC;AAE3E;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAIvD"}

package/{dist-esm/src → dist/browser}/log.js

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 import { createClientLogger } from "@azure/logger";
 /**
  * The `@azure/logger` configuration for this package.

package/{dist-esm/src → dist/browser}/log.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/log.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE3E;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAE,KAAa,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The `@azure/logger` configuration for this package.\n * This will output logs using the `azure:eventhubs-checkpointstore-blob` namespace prefix.\n */\nexport const logger = createClientLogger(\"eventhubs-checkpointstore-blob\");\n\n/**\n * Logs the error's stack trace to \"verbose\" if a stack trace is available.\n * @param error - Error containing a stack trace.\n * @internal\n */\nexport function logErrorStackTrace(error: unknown): void {\n  if (error && typeof error === \"object\" && \"stack\" in error) {\n    logger.verbose((error as any).stack);\n  }\n}\n"]}
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/log.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE3E;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAE,KAAa,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The `@azure/logger` configuration for this package.\n * This will output logs using the `azure:eventhubs-checkpointstore-blob` namespace prefix.\n */\nexport const logger = createClientLogger(\"eventhubs-checkpointstore-blob\");\n\n/**\n * Logs the error's stack trace to \"verbose\" if a stack trace is available.\n * @param error - Error containing a stack trace.\n * @internal\n */\nexport function logErrorStackTrace(error: unknown): void {\n  if (error && typeof error === \"object\" && \"stack\" in error) {\n    logger.verbose((error as any).stack);\n  }\n}\n"]}

package/dist/browser/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/browser/storageBlobInterfaces.d.ts

@@ -0,0 +1,39 @@
+import type { Metadata, BlobItem, ContainerListBlobFlatSegmentResponse, ContainerListBlobsOptions, BlockBlobUploadOptions, BlockBlobUploadResponse, HttpRequestBody, BlobSetMetadataOptions, ContainerSetMetadataResponse } from "@azure/storage-blob";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+/**
+ * An interface compatible with an instance of {@link BlobClient}.
+ */
+export interface BlobClientLike {
+    /**
+     * Creates a BlockBlobClient object.
+     */
+    getBlockBlobClient(): BlockBlobClientLike;
+}
+/**
+ * An interface compatible with Storage Blob's ContainerClient class.
+ */
+export 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>;
+}
+/**
+ * An interface compatible with Storage Blob's BlockBlobClient class.
+ */
+export 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>;
+}
+//# sourceMappingURL=storageBlobInterfaces.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"storageBlobInterfaces.d.ts","sourceRoot":"","sources":["../../src/storageBlobInterfaces.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,QAAQ,EACR,QAAQ,EACR,oCAAoC,EACpC,yBAAyB,EACzB,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,sBAAsB,EACtB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,kBAAkB,IAAI,mBAAmB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC;IAChD;;;OAGG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,yBAAyB,GAClC,0BAA0B,CAAC,QAAQ,EAAE,oCAAoC,CAAC,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,eAAe,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;OAEG;IACH,WAAW,CACT,QAAQ,CAAC,EAAE,QAAQ,EACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC1C"}

package/dist/browser/storageBlobInterfaces.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=storageBlobInterfaces.js.map

package/dist/browser/storageBlobInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storageBlobInterfaces.js","sourceRoot":"","sources":["../../src/storageBlobInterfaces.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  Metadata,\n  BlobItem,\n  ContainerListBlobFlatSegmentResponse,\n  ContainerListBlobsOptions,\n  BlockBlobUploadOptions,\n  BlockBlobUploadResponse,\n  HttpRequestBody,\n  BlobSetMetadataOptions,\n  ContainerSetMetadataResponse,\n} from \"@azure/storage-blob\";\nimport type { PagedAsyncIterableIterator } from \"@azure/core-paging\";\n\n/**\n * An interface compatible with an instance of {@link BlobClient}.\n */\nexport interface BlobClientLike {\n  /**\n   * Creates a BlockBlobClient object.\n   */\n  getBlockBlobClient(): BlockBlobClientLike;\n}\n\n/**\n * An interface compatible with Storage Blob's ContainerClient class.\n */\nexport interface ContainerClientLike {\n  /**\n   * Creates a {@link BlobClient}\n   */\n  getBlobClient(blobName: string): BlobClientLike;\n  /**\n   * Returns an async iterable iterator to list all the blobs\n   * under the specified account.\n   */\n  listBlobsFlat(\n    options?: ContainerListBlobsOptions,\n  ): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>;\n}\n\n/**\n * An interface compatible with Storage Blob's BlockBlobClient class.\n */\nexport interface BlockBlobClientLike {\n  /**\n   * Creates a new block blob, or updated the content of an existing block blob.\n   */\n  upload(\n    body: HttpRequestBody,\n    contentLength: number,\n    options?: BlockBlobUploadOptions,\n  ): Promise<BlockBlobUploadResponse>;\n  /**\n   * Sets user-defined metadata for the specified blob as one or more name-value pairs.\n   */\n  setMetadata(\n    metadata?: Metadata,\n    options?: BlobSetMetadataOptions,\n  ): Promise<ContainerSetMetadataResponse>;\n}\n"]}

package/dist/browser/util/error.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @internal
+ * Logs and Throws TypeError if given parameter is undefined or null
+ * @param methodName - Name of the method that was passed the parameter
+ * @param parameterName - Name of the parameter to check
+ * @param parameterValue - Value of the parameter to check
+ */
+export declare function throwTypeErrorIfParameterMissing(methodName: string, parameterName: string, parameterValue: unknown): void;
+//# sourceMappingURL=error.d.ts.map

package/dist/browser/util/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/util/error.ts"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,OAAO,GACtB,IAAI,CASN"}

package/{dist-esm/src → dist/browser}/util/error.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { logger, logErrorStackTrace } from "../log";
+// Licensed under the MIT License.
+import { logger, logErrorStackTrace } from "../log.js";
 /**
  * @internal
  * Logs and Throws TypeError if given parameter is undefined or null

package/dist/browser/util/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/util/error.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAC9C,UAAkB,EAClB,aAAqB,EACrB,cAAuB;IAEvB,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,IAAI,SAAS,CACzB,GAAG,UAAU,sCAAsC,aAAa,GAAG,CACpE,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1B,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { logger, logErrorStackTrace } from \"../log.js\";\n\n/**\n * @internal\n * Logs and Throws TypeError if given parameter is undefined or null\n * @param methodName - Name of the method that was passed the parameter\n * @param parameterName - Name of the parameter to check\n * @param parameterValue - Value of the parameter to check\n */\nexport function throwTypeErrorIfParameterMissing(\n  methodName: string,\n  parameterName: string,\n  parameterValue: unknown,\n): void {\n  if (parameterValue === undefined || parameterValue === null) {\n    const error = new TypeError(\n      `${methodName} called without required argument \"${parameterName}\"`,\n    );\n    logger.warning(error.message);\n    logErrorStackTrace(error);\n    throw error;\n  }\n}\n"]}

package/dist/commonjs/blobCheckpointStore.d.ts

@@ -0,0 +1,68 @@
+import type { CheckpointStore, PartitionOwnership, Checkpoint, OperationOptions } from "@azure/event-hubs";
+import type { ContainerClientLike } from "./storageBlobInterfaces.js";
+/**
+ * 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;
+}
+/**
+ * @internal
+ */
+export declare function parseIntOrThrow(blobName: string, fieldName: string, numStr: string | undefined): number;
+//# sourceMappingURL=blobCheckpointStore.d.ts.map

package/dist/commonjs/blobCheckpointStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobCheckpointStore.d.ts","sourceRoot":"","sources":["../../src/blobCheckpointStore.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGtE;;GAEG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACzD,OAAO,CAAC,gBAAgB,CAAsB;IAE9C;;;OAGG;gBACS,eAAe,EAAE,mBAAmB;IAGhD;;;;;;;;;;;;;OAaG;IACG,aAAa,CACjB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAoDhC;;;;;;;;;OASG;IACG,cAAc,CAClB,kBAAkB,EAAE,kBAAkB,EAAE,EACxC,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAiDhC;;;;;;;;;;OAUG;IACG,eAAe,CACnB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,UAAU,EAAE,CAAC;IA+CxB;;;;;;;;OAQG;IACG,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwC7F,OAAO,CAAC,MAAM,CAAC,aAAa;YAoBd,gBAAgB;CA+C/B;AAUD;;GAEG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,MAAM,CAcR"}