Interface IRoomManager

apps/realtime/src/rooms/types.ts:43–146

 * All methods that access state are async to support Redis operations
 */
export interface IRoomManager {
  readonly io: Server

  /**
   * Initialize the room manager (connect to Redis, etc.)
   */
  initialize(): Promise<void>

  /**
   * Whether the room manager is ready to serve requests
   */
  isReady(): boolean

  /**
   * Clean shutdown
   */
  shutdown(): Promise<void>

  /**
   * Add a user to a workflow room
   */
  addUserToRoom(workflowId: string, socketId: string, presence: UserPresence): Promise<void>

  /**
   * Remove a user from their current room
   * Optional workflowIdHint is used when socket mapping keys are missing/expired.
   * Returns the workflowId they were in, or null if not in any room.
   */
  removeUserFromRoom(socketId: string, workflowIdHint?: string): Promise<string | null>

  /**
   * Get the workflow ID for a socket
   */
  getWorkflowIdForSocket(socketId: string): Promise<string | null>

  /**
   * Get user session data for a socket
   */
  getUserSession(socketId: string): Promise<UserSession | null>

  /**
   * Get all users in a workflow room
   */
  getWorkflowUsers(workflowId: string): Promise<UserPresence[]>

  /**
   * Check if a workflow room exists
   */
  hasWorkflowRoom(workflowId: string): Promise<boolean>

  /**
   * Update user activity (cursor, selection, lastActivity)
   */
  updateUserActivity(
    workflowId: string,
    socketId: string,
    updates: Partial<Pick<UserPresence, 'cursor' | 'selection' | 'lastActivity'>>
  ): Promise<void>