@relaybus/rabbitmq 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
-import { NonRetryableError, RelayBusError, EventHeaders, EventEnvelope, RetryPolicyOptions, Duration, RelayBusLogger, Transport, TransportMessageHandler, TransportSubscriptionHooks, CloseOptions } from '@relaybus/core';
-import { JsonEnvelopeMapping } from '@relaybus/core/internal';
+import { NonRetryableError, RelayBusError, EventHeaders, EventEnvelope, RetryPolicyOptions, Duration, RelayBusLogger, CloseOptions } from '@relaybus/core';
+import { JsonEnvelopeMapping, SubscribingTransport, TransportSubscription } from '@relaybus/core/internal';
 export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
 
 /**
@@ -296,6 +296,12 @@ type RabbitMqJsonEnvelopeMapping = JsonEnvelopeMapping<'message-id-property'>;
  * @throws ConfigurationError for an incomplete or self-overlapping mapping.
  */
 declare function jsonEnvelope(mapping: RabbitMqJsonEnvelopeMapping): RabbitMqCodec;
+/**
+ * The event a {@link RabbitMqTransport} with `codec` hands to the bus for `message`: the codec's
+ * `decode`, with what it leaves out filled in (see `DecodedEvent`). Throws for a malformed
+ * message. For codec contract tests (`rabbitMqCodecContract` of `@relaybus/testing`).
+ */
+declare function decodeRabbitMqMessage(codec: RabbitMqCodec, message: AmqpMessage): EventEnvelope;
 
 /** Connection settings accepted by `amqplib.connect`, given as an object instead of a URL. */
 interface BrokerConnectionSettings {
@@ -458,7 +464,7 @@ interface ConnectOptions {
  * consumer. Events published meanwhile are rejected, and therefore retried by
  * the outbox, rather than buffered in memory.
  */
-declare class RabbitMqTransport implements Transport {
+declare class RabbitMqTransport extends SubscribingTransport {
     #private;
     readonly name: string;
     readonly system = "rabbitmq";
@@ -492,7 +498,7 @@ declare class RabbitMqTransport implements Transport {
      * to `onMessage`. Call it once per transport; give each subscription its own
      * transport instance, with its own `name` and `consumerGroup`.
      */
-    subscribe(destinations: readonly string[], onMessage: TransportMessageHandler, hooks?: TransportSubscriptionHooks): Promise<void>;
+    protected openSubscription({ destinations, onMessage, hooks, }: TransportSubscription): Promise<void>;
     /**
      * Stops consuming, waits up to `shutdownTimeout` for running handlers
      * (messages still being retried go back to the queue), then closes the
@@ -502,4 +508,5 @@ declare class RabbitMqTransport implements Transport {
     close(options?: CloseOptions): Promise<void>;
 }
 
-export { type AmqpChannel, type AmqpConfirmChannel, type AmqpConnection, AmqpLimitExceededError, type AmqpMessage, type AmqpMessageProperties, type AmqpPublishOptions, type BrokerConnectionSettings, type DecodedEvent, type EncodedMessage, MalformedMessageError, type PlainJsonDecoderOptions, type PlainJsonMessage, type RabbitMqCodec, type RabbitMqJsonEnvelopeMapping, type RabbitMqMessageDecoder, RabbitMqPublishRejectedError, RabbitMqTransport, type RabbitMqTransportOptions, RabbitMqUnavailableError, RabbitMqUnencodableEventError, type ReconnectOptions, type RedeliveryOptions, UnroutableMessageError, UnserializablePayloadError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, jsonEnvelope, plainJsonDecoder };
+export { AmqpLimitExceededError, MalformedMessageError, RabbitMqPublishRejectedError, RabbitMqTransport, RabbitMqUnavailableError, RabbitMqUnencodableEventError, UnroutableMessageError, UnserializablePayloadError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, decodeRabbitMqMessage, jsonEnvelope, plainJsonDecoder };
+export type { AmqpChannel, AmqpConfirmChannel, AmqpConnection, AmqpMessage, AmqpMessageProperties, AmqpPublishOptions, BrokerConnectionSettings, DecodedEvent, EncodedMessage, PlainJsonDecoderOptions, PlainJsonMessage, RabbitMqCodec, RabbitMqJsonEnvelopeMapping, RabbitMqMessageDecoder, RabbitMqTransportOptions, ReconnectOptions, RedeliveryOptions };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
-import { NonRetryableError, RelayBusError, EventHeaders, EventEnvelope, RetryPolicyOptions, Duration, RelayBusLogger, Transport, TransportMessageHandler, TransportSubscriptionHooks, CloseOptions } from '@relaybus/core';
-import { JsonEnvelopeMapping } from '@relaybus/core/internal';
+import { NonRetryableError, RelayBusError, EventHeaders, EventEnvelope, RetryPolicyOptions, Duration, RelayBusLogger, CloseOptions } from '@relaybus/core';
+import { JsonEnvelopeMapping, SubscribingTransport, TransportSubscription } from '@relaybus/core/internal';
 export { fromHeader, fromPayloadField } from '@relaybus/core/internal';
 
 /**
@@ -296,6 +296,12 @@ type RabbitMqJsonEnvelopeMapping = JsonEnvelopeMapping<'message-id-property'>;
  * @throws ConfigurationError for an incomplete or self-overlapping mapping.
  */
 declare function jsonEnvelope(mapping: RabbitMqJsonEnvelopeMapping): RabbitMqCodec;
+/**
+ * The event a {@link RabbitMqTransport} with `codec` hands to the bus for `message`: the codec's
+ * `decode`, with what it leaves out filled in (see `DecodedEvent`). Throws for a malformed
+ * message. For codec contract tests (`rabbitMqCodecContract` of `@relaybus/testing`).
+ */
+declare function decodeRabbitMqMessage(codec: RabbitMqCodec, message: AmqpMessage): EventEnvelope;
 
 /** Connection settings accepted by `amqplib.connect`, given as an object instead of a URL. */
 interface BrokerConnectionSettings {
@@ -458,7 +464,7 @@ interface ConnectOptions {
  * consumer. Events published meanwhile are rejected, and therefore retried by
  * the outbox, rather than buffered in memory.
  */
-declare class RabbitMqTransport implements Transport {
+declare class RabbitMqTransport extends SubscribingTransport {
     #private;
     readonly name: string;
     readonly system = "rabbitmq";
@@ -492,7 +498,7 @@ declare class RabbitMqTransport implements Transport {
      * to `onMessage`. Call it once per transport; give each subscription its own
      * transport instance, with its own `name` and `consumerGroup`.
      */
-    subscribe(destinations: readonly string[], onMessage: TransportMessageHandler, hooks?: TransportSubscriptionHooks): Promise<void>;
+    protected openSubscription({ destinations, onMessage, hooks, }: TransportSubscription): Promise<void>;
     /**
      * Stops consuming, waits up to `shutdownTimeout` for running handlers
      * (messages still being retried go back to the queue), then closes the
@@ -502,4 +508,5 @@ declare class RabbitMqTransport implements Transport {
     close(options?: CloseOptions): Promise<void>;
 }
 
-export { type AmqpChannel, type AmqpConfirmChannel, type AmqpConnection, AmqpLimitExceededError, type AmqpMessage, type AmqpMessageProperties, type AmqpPublishOptions, type BrokerConnectionSettings, type DecodedEvent, type EncodedMessage, MalformedMessageError, type PlainJsonDecoderOptions, type PlainJsonMessage, type RabbitMqCodec, type RabbitMqJsonEnvelopeMapping, type RabbitMqMessageDecoder, RabbitMqPublishRejectedError, RabbitMqTransport, type RabbitMqTransportOptions, RabbitMqUnavailableError, RabbitMqUnencodableEventError, type ReconnectOptions, type RedeliveryOptions, UnroutableMessageError, UnserializablePayloadError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, jsonEnvelope, plainJsonDecoder };
+export { AmqpLimitExceededError, MalformedMessageError, RabbitMqPublishRejectedError, RabbitMqTransport, RabbitMqUnavailableError, RabbitMqUnencodableEventError, UnroutableMessageError, UnserializablePayloadError, cloudEventsBinary, cloudEventsStructured, decodeCloudEvent, decodeRabbitMqMessage, jsonEnvelope, plainJsonDecoder };
+export type { AmqpChannel, AmqpConfirmChannel, AmqpConnection, AmqpMessage, AmqpMessageProperties, AmqpPublishOptions, BrokerConnectionSettings, DecodedEvent, EncodedMessage, PlainJsonDecoderOptions, PlainJsonMessage, RabbitMqCodec, RabbitMqJsonEnvelopeMapping, RabbitMqMessageDecoder, RabbitMqTransportOptions, ReconnectOptions, RedeliveryOptions };