@gravito/ripple 3.0.0 → 3.1.0

package/dist/types.d.ts

@@ -1,163 +0,0 @@
-/**
- * @fileoverview Core types for @gravito/ripple WebSocket module
- * @module @gravito/ripple
- */
-import type { Server, ServerWebSocket } from 'bun';
-/**
- * Data attached to each WebSocket connection
- */
-export interface ClientData {
-    /** Unique client identifier */
-    id: string;
-    /** User ID if authenticated */
-    userId?: string | number;
-    /** Channels this client has joined */
-    channels: Set<string>;
-    /** Additional user info for presence channels */
-    userInfo?: Record<string, unknown>;
-}
-export type ChannelType = 'public' | 'private' | 'presence';
-/**
- * Base channel interface
- */
-export interface Channel {
-    /** Channel name (without prefix) */
-    readonly name: string;
-    /** Channel type */
-    readonly type: ChannelType;
-    /** Full channel name with prefix */
-    readonly fullName: string;
-}
-/**
- * Channel authorization callback
- */
-export type ChannelAuthorizer = (channelName: string, userId: string | number | undefined, socketId: string) => boolean | Promise<boolean> | PresenceUserInfo | Promise<PresenceUserInfo | false>;
-/**
- * User info returned for presence channels
- */
-export interface PresenceUserInfo {
-    id: string | number;
-    info: Record<string, unknown>;
-}
-/**
- * Broadcast event interface
- */
-export interface BroadcastEventInterface {
-    /** Channels to broadcast to */
-    broadcastOn(): Channel | Channel[];
-    /** Event name (defaults to class name) */
-    broadcastAs?(): string;
-    /** Exclude specific socket IDs */
-    broadcastExcept?(): string[];
-}
-/**
- * Client-to-server message types
- */
-export type ClientMessage = {
-    type: 'subscribe';
-    channel: string;
-    auth?: {
-        socketId: string;
-        signature: string;
-    };
-} | {
-    type: 'unsubscribe';
-    channel: string;
-} | {
-    type: 'whisper';
-    channel: string;
-    event: string;
-    data: unknown;
-} | {
-    type: 'ping';
-};
-/**
- * Server-to-client message types
- */
-export type ServerMessage = {
-    type: 'subscribed';
-    channel: string;
-} | {
-    type: 'unsubscribed';
-    channel: string;
-} | {
-    type: 'error';
-    message: string;
-    channel?: string;
-} | {
-    type: 'event';
-    channel: string;
-    event: string;
-    data: unknown;
-} | {
-    type: 'presence';
-    channel: string;
-    event: 'join' | 'leave' | 'members';
-    data: unknown;
-} | {
-    type: 'pong';
-} | {
-    type: 'connected';
-    socketId: string;
-};
-/**
- * Driver interface for pub/sub backends
- */
-export interface RippleDriver {
-    /** Driver name */
-    readonly name: string;
-    /**
-     * Publish a message to a channel
-     */
-    publish(channel: string, event: string, data: unknown): Promise<void>;
-    /**
-     * Subscribe to channel messages (for Redis driver)
-     */
-    subscribe?(channel: string, callback: (event: string, data: unknown) => void): Promise<void>;
-    /**
-     * Unsubscribe from a channel
-     */
-    unsubscribe?(channel: string): Promise<void>;
-    /**
-     * Initialize the driver
-     */
-    init?(): Promise<void>;
-    /**
-     * Shutdown the driver
-     */
-    shutdown?(): Promise<void>;
-}
-/**
- * Ripple server configuration
- */
-export interface RippleConfig {
-    /** WebSocket endpoint path (default: '/ws') */
-    path?: string;
-    /** Authentication endpoint for private/presence channels */
-    authEndpoint?: string;
-    /** Driver to use ('local' | 'redis') */
-    driver?: 'local' | 'redis';
-    /** Redis configuration (if using redis driver) */
-    redis?: {
-        host?: string;
-        port?: number;
-        password?: string;
-        db?: number;
-    };
-    /** Channel authorizer function */
-    authorizer?: ChannelAuthorizer;
-    /** Ping interval in milliseconds (default: 30000) */
-    pingInterval?: number;
-}
-export type RippleWebSocket = ServerWebSocket<ClientData>;
-export type RippleBunServer = Server<ClientData>;
-/**
- * WebSocket handler configuration for Bun.serve
- */
-export interface WebSocketHandlerConfig {
-    open: (ws: RippleWebSocket) => void | Promise<void>;
-    message: (ws: RippleWebSocket, message: string | Buffer) => void | Promise<void>;
-    close: (ws: RippleWebSocket, code: number, reason: string) => void | Promise<void>;
-    drain?: (ws: RippleWebSocket) => void;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAMlD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,sCAAsC;IACtC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAMD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EACnC,QAAQ,EAAE,MAAM,KACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAA;AAEtF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,WAAW,IAAI,OAAO,GAAG,OAAO,EAAE,CAAA;IAClC,0CAA0C;IAC1C,WAAW,CAAC,IAAI,MAAM,CAAA;IACtB,kCAAkC;IAClC,eAAe,CAAC,IAAI,MAAM,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACtF;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAClE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpB;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACzC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GACpD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACzF;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAM3C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;OAEG;IACH,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5F;;OAEG;IACH,WAAW,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5C;;OAEG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAE1B,kDAAkD;IAClD,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;IAED,kCAAkC;IAClC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAE9B,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAMD,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;AACzD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;AAEhD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,OAAO,EAAE,CAAC,EAAE,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChF,KAAK,EAAE,CAAC,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClF,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,eAAe,KAAK,IAAI,CAAA;CACtC"}