@relaybus/rabbitmq 0.4.1 → 0.5.0

package/dist/index.d.cts

@@ -252,6 +252,12 @@ interface EncodedMessage {
 interface RabbitMqCodec {
     readonly encode: (envelope: EventEnvelope) => EncodedMessage;
     readonly decode: RabbitMqMessageDecoder;
+    /**
+     * 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>>) => RabbitMqCodec;
 }
 /**
  * CloudEvents 1.0 binary content mode, the default: the body is the JSON
@@ -492,6 +498,15 @@ declare class RabbitMqTransport extends SubscribingTransport {
      * @throws {UnroutableMessageError} no queue is bound to `destination` (unless `allowUnroutable`)
      * @throws whatever the `codec`'s `encode` throws, such as {@link RabbitMqUnencodableEventError}
      */
+    /**
+     * 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>;
     /**
      * Binds one durable quorum queue to `destinations` and delivers its messages

package/dist/index.d.ts

@@ -252,6 +252,12 @@ interface EncodedMessage {
 interface RabbitMqCodec {
     readonly encode: (envelope: EventEnvelope) => EncodedMessage;
     readonly decode: RabbitMqMessageDecoder;
+    /**
+     * 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>>) => RabbitMqCodec;
 }
 /**
  * CloudEvents 1.0 binary content mode, the default: the body is the JSON
@@ -492,6 +498,15 @@ declare class RabbitMqTransport extends SubscribingTransport {
      * @throws {UnroutableMessageError} no queue is bound to `destination` (unless `allowUnroutable`)
      * @throws whatever the `codec`'s `encode` throws, such as {@link RabbitMqUnencodableEventError}
      */
+    /**
+     * 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>;
     /**
      * Binds one durable quorum queue to `destinations` and delivers its messages

package/dist/index.js

@@ -1,5 +1,5 @@
-import { RelayBusError, NonRetryableError, assertEventType, ConfigurationError, systemClock, toErrorInfo, computeRetryDelay, isRetryableError, createRetryPolicy } from '@relaybus/core';
-import { createCloudEventReaders, DecodedEventReader, mediaTypeOf, isJsonObject, observeRejection, createJsonEnvelopeFormat, SubscribingTransport, writeStructuredCloudEvent, schedule, NonEmptyText, PositiveInteger, Milliseconds } from '@relaybus/core/internal';
+import { RelayBusError, NonRetryableError, assertEventType, WireTypesUnsupportedError, ConfigurationError, systemClock, toErrorInfo, computeRetryDelay, isRetryableError, createRetryPolicy } from '@relaybus/core';
+import { createCloudEventReaders, DecodedEventReader, mediaTypeOf, isJsonObject, observeRejection, createJsonEnvelopeFormat, mergeWireTypes, SubscribingTransport, withDeclaredWireTypes, writeStructuredCloudEvent, schedule, NonEmptyText, PositiveInteger, Milliseconds } from '@relaybus/core/internal';
 export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
 
 // src/errors.ts
@@ -780,6 +780,7 @@ function jsonEnvelope(mapping) {
   });
   const contentType = mapping.contentType ?? DEFAULT_CONTENT_TYPE;
   return {
+    withWireTypes: (declared) => jsonEnvelope({ ...mapping, wireTypes: mergeWireTypes(mapping, declared) }),
     encode: (envelope) => {
       assertJsonPayload(envelope.payload, envelope.id);
       assertShortString("Event id", envelope.id);
@@ -1014,11 +1015,16 @@ function resolveCodec({
   if (decode !== void 0 && codec !== void 0) {
     throw new ConfigurationError("Give 'codec' or the deprecated 'decode', not both");
   }
-  const chosen = decode === void 0 ? codec ?? cloudEventsBinary : { encode: encodeEnvelope, decode };
+  return codecSettings(
+    decode === void 0 ? codec ?? cloudEventsBinary : { encode: encodeEnvelope, decode }
+  );
+}
+function codecSettings(chosen) {
   if (chosen === cloudEventsBinary) {
-    return { encode: encodeEnvelope, decode: decodeEnvelope };
+    return { codec: chosen, encode: encodeEnvelope, decode: decodeEnvelope };
   }
   return {
+    codec: chosen,
     encode: chosen.encode,
     decode: (message) => decodeRabbitMqMessage(chosen, message)
   };
@@ -1396,6 +1402,8 @@ var RabbitMqTransport = class extends SubscribingTransport {
   #live;
   #subscription;
   #closing;
+  /** Set when the transport first connects, publishes or subscribes: its wire format is fixed from then on. */
+  #used = false;
   constructor(options) {
     super();
     this.#settings = resolveSettings(options);
@@ -1426,6 +1434,7 @@ var RabbitMqTransport = class extends SubscribingTransport {
   }
   /** Connects to the broker. Rejects when it is unreachable unless `failOnConnectError` is false. */
   async connect() {
+    this.#used = true;
     await this.#supervisor.start(this.#settings.failOnConnectError);
   }
   /**
@@ -1439,7 +1448,27 @@ var RabbitMqTransport = class extends SubscribingTransport {
    * @throws {UnroutableMessageError} no queue is bound to `destination` (unless `allowUnroutable`)
    * @throws whatever the `codec`'s `encode` throws, such as {@link RabbitMqUnencodableEventError}
    */
+  /**
+   * 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) {
+    if (this.#used) {
+      throw new WireTypesUnsupportedError(
+        `Transport '${this.name}' already started; declare wire names before it connects or subscribes`
+      );
+    }
+    const codec = withDeclaredWireTypes(this.#settings.codec, { wireTypes, transport: this.name });
+    return () => {
+      this.#settings = { ...this.#settings, ...codecSettings(codec) };
+    };
+  }
   async publish(envelope, destination) {
+    this.#used = true;
     assertShortString("Destination (routing key)", destination);
     const { content, options } = this.#settings.encode(envelope);
     await this.#publishing.publish(this.#live?.publisher, {
@@ -1460,6 +1489,7 @@ var RabbitMqTransport = class extends SubscribingTransport {
     onMessage,
     hooks
   }) {
+    this.#used = true;
     if (this.#subscription !== void 0) {
       throw new ConfigurationError(
         `Transport '${this.name}' already has a subscription; create another transport for another consumer group`
@@ -1525,6 +1555,7 @@ var RabbitMqTransport = class extends SubscribingTransport {
    * the connection's socket is destroyed instead of waiting for the broker.
    */
   async close(options = {}) {
+    this.#used = true;
     const { signal } = options;
     const force = () => this.#supervisor.forceClose();
     if (signal?.aborted === true) {