@relaybus/kafka 0.2.0 → 0.3.1

package/dist/index.d.cts

@@ -1,4 +1,42 @@
-import { RelayBusError, NonRetryableError, EventEnvelope, EventHeaders, Duration, Transport, RelayBusLogger, TransportMessageHandler } from '@relaybus/core';
+import { RelayBusError, NonRetryableError, EventEnvelope, EventHeaders, Duration, RelayBusLogger } from '@relaybus/core';
+import { JsonEnvelopeMapping, SubscribingTransport, TransportSubscription } from '@relaybus/core/internal';
+export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
+
+/** A Kafka record that cannot be turned into an {@link EventEnvelope}. Never retried. */
+declare class InvalidKafkaMessageError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/**
+ * An event that cannot be written to Kafka: its payload is not representable as
+ * JSON (`undefined`, a function, a symbol, a `BigInt`, a circular structure) or
+ * its `occurredAt` is not an RFC 3339 instant (invalid date, year outside 0..9999).
+ * Retrying cannot help, so it is a {@link NonRetryableError}.
+ */
+declare class UnencodableEventError extends NonRetryableError {
+    name: string;
+    readonly code: string;
+}
+/** `publish` did not get a broker ack within `publishTimeout`. The outbox retries it. */
+declare class PublishTimeoutError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** The transport was closed: it no longer publishes or subscribes. */
+declare class TransportClosedError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** The consumer did not join its group within `startupTimeout`. */
+declare class GroupJoinTimeoutError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** A handler failure re-thrown to the Kafka client, stripped of anything that could make it fatal. */
+declare class HandlerFailedError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
 
 /**
  * Structural views of the Kafka client API used by this package.
@@ -97,18 +135,6 @@ interface KafkaClientLike {
     consumer(config: KafkaConsumerConfig): KafkaConsumerLike;
 }
 
-/** A Kafka record that cannot be turned into an {@link EventEnvelope}. Never retried. */
-declare class InvalidKafkaMessageError extends RelayBusError {
-}
-/**
- * An event that cannot be written to Kafka: its payload is not representable as
- * JSON (`undefined`, a function, a symbol, a `BigInt`, a circular structure) or
- * its `occurredAt` is not an RFC 3339 instant (invalid date, year outside 0..9999).
- * Retrying cannot help, so it is a {@link NonRetryableError}.
- */
-declare class UnencodableEventError extends NonRetryableError {
-    name: string;
-}
 /** The wire form of one event: a Kafka record in CloudEvents binary content mode. */
 interface EncodedMessage {
     readonly key: string | null;
@@ -262,6 +288,69 @@ declare function decodeCloudEvent(record: DecodableMessage): EventEnvelope;
  */
 declare function plainJsonDecoder(options: PlainJsonDecoderOptions): KafkaMessageDecoder;
 
+/** The record a codec produces for one event. `timestamp` is epoch milliseconds in a string. */
+type KafkaEncodedRecord = KafkaOutgoingMessage & {
+    readonly timestamp?: string;
+};
+/**
+ * The wire format of a {@link KafkaTransport}: how an event becomes a record
+ * (`encode`, on publish) and a consumed record becomes an event (`decode`).
+ *
+ * Both must be synchronous and free of side effects. What `encode` throws
+ * fails the publish: the outbox retries it, unless it is a `NonRetryableError`
+ * such as {@link UnencodableEventError}. What `decode` throws marks the record
+ * as malformed: it goes to `onInvalidMessage` (dead-letter by default) and the
+ * consumer moves on. See {@link KafkaMessageDecoder} for the decode contract.
+ */
+interface KafkaCodec {
+    readonly encode: (envelope: EventEnvelope) => KafkaEncodedRecord;
+    readonly decode: KafkaMessageDecoder;
+}
+/**
+ * CloudEvents 1.0 binary content mode, the default: the value is the JSON
+ * payload, the attributes travel as `ce_*` headers ({@link encodeEnvelope}).
+ * Decoding is strict: any other record is malformed ({@link decodeEnvelope}).
+ */
+declare const cloudEventsBinary: KafkaCodec;
+/**
+ * CloudEvents 1.0 structured content mode: the value is one
+ * `application/cloudevents+json` document with the attributes and `data`.
+ * Decoding accepts structured and binary mode ({@link decodeCloudEvent}), so a
+ * topic can move from one to the other while both are in flight.
+ */
+declare const cloudEventsStructured: KafkaCodec;
+/**
+ * Where each value of a JSON message lives, for {@link jsonEnvelope}. Besides
+ * `{ body }` and `{ header }`, the id may be `'record-position'`: a consumed
+ * record gets `kafka:<topic>:<partition>:<offset>`, stable across redeliveries
+ * but different for two sends of one event. Records relaybus writes carry the
+ * event id in a `relaybus-event-id` header, which wins on read, so an outbox
+ * retry that sends an event twice is still deduplicated.
+ */
+type KafkaJsonEnvelopeMapping = JsonEnvelopeMapping<'record-position'>;
+/**
+ * A JSON wire format declared by a mapping, in both directions: for topics
+ * shared with services that wrap events in their own envelope
+ * (`{ "eventName": ..., "data": {...} }`, MassTransit) or send the bare
+ * payload. The record key is always the event key; when `occurredAt` is not
+ * mapped, the record timestamp carries it. Event headers that are message
+ * headers are written as they are, so a name the mapping uses for another
+ * field is refused with {@link UnencodableEventError}, as are `content-type`
+ * and `relaybus-event-id`.
+ *
+ * ```ts
+ * codec: jsonEnvelope({
+ *   type: { body: 'eventName' },
+ *   id: { body: 'messageId' },
+ *   payload: { body: 'data' },
+ *   correlationId: { body: 'meta.correlationId' },
+ * })
+ * ```
+ *
+ * @throws ConfigurationError for an incomplete or self-overlapping mapping.
+ */
+declare function jsonEnvelope(mapping: KafkaJsonEnvelopeMapping): KafkaCodec;
+
 /** A record the transport refused to hand to the bus because it is malformed. */
 interface InvalidKafkaMessage {
     readonly topic: string;
@@ -291,14 +380,6 @@ interface InvalidKafkaMessage {
 type InvalidMessagePolicy = 'dead-letter' | 'skip' | ((message: InvalidKafkaMessage) => void | Promise<void>) | {
     readonly deadLetterTopic: string | ((sourceTopic: string) => string);
 };
-/** `publish` did not get a broker ack within `publishTimeout`. The outbox retries it. */
-declare class PublishTimeoutError extends RelayBusError {
-    name: string;
-}
-/** A handler failure re-thrown to the Kafka client, stripped of anything that could make it fatal. */
-declare class HandlerFailedError extends RelayBusError {
-    name: string;
-}
 /** Bounded in-process retries around the inbound handler (the bus's `receive`). */
 interface KafkaProcessingOptions {
     /** Attempts per delivery of a record before the error is handed to the client. Default 5. */
@@ -344,24 +425,33 @@ interface KafkaTransportOptions {
     /** Handling of records that cannot be processed for good. Default `'dead-letter'`. */
     readonly onInvalidMessage?: InvalidMessagePolicy;
     /**
-     * How consumed records become events. Default: strict CloudEvents binary
-     * mode ({@link decodeEnvelope}), which is what relaybus producers write; any
-     * other record is malformed and goes to `onInvalidMessage`. Set it to read
-     * topics written by services that do not use relaybus:
-     * {@link decodeCloudEvent} also accepts structured mode, {@link plainJsonDecoder}
-     * maps plain JSON records, and a function of your own can do anything else
-     * (switch on `record.topic` to decode topics differently). Whatever a custom
-     * decoder throws marks the record as malformed, never crashes the consumer.
+     * The wire format, both ways: how events become records and consumed records
+     * become events. Default {@link cloudEventsBinary}: CloudEvents binary mode,
+     * strict on read, so any other record is malformed and goes to
+     * `onInvalidMessage`. {@link cloudEventsStructured} writes structured mode
+     * and reads both, {@link jsonEnvelope} maps a JSON format of your own (an
+     * envelope with the payload inside, or the bare payload), and an object with
+     * `encode` and `decode` can do anything else. Whatever a non-default codec's
+     * `decode` throws marks the record as malformed, never crashes the consumer.
+     */
+    readonly codec?: KafkaCodec;
+    /**
+     * How consumed records become events; events are still written in
+     * CloudEvents binary mode.
+     *
+     * @deprecated Use `codec`: `decode: fn` is `codec: { encode: encodeEnvelope, decode: fn }`.
+     * Giving both `decode` and `codec` is a configuration error.
      */
     readonly decode?: KafkaMessageDecoder;
     /** Default `console`. */
     readonly logger?: RelayBusLogger;
 }
+
 /**
  * Kafka {@link Transport}. Events travel as CloudEvents binary-mode records
  * (`ce_*` headers, JSON value), so any CloudEvents-aware consumer can read them.
- * Records from producers that do not use relaybus are read through the
- * `decode` option.
+ * The `codec` option changes the wire format, for example to read and write
+ * the JSON format of services that do not use relaybus.
  *
  * Publishing: idempotent producer, `acks=-1`, resolves after the broker ack and
  * rejects with {@link PublishTimeoutError} after `publishTimeout`. A timed-out
@@ -380,9 +470,10 @@ interface KafkaTransportOptions {
  * reports an unrecoverable crash anyway, the consumer run loop is restarted with
  * bounded backoff until the transport is closed.
  */
-declare class KafkaTransport implements Transport {
+declare class KafkaTransport extends SubscribingTransport {
     #private;
     readonly name: string;
+    readonly system = "kafka";
     constructor(options: KafkaTransportOptions);
     /**
      * True while the consumer is joined to its group, not between a crash or
@@ -407,38 +498,9 @@ declare class KafkaTransport implements Transport {
      * @throws ConfigurationError when `groupId` is missing, `destinations` is empty
      * or the transport already subscribed (create one transport per subscription).
      */
-    subscribe(destinations: readonly string[], onMessage: TransportMessageHandler): Promise<void>;
+    protected openSubscription(subscription: TransportSubscription): Promise<void>;
     /** Stops consuming and disconnects the consumer and the producer. Safe to call twice. */
     close(): Promise<void>;
 }
 
-/**
- * Reads one header of an incoming message, for the `type`, `id`, `key` or
- * `source` option of {@link plainJsonDecoder}. Header names are compared
- * exactly (Kafka header names are case-sensitive). Returns undefined when the
- * header is absent, so the decoder falls back to its default.
- *
- * ```ts
- * plainJsonDecoder({ type: fromHeader('event-type'), id: fromHeader('message-id') })
- * ```
- */
-declare function fromHeader(name: string): (message: {
-    readonly headers: EventHeaders;
-}) => string | undefined;
-/**
- * Reads a field of the JSON payload by a dotted path (`'meta.eventType'`), for
- * the `type`, `id`, `key` or `source` option of {@link plainJsonDecoder}. A
- * string is returned as is and a safe integer as its decimal text (numeric ids
- * are common). Anything else returns undefined so the decoder falls back to its
- * default: a missing field, and also a fraction or an integer beyond 2^53, which
- * JSON parsing may already have rounded, so two different ids could collide.
- *
- * ```ts
- * plainJsonDecoder({ type: fromPayloadField('eventType'), key: fromPayloadField('order.id') })
- * ```
- */
-declare function fromPayloadField(path: string): (message: {
-    readonly payload: unknown;
-}) => string | undefined;
-
-export { type DecodableMessage, type DecodedEvent, type EncodedMessage, HandlerFailedError, type InvalidKafkaMessage, InvalidKafkaMessageError, type InvalidMessagePolicy, type KafkaBytes, type KafkaClientLike, type KafkaConsumerConfig, type KafkaConsumerEvent, type KafkaConsumerEventNames, type KafkaConsumerLike, type KafkaEachMessagePayload, type KafkaInboundRecord, type KafkaIncomingHeaders, type KafkaIncomingMessage, type KafkaMessageDecoder, type KafkaOutgoingHeaders, type KafkaOutgoingMessage, type KafkaProcessingOptions, type KafkaProducerConfig, type KafkaProducerLike, type KafkaProducerRecord, type KafkaRestartOptions, type KafkaRunConfig, KafkaTransport, type KafkaTransportOptions, type PlainJsonDecoderOptions, type PlainJsonRecord, PublishTimeoutError, UnencodableEventError, decodeCloudEvent, decodeEnvelope, encodeEnvelope, fromHeader, fromPayloadField, plainJsonDecoder };
+export { type DecodableMessage, type DecodedEvent, type EncodedMessage, GroupJoinTimeoutError, HandlerFailedError, type InvalidKafkaMessage, InvalidKafkaMessageError, type InvalidMessagePolicy, type KafkaBytes, type KafkaClientLike, type KafkaCodec, type KafkaConsumerConfig, type KafkaConsumerEvent, type KafkaConsumerEventNames, type KafkaConsumerLike, type KafkaEachMessagePayload, type KafkaEncodedRecord, type KafkaInboundRecord, type KafkaIncomingHeaders, type KafkaIncomingMessage, type KafkaJsonEnvelopeMapping, type KafkaMessageDecoder, type KafkaOutgoingHeaders, type KafkaOutgoingMessage, type KafkaProcessingOptions, type KafkaProducerConfig, type KafkaProducerLike, type KafkaProducerRecord, type KafkaRestartOptions, type KafkaRunConfig, KafkaTransport, type KafkaTransportOptions, type PlainJsonDecoderOptions, type PlainJsonRecord, PublishTimeoutError, TransportClosedError, UnencodableEventError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, decodeEnvelope, encodeEnvelope, jsonEnvelope, plainJsonDecoder };

package/dist/index.d.ts

@@ -1,4 +1,42 @@
-import { RelayBusError, NonRetryableError, EventEnvelope, EventHeaders, Duration, Transport, RelayBusLogger, TransportMessageHandler } from '@relaybus/core';
+import { RelayBusError, NonRetryableError, EventEnvelope, EventHeaders, Duration, RelayBusLogger } from '@relaybus/core';
+import { JsonEnvelopeMapping, SubscribingTransport, TransportSubscription } from '@relaybus/core/internal';
+export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
+
+/** A Kafka record that cannot be turned into an {@link EventEnvelope}. Never retried. */
+declare class InvalidKafkaMessageError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/**
+ * An event that cannot be written to Kafka: its payload is not representable as
+ * JSON (`undefined`, a function, a symbol, a `BigInt`, a circular structure) or
+ * its `occurredAt` is not an RFC 3339 instant (invalid date, year outside 0..9999).
+ * Retrying cannot help, so it is a {@link NonRetryableError}.
+ */
+declare class UnencodableEventError extends NonRetryableError {
+    name: string;
+    readonly code: string;
+}
+/** `publish` did not get a broker ack within `publishTimeout`. The outbox retries it. */
+declare class PublishTimeoutError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** The transport was closed: it no longer publishes or subscribes. */
+declare class TransportClosedError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** The consumer did not join its group within `startupTimeout`. */
+declare class GroupJoinTimeoutError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** A handler failure re-thrown to the Kafka client, stripped of anything that could make it fatal. */
+declare class HandlerFailedError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
 
 /**
  * Structural views of the Kafka client API used by this package.
@@ -97,18 +135,6 @@ interface KafkaClientLike {
     consumer(config: KafkaConsumerConfig): KafkaConsumerLike;
 }
 
-/** A Kafka record that cannot be turned into an {@link EventEnvelope}. Never retried. */
-declare class InvalidKafkaMessageError extends RelayBusError {
-}
-/**
- * An event that cannot be written to Kafka: its payload is not representable as
- * JSON (`undefined`, a function, a symbol, a `BigInt`, a circular structure) or
- * its `occurredAt` is not an RFC 3339 instant (invalid date, year outside 0..9999).
- * Retrying cannot help, so it is a {@link NonRetryableError}.
- */
-declare class UnencodableEventError extends NonRetryableError {
-    name: string;
-}
 /** The wire form of one event: a Kafka record in CloudEvents binary content mode. */
 interface EncodedMessage {
     readonly key: string | null;
@@ -262,6 +288,69 @@ declare function decodeCloudEvent(record: DecodableMessage): EventEnvelope;
  */
 declare function plainJsonDecoder(options: PlainJsonDecoderOptions): KafkaMessageDecoder;
 
+/** The record a codec produces for one event. `timestamp` is epoch milliseconds in a string. */
+type KafkaEncodedRecord = KafkaOutgoingMessage & {
+    readonly timestamp?: string;
+};
+/**
+ * The wire format of a {@link KafkaTransport}: how an event becomes a record
+ * (`encode`, on publish) and a consumed record becomes an event (`decode`).
+ *
+ * Both must be synchronous and free of side effects. What `encode` throws
+ * fails the publish: the outbox retries it, unless it is a `NonRetryableError`
+ * such as {@link UnencodableEventError}. What `decode` throws marks the record
+ * as malformed: it goes to `onInvalidMessage` (dead-letter by default) and the
+ * consumer moves on. See {@link KafkaMessageDecoder} for the decode contract.
+ */
+interface KafkaCodec {
+    readonly encode: (envelope: EventEnvelope) => KafkaEncodedRecord;
+    readonly decode: KafkaMessageDecoder;
+}
+/**
+ * CloudEvents 1.0 binary content mode, the default: the value is the JSON
+ * payload, the attributes travel as `ce_*` headers ({@link encodeEnvelope}).
+ * Decoding is strict: any other record is malformed ({@link decodeEnvelope}).
+ */
+declare const cloudEventsBinary: KafkaCodec;
+/**
+ * CloudEvents 1.0 structured content mode: the value is one
+ * `application/cloudevents+json` document with the attributes and `data`.
+ * Decoding accepts structured and binary mode ({@link decodeCloudEvent}), so a
+ * topic can move from one to the other while both are in flight.
+ */
+declare const cloudEventsStructured: KafkaCodec;
+/**
+ * Where each value of a JSON message lives, for {@link jsonEnvelope}. Besides
+ * `{ body }` and `{ header }`, the id may be `'record-position'`: a consumed
+ * record gets `kafka:<topic>:<partition>:<offset>`, stable across redeliveries
+ * but different for two sends of one event. Records relaybus writes carry the
+ * event id in a `relaybus-event-id` header, which wins on read, so an outbox
+ * retry that sends an event twice is still deduplicated.
+ */
+type KafkaJsonEnvelopeMapping = JsonEnvelopeMapping<'record-position'>;
+/**
+ * A JSON wire format declared by a mapping, in both directions: for topics
+ * shared with services that wrap events in their own envelope
+ * (`{ "eventName": ..., "data": {...} }`, MassTransit) or send the bare
+ * payload. The record key is always the event key; when `occurredAt` is not
+ * mapped, the record timestamp carries it. Event headers that are message
+ * headers are written as they are, so a name the mapping uses for another
+ * field is refused with {@link UnencodableEventError}, as are `content-type`
+ * and `relaybus-event-id`.
+ *
+ * ```ts
+ * codec: jsonEnvelope({
+ *   type: { body: 'eventName' },
+ *   id: { body: 'messageId' },
+ *   payload: { body: 'data' },
+ *   correlationId: { body: 'meta.correlationId' },
+ * })
+ * ```
+ *
+ * @throws ConfigurationError for an incomplete or self-overlapping mapping.
+ */
+declare function jsonEnvelope(mapping: KafkaJsonEnvelopeMapping): KafkaCodec;
+
 /** A record the transport refused to hand to the bus because it is malformed. */
 interface InvalidKafkaMessage {
     readonly topic: string;
@@ -291,14 +380,6 @@ interface InvalidKafkaMessage {
 type InvalidMessagePolicy = 'dead-letter' | 'skip' | ((message: InvalidKafkaMessage) => void | Promise<void>) | {
     readonly deadLetterTopic: string | ((sourceTopic: string) => string);
 };
-/** `publish` did not get a broker ack within `publishTimeout`. The outbox retries it. */
-declare class PublishTimeoutError extends RelayBusError {
-    name: string;
-}
-/** A handler failure re-thrown to the Kafka client, stripped of anything that could make it fatal. */
-declare class HandlerFailedError extends RelayBusError {
-    name: string;
-}
 /** Bounded in-process retries around the inbound handler (the bus's `receive`). */
 interface KafkaProcessingOptions {
     /** Attempts per delivery of a record before the error is handed to the client. Default 5. */
@@ -344,24 +425,33 @@ interface KafkaTransportOptions {
     /** Handling of records that cannot be processed for good. Default `'dead-letter'`. */
     readonly onInvalidMessage?: InvalidMessagePolicy;
     /**
-     * How consumed records become events. Default: strict CloudEvents binary
-     * mode ({@link decodeEnvelope}), which is what relaybus producers write; any
-     * other record is malformed and goes to `onInvalidMessage`. Set it to read
-     * topics written by services that do not use relaybus:
-     * {@link decodeCloudEvent} also accepts structured mode, {@link plainJsonDecoder}
-     * maps plain JSON records, and a function of your own can do anything else
-     * (switch on `record.topic` to decode topics differently). Whatever a custom
-     * decoder throws marks the record as malformed, never crashes the consumer.
+     * The wire format, both ways: how events become records and consumed records
+     * become events. Default {@link cloudEventsBinary}: CloudEvents binary mode,
+     * strict on read, so any other record is malformed and goes to
+     * `onInvalidMessage`. {@link cloudEventsStructured} writes structured mode
+     * and reads both, {@link jsonEnvelope} maps a JSON format of your own (an
+     * envelope with the payload inside, or the bare payload), and an object with
+     * `encode` and `decode` can do anything else. Whatever a non-default codec's
+     * `decode` throws marks the record as malformed, never crashes the consumer.
+     */
+    readonly codec?: KafkaCodec;
+    /**
+     * How consumed records become events; events are still written in
+     * CloudEvents binary mode.
+     *
+     * @deprecated Use `codec`: `decode: fn` is `codec: { encode: encodeEnvelope, decode: fn }`.
+     * Giving both `decode` and `codec` is a configuration error.
      */
     readonly decode?: KafkaMessageDecoder;
     /** Default `console`. */
     readonly logger?: RelayBusLogger;
 }
+
 /**
  * Kafka {@link Transport}. Events travel as CloudEvents binary-mode records
  * (`ce_*` headers, JSON value), so any CloudEvents-aware consumer can read them.
- * Records from producers that do not use relaybus are read through the
- * `decode` option.
+ * The `codec` option changes the wire format, for example to read and write
+ * the JSON format of services that do not use relaybus.
  *
  * Publishing: idempotent producer, `acks=-1`, resolves after the broker ack and
  * rejects with {@link PublishTimeoutError} after `publishTimeout`. A timed-out
@@ -380,9 +470,10 @@ interface KafkaTransportOptions {
  * reports an unrecoverable crash anyway, the consumer run loop is restarted with
  * bounded backoff until the transport is closed.
  */
-declare class KafkaTransport implements Transport {
+declare class KafkaTransport extends SubscribingTransport {
     #private;
     readonly name: string;
+    readonly system = "kafka";
     constructor(options: KafkaTransportOptions);
     /**
      * True while the consumer is joined to its group, not between a crash or
@@ -407,38 +498,9 @@ declare class KafkaTransport implements Transport {
      * @throws ConfigurationError when `groupId` is missing, `destinations` is empty
      * or the transport already subscribed (create one transport per subscription).
      */
-    subscribe(destinations: readonly string[], onMessage: TransportMessageHandler): Promise<void>;
+    protected openSubscription(subscription: TransportSubscription): Promise<void>;
     /** Stops consuming and disconnects the consumer and the producer. Safe to call twice. */
     close(): Promise<void>;
 }
 
-/**
- * Reads one header of an incoming message, for the `type`, `id`, `key` or
- * `source` option of {@link plainJsonDecoder}. Header names are compared
- * exactly (Kafka header names are case-sensitive). Returns undefined when the
- * header is absent, so the decoder falls back to its default.
- *
- * ```ts
- * plainJsonDecoder({ type: fromHeader('event-type'), id: fromHeader('message-id') })
- * ```
- */
-declare function fromHeader(name: string): (message: {
-    readonly headers: EventHeaders;
-}) => string | undefined;
-/**
- * Reads a field of the JSON payload by a dotted path (`'meta.eventType'`), for
- * the `type`, `id`, `key` or `source` option of {@link plainJsonDecoder}. A
- * string is returned as is and a safe integer as its decimal text (numeric ids
- * are common). Anything else returns undefined so the decoder falls back to its
- * default: a missing field, and also a fraction or an integer beyond 2^53, which
- * JSON parsing may already have rounded, so two different ids could collide.
- *
- * ```ts
- * plainJsonDecoder({ type: fromPayloadField('eventType'), key: fromPayloadField('order.id') })
- * ```
- */
-declare function fromPayloadField(path: string): (message: {
-    readonly payload: unknown;
-}) => string | undefined;
-
-export { type DecodableMessage, type DecodedEvent, type EncodedMessage, HandlerFailedError, type InvalidKafkaMessage, InvalidKafkaMessageError, type InvalidMessagePolicy, type KafkaBytes, type KafkaClientLike, type KafkaConsumerConfig, type KafkaConsumerEvent, type KafkaConsumerEventNames, type KafkaConsumerLike, type KafkaEachMessagePayload, type KafkaInboundRecord, type KafkaIncomingHeaders, type KafkaIncomingMessage, type KafkaMessageDecoder, type KafkaOutgoingHeaders, type KafkaOutgoingMessage, type KafkaProcessingOptions, type KafkaProducerConfig, type KafkaProducerLike, type KafkaProducerRecord, type KafkaRestartOptions, type KafkaRunConfig, KafkaTransport, type KafkaTransportOptions, type PlainJsonDecoderOptions, type PlainJsonRecord, PublishTimeoutError, UnencodableEventError, decodeCloudEvent, decodeEnvelope, encodeEnvelope, fromHeader, fromPayloadField, plainJsonDecoder };
+export { type DecodableMessage, type DecodedEvent, type EncodedMessage, GroupJoinTimeoutError, HandlerFailedError, type InvalidKafkaMessage, InvalidKafkaMessageError, type InvalidMessagePolicy, type KafkaBytes, type KafkaClientLike, type KafkaCodec, type KafkaConsumerConfig, type KafkaConsumerEvent, type KafkaConsumerEventNames, type KafkaConsumerLike, type KafkaEachMessagePayload, type KafkaEncodedRecord, type KafkaInboundRecord, type KafkaIncomingHeaders, type KafkaIncomingMessage, type KafkaJsonEnvelopeMapping, type KafkaMessageDecoder, type KafkaOutgoingHeaders, type KafkaOutgoingMessage, type KafkaProcessingOptions, type KafkaProducerConfig, type KafkaProducerLike, type KafkaProducerRecord, type KafkaRestartOptions, type KafkaRunConfig, KafkaTransport, type KafkaTransportOptions, type PlainJsonDecoderOptions, type PlainJsonRecord, PublishTimeoutError, TransportClosedError, UnencodableEventError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, decodeEnvelope, encodeEnvelope, jsonEnvelope, plainJsonDecoder };