@guren/server 0.2.0-alpha.7 → 1.0.0-rc.9

package/dist/broadcasting/index.d.ts

@@ -0,0 +1,233 @@
+import { B as BroadcastManager, P as PresenceBroadcastDriver, c as BroadcastEvent, j as PresenceMember } from '../BroadcastManager-AkIWUGJo.js';
+export { A as AuthMiddlewareOptions, a as BroadcastDriver, b as BroadcastDriverFactory, d as BroadcastManagerOptions, e as BroadcastableEvent, C as Channel, f as ChannelAuthorizer, g as ChannelRegistration, h as PresenceChannel, i as PresenceChannelAuthorizer, k as PrivateChannel, S as SSEClient, l as SSEMiddlewareOptions, W as WebSocketClient, m as createBroadcastManager, n as getBroadcastManager, s as setBroadcastManager } from '../BroadcastManager-AkIWUGJo.js';
+import '../index-9_Jzj5jo.js';
+import 'hono';
+
+type ChannelEventsMap = Record<string, Record<string, unknown>>;
+type ChannelNameFor<TEvents extends ChannelEventsMap> = keyof TEvents & string;
+type EventNameFor<TEvents extends ChannelEventsMap, TChannel extends ChannelNameFor<TEvents>> = keyof TEvents[TChannel] & string;
+type PayloadFor<TEvents extends ChannelEventsMap, TChannel extends ChannelNameFor<TEvents>, TEvent extends EventNameFor<TEvents, TChannel>> = TEvents[TChannel][TEvent];
+interface TypedChannelHandle<TEvents extends ChannelEventsMap, TChannel extends ChannelNameFor<TEvents>> {
+    readonly name: TChannel;
+    broadcast<TEvent extends EventNameFor<TEvents, TChannel>>(event: TEvent, payload: PayloadFor<TEvents, TChannel, TEvent>): Promise<void>;
+}
+interface TypedPrivateChannelHandle<TEvents extends ChannelEventsMap, TChannel extends ChannelNameFor<TEvents>> extends TypedChannelHandle<TEvents, TChannel> {
+    readonly name: TChannel;
+}
+interface TypedPresenceChannelHandle<TEvents extends ChannelEventsMap, TChannel extends ChannelNameFor<TEvents>> extends TypedChannelHandle<TEvents, TChannel> {
+    readonly name: TChannel;
+}
+interface TypedBroadcaster<TEvents extends ChannelEventsMap> {
+    broadcast<TChannel extends ChannelNameFor<TEvents>, TEvent extends EventNameFor<TEvents, TChannel>>(channel: TChannel, event: TEvent, payload: PayloadFor<TEvents, TChannel, TEvent>): Promise<void>;
+    toChannel<TChannel extends ChannelNameFor<TEvents>>(channel: TChannel): TypedChannelHandle<TEvents, TChannel>;
+    toPrivate<TChannel extends ChannelNameFor<TEvents>>(channel: TChannel): TypedPrivateChannelHandle<TEvents, TChannel>;
+    toPresence<TChannel extends ChannelNameFor<TEvents>>(channel: TChannel): TypedPresenceChannelHandle<TEvents, TChannel>;
+}
+declare function createTypedBroadcaster<TEvents extends ChannelEventsMap>(manager: BroadcastManager): TypedBroadcaster<TEvents>;
+
+/**
+ * Memory broadcast driver.
+ *
+ * Stores all subscriptions and presence data in memory.
+ * Useful for testing and single-server deployments.
+ *
+ * @example
+ * ```typescript
+ * const driver = new MemoryDriver()
+ *
+ * // Subscribe to a channel
+ * const unsubscribe = driver.subscribe('notifications', (event) => {
+ *   console.log('Received:', event)
+ * })
+ *
+ * // Publish an event
+ * await driver.publish('notifications', 'NewMessage', { content: 'Hello!' })
+ *
+ * // Unsubscribe
+ * unsubscribe()
+ * ```
+ */
+declare class MemoryDriver implements PresenceBroadcastDriver {
+    /**
+     * Channel subscribers.
+     */
+    protected subscribers: Map<string, Set<(event: BroadcastEvent) => void>>;
+    /**
+     * Presence channel members.
+     */
+    protected presenceMembers: Map<string, Map<string | number, PresenceMember>>;
+    /**
+     * Published events (for testing).
+     */
+    protected publishedEvents: BroadcastEvent[];
+    /**
+     * Publish an event to a channel.
+     */
+    publish(channel: string, event: string, data: unknown): Promise<void>;
+    /**
+     * Subscribe to a channel.
+     */
+    subscribe(channel: string, callback: (event: BroadcastEvent) => void): () => void;
+    /**
+     * Unsubscribe from a channel.
+     */
+    unsubscribe(channel: string, callback: (event: BroadcastEvent) => void): void;
+    /**
+     * Get members of a presence channel.
+     */
+    getMembers(channel: string): PresenceMember[];
+    /**
+     * Add a member to a presence channel.
+     */
+    addMember(channel: string, member: PresenceMember): void;
+    /**
+     * Remove a member from a presence channel.
+     */
+    removeMember(channel: string, memberId: string | number): void;
+    /**
+     * Check if a channel has subscribers.
+     */
+    hasSubscribers(channel: string): boolean;
+    /**
+     * Get subscriber count for a channel.
+     */
+    getSubscriberCount(channel: string): number;
+    /**
+     * Get all channels with subscribers.
+     */
+    getChannels(): string[];
+    /**
+     * Get all presence channels.
+     */
+    getPresenceChannels(): string[];
+    /**
+     * Get all published events (for testing).
+     */
+    getPublishedEvents(): BroadcastEvent[];
+    /**
+     * Get published events for a specific channel.
+     */
+    getPublishedEventsFor(channel: string): BroadcastEvent[];
+    /**
+     * Clear all data (for testing).
+     */
+    clear(): void;
+    /**
+     * Clear published events only.
+     */
+    clearPublishedEvents(): void;
+}
+
+/**
+ * Redis client interface.
+ * Compatible with ioredis and similar clients.
+ */
+interface RedisClient {
+    publish(channel: string, message: string): Promise<number>;
+    subscribe(channel: string): Promise<void>;
+    unsubscribe(channel: string): Promise<void>;
+    on(event: 'message', callback: (channel: string, message: string) => void): void;
+    hset(key: string, field: string, value: string): Promise<number>;
+    hdel(key: string, field: string): Promise<number>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    duplicate(): RedisClient;
+}
+/**
+ * Redis broadcast driver.
+ *
+ * Uses Redis pub/sub for multi-server deployments.
+ *
+ * @example
+ * ```typescript
+ * import Redis from 'ioredis'
+ *
+ * const redis = new Redis()
+ * const driver = new RedisDriver(redis)
+ *
+ * // Subscribe to a channel
+ * driver.subscribe('notifications', (event) => {
+ *   console.log('Received:', event)
+ * })
+ *
+ * // Publish an event
+ * await driver.publish('notifications', 'NewMessage', { content: 'Hello!' })
+ * ```
+ */
+declare class RedisDriver implements PresenceBroadcastDriver {
+    /**
+     * Publisher Redis client.
+     */
+    protected publisher: RedisClient;
+    /**
+     * Subscriber Redis client.
+     */
+    protected subscriber: RedisClient;
+    /**
+     * Local subscribers.
+     */
+    protected subscribers: Map<string, Set<(event: BroadcastEvent) => void>>;
+    /**
+     * Local presence members cache.
+     */
+    protected localPresence: Map<string, Map<string | number, PresenceMember>>;
+    /**
+     * Presence key prefix.
+     */
+    protected presencePrefix: string;
+    /**
+     * Whether the driver is initialized.
+     */
+    protected initialized: boolean;
+    constructor(redis: RedisClient, options?: RedisDriverOptions);
+    /**
+     * Setup the subscriber client.
+     */
+    protected setupSubscriber(): void;
+    /**
+     * Publish an event to a channel.
+     */
+    publish(channel: string, event: string, data: unknown): Promise<void>;
+    /**
+     * Subscribe to a channel.
+     */
+    subscribe(channel: string, callback: (event: BroadcastEvent) => void): () => void;
+    /**
+     * Unsubscribe from a channel.
+     */
+    unsubscribe(channel: string, callback: (event: BroadcastEvent) => void): void;
+    /**
+     * Get members of a presence channel.
+     */
+    getMembers(channel: string): PresenceMember[];
+    /**
+     * Get members asynchronously from Redis.
+     */
+    getMembersAsync(channel: string): Promise<PresenceMember[]>;
+    /**
+     * Add a member to a presence channel.
+     */
+    addMember(channel: string, member: PresenceMember): void;
+    /**
+     * Remove a member from a presence channel.
+     */
+    removeMember(channel: string, memberId: string | number): void;
+    /**
+     * Check if a channel has subscribers.
+     */
+    hasSubscribers(channel: string): boolean;
+    /**
+     * Get subscriber count for a channel.
+     */
+    getSubscriberCount(channel: string): number;
+}
+/**
+ * Redis driver options.
+ */
+interface RedisDriverOptions {
+    /**
+     * Prefix for presence keys.
+     */
+    presencePrefix?: string;
+}
+
+export { BroadcastEvent, BroadcastManager, MemoryDriver, PresenceBroadcastDriver, PresenceMember, type RedisClient, RedisDriver, type RedisDriverOptions, type TypedBroadcaster, type TypedChannelHandle, type TypedPresenceChannelHandle, type TypedPrivateChannelHandle, createTypedBroadcaster };