@signalwire/core/src/utils/constants.ts

Shared code for the SignalWire JS SDK

export const STORAGE_PREFIX = '@signalwire:'
export const ADD = 'add'
export const REMOVE = 'remove'
export const SESSION_ID = 'sessId'
export const DEFAULT_HOST = 'wss://relay.signalwire.com'

export enum WebSocketState {
  CONNECTING = 0,
  OPEN = 1,
  CLOSING = 2,
  CLOSED = 3,
}

/**
 * Used for namespacing events.
 */
export const EVENT_NAMESPACE_DIVIDER = ':'

export const LOCAL_EVENT_PREFIX = '__local__'
export const SYNTHETIC_EVENT_PREFIX = '__synthetic__'

export const PRODUCT_PREFIX_VIDEO = 'video'
/**
 * video-manager is an [internal] superset of the video apis
 */
export const PRODUCT_PREFIX_VIDEO_MANAGER = 'video-manager'
export const PRODUCT_PREFIX_CHAT = 'chat' as const
/**
 * For now both, `PubSub` and `Chat` share the same
 * namespace but this might change in the future.
 */
export const PRODUCT_PREFIX_PUBSUB = 'chat' as const
export const PRODUCT_PREFIX_TASK = 'tasking'
export const PRODUCT_PREFIX_MESSAGING = 'messaging'
export const PRODUCT_PREFIX_VOICE = 'voice'
export const PRODUCT_PREFIX_VOICE_CALL = 'calling'

export const GLOBAL_VIDEO_EVENTS = ['room.started', 'room.ended'] as const

export const PRODUCT_PREFIXES = [
  PRODUCT_PREFIX_VIDEO,
  PRODUCT_PREFIX_VIDEO_MANAGER,
  PRODUCT_PREFIX_CHAT,
  PRODUCT_PREFIX_PUBSUB,
  PRODUCT_PREFIX_TASK,
  PRODUCT_PREFIX_MESSAGING,
  PRODUCT_PREFIX_VOICE,
  PRODUCT_PREFIX_VOICE_CALL,
] as const

/**
 * For internal usage only. These are the fully qualified event names
 * sent by the server
 * @internal
 */
export const INTERNAL_GLOBAL_VIDEO_EVENTS = GLOBAL_VIDEO_EVENTS.map(
  (event) => `${PRODUCT_PREFIX_VIDEO}.${event}` as const
)

export const SYMBOL_EXECUTE_CONNECTION_CLOSED = Symbol.for(
  'sw-execute-connection-closed'
)
export const SYMBOL_EXECUTE_TIMEOUT = Symbol.for('sw-execute-timeout')
export const SYMBOL_CONNECT_ERROR = Symbol.for('sw-connect-error')