@azure/event-hubs 5.13.0-beta.1 → 6.0.0-alpha.20250128.2

package/dist/commonjs/eventPosition.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Represents the position of an event in an Event Hub partition, typically used when calling the `subscribe()`
+ * method on an `EventHubConsumerClient` to specify the position in the partition to begin receiving events from.
+ *
+ * To get an EventPosition representing the start or end of the stream, use the constants
+ * `earliestEventPosition` and `latestEventPosition` respectively.
+ *
+ */
+export interface EventPosition {
+    /**
+     * The offset of the event identified by this position.
+     * Expected to be undefined if the position is just created from a sequence number or an enqueued time.
+     *
+     * The offset is the relative position for an event in the context of the partition.
+     * The offset should not be considered a stable value.
+     * The same offset may refer to a different event as events reach the age limit for
+     * retention and are no longer visible within the partition.
+     */
+    offset?: string | "@latest";
+    /**
+     * Indicates if the specified offset is inclusive of the event which it identifies.
+     * This information is only relevent if the event position was identified by an offset or sequence number.
+     * Default value: `false`.
+     */
+    isInclusive?: boolean;
+    /**
+     * The enqueued time in UTC of the event identified by this position.
+     * When provided as a number this value is the number of milliseconds since the Unix Epoch.
+     * Expected to be undefined if the position is just created from a sequence number or an offset.
+     */
+    enqueuedOn?: Date | number;
+    /**
+     * The sequence number of the event identified by this position.
+     * Expected to be undefined if the position is just created from an offset or enqueued time.
+     */
+    sequenceNumber?: number;
+}
+/**
+ * @internal
+ * Gets the expression to be set as the filter clause when creating the receiver
+ * @returns filterExpression
+ */
+export declare function getEventPositionFilter(eventPosition: EventPosition): string;
+/**
+ * @internal
+ */
+export declare function isLatestPosition(eventPosition: EventPosition): boolean;
+/**
+ * Gets the `EventPosition` corresponding to the location of the the first event present in the partition.
+ * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the
+ * first event in the partition which has not expired due to the retention policy.
+ */
+export declare const earliestEventPosition: EventPosition;
+/**
+ * Gets the `EventPosition` corresponding to the end of the partition.
+ * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the
+ * event that is enqueued right after the method call.
+ * @returns EventPosition
+ */
+export declare const latestEventPosition: EventPosition;
+/**
+ * @internal
+ */
+export declare function validateEventPositions(position: EventPosition | {
+    [partitionId: string]: EventPosition;
+}): void;
+/**
+ * Determines whether a position is an EventPosition.
+ * Does not validate that the position is allowed.
+ * @internal
+ */
+export declare function isEventPosition(position: unknown): position is EventPosition;
+//# sourceMappingURL=eventPosition.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventPosition.d.ts","sourceRoot":"","sources":["../../src/eventPosition.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CA0B3E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAMtE;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,aAEnC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,EAAE,aAEjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,aAAa,GAAG;IAAE,CAAC,WAAW,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,GACjE,IAAI,CAwBN;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,aAAa,CAkB5E"}

package/dist/commonjs/eventPosition.js

@@ -0,0 +1,128 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.latestEventPosition = exports.earliestEventPosition = void 0;
+exports.getEventPositionFilter = getEventPositionFilter;
+exports.isLatestPosition = isLatestPosition;
+exports.validateEventPositions = validateEventPositions;
+exports.isEventPosition = isEventPosition;
+const core_amqp_1 = require("@azure/core-amqp");
+const core_util_1 = require("@azure/core-util");
+/**
+ * @internal
+ * Gets the expression to be set as the filter clause when creating the receiver
+ * @returns filterExpression
+ */
+function getEventPositionFilter(eventPosition) {
+    let result;
+    // order of preference
+    if ((0, core_util_1.isDefined)(eventPosition.offset)) {
+        result = eventPosition.isInclusive
+            ? `${core_amqp_1.Constants.offsetAnnotation} >= '${eventPosition.offset}'`
+            : `${core_amqp_1.Constants.offsetAnnotation} > '${eventPosition.offset}'`;
+    }
+    else if ((0, core_util_1.isDefined)(eventPosition.sequenceNumber)) {
+        result = eventPosition.isInclusive
+            ? `${core_amqp_1.Constants.sequenceNumberAnnotation} >= '${eventPosition.sequenceNumber}'`
+            : `${core_amqp_1.Constants.sequenceNumberAnnotation} > '${eventPosition.sequenceNumber}'`;
+    }
+    else if ((0, core_util_1.isDefined)(eventPosition.enqueuedOn)) {
+        const time = eventPosition.enqueuedOn instanceof Date
+            ? eventPosition.enqueuedOn.getTime()
+            : eventPosition.enqueuedOn;
+        result = `${core_amqp_1.Constants.enqueuedTimeAnnotation} > '${time}'`;
+    }
+    if (!result) {
+        throw (0, core_amqp_1.translate)({
+            condition: core_amqp_1.ErrorNameConditionMapper.ArgumentError,
+            description: "No starting position was set in the EventPosition.",
+        });
+    }
+    return result;
+}
+/**
+ * @internal
+ */
+function isLatestPosition(eventPosition) {
+    if (eventPosition.offset === "@latest") {
+        return true;
+    }
+    return false;
+}
+/**
+ * Gets the `EventPosition` corresponding to the location of the the first event present in the partition.
+ * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the
+ * first event in the partition which has not expired due to the retention policy.
+ */
+exports.earliestEventPosition = {
+    offset: "-1",
+};
+/**
+ * Gets the `EventPosition` corresponding to the end of the partition.
+ * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the
+ * event that is enqueued right after the method call.
+ * @returns EventPosition
+ */
+exports.latestEventPosition = {
+    offset: "@latest",
+};
+/**
+ * @internal
+ */
+function validateEventPositions(position) {
+    if (!(0, core_util_1.isDefined)(position)) {
+        return;
+    }
+    const keys = Object.keys(position);
+    if (!keys.length) {
+        throw new TypeError("Invalid value for EventPosition found. Pass an object with either of offset, sequenceNumber or enqueuedOn properties set.");
+    }
+    if (isEventPosition(position)) {
+        validateEventPosition(position);
+        return;
+    }
+    const positions = position;
+    for (let i = 0; i < keys.length; i++) {
+        if (Object.prototype.hasOwnProperty.call(positions, keys[i])) {
+            validateEventPosition(positions[keys[i]]);
+        }
+    }
+}
+/**
+ * Determines whether a position is an EventPosition.
+ * Does not validate that the position is allowed.
+ * @internal
+ */
+function isEventPosition(position) {
+    if (!position) {
+        return false;
+    }
+    if ((0, core_util_1.objectHasProperty)(position, "offset") && (0, core_util_1.isDefined)(position.offset)) {
+        return true;
+    }
+    if ((0, core_util_1.objectHasProperty)(position, "sequenceNumber") && (0, core_util_1.isDefined)(position.sequenceNumber)) {
+        return true;
+    }
+    if ((0, core_util_1.objectHasProperty)(position, "enqueuedOn") && (0, core_util_1.isDefined)(position.enqueuedOn)) {
+        return true;
+    }
+    return false;
+}
+function validateEventPosition(position) {
+    if (!(0, core_util_1.isDefined)(position)) {
+        return;
+    }
+    const offsetPresent = (0, core_util_1.isDefined)(position.offset);
+    const sequenceNumberPresent = (0, core_util_1.isDefined)(position.sequenceNumber);
+    const enqueuedOnPresent = (0, core_util_1.isDefined)(position.enqueuedOn);
+    if ((offsetPresent && sequenceNumberPresent) ||
+        (offsetPresent && enqueuedOnPresent) ||
+        (enqueuedOnPresent && sequenceNumberPresent)) {
+        throw new TypeError("Invalid value for EventPosition found. Set only one of offset, sequenceNumber or enqueuedOn properties.");
+    }
+    if (!offsetPresent && !enqueuedOnPresent && !sequenceNumberPresent) {
+        throw new TypeError("Invalid value for EventPosition found. Pass an object with either of offset, sequenceNumber or enqueuedOn properties set.");
+    }
+}
+//# sourceMappingURL=eventPosition.js.map

package/dist/commonjs/eventPosition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventPosition.js","sourceRoot":"","sources":["../../src/eventPosition.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAiDlC,wDA0BC;AAKD,4CAMC;AAwBD,wDA0BC;AAOD,0CAkBC;AA/JD,gDAAkF;AAClF,gDAAgE;AAyChE;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,aAA4B;IACjE,IAAI,MAAM,CAAC;IACX,sBAAsB;IACtB,IAAI,IAAA,qBAAS,EAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,GAAG,aAAa,CAAC,WAAW;YAChC,CAAC,CAAC,GAAG,qBAAS,CAAC,gBAAgB,QAAQ,aAAa,CAAC,MAAM,GAAG;YAC9D,CAAC,CAAC,GAAG,qBAAS,CAAC,gBAAgB,OAAO,aAAa,CAAC,MAAM,GAAG,CAAC;IAClE,CAAC;SAAM,IAAI,IAAA,qBAAS,EAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QACnD,MAAM,GAAG,aAAa,CAAC,WAAW;YAChC,CAAC,CAAC,GAAG,qBAAS,CAAC,wBAAwB,QAAQ,aAAa,CAAC,cAAc,GAAG;YAC9E,CAAC,CAAC,GAAG,qBAAS,CAAC,wBAAwB,OAAO,aAAa,CAAC,cAAc,GAAG,CAAC;IAClF,CAAC;SAAM,IAAI,IAAA,qBAAS,EAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,GACR,aAAa,CAAC,UAAU,YAAY,IAAI;YACtC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE;YACpC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QAC/B,MAAM,GAAG,GAAG,qBAAS,CAAC,sBAAsB,OAAO,IAAI,GAAG,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAA,qBAAS,EAAC;YACd,SAAS,EAAE,oCAAwB,CAAC,aAAa;YACjD,WAAW,EAAE,oDAAoD;SAClE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,aAA4B;IAC3D,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACU,QAAA,qBAAqB,GAAkB;IAClD,MAAM,EAAE,IAAI;CACb,CAAC;AAEF;;;;;GAKG;AACU,QAAA,mBAAmB,GAAkB;IAChD,MAAM,EAAE,SAAS;CAClB,CAAC;AAEF;;GAEG;AACH,SAAgB,sBAAsB,CACpC,QAAkE;IAElE,IAAI,CAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,IAAI,SAAS,CACjB,2HAA2H,CAC5H,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO;IACT,CAAC;IAED,MAAM,SAAS,GAAG,QAAoD,CAAC;IACvE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,QAAiB;IAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,IAAA,6BAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,IAAA,qBAAS,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAA,6BAAiB,EAAC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,IAAA,qBAAS,EAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAA,6BAAiB,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,IAAA,qBAAS,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAuB;IACpD,IAAI,CAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IACD,MAAM,aAAa,GAAG,IAAA,qBAAS,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,qBAAqB,GAAG,IAAA,qBAAS,EAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACjE,MAAM,iBAAiB,GAAG,IAAA,qBAAS,EAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAEzD,IACE,CAAC,aAAa,IAAI,qBAAqB,CAAC;QACxC,CAAC,aAAa,IAAI,iBAAiB,CAAC;QACpC,CAAC,iBAAiB,IAAI,qBAAqB,CAAC,EAC5C,CAAC;QACD,MAAM,IAAI,SAAS,CACjB,yGAAyG,CAC1G,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,aAAa,IAAI,CAAC,iBAAiB,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CACjB,2HAA2H,CAC5H,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { Constants, ErrorNameConditionMapper, translate } from \"@azure/core-amqp\";\nimport { isDefined, objectHasProperty } from \"@azure/core-util\";\n\n/**\n * Represents the position of an event in an Event Hub partition, typically used when calling the `subscribe()`\n * method on an `EventHubConsumerClient` to specify the position in the partition to begin receiving events from.\n *\n * To get an EventPosition representing the start or end of the stream, use the constants\n * `earliestEventPosition` and `latestEventPosition` respectively.\n *\n */\nexport interface EventPosition {\n  /**\n   * The offset of the event identified by this position.\n   * Expected to be undefined if the position is just created from a sequence number or an enqueued time.\n   *\n   * The offset is the relative position for an event in the context of the partition.\n   * The offset should not be considered a stable value.\n   * The same offset may refer to a different event as events reach the age limit for\n   * retention and are no longer visible within the partition.\n   */\n  offset?: string | \"@latest\";\n  /**\n   * Indicates if the specified offset is inclusive of the event which it identifies.\n   * This information is only relevent if the event position was identified by an offset or sequence number.\n   * Default value: `false`.\n   */\n  isInclusive?: boolean;\n  /**\n   * The enqueued time in UTC of the event identified by this position.\n   * When provided as a number this value is the number of milliseconds since the Unix Epoch.\n   * Expected to be undefined if the position is just created from a sequence number or an offset.\n   */\n  enqueuedOn?: Date | number;\n\n  /**\n   * The sequence number of the event identified by this position.\n   * Expected to be undefined if the position is just created from an offset or enqueued time.\n   */\n  sequenceNumber?: number;\n}\n\n/**\n * @internal\n * Gets the expression to be set as the filter clause when creating the receiver\n * @returns filterExpression\n */\nexport function getEventPositionFilter(eventPosition: EventPosition): string {\n  let result;\n  // order of preference\n  if (isDefined(eventPosition.offset)) {\n    result = eventPosition.isInclusive\n      ? `${Constants.offsetAnnotation} >= '${eventPosition.offset}'`\n      : `${Constants.offsetAnnotation} > '${eventPosition.offset}'`;\n  } else if (isDefined(eventPosition.sequenceNumber)) {\n    result = eventPosition.isInclusive\n      ? `${Constants.sequenceNumberAnnotation} >= '${eventPosition.sequenceNumber}'`\n      : `${Constants.sequenceNumberAnnotation} > '${eventPosition.sequenceNumber}'`;\n  } else if (isDefined(eventPosition.enqueuedOn)) {\n    const time =\n      eventPosition.enqueuedOn instanceof Date\n        ? eventPosition.enqueuedOn.getTime()\n        : eventPosition.enqueuedOn;\n    result = `${Constants.enqueuedTimeAnnotation} > '${time}'`;\n  }\n\n  if (!result) {\n    throw translate({\n      condition: ErrorNameConditionMapper.ArgumentError,\n      description: \"No starting position was set in the EventPosition.\",\n    });\n  }\n  return result;\n}\n\n/**\n * @internal\n */\nexport function isLatestPosition(eventPosition: EventPosition): boolean {\n  if (eventPosition.offset === \"@latest\") {\n    return true;\n  }\n\n  return false;\n}\n\n/**\n * Gets the `EventPosition` corresponding to the location of the the first event present in the partition.\n * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the\n * first event in the partition which has not expired due to the retention policy.\n */\nexport const earliestEventPosition: EventPosition = {\n  offset: \"-1\",\n};\n\n/**\n * Gets the `EventPosition` corresponding to the end of the partition.\n * Pass this position to the `EventHubConsumerClient.subscribe()` method to begin receiving events from the\n * event that is enqueued right after the method call.\n * @returns EventPosition\n */\nexport const latestEventPosition: EventPosition = {\n  offset: \"@latest\",\n};\n\n/**\n * @internal\n */\nexport function validateEventPositions(\n  position: EventPosition | { [partitionId: string]: EventPosition },\n): void {\n  if (!isDefined(position)) {\n    return;\n  }\n\n  const keys = Object.keys(position);\n\n  if (!keys.length) {\n    throw new TypeError(\n      \"Invalid value for EventPosition found. Pass an object with either of offset, sequenceNumber or enqueuedOn properties set.\",\n    );\n  }\n\n  if (isEventPosition(position)) {\n    validateEventPosition(position);\n    return;\n  }\n\n  const positions = position as { [partitionId: string]: EventPosition };\n  for (let i = 0; i < keys.length; i++) {\n    if (Object.prototype.hasOwnProperty.call(positions, keys[i])) {\n      validateEventPosition(positions[keys[i]]);\n    }\n  }\n}\n\n/**\n * Determines whether a position is an EventPosition.\n * Does not validate that the position is allowed.\n * @internal\n */\nexport function isEventPosition(position: unknown): position is EventPosition {\n  if (!position) {\n    return false;\n  }\n\n  if (objectHasProperty(position, \"offset\") && isDefined(position.offset)) {\n    return true;\n  }\n\n  if (objectHasProperty(position, \"sequenceNumber\") && isDefined(position.sequenceNumber)) {\n    return true;\n  }\n\n  if (objectHasProperty(position, \"enqueuedOn\") && isDefined(position.enqueuedOn)) {\n    return true;\n  }\n\n  return false;\n}\n\nfunction validateEventPosition(position: EventPosition): void {\n  if (!isDefined(position)) {\n    return;\n  }\n  const offsetPresent = isDefined(position.offset);\n  const sequenceNumberPresent = isDefined(position.sequenceNumber);\n  const enqueuedOnPresent = isDefined(position.enqueuedOn);\n\n  if (\n    (offsetPresent && sequenceNumberPresent) ||\n    (offsetPresent && enqueuedOnPresent) ||\n    (enqueuedOnPresent && sequenceNumberPresent)\n  ) {\n    throw new TypeError(\n      \"Invalid value for EventPosition found. Set only one of offset, sequenceNumber or enqueuedOn properties.\",\n    );\n  }\n\n  if (!offsetPresent && !enqueuedOnPresent && !sequenceNumberPresent) {\n    throw new TypeError(\n      \"Invalid value for EventPosition found. Pass an object with either of offset, sequenceNumber or enqueuedOn properties set.\",\n    );\n  }\n}\n"]}

package/dist/commonjs/eventProcessor.d.ts

@@ -0,0 +1,232 @@
+import type { Checkpoint } from "./partitionProcessor.js";
+import type { PumpManager } from "./pumpManager.js";
+import type { CommonEventProcessorOptions } from "./models/private.js";
+import type { ConnectionContext } from "./connectionContext.js";
+import type { OperationOptions } from "./util/operationOptions.js";
+import type { SubscriptionEventHandlers } from "./eventHubConsumerClientModels.js";
+/**
+ * An interface representing the details on which instance of a `EventProcessor` owns processing
+ * of a given partition from a consumer group of an Event Hub instance.
+ *
+ * **Note**: This is used internally by the `EventProcessor` and user never has to create it directly.
+ */
+export interface PartitionOwnership {
+    /**
+     * The fully qualified Event Hubs namespace. This is likely to be similar to
+     * <yournamespace>.servicebus.windows.net
+     */
+    fullyQualifiedNamespace: string;
+    /**
+     * The event hub name
+     */
+    eventHubName: string;
+    /**
+     * The consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The identifier of the Event Hub partition.
+     */
+    partitionId: string;
+    /**
+     * The unique identifier of the event processor.
+     */
+    ownerId: string;
+    /**
+     * The last modified time.
+     */
+    lastModifiedTimeInMs?: number;
+    /**
+     * The unique identifier for the operation.
+     */
+    etag?: string;
+}
+/**
+ * A checkpoint store stores and retrieves partition ownership information and checkpoint details
+ * for each partition in a given consumer group of an event hub instance.
+ *
+ * Users are not meant to implement an `CheckpointStore`.
+ * Users are expected to choose existing implementations of this interface, instantiate it, and pass
+ * it to the `EventHubConsumerClient` class constructor when instantiating a client.
+ * Users are not expected to use any of the methods on a checkpoint store, these are used internally by
+ * the client.
+ *
+ * Implementations of `CheckpointStore` can be found on npm by searching for packages with the prefix &commat;azure/eventhub-checkpointstore-.
+ */
+export interface CheckpointStore {
+    /**
+     * Called to get the list of all existing partition ownership from the underlying data store. Could return empty
+     * results if there are is no existing ownership information.
+     *
+     * @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 A list of partition ownership details of all the partitions that have/had an owner.
+     */
+    listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>;
+    /**
+     * Called to claim ownership of a list of partitions. This will return the list of partitions that were owned
+     * successfully.
+     *
+     * @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 of partitions this instance successfully claimed ownership.
+     */
+    claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>;
+    /**
+     * 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.
+     */
+    updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>;
+    /**
+     * 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.
+     * @returns A list of checkpoints for a given namespace, eventhub, and consumer group.
+     */
+    listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>;
+}
+/**
+ * A set of options to pass to the constructor of `EventProcessor`.
+ * You can specify
+ * - `maxBatchSize`: The max size of the batch of events passed each time to user code for processing.
+ * - `maxWaitTimeInSeconds`: The maximum amount of time to wait to build up the requested message count before
+ * passing the data to user code for processing. If not provided, it defaults to 60 seconds.
+ *
+ * Example usage with default values:
+ * ```ts
+ * {
+ *     maxBatchSize: 1,
+ *     maxWaitTimeInSeconds: 60,
+ * }
+ * ```
+ * @internal
+ */
+export interface FullEventProcessorOptions extends CommonEventProcessorOptions {
+    /**
+     * An optional pump manager to use, rather than instantiating one internally
+     * @internal
+     */
+    pumpManager?: PumpManager;
+    /**
+     * The amount of time between load balancing attempts.
+     */
+    loopIntervalInMs: number;
+    /**
+     * A specific partition to target.
+     */
+    processingTarget?: string;
+}
+/**
+ * Event Processor based applications consist of one or more instances of EventProcessor which have been
+ * configured to consume events from the same Event Hub and consumer group. They balance the
+ * workload across different instances by distributing the partitions to be processed among themselves.
+ * They also allow the user to track progress when events are processed using checkpoints.
+ *
+ * A checkpoint is meant to represent the last successfully processed event by the user from a particular
+ * partition of a consumer group in an Event Hub instance.
+ *
+ * @internal
+ */
+export declare class EventProcessor {
+    private _consumerGroup;
+    private _context;
+    private _subscriptionEventHandlers;
+    private _checkpointStore;
+    private _processorOptions;
+    private _pumpManager;
+    private _id;
+    private _isRunning;
+    private _loopTask?;
+    private _abortController?;
+    /**
+     * A specific partition to target.
+     */
+    private _processingTarget?;
+    /**
+     * Determines which partitions to claim as part of load balancing.
+     */
+    private _loadBalancingStrategy;
+    /**
+     * The amount of time between load balancing attempts.
+     */
+    private _loopIntervalInMs;
+    private _eventHubName;
+    private _fullyQualifiedNamespace;
+    /**
+     * @param consumerGroup - The name of the consumer group from which you want to process events.
+     * @param eventHubClient - An instance of `EventHubClient` that was created for the Event Hub instance.
+     * @param PartitionProcessorClass - A user-provided class that extends the `PartitionProcessor` class.
+     * This class will be responsible for processing and checkpointing events.
+     * @param checkpointStore - An instance of `CheckpointStore`. See &commat;azure/eventhubs-checkpointstore-blob for an implementation.
+     * For production, choose an implementation that will store checkpoints and partition ownership details to a durable store.
+     * @param options - A set of options to configure the Event Processor
+     * - `maxBatchSize`         : The max size of the batch of events passed each time to user code for processing.
+     * - `maxWaitTimeInSeconds` : The maximum amount of time to wait to build up the requested message count before
+     * passing the data to user code for processing. If not provided, it defaults to 60 seconds.
+     */
+    constructor(_consumerGroup: string, _context: ConnectionContext, _subscriptionEventHandlers: SubscriptionEventHandlers, _checkpointStore: CheckpointStore, options: FullEventProcessorOptions);
+    /**
+     * The unique identifier for the EventProcessor.
+     */
+    get id(): string;
+    private _createPartitionOwnershipRequest;
+    private _claimOwnership;
+    private _startPump;
+    private _getStartingPosition;
+    private _runLoopForSinglePartition;
+    /**
+     * Every loop to this method will result in this EventProcessor owning at most one new partition.
+     *
+     * The load is considered balanced when no active EventProcessor owns 2 partitions more than any other active
+     * EventProcessor. Given that each invocation to this method results in ownership claim of at most one partition,
+     * this algorithm converges gradually towards a steady state.
+     *
+     * When a new partition is claimed, this method is also responsible for starting a partition pump that creates an
+     * EventHubConsumer for processing events from that partition.
+     */
+    private _runLoopWithLoadBalancing;
+    private _performLoadBalancing;
+    /**
+     * This is called when there are errors that are not specific to a partition (ex: load balancing)
+     */
+    private _handleSubscriptionError;
+    /**
+     * Starts the `EventProcessor`. Based on the number of instances of `EventProcessor` that are running for the
+     * same consumer group, the partitions are distributed among these instances to process events.
+     *
+     * For each partition, the user provided `PartitionProcessor` is instantiated.
+     *
+     * Subsequent calls to start will be ignored if this event processor is already running.
+     * Calling `start()` after `stop()` is called will restart this event processor.
+     *
+     */
+    start(): void;
+    isRunning(): boolean;
+    /**
+     * Stops processing events for all partitions owned by this event processor.
+     * All `PartitionProcessor` will be shutdown and any open resources will be closed.
+     *
+     * Subsequent calls to stop will be ignored if the event processor is not running.
+     *
+     */
+    stop(): Promise<void>;
+    private abandonPartitionOwnerships;
+}
+//# sourceMappingURL=eventProcessor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventProcessor.d.ts","sourceRoot":"","sources":["../../src/eventProcessor.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAI1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAIpD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAKnF;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACjC;;;;;;;;;OASG;IACH,cAAc,CACZ,kBAAkB,EAAE,kBAAkB,EAAE,EACxC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpF;;;;;;;;;;;OAWG;IACH,eAAe,CACb,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,yBAA0B,SAAQ,2BAA2B;IAC5E;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;GAUG;AACH,qBAAa,cAAc;IAmCvB,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,0BAA0B;IAClC,OAAO,CAAC,gBAAgB;IArC1B,OAAO,CAAC,iBAAiB,CAA4B;IACrD,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAAS;IACnC;;OAEG;IACH,OAAO,CAAC,sBAAsB,CAAwB;IACtD;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,wBAAwB,CAAS;IAEzC;;;;;;;;;;;OAWG;gBAEO,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,iBAAiB,EAC3B,0BAA0B,EAAE,yBAAyB,EACrD,gBAAgB,EAAE,eAAe,EACzC,OAAO,EAAE,yBAAyB;IAoBpC;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,OAAO,CAAC,gCAAgC;YAoB1B,eAAe;YAoCf,UAAU;YA0CV,oBAAoB;YAqBpB,0BAA0B;IAyBxC;;;;;;;;;OASG;YACW,yBAAyB;YAkDzB,qBAAqB;IAmCnC;;OAEG;YACW,wBAAwB;IAyBtC;;;;;;;;;OASG;IACH,KAAK,IAAI,IAAI;IAyBb,SAAS,IAAI,OAAO;IAIpB;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YA2Bb,0BAA0B;CAczC"}