@baasix/sdk 0.1.8 → 0.1.9

package/dist/index.d.cts

@@ -1076,6 +1076,7 @@ interface RoomUserEvent {
     room: string;
     userId: string | number;
     socketId: string;
+    metadata: Record<string, any>;
     timestamp: string;
 }
 interface RoomKickEvent {
@@ -1093,6 +1094,7 @@ interface RoomMember {
     socketId: string;
     userId: string | number;
     isCreator: boolean;
+    metadata: Record<string, any>;
 }
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
@@ -1267,20 +1269,31 @@ declare class RealtimeModule {
     subscribeToExecution(executionId: string | number, callback: (data: WorkflowExecutionUpdate) => void): () => void;
     private handleWorkflowUpdate;
     /**
-     * Join a custom room for real-time communication
+     * Join a custom room for real-time communication.
+     *
+     * You can optionally attach metadata (e.g. display name, avatar, team) that
+     * will be visible to all other members via {@link getRoomMembers} and in
+     * `room:user:joined` events.
+     *
+     * @param roomName - The room to join.
+     * @param metadata - Optional key/value pairs stored alongside this member.
      *
      * @example
      * ```typescript
-     * // Join a room
-     * await baasix.realtime.joinRoom('game:lobby');
+     * // Join a room with metadata
+     * await baasix.realtime.joinRoom('game:lobby', {
+     *   username: 'Alice',
+     *   avatar: 'https://example.com/alice.png',
+     *   team: 'blue',
+     * });
      *
-     * // Listen for messages
-     * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
-     *   console.log(`${data.sender.userId}: ${data.payload.text}`);
+     * // Listen for other users joining (includes their metadata)
+     * baasix.realtime.onUserJoined('game:lobby', (data) => {
+     *   console.log(data.metadata.username, 'joined');
      * });
      * ```
      */
-    joinRoom(roomName: string): Promise<void>;
+    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<void>;
     /**
      * Leave a custom room
      *
@@ -1294,11 +1307,14 @@ declare class RealtimeModule {
      * Get the list of users currently in a room.
      * You must already be a member of the room to call this.
      *
+     * Each entry includes `userId`, `socketId`, `isCreator`, and `metadata`
+     * (the custom object the member passed to {@link joinRoom}).
+     *
      * @example
      * ```typescript
      * const members = await baasix.realtime.getRoomMembers('game:lobby');
      * members.forEach(m => {
-     *   console.log(m.userId, m.isCreator ? '(owner)' : '');
+     *   console.log(m.metadata.username, m.isCreator ? '(owner)' : '');
      * });
      * ```
      */

package/dist/index.d.ts

@@ -1076,6 +1076,7 @@ interface RoomUserEvent {
     room: string;
     userId: string | number;
     socketId: string;
+    metadata: Record<string, any>;
     timestamp: string;
 }
 interface RoomKickEvent {
@@ -1093,6 +1094,7 @@ interface RoomMember {
     socketId: string;
     userId: string | number;
     isCreator: boolean;
+    metadata: Record<string, any>;
 }
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
@@ -1267,20 +1269,31 @@ declare class RealtimeModule {
     subscribeToExecution(executionId: string | number, callback: (data: WorkflowExecutionUpdate) => void): () => void;
     private handleWorkflowUpdate;
     /**
-     * Join a custom room for real-time communication
+     * Join a custom room for real-time communication.
+     *
+     * You can optionally attach metadata (e.g. display name, avatar, team) that
+     * will be visible to all other members via {@link getRoomMembers} and in
+     * `room:user:joined` events.
+     *
+     * @param roomName - The room to join.
+     * @param metadata - Optional key/value pairs stored alongside this member.
      *
      * @example
      * ```typescript
-     * // Join a room
-     * await baasix.realtime.joinRoom('game:lobby');
+     * // Join a room with metadata
+     * await baasix.realtime.joinRoom('game:lobby', {
+     *   username: 'Alice',
+     *   avatar: 'https://example.com/alice.png',
+     *   team: 'blue',
+     * });
      *
-     * // Listen for messages
-     * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
-     *   console.log(`${data.sender.userId}: ${data.payload.text}`);
+     * // Listen for other users joining (includes their metadata)
+     * baasix.realtime.onUserJoined('game:lobby', (data) => {
+     *   console.log(data.metadata.username, 'joined');
      * });
      * ```
      */
-    joinRoom(roomName: string): Promise<void>;
+    joinRoom(roomName: string, metadata?: Record<string, any>): Promise<void>;
     /**
      * Leave a custom room
      *
@@ -1294,11 +1307,14 @@ declare class RealtimeModule {
      * Get the list of users currently in a room.
      * You must already be a member of the room to call this.
      *
+     * Each entry includes `userId`, `socketId`, `isCreator`, and `metadata`
+     * (the custom object the member passed to {@link joinRoom}).
+     *
      * @example
      * ```typescript
      * const members = await baasix.realtime.getRoomMembers('game:lobby');
      * members.forEach(m => {
-     *   console.log(m.userId, m.isCreator ? '(owner)' : '');
+     *   console.log(m.metadata.username, m.isCreator ? '(owner)' : '');
      * });
      * ```
      */

package/dist/index.js

@@ -3693,25 +3693,36 @@ var RealtimeModule = class {
   // Custom Rooms API
   // ===================
   /**
-   * Join a custom room for real-time communication
-   * 
+   * Join a custom room for real-time communication.
+   *
+   * You can optionally attach metadata (e.g. display name, avatar, team) that
+   * will be visible to all other members via {@link getRoomMembers} and in
+   * `room:user:joined` events.
+   *
+   * @param roomName - The room to join.
+   * @param metadata - Optional key/value pairs stored alongside this member.
+   *
    * @example
    * ```typescript
-   * // Join a room
-   * await baasix.realtime.joinRoom('game:lobby');
-   * 
-   * // Listen for messages
-   * baasix.realtime.onRoomMessage('game:lobby', 'chat', (data) => {
-   *   console.log(`${data.sender.userId}: ${data.payload.text}`);
+   * // Join a room with metadata
+   * 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');
    * });
    * ```
    */
-  async joinRoom(roomName) {
+  async joinRoom(roomName, metadata = {}) {
     if (!this.socket?.connected) {
       throw new Error("Not connected. Call connect() first.");
     }
     return new Promise((resolve, reject) => {
-      this.socket.emit("room:join", { room: roomName }, (response) => {
+      this.socket.emit("room:join", { room: roomName, metadata }, (response) => {
         if (response.status === "success") {
           this.setupRoomListeners(roomName);
           resolve();
@@ -3748,11 +3759,14 @@ var RealtimeModule = class {
    * Get the list of users currently in a room.
    * You must already be a member of the room to call this.
    *
+   * Each entry includes `userId`, `socketId`, `isCreator`, and `metadata`
+   * (the custom object the member passed to {@link joinRoom}).
+   *
    * @example
    * ```typescript
    * const members = await baasix.realtime.getRoomMembers('game:lobby');
    * members.forEach(m => {
-   *   console.log(m.userId, m.isCreator ? '(owner)' : '');
+   *   console.log(m.metadata.username, m.isCreator ? '(owner)' : '');
    * });
    * ```
    */