@signalwire/core/src/chat/BaseChat.ts

Shared code for the SignalWire JS SDK

import {
  BaseComponentOptions,
  connect,
  extendComponent,
  JSONRPCSubscribeMethod,
} from '..'
import { BasePubSubConsumer } from '../pubSub'
import type {
  ChatMemberEventNames,
  ChatMessageEventName,
  ChatMethods,
} from '../types/chat'
import { PRODUCT_PREFIX_CHAT } from '../utils/constants'
import { ChatMember } from './ChatMember'
import { ChatMessage } from './ChatMessage'
import * as chatMethods from './methods'
import { chatWorker } from './workers/chatWorker'

export type BaseChatApiEventsHandlerMapping = Record<
  ChatMessageEventName,
  (message: ChatMessage) => void
> &
  Record<ChatMemberEventNames, (member: ChatMember) => void>

/**
 * @privateRemarks
 *
 * Each package will have the option to either extend this
 * type or provide their own event mapping.
 */
export type BaseChatApiEvents<T = BaseChatApiEventsHandlerMapping> = {
  [k in keyof T]: T[k]
}

export class BaseChatConsumer extends BasePubSubConsumer<BaseChatApiEvents> {
  protected override subscribeMethod: JSONRPCSubscribeMethod = `${PRODUCT_PREFIX_CHAT}.subscribe`

  constructor(options: BaseComponentOptions) {
    super(options)
  }

  protected override initWorker() {
    this.runWorker('chat', { worker: chatWorker })
  }
}

export const BaseChatAPI = extendComponent<BaseChatConsumer, ChatMethods>(
  BaseChatConsumer,
  {
    publish: chatMethods.publish,
    getMembers: chatMethods.getMembers,
    getMessages: chatMethods.getMessages,
    setMemberState: chatMethods.setMemberState,
    getMemberState: chatMethods.getMemberState,
  }
)

export const createBaseChatObject = <ChatType>(
  params: BaseComponentOptions
) => {
  const chat = connect<BaseChatApiEvents, BaseChatConsumer, ChatType>({
    store: params.store,
    Component: BaseChatAPI,
  })(params)

  return chat
}