@relaybus/kafka 0.4.1 → 0.5.0

package/dist/index.d.cts

@@ -344,6 +344,12 @@ type KafkaEncodedRecord = KafkaOutgoingMessage & {
 interface KafkaCodec {
     readonly encode: (envelope: EventEnvelope) => KafkaEncodedRecord;
     readonly decode: KafkaMessageDecoder;
+    /**
+     * Returns this codec with more wire names for event types, which a route or catalog declares
+     * (`wireTypes` of `route(...)` or `defineCatalog`). Only a codec that maps type names has it
+     * ({@link jsonEnvelope}); declaring wire names for a transport whose codec lacks it fails at boot.
+     */
+    readonly withWireTypes?: (wireTypes: Readonly<Record<string, string>>) => KafkaCodec;
 }
 /**
  * CloudEvents 1.0 binary content mode, the default: the value is the JSON
@@ -578,6 +584,15 @@ declare class KafkaTransport extends SubscribingTransport {
     isReady(): boolean;
     /** Connects the producer. Called by the bus on start; `publish` also connects on demand. */
     connect(): Promise<void>;
+    /**
+     * Checks the wire names a route or catalog declares and returns the function that makes the codec
+     * write and read events under them. The bus calls it when it is created, before the transport
+     * connects.
+     *
+     * @throws WireTypesUnsupportedError when the codec does not map type names (use `jsonEnvelope`),
+     * WireTypeCollisionError when a name clashes with one of the codec's own `wireTypes`.
+     */
+    declareWireTypes(wireTypes: Readonly<Record<string, string>>): () => void;
     publish(envelope: EventEnvelope, destination: string): Promise<void>;
     /**
      * Starts the consumer and resolves once it joined its group, so a start-up

package/dist/index.d.ts

@@ -344,6 +344,12 @@ type KafkaEncodedRecord = KafkaOutgoingMessage & {
 interface KafkaCodec {
     readonly encode: (envelope: EventEnvelope) => KafkaEncodedRecord;
     readonly decode: KafkaMessageDecoder;
+    /**
+     * Returns this codec with more wire names for event types, which a route or catalog declares
+     * (`wireTypes` of `route(...)` or `defineCatalog`). Only a codec that maps type names has it
+     * ({@link jsonEnvelope}); declaring wire names for a transport whose codec lacks it fails at boot.
+     */
+    readonly withWireTypes?: (wireTypes: Readonly<Record<string, string>>) => KafkaCodec;
 }
 /**
  * CloudEvents 1.0 binary content mode, the default: the value is the JSON
@@ -578,6 +584,15 @@ declare class KafkaTransport extends SubscribingTransport {
     isReady(): boolean;
     /** Connects the producer. Called by the bus on start; `publish` also connects on demand. */
     connect(): Promise<void>;
+    /**
+     * Checks the wire names a route or catalog declares and returns the function that makes the codec
+     * write and read events under them. The bus calls it when it is created, before the transport
+     * connects.
+     *
+     * @throws WireTypesUnsupportedError when the codec does not map type names (use `jsonEnvelope`),
+     * WireTypeCollisionError when a name clashes with one of the codec's own `wireTypes`.
+     */
+    declareWireTypes(wireTypes: Readonly<Record<string, string>>): () => void;
     publish(envelope: EventEnvelope, destination: string): Promise<void>;
     /**
      * Starts the consumer and resolves once it joined its group, so a start-up

package/dist/index.js

@@ -1,5 +1,5 @@
-import { RelayBusError, NonRetryableError, assertEventType, ConfigurationError, toErrorInfo, systemClock } from '@relaybus/core';
-import { createCloudEventReaders, DecodedEventReader, mediaTypeOf, isJsonObject, observeRejection, createJsonEnvelopeFormat, SubscribingTransport, writeStructuredCloudEvent, schedule, BoundedInteger, PositiveInteger, ExponentialBackoff, Milliseconds } from '@relaybus/core/internal';
+import { RelayBusError, NonRetryableError, assertEventType, ConfigurationError, toErrorInfo, systemClock, WireTypesUnsupportedError } from '@relaybus/core';
+import { createCloudEventReaders, DecodedEventReader, mediaTypeOf, isJsonObject, observeRejection, createJsonEnvelopeFormat, mergeWireTypes, SubscribingTransport, writeStructuredCloudEvent, schedule, BoundedInteger, withDeclaredWireTypes, PositiveInteger, ExponentialBackoff, Milliseconds } from '@relaybus/core/internal';
 export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
 
 // src/errors.ts
@@ -441,6 +441,7 @@ function jsonEnvelope(mapping) {
   const ownHeaders = (envelope) => mapping.id === RECORD_POSITION ? { ...contentType, [EVENT_ID_HEADER]: envelope.id } : contentType;
   const recordKey = resolveRecordKey(mapping.recordKey);
   return {
+    withWireTypes: (declared) => jsonEnvelope({ ...mapping, wireTypes: mergeWireTypes(mapping, declared) }),
     encode: (envelope) => encodeJson(envelope, { format, stampsTime, ownHeaders, recordKey }),
     decode: (record) => decodeJson(record, format)
   };
@@ -862,6 +863,18 @@ function assertCanSubscribe(state, {
     }
   }
 }
+function withDeclaredWireTypeSettings(settings, {
+  wireTypes,
+  started
+}) {
+  if (started) {
+    throw new WireTypesUnsupportedError(
+      `Transport '${settings.name}' already started; declare wire names before it connects or subscribes`
+    );
+  }
+  const codec = withDeclaredWireTypes(settings.codec, { wireTypes, transport: settings.name });
+  return { ...settings, codec };
+}
 
 // src/kafka-records.ts
 function decodeRecord(codec, { topic, partition, message }) {
@@ -995,6 +1008,21 @@ var KafkaTransport = class extends SubscribingTransport {
   async connect() {
     await this.#producer.connected();
   }
+  /**
+   * Checks the wire names a route or catalog declares and returns the function that makes the codec
+   * write and read events under them. The bus calls it when it is created, before the transport
+   * connects.
+   *
+   * @throws WireTypesUnsupportedError when the codec does not map type names (use `jsonEnvelope`),
+   * WireTypeCollisionError when a name clashes with one of the codec's own `wireTypes`.
+   */
+  declareWireTypes(wireTypes) {
+    const settings = withDeclaredWireTypeSettings(this.#settings, {
+      wireTypes,
+      started: this.#state !== "idle" || this.#producer.pending !== void 0
+    });
+    return () => void (this.#settings = settings);
+  }
   async publish(envelope, destination) {
     const producer = await this.#producer.connected();
     await this.#producer.send(producer, {