@signalwire/realtime-api/src/chat/Chat.ts

SignalWire RealTime SDK for Node.js

import {
  ChatMember,
  ChatMessage,
  ChatEvents,
  Chat as ChatCore,
} from '@signalwire/core'
import { BaseChat } from './BaseChat'
import { chatWorker } from './workers'
import { SWClient } from '../SWClient'
import { RealTimeChatEvents } from '../types/chat'

interface ChatListenOptions {
  channels: string[]
  onMessageReceived?: (message: ChatMessage) => unknown
  onMemberJoined?: (member: ChatMember) => unknown
  onMemberUpdated?: (member: ChatMember) => unknown
  onMemberLeft?: (member: ChatMember) => unknown
}

type ChatListenersKeys = keyof Omit<ChatListenOptions, 'channels' | 'topics'>

export class Chat extends ChatCore.applyCommonMethods(
  BaseChat<ChatListenOptions, RealTimeChatEvents>
) {
  protected _eventMap: Record<ChatListenersKeys, ChatEvents> = {
    onMessageReceived: 'chat.message',
    onMemberJoined: 'chat.member.joined',
    onMemberUpdated: 'chat.member.updated',
    onMemberLeft: 'chat.member.left',
  }

  constructor(options: SWClient) {
    super(options)

    this._client.runWorker('chatWorker', {
      worker: chatWorker,
      initialState: {
        chat: this,
      },
    })
  }
}

export { ChatMember, ChatMessage } from '@signalwire/core'
export type {
  ChatAction,
  ChatChannel,
  ChatChannelMessageEvent,
  ChatChannelMessageEventParams,
  ChatChannelState,
  ChatEvent,
  ChatGetMembersParams,
  ChatGetMemberStateParams,
  ChatGetMessagesParams,
  ChatMemberContract,
  ChatMemberEntity,
  ChatMemberJoinedEvent,
  ChatMemberJoinedEventParams,
  ChatMemberLeftEvent,
  ChatMemberLeftEventParams,
  ChatMemberUpdatedEvent,
  ChatMemberUpdatedEventParams,
  ChatMessageContract,
  ChatMessageEntity,
  ChatSetMemberStateParams,
  InternalChatMemberEntity,
  InternalChatMessageEntity,
  InternalPubSubMessageEntity,
  MapToPubSubShape,
  MessagingAction,
  PaginationCursor,
  PubSubAction,
  PubSubChannel,
  PubSubChannelMessageEvent,
  PubSubChannelMessageEventParams,
  PubSubEvent,
  PubSubEventAction,
  PubSubPublishParams,
} from '@signalwire/core'