@warlock.js/herald 4.0.166 → 4.0.171

package/esm/types/connection.types.d.ts

@@ -0,0 +1,65 @@
+/// <reference types="node" />
+export type BaseConnectionOptions = {
+    name?: string;
+    isDefault?: boolean;
+};
+export type RabbitMQSocketOptions = {
+    keepAlive?: boolean | number;
+    noDelay?: boolean;
+    timeout?: number;
+    ca?: string | Buffer | Array<string | Buffer>;
+    cert?: string | Buffer;
+    key?: string | Buffer;
+    passphrase?: string;
+    servername?: string;
+    rejectUnauthorized?: boolean;
+};
+export type RabbitMQClientOptions = {
+    frameMax?: number;
+    channelMax?: number;
+    locale?: string;
+    socket?: RabbitMQSocketOptions;
+};
+export type RabbitMQConnectionOptions<TClientOptions extends RabbitMQClientOptions = RabbitMQClientOptions> = BaseConnectionOptions & {
+    driver: "rabbitmq";
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    vhost?: string;
+    uri?: string;
+    heartbeat?: number;
+    connectionTimeout?: number;
+    reconnect?: boolean;
+    reconnectDelay?: number;
+    prefetch?: number;
+    clientOptions?: TClientOptions;
+};
+export type KafkaClientOptions = {
+    retry?: {
+        initialRetryTime?: number;
+        retries?: number;
+        maxRetryTime?: number;
+        factor?: number;
+        multiplier?: number;
+    };
+    logLevel?: number;
+    logCreator?: any;
+};
+export type KafkaConnectionOptions<TClientOptions extends KafkaClientOptions = KafkaClientOptions> = BaseConnectionOptions & {
+    driver: "kafka";
+    brokers: string[];
+    clientId?: string;
+    connectionTimeout?: number;
+    requestTimeout?: number;
+    ssl?: boolean | object;
+    sasl?: {
+        mechanism: "plain" | "scram-sha-256" | "scram-sha-512";
+        username: string;
+        password: string;
+    };
+    clientOptions?: TClientOptions;
+};
+export type ConnectionOptions = RabbitMQConnectionOptions | KafkaConnectionOptions;
+export type BrokerConfigurations<TClientOptions = any> = RabbitMQConnectionOptions<TClientOptions extends RabbitMQClientOptions ? TClientOptions : RabbitMQClientOptions> | KafkaConnectionOptions<TClientOptions extends KafkaClientOptions ? TClientOptions : KafkaClientOptions>;
+//# sourceMappingURL=connection.types.d.ts.map

package/esm/types/connection.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.types.d.ts","sourceRoot":"","sources":["../../src/types/connection.types.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,yBAAyB,CACnC,cAAc,SAAS,qBAAqB,GAAG,qBAAqB,IAClE,qBAAqB,GAAG;IAC1B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE;QACN,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,GAAG,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,IAC/F,qBAAqB,GAAG;IACtB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE;QACL,SAAS,EAAE,OAAO,GAAG,eAAe,GAAG,eAAe,CAAC;QACvD,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,aAAa,CAAC,EAAE,cAAc,CAAC;CAChC,CAAC;AAEJ,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,GAAG,sBAAsB,CAAC;AAEnF,MAAM,MAAM,oBAAoB,CAAC,cAAc,GAAG,GAAG,IACjD,yBAAyB,CACvB,cAAc,SAAS,qBAAqB,GAAG,cAAc,GAAG,qBAAqB,CACtF,GACD,sBAAsB,CACpB,cAAc,SAAS,kBAAkB,GAAG,cAAc,GAAG,kBAAkB,CAChF,CAAC"}

package/esm/types/driver.types.d.ts

@@ -0,0 +1,10 @@
+export type BrokerDriverType = "rabbitmq" | "kafka" | "redis-streams" | "sqs";
+export type BrokerEvent = "connected" | "disconnected" | "error" | "reconnecting";
+export type BrokerEventListener = (...args: unknown[]) => void;
+export type HealthCheckResult = {
+    healthy: boolean;
+    latency?: number;
+    error?: string;
+    details?: Record<string, unknown>;
+};
+//# sourceMappingURL=driver.types.d.ts.map

package/esm/types/driver.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.types.d.ts","sourceRoot":"","sources":["../../src/types/driver.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,OAAO,GAAG,eAAe,GAAG,KAAK,CAAC;AAE9E,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,GAAG,cAAc,CAAC;AAElF,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAE/D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC"}

package/esm/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./channel.types";
+export * from "./connection.types";
+export * from "./driver.types";
+export * from "./message.types";
+export * from "./publish.types";
+export * from "./registry.types";
+export * from "./subscribe.types";
+//# sourceMappingURL=index.d.ts.map

package/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/esm/types/message.types.d.ts

@@ -0,0 +1,34 @@
+export type MessageMetadata = {
+    messageId: string;
+    correlationId?: string;
+    replyTo?: string;
+    priority?: number;
+    timestamp: Date;
+    headers?: Record<string, string>;
+    retryCount?: number;
+    originalChannel?: string;
+};
+export type Message<TPayload = unknown> = {
+    readonly metadata: MessageMetadata;
+    readonly payload: TPayload;
+    readonly raw?: unknown;
+};
+export type MessageContext = {
+    ack(): Promise<void>;
+    nack(requeue?: boolean): Promise<void>;
+    reject(): Promise<void>;
+    reply<T>(payload: T): Promise<void>;
+    retry(delay?: number): Promise<void>;
+};
+export type Subscription = {
+    readonly id: string;
+    readonly channel: string;
+    readonly consumerTag?: string;
+    unsubscribe(): Promise<void>;
+    pause(): Promise<void>;
+    resume(): Promise<void>;
+    isActive(): boolean;
+};
+export type MessageHandler<TPayload = unknown> = (message: Message<TPayload>, ctx: MessageContext) => Promise<void> | void;
+export type ResponseHandler<TPayload = unknown, TResponse = unknown> = (message: Message<TPayload>, ctx: MessageContext) => Promise<TResponse> | TResponse;
+//# sourceMappingURL=message.types.d.ts.map

package/esm/types/message.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.types.d.ts","sourceRoot":"","sources":["../../src/types/message.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,QAAQ,GAAG,OAAO,IAAI;IACxC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACrB,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,QAAQ,IAAI,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,QAAQ,GAAG,OAAO,IAAI,CAC/C,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAC1B,GAAG,EAAE,cAAc,KAChB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE1B,MAAM,MAAM,eAAe,CAAC,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,IAAI,CACrE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAC1B,GAAG,EAAE,cAAc,KAChB,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC"}

package/esm/types/publish.types.d.ts

@@ -0,0 +1,13 @@
+export type PublishOptions = {
+    priority?: number;
+    ttl?: number;
+    delay?: number;
+    headers?: Record<string, string>;
+    persistent?: boolean;
+    correlationId?: string;
+    expiration?: number;
+};
+export type RequestOptions = PublishOptions & {
+    timeout?: number;
+};
+//# sourceMappingURL=publish.types.d.ts.map

package/esm/types/publish.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.types.d.ts","sourceRoot":"","sources":["../../src/types/publish.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/esm/types/registry.types.d.ts

@@ -0,0 +1,4 @@
+import type { Broker } from "../communicators/broker";
+export type BrokerRegistryEvent = "registered" | "default-registered" | "connected" | "disconnected";
+export type BrokerRegistryListener = (broker: Broker) => void;
+//# sourceMappingURL=registry.types.d.ts.map

package/esm/types/registry.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.types.d.ts","sourceRoot":"","sources":["../../src/types/registry.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,oBAAoB,GACpB,WAAW,GACX,cAAc,CAAC;AAEnB,MAAM,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC"}

package/esm/types/subscribe.types.d.ts

@@ -0,0 +1,18 @@
+export type RetryOptions = {
+    maxRetries: number;
+    delay: number | ((attempt: number) => number);
+};
+export type DeadLetterOptions = {
+    channel: string;
+    preserveOriginal?: boolean;
+};
+export type SubscribeOptions = {
+    consumerId?: string;
+    group?: string;
+    prefetch?: number;
+    autoAck?: boolean;
+    retry?: RetryOptions;
+    deadLetter?: DeadLetterOptions;
+    exclusive?: boolean;
+};
+//# sourceMappingURL=subscribe.types.d.ts.map

package/esm/types/subscribe.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe.types.d.ts","sourceRoot":"","sources":["../../src/types/subscribe.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/{cjs/utils/connect-to-communicator.d.ts → esm/utils/connect-to-broker.d.ts}

@@ -1,26 +1,26 @@
-import { Communicator } from "../communicators";
+import { Broker } from "../communicators";
 import type { ChannelContract } from "../contracts";
 import { EventConsumerClass, EventMessage } from "../message-managers";
 import type { ChannelOptions, ConnectionOptions } from "../types";
 /**
- * Connect to a message broker and register the communicator.
+ * Connect to a message broker and register it.
  *
  * This is a high-level utility function that simplifies connection setup
  * for most projects. It handles driver instantiation, connection,
- * communicator creation, and automatic registration.
+ * broker creation, and automatic registration.
  *
  * **Supported Drivers:**
  * - `rabbitmq` (default) - RabbitMQ/AMQP driver
  * - `kafka` - Apache Kafka driver (coming soon)
  *
  * @param options - Connection configuration options
- * @returns A connected and registered Communicator instance
+ * @returns A connected and registered Broker instance
  * @throws {Error} If connection fails or driver is not implemented
  *
  * @example
  * ```typescript
  * // RabbitMQ connection
- * const communicator = await connectToCommunicator({
+ * const broker = await connectToBroker({
  *   driver: "rabbitmq",
  *   host: "localhost",
  *   port: 5672,
@@ -28,55 +28,55 @@ import type { ChannelOptions, ConnectionOptions } from "../types";
  *   password: "guest",
  * });
  *
- * // Use the communicator
- * await communicator.channel("user.created").publish({ userId: 1 });
+ * // Use the broker
+ * await broker.channel("user.created").publish({ userId: 1 });
  * ```
  *
  * @example
  * ```typescript
- * // Multiple communicators
- * await connectToCommunicator({
+ * // Multiple brokers
+ * await connectToBroker({
  *   driver: "rabbitmq",
  *   name: "notifications",
  *   isDefault: true,
  *   host: process.env.RABBITMQ_HOST,
  * });
  *
- * await connectToCommunicator({
+ * await connectToBroker({
  *   driver: "rabbitmq",
  *   name: "analytics",
  *   host: process.env.ANALYTICS_RABBITMQ_HOST,
  * });
  *
- * // Use default communicator
- * communicators().channel("notifications").publish({ ... });
+ * // Use default broker
+ * herald().channel("notifications").publish({ ... });
  *
- * // Use specific communicator
- * communicators("analytics").channel("events").publish({ ... });
+ * // Use specific broker
+ * herald("analytics").channel("events").publish({ ... });
  * ```
  */
-export declare function connectToCommunicator(options: ConnectionOptions): Promise<Communicator>;
+export declare function connectToBroker(options: ConnectionOptions): Promise<Broker>;
 /**
- * Get a communicator by name or the default one.
+ * Get a broker by name or the default one.
  *
- * This is the main entry point for using communicators in your application.
+ * This is the main entry point for using brokers in your application.
+ * Named after the package — `herald()` carries your messages!
  *
- * @param name - Optional communicator name (uses default if not provided)
- * @returns Communicator instance
- * @throws MissingCommunicatorError if communicator not found
+ * @param name - Optional broker name (uses default if not provided)
+ * @returns Broker instance
+ * @throws MissingBrokerError if broker not found
  *
  * @example
- * ```typescript
- * // Get default communicator
- * const channel = communicators().channel("user.created");
+ * // Get default broker
+ * const channel = herald().channel("user.created");
  * await channel.publish({ userId: 1 });
  *
- * // Get specific communicator
- * const analyticsChannel = communicators("analytics").channel("events");
+ * // Get specific broker
+ * const analyticsChannel = herald("analytics").channel("events");
  * await analyticsChannel.publish({ event: "page_view" });
  *
  * // Subscribe to messages
- * communicators()
+ * herald()
  *   .channel<UserPayload>("user.created")
  *   .subscribe(async (message, ctx) => {
  *     console.log("User created:", message.payload);
@@ -84,25 +84,30 @@ export declare function connectToCommunicator(options: ConnectionOptions): Promi
  *   });
  * ```
  */
-export declare function communicators(name?: string): Communicator;
+export declare function herald(name?: string): Broker;
 /**
- * Get channel instance for the given name from default communicator
+ * Get channel instance for the given name from default broker.
+ *
+ * Shorthand for `herald().channel(name, options)`.
+ *
  * @param name - Channel name
+ * @param options - Optional channel options
  * @returns Channel instance
- * @throws MissingCommunicatorError if communicator not found
+ * @throws MissingBrokerError if broker not found
  *
  * @example
  * ```typescript
- * const channel = communicatorChannel("user.created");
+ * const channel = heraldChannel("user.created");
  * await channel.publish({ userId: 1 });
  * ```
  */
-export declare function communicatorChannel<TPayload = unknown>(name: string, options?: ChannelOptions<TPayload>): ChannelContract<TPayload>;
+export declare function heraldChannel<TPayload = unknown>(name: string, options?: ChannelOptions<TPayload>): ChannelContract<TPayload>;
 /**
- * Publish the given
+ * Publish an EventMessage to the default broker.
+ *
  * @param event - Event message to publish
  * @returns Promise that resolves when the event is published
- * @throws Error if the event is not published
+ * @throws Error if the broker is not connected
  *
  * @example
  * ```typescript
@@ -111,19 +116,16 @@ export declare function communicatorChannel<TPayload = unknown>(name: string, op
  */
 export declare function publishEvent<TPayload = Record<string, any>>(event: EventMessage<TPayload>): Promise<void>;
 /**
- * Subscribe the given consumer to the default communicator
+ * Subscribe an EventConsumer class to the default broker.
+ *
  * @param Consumer - Event consumer class
- * @returns Function to unsubscribe the consumer
- * @throws Error if the consumer is not subscribed
+ * @returns Unsubscribe function
+ * @throws MissingBrokerError if broker not found
  *
  * @example
  * ```typescript
  * await subscribeConsumer(UserUpdatedConsumer);
- * });
- *
- * // Unsubscribe
- * await unsubscribeConsumer(UserUpdatedConsumer);
  * ```
  */
 export declare function subscribeConsumer<TPayload = Record<string, any>>(Consumer: EventConsumerClass<TPayload>): Promise<() => void>;
-//# sourceMappingURL=connect-to-communicator.d.ts.map
+//# sourceMappingURL=connect-to-broker.d.ts.map

package/esm/utils/connect-to-broker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect-to-broker.d.ts","sourceRoot":"","sources":["../../src/utils/connect-to-broker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAkB,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAwB,eAAe,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAA6B,MAAM,UAAU,CAAC;AAE7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CA+CjF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,QAAQ,GAAG,OAAO,EAC9C,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,GACjC,eAAe,CAAC,QAAQ,CAAC,CAE3B;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,QAAQ,CAAC,iBAE/F;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpE,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,uBAGvC"}

package/esm/utils/{connect-to-communicator.js → connect-to-broker.js}

@@ -1,22 +1,22 @@
-import {communicatorRegistry}from'../communicators/communicator-registry.js';/**
- * Connect to a message broker and register the communicator.
+import {brokerRegistry}from'../communicators/broker-registry.js';/**
+ * Connect to a message broker and register it.
  *
  * This is a high-level utility function that simplifies connection setup
  * for most projects. It handles driver instantiation, connection,
- * communicator creation, and automatic registration.
+ * broker creation, and automatic registration.
  *
  * **Supported Drivers:**
  * - `rabbitmq` (default) - RabbitMQ/AMQP driver
  * - `kafka` - Apache Kafka driver (coming soon)
  *
  * @param options - Connection configuration options
- * @returns A connected and registered Communicator instance
+ * @returns A connected and registered Broker instance
  * @throws {Error} If connection fails or driver is not implemented
  *
  * @example
  * ```typescript
  * // RabbitMQ connection
- * const communicator = await connectToCommunicator({
+ * const broker = await connectToBroker({
  *   driver: "rabbitmq",
  *   host: "localhost",
  *   port: 5672,
@@ -24,37 +24,37 @@ import {communicatorRegistry}from'../communicators/communicator-registry.js';/**
  *   password: "guest",
  * });
  *
- * // Use the communicator
- * await communicator.channel("user.created").publish({ userId: 1 });
+ * // Use the broker
+ * await broker.channel("user.created").publish({ userId: 1 });
  * ```
  *
  * @example
  * ```typescript
- * // Multiple communicators
- * await connectToCommunicator({
+ * // Multiple brokers
+ * await connectToBroker({
  *   driver: "rabbitmq",
  *   name: "notifications",
  *   isDefault: true,
  *   host: process.env.RABBITMQ_HOST,
  * });
  *
- * await connectToCommunicator({
+ * await connectToBroker({
  *   driver: "rabbitmq",
  *   name: "analytics",
  *   host: process.env.ANALYTICS_RABBITMQ_HOST,
  * });
  *
- * // Use default communicator
- * communicators().channel("notifications").publish({ ... });
+ * // Use default broker
+ * herald().channel("notifications").publish({ ... });
  *
- * // Use specific communicator
- * communicators("analytics").channel("events").publish({ ... });
+ * // Use specific broker
+ * herald("analytics").channel("events").publish({ ... });
  * ```
  */
-async function connectToCommunicator(options) {
+async function connectToBroker(options) {
     // Default values
     const driverType = options.driver ?? "rabbitmq";
-    const communicatorName = options.name ?? "default";
+    const brokerName = options.name ?? "default";
     const isDefault = options.isDefault ?? true;
     // Create driver based on type
     let driver;
@@ -74,9 +74,9 @@ async function connectToCommunicator(options) {
         default:
             throw new Error(`Unknown driver: "${driverType}". Supported drivers: rabbitmq, kafka`);
     }
-    // Create communicator
-    const communicator = communicatorRegistry.register({
-        name: communicatorName,
+    // Create broker
+    const broker = brokerRegistry.register({
+        name: brokerName,
         driver,
         isDefault,
     });
@@ -87,29 +87,29 @@ async function connectToCommunicator(options) {
     catch (error) {
         throw new Error(`Failed to connect to ${driverType}: ${error instanceof Error ? error.message : String(error)}`);
     }
-    return communicator;
+    return broker;
 }
 /**
- * Get a communicator by name or the default one.
+ * Get a broker by name or the default one.
  *
- * This is the main entry point for using communicators in your application.
+ * This is the main entry point for using brokers in your application.
+ * Named after the package — `herald()` carries your messages!
  *
- * @param name - Optional communicator name (uses default if not provided)
- * @returns Communicator instance
- * @throws MissingCommunicatorError if communicator not found
+ * @param name - Optional broker name (uses default if not provided)
+ * @returns Broker instance
+ * @throws MissingBrokerError if broker not found
  *
  * @example
- * ```typescript
- * // Get default communicator
- * const channel = communicators().channel("user.created");
+ * // Get default broker
+ * const channel = herald().channel("user.created");
  * await channel.publish({ userId: 1 });
  *
- * // Get specific communicator
- * const analyticsChannel = communicators("analytics").channel("events");
+ * // Get specific broker
+ * const analyticsChannel = herald("analytics").channel("events");
  * await analyticsChannel.publish({ event: "page_view" });
  *
  * // Subscribe to messages
- * communicators()
+ * herald()
  *   .channel<UserPayload>("user.created")
  *   .subscribe(async (message, ctx) => {
  *     console.log("User created:", message.payload);
@@ -117,29 +117,34 @@ async function connectToCommunicator(options) {
  *   });
  * ```
  */
-function communicators(name) {
-    return communicatorRegistry.get(name);
+function herald(name) {
+    return brokerRegistry.get(name);
 }
 /**
- * Get channel instance for the given name from default communicator
+ * Get channel instance for the given name from default broker.
+ *
+ * Shorthand for `herald().channel(name, options)`.
+ *
  * @param name - Channel name
+ * @param options - Optional channel options
  * @returns Channel instance
- * @throws MissingCommunicatorError if communicator not found
+ * @throws MissingBrokerError if broker not found
  *
  * @example
  * ```typescript
- * const channel = communicatorChannel("user.created");
+ * const channel = heraldChannel("user.created");
  * await channel.publish({ userId: 1 });
  * ```
  */
-function communicatorChannel(name, options) {
-    return communicators().channel(name, options);
+function heraldChannel(name, options) {
+    return herald().channel(name, options);
 }
 /**
- * Publish the given
+ * Publish an EventMessage to the default broker.
+ *
  * @param event - Event message to publish
  * @returns Promise that resolves when the event is published
- * @throws Error if the event is not published
+ * @throws Error if the broker is not connected
  *
  * @example
  * ```typescript
@@ -147,23 +152,20 @@ function communicatorChannel(name, options) {
  * ```
  */
 async function publishEvent(event) {
-    return communicators().publish(event);
+    return herald().publish(event);
 }
 /**
- * Subscribe the given consumer to the default communicator
+ * Subscribe an EventConsumer class to the default broker.
+ *
  * @param Consumer - Event consumer class
- * @returns Function to unsubscribe the consumer
- * @throws Error if the consumer is not subscribed
+ * @returns Unsubscribe function
+ * @throws MissingBrokerError if broker not found
  *
  * @example
  * ```typescript
  * await subscribeConsumer(UserUpdatedConsumer);
- * });
- *
- * // Unsubscribe
- * await unsubscribeConsumer(UserUpdatedConsumer);
  * ```
  */
 async function subscribeConsumer(Consumer) {
-    return communicators().subscribe(Consumer);
-}export{communicatorChannel,communicators,connectToCommunicator,publishEvent,subscribeConsumer};//# sourceMappingURL=connect-to-communicator.js.map
+    return herald().subscribe(Consumer);
+}export{connectToBroker,herald,heraldChannel,publishEvent,subscribeConsumer};//# sourceMappingURL=connect-to-broker.js.map

package/esm/utils/connect-to-broker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect-to-broker.js","sources":["../../src/utils/connect-to-broker.ts"],"sourcesContent":[null],"names":[],"mappings":"iEAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDG;AACI,eAAe,eAAe,CAAC,OAA0B,EAAA;;AAE9D,IAAA,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC;AAChD,IAAA,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC;AAC7C,IAAA,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;;AAG5C,IAAA,IAAI,MAA4B,CAAC;AAEjC,IAAA,QAAQ,UAAU;QAChB,KAAK,UAAU,EAAE;YACf,MAAM,aAAa,GAAG,OAAoC,CAAC;;YAE3D,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,OAAO,wCAAqC,CAAC,CAAC;AAC/E,YAAA,MAAM,GAAG,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC;YAC3C,MAAM;AACP,SAAA;QAED,KAAK,OAAO,EAAE;;;AAGZ,YAAA,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;AACH,SAAA;AAED,QAAA;AACE,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,CAAA,qCAAA,CAAuC,CAAC,CAAC;AAC1F,KAAA;;AAGD,IAAA,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,CAAC;AACrC,QAAA,IAAI,EAAE,UAAU;QAChB,MAAM;QACN,SAAS;AACV,KAAA,CAAC,CAAC;;IAGH,IAAI;AACF,QAAA,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;AACxB,KAAA;AAAC,IAAA,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CACb,CAAwB,qBAAA,EAAA,UAAU,KAAK,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAE,CAAA,CAChG,CAAC;AACH,KAAA;AAED,IAAA,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACG,SAAU,MAAM,CAAC,IAAa,EAAA;AAClC,IAAA,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;AAeG;AACa,SAAA,aAAa,CAC3B,IAAY,EACZ,OAAkC,EAAA;IAElC,OAAO,MAAM,EAAE,CAAC,OAAO,CAAW,IAAI,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,YAAY,CAAiC,KAA6B,EAAA;AAC9F,IAAA,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,iBAAiB,CACrC,QAAsC,EAAA;AAEtC,IAAA,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACtC"}

package/esm/utils/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./connect-to-communicator";
+export * from "./connect-to-broker";
 //# sourceMappingURL=index.d.ts.map

package/esm/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@warlock.js/herald",
-    "version": "4.0.166",
+    "version": "4.0.171",
     "description": "Message bus/communicators for RabbitMQ, Kafka, and more",
     "main": "./cjs/index.js",
     "dependencies": {
         "@mongez/copper": "^1.0.1",
         "@mongez/events": "^2.1.0",
         "@mongez/reinforcements": "^2.3.17",
-        "@warlock.js/logger": "4.0.166",
-        "@warlock.js/seal": "4.0.166"
+        "@warlock.js/logger": "4.0.171",
+        "@warlock.js/seal": "4.0.171"
     },
     "scripts": {
         "update": "npx ncu -u",