@azure/event-hubs 5.13.0-beta.2 → 6.0.0-alpha.20250129.1

package/dist/commonjs/eventHubBufferedProducerClient.js

@@ -0,0 +1,289 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventHubBufferedProducerClient = void 0;
+const eventHubProducerClient_js_1 = require("./eventHubProducerClient.js");
+const core_util_1 = require("@azure/core-util");
+const typeGuards_js_1 = require("./util/typeGuards.js");
+const core_amqp_1 = require("@azure/core-amqp");
+const batchingPartitionChannel_js_1 = require("./batchingPartitionChannel.js");
+const partitionAssigner_js_1 = require("./impl/partitionAssigner.js");
+const logger_js_1 = require("./logger.js");
+const utils_js_1 = require("./util/utils.js");
+/**
+ * The `EventHubBufferedProducerClient`is used to publish events to a specific Event Hub.
+ *
+ * The `EventHubBufferedProducerClient` does not publish events immediately.
+ * Instead, events are buffered so they can be efficiently batched and published
+ * when the batch is full or the `maxWaitTimeInMs` has elapsed with no new events
+ * enqueued.
+ *
+ * Depending on the options specified when events are enqueued, they may be
+ * automatically assigned to a partition, grouped according to the specified partition key,
+ * or assigned a specifically requested partition.
+ *
+ * This model is intended to shift the burden of batch management from callers, at the cost of
+ * non-deterministic timing, for when events will be published. There are additional trade-offs
+ * to consider, as well:
+ * - If the application crashes, events in the buffer will not have been published. To prevent
+ *   data loss, callers are encouraged to track publishing progress using the
+ *   `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.
+ * - Events specifying a partition key may be assigned a different partition than those using
+ *   the same key with other producers.
+ * - In the unlikely event that a partition becomes temporarily unavailable, the
+ *   `EventHubBufferedProducerClient` may take longer to recover than other producers.
+ *
+ * In scenarios where it is important to have events published immediately with a deterministic
+ * outcome, ensure that partition keys are assigned to a partition consistent with other
+ * publishers, or where maximizing availability is a requirement, using the
+ * `EventHubProducerClient` is recommended.
+ */
+class EventHubBufferedProducerClient {
+    /**
+     * @readonly
+     * The name of the Event Hub instance for which this client is created.
+     */
+    get eventHubName() {
+        return this._producer.eventHubName;
+    }
+    /**
+     * @readonly
+     * The fully qualified namespace of the Event Hub instance for which this client is created.
+     * This is likely to be similar to <yournamespace>.servicebus.windows.net.
+     */
+    get fullyQualifiedNamespace() {
+        return this._producer.fullyQualifiedNamespace;
+    }
+    constructor(fullyQualifiedNamespaceOrConnectionString1, eventHubNameOrOptions2, credentialOrOptions3, options4) {
+        var _a, _b, _c;
+        /**
+         * Controls the `abortSignal` passed to each `BatchingPartitionChannel`.
+         * Used to signal when a channel should stop waiting for events.
+         */
+        this._abortController = new AbortController();
+        /**
+         * Indicates whether the client has been explicitly closed.
+         */
+        this._isClosed = false;
+        /**
+         * Handles assigning partitions.
+         */
+        this._partitionAssigner = new partitionAssigner_js_1.PartitionAssigner();
+        /**
+         * The known partitionIds that will be used when assigning events to partitions.
+         */
+        this._partitionIds = [];
+        /**
+         * Mapping of partitionIds to `BatchingPartitionChannels`.
+         * Each `BatchingPartitionChannel` handles buffering events and backpressure independently.
+         */
+        this._partitionChannels = new Map();
+        /**
+         * The interval at which the background management operation should run.
+         */
+        this._backgroundManagementInterval = 10000; // 10 seconds
+        /**
+         * Indicates whether the background management loop is running.
+         */
+        this._isBackgroundManagementRunning = false;
+        if (typeof eventHubNameOrOptions2 !== "string") {
+            this.identifier = (_a = eventHubNameOrOptions2.identifier) !== null && _a !== void 0 ? _a : (0, utils_js_1.getRandomName)();
+            this._producer = new eventHubProducerClient_js_1.EventHubProducerClient(fullyQualifiedNamespaceOrConnectionString1, Object.assign(Object.assign({}, eventHubNameOrOptions2), { identifier: this.identifier }));
+            this._clientOptions = Object.assign({}, eventHubNameOrOptions2);
+        }
+        else if (!(0, typeGuards_js_1.isCredential)(credentialOrOptions3)) {
+            this.identifier = (_b = credentialOrOptions3 === null || credentialOrOptions3 === void 0 ? void 0 : credentialOrOptions3.identifier) !== null && _b !== void 0 ? _b : (0, utils_js_1.getRandomName)();
+            this._producer = new eventHubProducerClient_js_1.EventHubProducerClient(fullyQualifiedNamespaceOrConnectionString1, eventHubNameOrOptions2, Object.assign(Object.assign({}, credentialOrOptions3), { identifier: this.identifier }));
+            this._clientOptions = Object.assign({}, credentialOrOptions3);
+        }
+        else {
+            this.identifier = (_c = options4 === null || options4 === void 0 ? void 0 : options4.identifier) !== null && _c !== void 0 ? _c : (0, utils_js_1.getRandomName)();
+            this._producer = new eventHubProducerClient_js_1.EventHubProducerClient(fullyQualifiedNamespaceOrConnectionString1, eventHubNameOrOptions2, credentialOrOptions3, Object.assign(Object.assign({}, options4), { identifier: this.identifier }));
+            this._clientOptions = Object.assign({}, options4);
+        }
+        // setting internal idempotent publishing option on the standard producer.
+        this._producer._enableIdempotentRetries = this._clientOptions.enableIdempotentRetries;
+    }
+    /**
+     * Closes the AMQP connection to the Event Hub instance,
+     * returning a promise that will be resolved when disconnection is completed.
+     *
+     * This will wait for enqueued events to be flushed to the service before closing
+     * the connection.
+     * To close without flushing, set the `flush` option to `false`.
+     *
+     * @param options - The set of options to apply to the operation call.
+     * @returns Promise<void>
+     * @throws Error if the underlying connection encounters an error while closing.
+     */
+    async close(options = {}) {
+        logger_js_1.logger.verbose("closing buffered producer client...");
+        if (!(0, core_util_1.isDefined)(options.flush) || options.flush === true) {
+            await this.flush(options);
+        }
+        // Calling abort signals to the BatchingPartitionChannels that they
+        // should stop reading/sending events, and to the background management
+        // loop that it should stop periodic partition id updates.
+        this._abortController.abort();
+        await this._producer.close();
+        this._isClosed = true;
+    }
+    /**
+     * Enqueues an event into the buffer to be published to the Event Hub.
+     * If there is no capacity in the buffer when this method is invoked,
+     * it will wait for space to become available and ensure that the event
+     * has been enqueued.
+     *
+     * When this call returns, the event has been accepted into the buffer,
+     * but it may not have been published yet.
+     * Publishing will take place at a nondeterministic point in the future as the buffer is processed.
+     *
+     * @param events - An {@link EventData} or `AmqpAnnotatedMessage`.
+     * @param options - A set of options that can be specified to influence the way in which
+     * the event is sent to the associated Event Hub.
+     * - `abortSignal`  : A signal used to cancel the enqueueEvent operation.
+     * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.
+     * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.
+     * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.
+     */
+    async enqueueEvent(event, options = {}) {
+        if (this._isClosed) {
+            throw new Error(`This EventHubBufferedProducerClient has already been closed. Create a new client to enqueue events.`);
+        }
+        if (!this._partitionIds.length) {
+            await this._updatePartitionIds();
+        }
+        if (!this._isBackgroundManagementRunning) {
+            this._startPartitionIdsUpdateLoop().catch((e) => {
+                logger_js_1.logger.error(`The following error occured during batch creation or sending: ${JSON.stringify(e, undefined, "  ")}`);
+            });
+            this._isBackgroundManagementRunning = true;
+        }
+        const partitionId = this._partitionAssigner.assignPartition({
+            partitionId: options.partitionId,
+            partitionKey: options.partitionKey,
+        });
+        const partitionChannel = this._getPartitionChannel(partitionId);
+        await partitionChannel.enqueueEvent(event);
+        return this._getTotalBufferedEventsCount();
+    }
+    /**
+     * Enqueues events into the buffer to be published to the Event Hub.
+     * If there is no capacity in the buffer when this method is invoked,
+     * it will wait for space to become available and ensure that the events
+     * have been enqueued.
+     *
+     * When this call returns, the events have been accepted into the buffer,
+     * but it may not have been published yet.
+     * Publishing will take place at a nondeterministic point in the future as the buffer is processed.
+     *
+     * @param events - An array of {@link EventData} or `AmqpAnnotatedMessage`.
+     * @param options - A set of options that can be specified to influence the way in which
+     * events are sent to the associated Event Hub.
+     * - `abortSignal`  : A signal used to cancel the enqueueEvents operation.
+     * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.
+     * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.
+     * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.
+     */
+    async enqueueEvents(events, 
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
+    options = {}) {
+        for (const event of events) {
+            await this.enqueueEvent(event, options);
+        }
+        return this._getTotalBufferedEventsCount();
+    }
+    /**
+     * Attempts to publish all events in the buffer immediately.
+     * This may result in multiple batches being published,
+     * the outcome of each of which will be individually reported by
+     * the `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.
+     *
+     * @param options - The set of options to apply to the operation call.
+     */
+    async flush(options = {}) {
+        await Promise.all(Array.from(this._partitionChannels.values()).map((channel) => channel.flush(options)));
+    }
+    /**
+     * Provides the Event Hub runtime information.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with information about the Event Hub instance.
+     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getEventHubProperties(options = {}) {
+        return this._producer.getEventHubProperties(options);
+    }
+    /**
+     * Provides the id for each partition associated with the Event Hub.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with an Array of strings representing the id for
+     * each partition associated with the Event Hub.
+     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getPartitionIds(options = {}) {
+        return this._producer.getPartitionIds(options);
+    }
+    /**
+     * Provides information about the state of the specified partition.
+     * @param partitionId - The id of the partition for which information is required.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with information about the state of the partition .
+     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getPartitionProperties(partitionId, options = {}) {
+        return this._producer.getPartitionProperties(partitionId, options);
+    }
+    /**
+     * Gets the `BatchingPartitionChannel` associated with the partitionId.
+     *
+     * If one does not exist, it is created.
+     */
+    _getPartitionChannel(partitionId) {
+        var _a;
+        const partitionChannel = (_a = this._partitionChannels.get(partitionId)) !== null && _a !== void 0 ? _a : new batchingPartitionChannel_js_1.BatchingPartitionChannel({
+            loopAbortSignal: this._abortController.signal,
+            maxBufferSize: this._clientOptions.maxEventBufferLengthPerPartition || 1500,
+            maxWaitTimeInMs: this._clientOptions.maxWaitTimeInMs || 1000,
+            onSendEventsErrorHandler: this._clientOptions.onSendEventsErrorHandler,
+            onSendEventsSuccessHandler: this._clientOptions.onSendEventsSuccessHandler,
+            partitionId,
+            producer: this._producer,
+        });
+        this._partitionChannels.set(partitionId, partitionChannel);
+        return partitionChannel;
+    }
+    /**
+     * Returns the total number of buffered events across all partitions.
+     */
+    _getTotalBufferedEventsCount() {
+        let total = 0;
+        for (const [_, channel] of this._partitionChannels) {
+            total += channel.getCurrentBufferedCount();
+        }
+        return total;
+    }
+    async _updatePartitionIds() {
+        logger_js_1.logger.verbose("Checking for partition Id updates...");
+        const queriedPartitionIds = await this.getPartitionIds();
+        if (this._partitionIds.length !== queriedPartitionIds.length) {
+            logger_js_1.logger.verbose("Applying partition Id updates");
+            this._partitionIds = queriedPartitionIds;
+            this._partitionAssigner.setPartitionIds(this._partitionIds);
+        }
+    }
+    async _startPartitionIdsUpdateLoop() {
+        logger_js_1.logger.verbose("Starting a background loop to check and apply partition id updates...");
+        while (!this._abortController.signal.aborted && !this._isClosed) {
+            await (0, core_amqp_1.delay)(this._backgroundManagementInterval);
+            if (!this._isClosed) {
+                await this._updatePartitionIds();
+            }
+        }
+    }
+}
+exports.EventHubBufferedProducerClient = EventHubBufferedProducerClient;
+//# sourceMappingURL=eventHubBufferedProducerClient.js.map

package/dist/commonjs/eventHubBufferedProducerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventHubBufferedProducerClient.js","sourceRoot":"","sources":["../../src/eventHubBufferedProducerClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,2EAAqE;AAWrE,gDAA6C;AAC7C,wDAAoD;AAEpD,gDAAyC;AACzC,+EAAyE;AACzE,sEAAgE;AAChE,2CAAqC;AACrC,8CAAgD;AA4FhD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,8BAA8B;IAgDzC;;;OAGG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,uBAAuB;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC;IAChD,CAAC;IAiED,YACE,0CAAkD,EAClD,sBAAsE,EACtE,oBAIyC,EACzC,QAAgD;;QAvIlD;;;WAGG;QACK,qBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;QAEjD;;WAEG;QACK,cAAS,GAAY,KAAK,CAAC;QAEnC;;WAEG;QACK,uBAAkB,GAAG,IAAI,wCAAiB,EAAE,CAAC;QAErD;;WAEG;QACK,kBAAa,GAAa,EAAE,CAAC;QAOrC;;;WAGG;QACK,uBAAkB,GAAG,IAAI,GAAG,EAAoC,CAAC;QAOzE;;WAEG;QACK,kCAA6B,GAAG,KAAK,CAAC,CAAC,aAAa;QAE5D;;WAEG;QACK,mCAA8B,GAAG,KAAK,CAAC;QA4F7C,IAAI,OAAO,sBAAsB,KAAK,QAAQ,EAAE,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,MAAA,sBAAsB,CAAC,UAAU,mCAAI,IAAA,wBAAa,GAAE,CAAC;YACvE,IAAI,CAAC,SAAS,GAAG,IAAI,kDAAsB,CAAC,0CAA0C,kCACjF,sBAAsB,KACzB,UAAU,EAAE,IAAI,CAAC,UAAU,IAC3B,CAAC;YACH,IAAI,CAAC,cAAc,qBAAQ,sBAAsB,CAAE,CAAC;QACtD,CAAC;aAAM,IAAI,CAAC,IAAA,4BAAY,EAAC,oBAAoB,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,MAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,UAAU,mCAAI,IAAA,wBAAa,GAAE,CAAC;YACtE,IAAI,CAAC,SAAS,GAAG,IAAI,kDAAsB,CACzC,0CAA0C,EAC1C,sBAAsB,kCACjB,oBAAoB,KAAE,UAAU,EAAE,IAAI,CAAC,UAAU,IACvD,CAAC;YACF,IAAI,CAAC,cAAc,qBAAQ,oBAAqB,CAAE,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,UAAU,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,mCAAI,IAAA,wBAAa,GAAE,CAAC;YAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,kDAAsB,CACzC,0CAA0C,EAC1C,sBAAsB,EACtB,oBAAoB,kCACf,QAAQ,KAAE,UAAU,EAAE,IAAI,CAAC,UAAU,IAC3C,CAAC;YACF,IAAI,CAAC,cAAc,qBAAQ,QAAS,CAAE,CAAC;QACzC,CAAC;QACD,0EAA0E;QACzE,IAAI,CAAC,SAAiB,CAAC,wBAAwB,GAAG,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAK,CAAC,UAAgC,EAAE;QAC5C,kBAAM,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;QACtD,IAAI,CAAC,IAAA,qBAAS,EAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,mEAAmE;QACnE,uEAAuE;QACvE,0DAA0D;QAC1D,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,YAAY,CAChB,KAAuC,EACvC,UAA+B,EAAE;QAEjC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,qGAAqG,CACtG,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE,CAAC;YACzC,IAAI,CAAC,4BAA4B,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC9C,kBAAM,CAAC,KAAK,CACV,iEAAiE,IAAI,CAAC,SAAS,CAC7E,CAAC,EACD,SAAS,EACT,IAAI,CACL,EAAE,CACJ,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8BAA8B,GAAG,IAAI,CAAC;QAC7C,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC;YAC1D,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,YAAY,EAAE,OAAO,CAAC,YAAY;SACnC,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAChE,MAAM,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,4BAA4B,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,aAAa,CACjB,MAA4C;IAC5C,8DAA8D;IAC9D,UAA+B,EAAE;QAEjC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,4BAA4B,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CAAC,UAAgC,EAAE;QAC5C,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CACtF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,qBAAqB,CAAC,UAAwC,EAAE;QAC9D,OAAO,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,UAAkC,EAAE;QAClD,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,WAAmB,EACnB,UAAyC,EAAE;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACK,oBAAoB,CAAC,WAAmB;;QAC9C,MAAM,gBAAgB,GACpB,MAAA,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,mCACxC,IAAI,sDAAwB,CAAC;YAC3B,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM;YAC7C,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,gCAAgC,IAAI,IAAI;YAC3E,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,eAAe,IAAI,IAAI;YAC5D,wBAAwB,EAAE,IAAI,CAAC,cAAc,CAAC,wBAAwB;YACtE,0BAA0B,EAAE,IAAI,CAAC,cAAc,CAAC,0BAA0B;YAC1E,WAAW;YACX,QAAQ,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC,CAAC;QACL,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAC3D,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,4BAA4B;QAClC,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACnD,KAAK,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QAC7C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,kBAAM,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;QACvD,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzD,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,mBAAmB,CAAC,MAAM,EAAE,CAAC;YAC7D,kBAAM,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;YAChD,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC;YACzC,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,4BAA4B;QACxC,kBAAM,CAAC,OAAO,CAAC,uEAAuE,CAAC,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAChE,MAAM,IAAA,iBAAK,EAAO,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACnC,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA7XD,wEA6XC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { EventData } from \"./eventData.js\";\nimport { EventHubProducerClient } from \"./eventHubProducerClient.js\";\nimport type { OperationOptions } from \"./util/operationOptions.js\";\nimport type {\n  EventHubClientOptions,\n  GetEventHubPropertiesOptions,\n  GetPartitionIdsOptions,\n  GetPartitionPropertiesOptions,\n  SendBatchOptions,\n} from \"./models/public.js\";\nimport type { EventHubProperties, PartitionProperties } from \"./managementClient.js\";\nimport type { NamedKeyCredential, SASCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isDefined } from \"@azure/core-util\";\nimport { isCredential } from \"./util/typeGuards.js\";\nimport type { AmqpAnnotatedMessage } from \"@azure/core-amqp\";\nimport { delay } from \"@azure/core-amqp\";\nimport { BatchingPartitionChannel } from \"./batchingPartitionChannel.js\";\nimport { PartitionAssigner } from \"./impl/partitionAssigner.js\";\nimport { logger } from \"./logger.js\";\nimport { getRandomName } from \"./util/utils.js\";\n\n/**\n * Contains the events that were successfully sent to the Event Hub,\n * and the partition they were assigned to.\n */\nexport interface OnSendEventsSuccessContext {\n  /**\n   * The partition each event was assigned.\n   */\n  partitionId: string;\n  /**\n   * The array of {@link EventData} and/or `AmqpAnnotatedMessage` that were successfully sent to the Event Hub.\n   */\n  events: Array<EventData | AmqpAnnotatedMessage>;\n}\n\n/**\n * Contains the events that were not successfully sent to the Event Hub,\n * the partition they were assigned to, and the error that was encountered while sending.\n */\nexport interface OnSendEventsErrorContext {\n  /**\n   * The partition each event was assigned.\n   */\n  partitionId: string;\n  /**\n   * The array of {@link EventData} and/or `AmqpAnnotatedMessage` that were not successfully sent to the Event Hub.\n   */\n  events: Array<EventData | AmqpAnnotatedMessage>;\n  /**\n   * The error that occurred when sending the associated events to the Event Hub.\n   */\n  error: Error;\n}\n\n/**\n * Describes the options that can be provided while creating the `EventHubBufferedProducerClient`.\n */\nexport interface EventHubBufferedProducerClientOptions extends EventHubClientOptions {\n  /**\n   * The total number of events that can be buffered for publishing at a given time for a given partition.\n   *\n   * Default: 1500\n   */\n  maxEventBufferLengthPerPartition?: number;\n  /**\n   * The amount of time to wait for a new event to be enqueued in the buffer before publishing a partially full batch.\n   *\n   * Default: 1 second.\n   */\n  maxWaitTimeInMs?: number;\n  /**\n   * The handler to call once a batch has successfully published.\n   */\n  onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void;\n  /**\n   * The handler to call when a batch fails to publish.\n   */\n  onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void;\n  /**\n   * Indicates whether or not the EventHubProducerClient should enable idempotent publishing to Event Hub partitions.\n   * If enabled, the producer will only be able to publish directly to partitions;\n   * it will not be able to publish to the Event Hubs gateway for automatic partition routing\n   * nor will it be able to use a partition key.\n   * Default: false\n   */\n  enableIdempotentRetries?: boolean;\n}\n\n/**\n * Options to configure the `flush` method on the `EventHubBufferedProducerClient`.\n */\nexport interface BufferedFlushOptions extends OperationOptions {}\n\n/**\n * Options to configure the `close` method on the `EventHubBufferedProducerClient`.\n */\nexport interface BufferedCloseOptions extends OperationOptions {\n  /**\n   * When `true`, all buffered events that are pending should be sent before closing.\n   * When `false`, abandon all buffered events and close immediately.\n   * Defaults to `true`.\n   */\n  flush?: boolean;\n}\n\n/**\n * Options to configure the `enqueueEvents` method on the `EventHubBufferedProducerClient`.\n */\nexport interface EnqueueEventOptions extends SendBatchOptions {}\n\n/**\n * The `EventHubBufferedProducerClient`is used to publish events to a specific Event Hub.\n *\n * The `EventHubBufferedProducerClient` does not publish events immediately.\n * Instead, events are buffered so they can be efficiently batched and published\n * when the batch is full or the `maxWaitTimeInMs` has elapsed with no new events\n * enqueued.\n *\n * Depending on the options specified when events are enqueued, they may be\n * automatically assigned to a partition, grouped according to the specified partition key,\n * or assigned a specifically requested partition.\n *\n * This model is intended to shift the burden of batch management from callers, at the cost of\n * non-deterministic timing, for when events will be published. There are additional trade-offs\n * to consider, as well:\n * - If the application crashes, events in the buffer will not have been published. To prevent\n *   data loss, callers are encouraged to track publishing progress using the\n *   `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.\n * - Events specifying a partition key may be assigned a different partition than those using\n *   the same key with other producers.\n * - In the unlikely event that a partition becomes temporarily unavailable, the\n *   `EventHubBufferedProducerClient` may take longer to recover than other producers.\n *\n * In scenarios where it is important to have events published immediately with a deterministic\n * outcome, ensure that partition keys are assigned to a partition consistent with other\n * publishers, or where maximizing availability is a requirement, using the\n * `EventHubProducerClient` is recommended.\n */\nexport class EventHubBufferedProducerClient {\n  /**\n   * Controls the `abortSignal` passed to each `BatchingPartitionChannel`.\n   * Used to signal when a channel should stop waiting for events.\n   */\n  private _abortController = new AbortController();\n\n  /**\n   * Indicates whether the client has been explicitly closed.\n   */\n  private _isClosed: boolean = false;\n\n  /**\n   * Handles assigning partitions.\n   */\n  private _partitionAssigner = new PartitionAssigner();\n\n  /**\n   * The known partitionIds that will be used when assigning events to partitions.\n   */\n  private _partitionIds: string[] = [];\n\n  /**\n   * The EventHubProducerClient to use when creating and sending batches to the Event Hub.\n   */\n  private _producer: EventHubProducerClient;\n\n  /**\n   * Mapping of partitionIds to `BatchingPartitionChannels`.\n   * Each `BatchingPartitionChannel` handles buffering events and backpressure independently.\n   */\n  private _partitionChannels = new Map<string, BatchingPartitionChannel>();\n\n  /**\n   * The options passed by the user when creating the EventHubBufferedProducerClient instance.\n   */\n  private _clientOptions: EventHubBufferedProducerClientOptions;\n\n  /**\n   * The interval at which the background management operation should run.\n   */\n  private _backgroundManagementInterval = 10000; // 10 seconds\n\n  /**\n   * Indicates whether the background management loop is running.\n   */\n  private _isBackgroundManagementRunning = false;\n\n  /**\n   * @readonly\n   * The name of the Event Hub instance for which this client is created.\n   */\n  get eventHubName(): string {\n    return this._producer.eventHubName;\n  }\n\n  /**\n   * @readonly\n   * The fully qualified namespace of the Event Hub instance for which this client is created.\n   * This is likely to be similar to <yournamespace>.servicebus.windows.net.\n   */\n  get fullyQualifiedNamespace(): string {\n    return this._producer.fullyQualifiedNamespace;\n  }\n\n  /**\n   * The name used to identify this EventHubBufferedProducerClient.\n   * If not specified or empty, a random unique one will be generated.\n   */\n  public readonly identifier: string;\n\n  /**\n   * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.\n   * Use the `options` parmeter to configure retry policy or proxy settings.\n   * @param connectionString - The connection string to use for connecting to the Event Hub instance.\n   * It is expected that the shared key properties and the Event Hub path are contained in this connection string.\n   * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'.\n   * @param options - A set of options to apply when configuring the client.\n   * - `retryOptions`   : Configures the retry policy for all the operations on the client.\n   * For example, `{ \"maxRetries\": 4 }` or `{ \"maxRetries\": 4, \"retryDelayInMs\": 30000 }`.\n   * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.\n   * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.\n   */\n  constructor(connectionString: string, options: EventHubBufferedProducerClientOptions);\n  /**\n   * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.\n   * Use the `options` parmeter to configure retry policy or proxy settings.\n   * @param connectionString - The connection string to use for connecting to the Event Hubs namespace.\n   * It is expected that the shared key properties are contained in this connection string, but not the Event Hub path,\n   * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.\n   * @param eventHubName - The name of the specific Event Hub to connect the client to.\n   * @param options - A set of options to apply when configuring the client.\n   * - `retryOptions`   : Configures the retry policy for all the operations on the client.\n   * For example, `{ \"maxRetries\": 4 }` or `{ \"maxRetries\": 4, \"retryDelayInMs\": 30000 }`.\n   * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.\n   * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.\n   */\n  constructor(\n    connectionString: string,\n    eventHubName: string,\n    options: EventHubBufferedProducerClientOptions,\n  );\n  /**\n   * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.\n   * Use the `options` parmeter to configure retry policy or proxy settings.\n   * @param fullyQualifiedNamespace - The full namespace which is likely to be similar to\n   * <yournamespace>.servicebus.windows.net\n   * @param eventHubName - The name of the specific Event Hub to connect the client to.\n   * @param credential - An credential object used by the client to get the token to authenticate the connection\n   * with the Azure Event Hubs service.\n   * See &commat;azure/identity for creating credentials that support AAD auth.\n   * Use the `AzureNamedKeyCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessKeyName`\n   * and `SharedAccessKey` without using a connection string. These fields map to the `name` and `key` field respectively\n   * in `AzureNamedKeyCredential`.\n   * Use the `AzureSASCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessSignature`\n   * without using a connection string. This field maps to `signature` in `AzureSASCredential`.\n   * @param options - A set of options to apply when configuring the client.\n   * - `retryOptions`   : Configures the retry policy for all the operations on the client.\n   * For example, `{ \"maxRetries\": 4 }` or `{ \"maxRetries\": 4, \"retryDelayInMs\": 30000 }`.\n   * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.\n   * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.\n   */\n  constructor(\n    fullyQualifiedNamespace: string,\n    eventHubName: string,\n    credential: TokenCredential | NamedKeyCredential | SASCredential,\n    options: EventHubBufferedProducerClientOptions,\n  );\n  constructor(\n    fullyQualifiedNamespaceOrConnectionString1: string,\n    eventHubNameOrOptions2: string | EventHubBufferedProducerClientOptions,\n    credentialOrOptions3?:\n      | TokenCredential\n      | NamedKeyCredential\n      | SASCredential\n      | EventHubBufferedProducerClientOptions,\n    options4?: EventHubBufferedProducerClientOptions,\n  ) {\n    if (typeof eventHubNameOrOptions2 !== \"string\") {\n      this.identifier = eventHubNameOrOptions2.identifier ?? getRandomName();\n      this._producer = new EventHubProducerClient(fullyQualifiedNamespaceOrConnectionString1, {\n        ...eventHubNameOrOptions2,\n        identifier: this.identifier,\n      });\n      this._clientOptions = { ...eventHubNameOrOptions2 };\n    } else if (!isCredential(credentialOrOptions3)) {\n      this.identifier = credentialOrOptions3?.identifier ?? getRandomName();\n      this._producer = new EventHubProducerClient(\n        fullyQualifiedNamespaceOrConnectionString1,\n        eventHubNameOrOptions2,\n        { ...credentialOrOptions3, identifier: this.identifier },\n      );\n      this._clientOptions = { ...credentialOrOptions3! };\n    } else {\n      this.identifier = options4?.identifier ?? getRandomName();\n      this._producer = new EventHubProducerClient(\n        fullyQualifiedNamespaceOrConnectionString1,\n        eventHubNameOrOptions2,\n        credentialOrOptions3,\n        { ...options4, identifier: this.identifier },\n      );\n      this._clientOptions = { ...options4! };\n    }\n    // setting internal idempotent publishing option on the standard producer.\n    (this._producer as any)._enableIdempotentRetries = this._clientOptions.enableIdempotentRetries;\n  }\n\n  /**\n   * Closes the AMQP connection to the Event Hub instance,\n   * returning a promise that will be resolved when disconnection is completed.\n   *\n   * This will wait for enqueued events to be flushed to the service before closing\n   * the connection.\n   * To close without flushing, set the `flush` option to `false`.\n   *\n   * @param options - The set of options to apply to the operation call.\n   * @returns Promise<void>\n   * @throws Error if the underlying connection encounters an error while closing.\n   */\n  async close(options: BufferedCloseOptions = {}): Promise<void> {\n    logger.verbose(\"closing buffered producer client...\");\n    if (!isDefined(options.flush) || options.flush === true) {\n      await this.flush(options);\n    }\n    // Calling abort signals to the BatchingPartitionChannels that they\n    // should stop reading/sending events, and to the background management\n    // loop that it should stop periodic partition id updates.\n    this._abortController.abort();\n    await this._producer.close();\n    this._isClosed = true;\n  }\n\n  /**\n   * Enqueues an event into the buffer to be published to the Event Hub.\n   * If there is no capacity in the buffer when this method is invoked,\n   * it will wait for space to become available and ensure that the event\n   * has been enqueued.\n   *\n   * When this call returns, the event has been accepted into the buffer,\n   * but it may not have been published yet.\n   * Publishing will take place at a nondeterministic point in the future as the buffer is processed.\n   *\n   * @param events - An {@link EventData} or `AmqpAnnotatedMessage`.\n   * @param options - A set of options that can be specified to influence the way in which\n   * the event is sent to the associated Event Hub.\n   * - `abortSignal`  : A signal used to cancel the enqueueEvent operation.\n   * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.\n   * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.\n   * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.\n   */\n  async enqueueEvent(\n    event: EventData | AmqpAnnotatedMessage,\n    options: EnqueueEventOptions = {},\n  ): Promise<number> {\n    if (this._isClosed) {\n      throw new Error(\n        `This EventHubBufferedProducerClient has already been closed. Create a new client to enqueue events.`,\n      );\n    }\n\n    if (!this._partitionIds.length) {\n      await this._updatePartitionIds();\n    }\n    if (!this._isBackgroundManagementRunning) {\n      this._startPartitionIdsUpdateLoop().catch((e) => {\n        logger.error(\n          `The following error occured during batch creation or sending: ${JSON.stringify(\n            e,\n            undefined,\n            \"  \",\n          )}`,\n        );\n      });\n      this._isBackgroundManagementRunning = true;\n    }\n\n    const partitionId = this._partitionAssigner.assignPartition({\n      partitionId: options.partitionId,\n      partitionKey: options.partitionKey,\n    });\n\n    const partitionChannel = this._getPartitionChannel(partitionId);\n    await partitionChannel.enqueueEvent(event);\n    return this._getTotalBufferedEventsCount();\n  }\n\n  /**\n   * Enqueues events into the buffer to be published to the Event Hub.\n   * If there is no capacity in the buffer when this method is invoked,\n   * it will wait for space to become available and ensure that the events\n   * have been enqueued.\n   *\n   * When this call returns, the events have been accepted into the buffer,\n   * but it may not have been published yet.\n   * Publishing will take place at a nondeterministic point in the future as the buffer is processed.\n   *\n   * @param events - An array of {@link EventData} or `AmqpAnnotatedMessage`.\n   * @param options - A set of options that can be specified to influence the way in which\n   * events are sent to the associated Event Hub.\n   * - `abortSignal`  : A signal used to cancel the enqueueEvents operation.\n   * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.\n   * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.\n   * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.\n   */\n  async enqueueEvents(\n    events: EventData[] | AmqpAnnotatedMessage[],\n    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options\n    options: EnqueueEventOptions = {},\n  ): Promise<number> {\n    for (const event of events) {\n      await this.enqueueEvent(event, options);\n    }\n\n    return this._getTotalBufferedEventsCount();\n  }\n\n  /**\n   * Attempts to publish all events in the buffer immediately.\n   * This may result in multiple batches being published,\n   * the outcome of each of which will be individually reported by\n   * the `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.\n   *\n   * @param options - The set of options to apply to the operation call.\n   */\n  async flush(options: BufferedFlushOptions = {}): Promise<void> {\n    await Promise.all(\n      Array.from(this._partitionChannels.values()).map((channel) => channel.flush(options)),\n    );\n  }\n\n  /**\n   * Provides the Event Hub runtime information.\n   * @param options - The set of options to apply to the operation call.\n   * @returns A promise that resolves with information about the Event Hub instance.\n   * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.\n   * @throws AbortError if the operation is cancelled via the abortSignal.\n   */\n  getEventHubProperties(options: GetEventHubPropertiesOptions = {}): Promise<EventHubProperties> {\n    return this._producer.getEventHubProperties(options);\n  }\n\n  /**\n   * Provides the id for each partition associated with the Event Hub.\n   * @param options - The set of options to apply to the operation call.\n   * @returns A promise that resolves with an Array of strings representing the id for\n   * each partition associated with the Event Hub.\n   * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.\n   * @throws AbortError if the operation is cancelled via the abortSignal.\n   */\n  getPartitionIds(options: GetPartitionIdsOptions = {}): Promise<Array<string>> {\n    return this._producer.getPartitionIds(options);\n  }\n\n  /**\n   * Provides information about the state of the specified partition.\n   * @param partitionId - The id of the partition for which information is required.\n   * @param options - The set of options to apply to the operation call.\n   * @returns A promise that resolves with information about the state of the partition .\n   * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.\n   * @throws AbortError if the operation is cancelled via the abortSignal.\n   */\n  getPartitionProperties(\n    partitionId: string,\n    options: GetPartitionPropertiesOptions = {},\n  ): Promise<PartitionProperties> {\n    return this._producer.getPartitionProperties(partitionId, options);\n  }\n\n  /**\n   * Gets the `BatchingPartitionChannel` associated with the partitionId.\n   *\n   * If one does not exist, it is created.\n   */\n  private _getPartitionChannel(partitionId: string): BatchingPartitionChannel {\n    const partitionChannel =\n      this._partitionChannels.get(partitionId) ??\n      new BatchingPartitionChannel({\n        loopAbortSignal: this._abortController.signal,\n        maxBufferSize: this._clientOptions.maxEventBufferLengthPerPartition || 1500,\n        maxWaitTimeInMs: this._clientOptions.maxWaitTimeInMs || 1000,\n        onSendEventsErrorHandler: this._clientOptions.onSendEventsErrorHandler,\n        onSendEventsSuccessHandler: this._clientOptions.onSendEventsSuccessHandler,\n        partitionId,\n        producer: this._producer,\n      });\n    this._partitionChannels.set(partitionId, partitionChannel);\n    return partitionChannel;\n  }\n\n  /**\n   * Returns the total number of buffered events across all partitions.\n   */\n  private _getTotalBufferedEventsCount(): number {\n    let total = 0;\n    for (const [_, channel] of this._partitionChannels) {\n      total += channel.getCurrentBufferedCount();\n    }\n\n    return total;\n  }\n\n  private async _updatePartitionIds(): Promise<void> {\n    logger.verbose(\"Checking for partition Id updates...\");\n    const queriedPartitionIds = await this.getPartitionIds();\n\n    if (this._partitionIds.length !== queriedPartitionIds.length) {\n      logger.verbose(\"Applying partition Id updates\");\n      this._partitionIds = queriedPartitionIds;\n      this._partitionAssigner.setPartitionIds(this._partitionIds);\n    }\n  }\n\n  private async _startPartitionIdsUpdateLoop(): Promise<void> {\n    logger.verbose(\"Starting a background loop to check and apply partition id updates...\");\n    while (!this._abortController.signal.aborted && !this._isClosed) {\n      await delay<void>(this._backgroundManagementInterval);\n      if (!this._isClosed) {\n        await this._updatePartitionIds();\n      }\n    }\n  }\n}\n"]}

package/dist/commonjs/eventHubConsumerClient.d.ts

@@ -0,0 +1,277 @@
+import type { CheckpointStore } from "./eventProcessor.js";
+import type { EventHubConsumerClientOptions, GetEventHubPropertiesOptions, GetPartitionIdsOptions, GetPartitionPropertiesOptions } from "./models/public.js";
+import type { EventHubProperties, PartitionProperties } from "./managementClient.js";
+import type { NamedKeyCredential, SASCredential, TokenCredential } from "@azure/core-auth";
+import type { SubscribeOptions, Subscription, SubscriptionEventHandlers } from "./eventHubConsumerClientModels.js";
+/**
+ * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+ *
+ * There are multiple ways to create an `EventHubConsumerClient`
+ * - Use the connection string from the SAS policy created for your Event Hub instance.
+ * - Use the connection string from the SAS policy created for your Event Hub namespace,
+ * and the name of the Event Hub instance
+ * - Use the full namespace like `<yournamespace>.servicebus.windows.net`, and a credentials object.
+ *
+ * Optionally, you can also pass:
+ * - An options bag to configure the retry policy or proxy settings.
+ * - A checkpoint store that is used by the client to read checkpoints to determine the position from where it should
+ * resume receiving events when your application gets restarted. The checkpoint store is also used by the client
+ * to load balance multiple instances of your application.
+ */
+export declare class EventHubConsumerClient {
+    private _consumerGroup;
+    /**
+     * Describes the amqp connection context for the client.
+     */
+    private _context;
+    /**
+     * The options passed by the user when creating the EventHubClient instance.
+     */
+    private _clientOptions;
+    private _partitionGate;
+    /**
+     * The Subscriptions that were spawned by calling `subscribe()`.
+     * Subscriptions that have been stopped by the user will not
+     * be present in this set.
+     */
+    private _subscriptions;
+    /**
+     * The name of the default consumer group in the Event Hubs service.
+     */
+    static defaultConsumerGroupName: string;
+    private _checkpointStore;
+    private _userChoseCheckpointStore;
+    /**
+     * Options for configuring load balancing.
+     */
+    private readonly _loadBalancingOptions;
+    /**
+     * @readonly
+     * The name of the Event Hub instance for which this client is created.
+     */
+    get eventHubName(): string;
+    /**
+     * @readonly
+     * The fully qualified namespace of the Event Hub instance for which this client is created.
+     * This is likely to be similar to <yournamespace>.servicebus.windows.net.
+     */
+    get fullyQualifiedNamespace(): string;
+    /**
+     * The name used to identify this EventHubConsumerClient.
+     * If not specified or empty, a random unique one will be generated.
+     */
+    readonly identifier: string;
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param connectionString - The connection string to use for connecting to the Event Hub instance.
+     * It is expected that the shared key properties and the Event Hub path are contained in this connection string.
+     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions);
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param connectionString - The connection string to use for connecting to the Event Hub instance.
+     * It is expected that the shared key properties and the Event Hub path are contained in this connection string.
+     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'.
+     * @param checkpointStore - A checkpoint store that is used by the client to read checkpoints to determine
+     * the position from where it should resume receiving events when your application gets restarted.
+     * It is also used by the client to load balance multiple instances of your application.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param connectionString - The connection string to use for connecting to the Event Hubs namespace.
+     * It is expected that the shared key properties are contained in this connection string, but not the Event Hub path,
+     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.
+     * @param eventHubName - The name of the specific Event Hub to connect the client to.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions);
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param connectionString - The connection string to use for connecting to the Event Hubs namespace.
+     * It is expected that the shared key properties are contained in this connection string, but not the Event Hub path,
+     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.
+     * @param eventHubName - The name of the specific Event Hub to connect the client to.
+     * @param checkpointStore - A checkpoint store that is used by the client to read checkpoints to determine
+     * the position from where it should resume receiving events when your application gets restarted.
+     * It is also used by the client to load balance multiple instances of your application.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param fullyQualifiedNamespace - The full namespace which is likely to be similar to
+     * <yournamespace>.servicebus.windows.net
+     * @param eventHubName - The name of the specific Event Hub to connect the client to.
+     * @param credential - An credential object used by the client to get the token to authenticate the connection
+     * with the Azure Event Hubs service.
+     * See &commat;azure/identity for creating credentials that support AAD auth.
+     * Use the `AzureNamedKeyCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessKeyName`
+     * and `SharedAccessKey` without using a connection string. These fields map to the `name` and `key` field respectively
+     * in `AzureNamedKeyCredential`.
+     * Use the `AzureSASCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessSignature`
+     * without using a connection string. This field maps to `signature` in `AzureSASCredential`.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions);
+    /**
+     * The `EventHubConsumerClient` class is used to consume events from an Event Hub.
+     * Use the `options` parmeter to configure retry policy or proxy settings.
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param fullyQualifiedNamespace - The full namespace which is likely to be similar to
+     * <yournamespace>.servicebus.windows.net
+     * @param eventHubName - The name of the specific Event Hub to connect the client to.
+     * @param credential - An credential object used by the client to get the token to authenticate the connection
+     * with the Azure Event Hubs service.
+     * See &commat;azure/identity for creating credentials that support AAD auth.
+     * Use the `AzureNamedKeyCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessKeyName`
+     * and `SharedAccessKey` without using a connection string. These fields map to the `name` and `key` field respectively
+     * in `AzureNamedKeyCredential`.
+     * Use the `AzureSASCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessSignature`
+     * without using a connection string. This field maps to `signature` in `AzureSASCredential`.
+     * @param checkpointStore - A checkpoint store that is used by the client to read checkpoints to determine
+     * the position from where it should resume receiving events when your application gets restarted.
+     * It is also used by the client to load balance multiple instances of your application.
+     * @param options - A set of options to apply when configuring the client.
+     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
+     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
+     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
+     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
+     */
+    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
+    /**
+     * Closes the AMQP connection to the Event Hub instance,
+     * returning a promise that will be resolved when disconnection is completed.
+     * @returns Promise<void>
+     * @throws Error if the underlying connection encounters an error while closing.
+     */
+    close(): Promise<void>;
+    /**
+     * Provides the id for each partition associated with the Event Hub.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with an Array of strings representing the id for
+     * each partition associated with the Event Hub.
+     * @throws Error if the underlying connection has been closed, create a new EventHubConsumerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getPartitionIds(options?: GetPartitionIdsOptions): Promise<Array<string>>;
+    /**
+     * Provides information about the state of the specified partition.
+     * @param partitionId - The id of the partition for which information is required.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with information about the state of the partition .
+     * @throws Error if the underlying connection has been closed, create a new EventHubConsumerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>;
+    /**
+     * Provides the Event Hub runtime information.
+     * @param options - The set of options to apply to the operation call.
+     * @returns A promise that resolves with information about the Event Hub instance.
+     * @throws Error if the underlying connection has been closed, create a new EventHubConsumerClient.
+     * @throws AbortError if the operation is cancelled via the abortSignal.
+     */
+    getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>;
+    /**
+     * Subscribe to events from all partitions.
+     *
+     * If checkpoint store is provided to the `EventHubConsumerClient` and there are multiple
+     * instances of your application, then each instance will subscribe to a subset of the
+     * partitions such that the load is balanced amongst them.
+     *
+     * Call close() on the returned object to stop receiving events.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
+     * const subscription = client.subscribe(
+     *  {
+     *    processEvents: (events, context) => { console.log("Received event count: ", events.length) },
+     *    processError: (err, context) => { console.log("Error: ", err) }
+     *  },
+     *  { startPosition: earliestEventPosition }
+     * );
+     * ```
+     *
+     * @param handlers - Handlers for the lifecycle of the subscription - subscription initialization
+     *                 per partition, receiving events, handling errors and the closing
+     *                 of a subscription per partition.
+     * @param options - Configures the way events are received.
+     * Most common are `maxBatchSize` and `maxWaitTimeInSeconds` that control the flow of
+     * events to the handler provided to receive events as well as the start position. For example,
+     * `{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }`
+     */
+    subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription;
+    /**
+     * Subscribe to events from a single partition.
+     * Call close() on the returned object to stop receiving events.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
+     * const subscription = client.subscribe(
+     *  partitionId,
+     *  {
+     *    processEvents: (events, context) => { console.log("Received event count: ", events.length) },
+     *    processError: (err, context) => { console.log("Error: ", err) }
+     *  },
+     *  { startPosition: earliestEventPosition }
+     * );
+     * ```
+     *
+     * @param partitionId - The id of the partition to subscribe to.
+     * @param handlers - Handlers for the lifecycle of the subscription - subscription initialization
+     *                 of the partition, receiving events, handling errors and the closing
+     *                 of a subscription to the partition.
+     * @param options - Configures the way events are received.
+     * Most common are `maxBatchSize` and `maxWaitTimeInSeconds` that control the flow of
+     * events to the handler provided to receive events as well as the start position. For example,
+     * `{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }`
+     */
+    subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription;
+    /**
+     * Gets the LoadBalancing strategy that should be used based on what the user provided.
+     */
+    private _getLoadBalancingStrategy;
+    private createEventProcessorForAllPartitions;
+    private createEventProcessorForSinglePartition;
+    private _createEventProcessor;
+}
+/**
+ * @internal
+ */
+export declare function isCheckpointStore(possible: CheckpointStore | any): possible is CheckpointStore;
+//# sourceMappingURL=eventHubConsumerClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventHubConsumerClient.d.ts","sourceRoot":"","sources":["../../src/eventHubConsumerClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAA6B,MAAM,qBAAqB,CAAC;AAItF,OAAO,KAAK,EACV,6BAA6B,EAC7B,4BAA4B,EAC5B,sBAAsB,EACtB,6BAA6B,EAE9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC3F,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,yBAAyB,EAC1B,MAAM,mCAAmC,CAAC;AAsB3C;;;;;;;;;;;;;;GAcG;AACH,qBAAa,sBAAsB;IAuM/B,OAAO,CAAC,cAAc;IAtMxB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAoB;IACpC;;OAEG;IACH,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,cAAc,CAAuB;IAE7C;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAA2B;IAEjD;;OAEG;IACH,MAAM,CAAC,wBAAwB,EAAE,MAAM,CAAkC;IAEzE,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,yBAAyB,CAAU;IAE3C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAiC;IAEvE;;;OAGG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;;;OAIG;IACH,IAAI,uBAAuB,IAAI,MAAM,CAEpC;IAED;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;;;;;;;;;;;OAYG;gBAED,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;;;OAeG;gBAED,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,EACxB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;OAaG;gBAED,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;;;;OAgBG;gBAED,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;;;;;;;;OAoBG;gBAED,aAAa,EAAE,MAAM,EACrB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,eAAe,GAAG,kBAAkB,GAAG,aAAa,EAChE,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;gBAED,aAAa,EAAE,MAAM,EACrB,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,eAAe,GAAG,kBAAkB,GAAG,aAAa,EAChE,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,6BAA6B;IA8FzC;;;;;OAKG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;;;;;;OAOG;IACH,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAW7E;;;;;;;OAOG;IACH,sBAAsB,CACpB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;;;;OAMG;IACH,qBAAqB,CAAC,OAAO,GAAE,4BAAiC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAO9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,SAAS,CAAC,QAAQ,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,YAAY;IACxF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEH,SAAS,CACP,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,yBAAyB,EACnC,OAAO,CAAC,EAAE,gBAAgB,GACzB,YAAY;IAoDf;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAkBjC,OAAO,CAAC,oCAAoC;IAmC5C,OAAO,CAAC,sCAAsC;IAqC9C,OAAO,CAAC,qBAAqB;CAc9B;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,eAAe,GAAG,GAAG,GAAG,QAAQ,IAAI,eAAe,CAa9F"}