@baasix/sdk 0.1.9 → 0.1.11

package/dist/index.d.cts

@@ -1096,6 +1096,28 @@ interface RoomMember {
     isCreator: boolean;
     metadata: Record<string, any>;
 }
+/**
+ * A single message from the room's history buffer, replayed when you join.
+ * Has the same shape as a live {@link RoomMessage} (minus the `room` field).
+ */
+interface RoomHistoryMessage {
+    event: string;
+    payload: any;
+    sender: {
+        userId: string | number;
+        socketId: string;
+    };
+    timestamp: string;
+}
+/**
+ * Summary of a single custom room returned by {@link RealtimeModule.listRooms}.
+ */
+interface RoomInfo {
+    /** Room name (e.g. `"game:lobby"`) */
+    name: string;
+    /** Number of connected members */
+    memberCount: number;
+}
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
 }
@@ -1275,25 +1297,32 @@ declare class RealtimeModule {
      * will be visible to all other members via {@link getRoomMembers} and in
      * `room:user:joined` events.
      *
+     * Returns the room's message history (up to 200 messages) so late joiners
+     * can replay past messages immediately.
+     *
      * @param roomName - The room to join.
      * @param metadata - Optional key/value pairs stored alongside this member.
+     * @returns An object containing the buffered `history` for the room.
      *
      * @example
      * ```typescript
-     * // Join a room with metadata
-     * await baasix.realtime.joinRoom('game:lobby', {
+     * const { history } = await baasix.realtime.joinRoom('game:lobby', {
      *   username: 'Alice',
      *   avatar: 'https://example.com/alice.png',
-     *   team: 'blue',
      * });
      *
-     * // Listen for other users joining (includes their metadata)
-     * baasix.realtime.onUserJoined('game:lobby', (data) => {
-     *   console.log(data.metadata.username, 'joined');
+     * // Render past messages first
+     * history.forEach((msg) => renderMessage(msg));
+     *
+     * // Then listen for new ones
+     * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
+     *   renderMessage(data);
      * });
      * ```
      */
-    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<void>;
+    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<{
+        history: RoomHistoryMessage[];
+    }>;
     /**
      * Leave a custom room
      *
@@ -1319,6 +1348,26 @@ declare class RealtimeModule {
      * ```
      */
     getRoomMembers(roomName: string): Promise<RoomMember[]>;
+    /**
+     * List all active custom rooms, optionally filtered by a name prefix.
+     *
+     * Returns every room that currently has at least one member.
+     * You do **not** need to be a member of a room to list it.
+     *
+     * @param prefix - Optional prefix to filter rooms. E.g. `"game:"` returns only
+     *   rooms whose name starts with `"game:"`.
+     *
+     * @example
+     * ```typescript
+     * // All active rooms
+     * const rooms = await baasix.realtime.listRooms();
+     * // [{ name: 'game:lobby', memberCount: 4 }, { name: 'chat:general', memberCount: 12 }]
+     *
+     * // Only rooms whose name starts with 'game:'
+     * const gameRooms = await baasix.realtime.listRooms('game:');
+     * ```
+     */
+    listRooms(prefix?: string): Promise<RoomInfo[]>;
     /**
      * Kick a user from a custom room. Only the room creator may call this.
      *
@@ -1353,18 +1402,27 @@ declare class RealtimeModule {
      */
     onRoomCreatorChanged(roomName: string, callback: (data: RoomCreatorChangedEvent) => void): () => void;
     /**
-     * Send a message to a room
+     * Send a message to a room.
+     *
+     * By default the message is stored in the room's history buffer so late
+     * joiners can replay it. Pass `{ history: false }` to broadcast without
+     * persisting (e.g. ephemeral cursor positions, typing indicators).
      *
      * @example
      * ```typescript
-     * // Send a chat message
+     * // Persisted — replayed to future joiners
      * await baasix.realtime.sendToRoom('game:lobby', 'chat', { text: 'Hello!' });
      *
-     * // Send a game event
-     * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 });
+     * // Ephemeral — broadcast only, never stored in history
+     * await baasix.realtime.sendToRoom('game:lobby', 'typing', { userId }, { history: false });
+     *
+     * // Game move — skips history
+     * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 }, { history: false });
      * ```
      */
-    sendToRoom(roomName: string, event: string, payload: any): Promise<void>;
+    sendToRoom(roomName: string, event: string, payload: any, options?: {
+        history?: boolean;
+    }): Promise<void>;
     /**
      * Listen for messages in a room with a specific event type
      *

package/dist/index.d.ts

@@ -1096,6 +1096,28 @@ interface RoomMember {
     isCreator: boolean;
     metadata: Record<string, any>;
 }
+/**
+ * A single message from the room's history buffer, replayed when you join.
+ * Has the same shape as a live {@link RoomMessage} (minus the `room` field).
+ */
+interface RoomHistoryMessage {
+    event: string;
+    payload: any;
+    sender: {
+        userId: string | number;
+        socketId: string;
+    };
+    timestamp: string;
+}
+/**
+ * Summary of a single custom room returned by {@link RealtimeModule.listRooms}.
+ */
+interface RoomInfo {
+    /** Room name (e.g. `"game:lobby"`) */
+    name: string;
+    /** Number of connected members */
+    memberCount: number;
+}
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
 }
@@ -1275,25 +1297,32 @@ declare class RealtimeModule {
      * will be visible to all other members via {@link getRoomMembers} and in
      * `room:user:joined` events.
      *
+     * Returns the room's message history (up to 200 messages) so late joiners
+     * can replay past messages immediately.
+     *
      * @param roomName - The room to join.
      * @param metadata - Optional key/value pairs stored alongside this member.
+     * @returns An object containing the buffered `history` for the room.
      *
      * @example
      * ```typescript
-     * // Join a room with metadata
-     * await baasix.realtime.joinRoom('game:lobby', {
+     * const { history } = await baasix.realtime.joinRoom('game:lobby', {
      *   username: 'Alice',
      *   avatar: 'https://example.com/alice.png',
-     *   team: 'blue',
      * });
      *
-     * // Listen for other users joining (includes their metadata)
-     * baasix.realtime.onUserJoined('game:lobby', (data) => {
-     *   console.log(data.metadata.username, 'joined');
+     * // Render past messages first
+     * history.forEach((msg) => renderMessage(msg));
+     *
+     * // Then listen for new ones
+     * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
+     *   renderMessage(data);
      * });
      * ```
      */
-    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<void>;
+    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<{
+        history: RoomHistoryMessage[];
+    }>;
     /**
      * Leave a custom room
      *
@@ -1319,6 +1348,26 @@ declare class RealtimeModule {
      * ```
      */
     getRoomMembers(roomName: string): Promise<RoomMember[]>;
+    /**
+     * List all active custom rooms, optionally filtered by a name prefix.
+     *
+     * Returns every room that currently has at least one member.
+     * You do **not** need to be a member of a room to list it.
+     *
+     * @param prefix - Optional prefix to filter rooms. E.g. `"game:"` returns only
+     *   rooms whose name starts with `"game:"`.
+     *
+     * @example
+     * ```typescript
+     * // All active rooms
+     * const rooms = await baasix.realtime.listRooms();
+     * // [{ name: 'game:lobby', memberCount: 4 }, { name: 'chat:general', memberCount: 12 }]
+     *
+     * // Only rooms whose name starts with 'game:'
+     * const gameRooms = await baasix.realtime.listRooms('game:');
+     * ```
+     */
+    listRooms(prefix?: string): Promise<RoomInfo[]>;
     /**
      * Kick a user from a custom room. Only the room creator may call this.
      *
@@ -1353,18 +1402,27 @@ declare class RealtimeModule {
      */
     onRoomCreatorChanged(roomName: string, callback: (data: RoomCreatorChangedEvent) => void): () => void;
     /**
-     * Send a message to a room
+     * Send a message to a room.
+     *
+     * By default the message is stored in the room's history buffer so late
+     * joiners can replay it. Pass `{ history: false }` to broadcast without
+     * persisting (e.g. ephemeral cursor positions, typing indicators).
      *
      * @example
      * ```typescript
-     * // Send a chat message
+     * // Persisted — replayed to future joiners
      * await baasix.realtime.sendToRoom('game:lobby', 'chat', { text: 'Hello!' });
      *
-     * // Send a game event
-     * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 });
+     * // Ephemeral — broadcast only, never stored in history
+     * await baasix.realtime.sendToRoom('game:lobby', 'typing', { userId }, { history: false });
+     *
+     * // Game move — skips history
+     * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 }, { history: false });
      * ```
      */
-    sendToRoom(roomName: string, event: string, payload: any): Promise<void>;
+    sendToRoom(roomName: string, event: string, payload: any, options?: {
+        history?: boolean;
+    }): Promise<void>;
     /**
      * Listen for messages in a room with a specific event type
      *

package/dist/index.js

@@ -3699,21 +3699,26 @@ var RealtimeModule = class {
    * will be visible to all other members via {@link getRoomMembers} and in
    * `room:user:joined` events.
    *
+   * Returns the room's message history (up to 200 messages) so late joiners
+   * can replay past messages immediately.
+   *
    * @param roomName - The room to join.
    * @param metadata - Optional key/value pairs stored alongside this member.
+   * @returns An object containing the buffered `history` for the room.
    *
    * @example
    * ```typescript
-   * // Join a room with metadata
-   * await baasix.realtime.joinRoom('game:lobby', {
+   * const { history } = await baasix.realtime.joinRoom('game:lobby', {
    *   username: 'Alice',
    *   avatar: 'https://example.com/alice.png',
-   *   team: 'blue',
    * });
    *
-   * // Listen for other users joining (includes their metadata)
-   * baasix.realtime.onUserJoined('game:lobby', (data) => {
-   *   console.log(data.metadata.username, 'joined');
+   * // Render past messages first
+   * history.forEach((msg) => renderMessage(msg));
+   *
+   * // Then listen for new ones
+   * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
+   *   renderMessage(data);
    * });
    * ```
    */
@@ -3725,7 +3730,7 @@ var RealtimeModule = class {
       this.socket.emit("room:join", { room: roomName, metadata }, (response) => {
         if (response.status === "success") {
           this.setupRoomListeners(roomName);
-          resolve();
+          resolve({ history: response.history ?? [] });
         } else {
           reject(new Error(response.message || "Failed to join room"));
         }
@@ -3784,6 +3789,39 @@ var RealtimeModule = class {
       });
     });
   }
+  /**
+   * List all active custom rooms, optionally filtered by a name prefix.
+   *
+   * Returns every room that currently has at least one member.
+   * You do **not** need to be a member of a room to list it.
+   *
+   * @param prefix - Optional prefix to filter rooms. E.g. `"game:"` returns only
+   *   rooms whose name starts with `"game:"`.
+   *
+   * @example
+   * ```typescript
+   * // All active rooms
+   * const rooms = await baasix.realtime.listRooms();
+   * // [{ name: 'game:lobby', memberCount: 4 }, { name: 'chat:general', memberCount: 12 }]
+   *
+   * // Only rooms whose name starts with 'game:'
+   * const gameRooms = await baasix.realtime.listRooms('game:');
+   * ```
+   */
+  async listRooms(prefix) {
+    if (!this.socket?.connected) {
+      throw new Error("Not connected. Call connect() first.");
+    }
+    return new Promise((resolve, reject) => {
+      this.socket.emit("room:list", { prefix: prefix ?? "" }, (response) => {
+        if (response.status === "success") {
+          resolve(response.rooms);
+        } else {
+          reject(new Error(response.message || "Failed to list rooms"));
+        }
+      });
+    });
+  }
   /**
    * Kick a user from a custom room. Only the room creator may call this.
    *
@@ -3863,25 +3901,33 @@ var RealtimeModule = class {
     };
   }
   /**
-   * Send a message to a room
-   * 
+   * Send a message to a room.
+   *
+   * By default the message is stored in the room's history buffer so late
+   * joiners can replay it. Pass `{ history: false }` to broadcast without
+   * persisting (e.g. ephemeral cursor positions, typing indicators).
+   *
    * @example
    * ```typescript
-   * // Send a chat message
+   * // Persisted — replayed to future joiners
    * await baasix.realtime.sendToRoom('game:lobby', 'chat', { text: 'Hello!' });
-   * 
-   * // Send a game event
-   * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 });
+   *
+   * // Ephemeral — broadcast only, never stored in history
+   * await baasix.realtime.sendToRoom('game:lobby', 'typing', { userId }, { history: false });
+   *
+   * // Game move — skips history
+   * await baasix.realtime.sendToRoom('game:123', 'move', { x: 10, y: 20 }, { history: false });
    * ```
    */
-  async sendToRoom(roomName, event, payload) {
+  async sendToRoom(roomName, event, payload, options = {}) {
     if (!this.socket?.connected) {
       throw new Error("Not connected. Call connect() first.");
     }
+    const history = options.history ?? true;
     return new Promise((resolve, reject) => {
       this.socket.emit(
         "room:message",
-        { room: roomName, event, payload },
+        { room: roomName, event, payload, history },
         (response) => {
           if (response.status === "success") {
             resolve();