@ably/chat/src/react/hooks/internal/use-room-reference-manager.ts

Ably Chat is a set of purpose-built APIs for a host of chat features enabling you to create 1:1, 1:Many, Many:1 and Many:Many chat rooms for any scale. It is designed to meet a wide range of chat use cases, such as livestreams, in-game communication, cust

import * as Ably from 'ably';
import * as React from 'react';

import { ChatClientContext, ChatClientContextValue } from '../../contexts/chat-client-context.js';
import { RoomReferenceManager } from '../../helper/room-reference-manager.js';

// Symbol to store the room reference manager in the context without conflicting with the string index
export const ROOM_REFERENCE_MANAGER_KEY = Symbol('roomReferenceManager');

/**
 * Extended context value that includes the room reference manager.
 */
export interface ExtendedChatClientContextValue extends ChatClientContextValue {
  [ROOM_REFERENCE_MANAGER_KEY]?: RoomReferenceManager;
}

/**
 * Hook to access the room reference manager from the current ChatClientProvider.
 * @returns The room reference manager instance
 * @throws ErrorInfo if used outside of a ChatClientProvider
 */
export const useRoomReferenceManager = (): RoomReferenceManager => {
  const context = React.useContext(ChatClientContext) as ExtendedChatClientContextValue;
  const manager = context[ROOM_REFERENCE_MANAGER_KEY];
  if (!manager) {
    throw new Ably.ErrorInfo('useRoomReferenceManager must be used within a ChatClientProvider', 40000, 400);
  }
  return manager;
};