@signalwire/js 3.29.2 → 4.0.0-dev-20260220205014

package/src/fabric/interfaces/wsClient.ts

@@ -1,154 +0,0 @@
-import { SessionOptions, UserOptions } from '@signalwire/core'
-import {
-  IncomingCallHandler,
-  IncomingCallHandlers,
-} from './incomingCallManager'
-import { FabricRoomSession } from '../FabricRoomSession'
-
-export interface WSClientContract {
-  /**
-   * Disconnects the client from the SignalWire network.
-   */
-  disconnect(): Promise<void>
-  /**
-   * Dial a resource and connect the call
-   *
-   * @param params {@link DialParams}
-   * @returns A promise resolving to the session object {@link FabricRoomSession}.
-   */
-  dial(params: DialParams): Promise<FabricRoomSession>
-  /**
-   * Reattach to the previous call if the previous call was not disconnected
-   *
-   * @param params {@link DialParams}
-   * @returns A promise resolving to the session object {@link FabricRoomSession}.
-   */
-  reattach(params: DialParams): Promise<FabricRoomSession>
-  /**
-   * Handles the incoming call via Push Notification
-   *
-   * @param params {@link HandlePushNotificationParams}
-   * @returns A promise resolving to the push notification result {@link HandlePushNotificationResult}.
-   */
-  handlePushNotification(
-    params: HandlePushNotificationParams
-  ): Promise<HandlePushNotificationResult>
-  /**
-   * Allow the user to update the authentication token.
-   *
-   * @param token string: The new authentication token.
-   * @returns A promise that resolves when the token is successfully updated.
-   */
-  updateToken(token: string): Promise<void>
-  /**
-   * Mark the client as 'online' to receive calls over WebSocket.
-   *
-   * @param incomingCallHandlers - The handlers for processing incoming calls.
-   * @returns A promise that resolves when the client is successfully marked as online.
-   */
-  online({ incomingCallHandlers }: OnlineParams): Promise<void>
-
-  /**
-   * Mark the client as 'offline' to stop receiving calls over WebSocket.
-   *
-   * @returns A promise that resolves when the client is successfully marked as offline.
-   */
-  offline(): Promise<void>
-}
-
-export interface OnlineParams {
-  incomingCallHandlers: IncomingCallHandlers
-}
-
-export interface PushNotificationPayload {
-  encryption_type: 'aes_256_gcm'
-  notification_uuid: string
-  with_video: 'true' | 'false'
-  incoming_caller_name: string
-  incoming_caller_id: string
-  tag: string
-  invite: string
-  title: string
-  type: 'call_invite'
-  iv: string
-  version: string
-  decrypted: Record<string, any>
-}
-
-export type HandlePushNotificationParams = PushNotificationPayload & {
-  incomingCallHandler?: IncomingCallHandler
-}
-
-export interface HandlePushNotificationResult {
-  resultType: 'inboundCall'
-}
-
-/**
- * These are the default call parameters that can be passed
- * while initiating a SignalWire client or the call
- */
-interface DefaultCallParams {
-  /** HTML element in which to display the video stream */
-  rootElement?: HTMLElement | null
-  /** User & UserAgent metadata */
-  userVariables?: Record<string, any>
-}
-
-export interface CallParams extends DefaultCallParams {
-  /** Disable ICE UDP transport policy */
-  disableUdpIceServers?: boolean
-  /** Audio constraints to use when joining the room. Default: `true`. */
-  audio?: MediaStreamConstraints['audio']
-  /** Video constraints to use when joining the room. Default: `true` for "video" channel. */
-  video?: MediaStreamConstraints['video']
-  /** Negotiate the incoming audio from the RTC. Default: `true`. */
-  negotiateAudio?: boolean
-  /** Negotiate the incoming video from the RTC. Default: `true` for "video" channel. */
-  negotiateVideo?: boolean
-  /** Whether to apply the local-overlay on top of your video. Default: `true`. */
-  applyLocalVideoOverlay?: boolean
-  /** Whether to apply an overlay on top of each member. Default: `true`. */
-  applyMemberOverlay?: boolean
-  /** Whether to mirror the local video overlay. Default: `false`. */
-  mirrorLocalVideoOverlay?: boolean
-  /** Whether to stop the camera when the member is muted. Default: `true`. */
-  stopCameraWhileMuted?: boolean
-  /** Whether to stop the microphone when the member is muted. Default: `true`. */
-  stopMicrophoneWhileMuted?: boolean
-  /** Fabric address ID matching one of the subscriber’s addresses to attribute conversation API events in the INVITE. */
-  fromFabricAddressId?: string
-}
-
-export interface DialParams extends CallParams {
-  to: string
-  nodeId?: string
-}
-
-export interface ReattachParams extends CallParams {
-  to?: string
-  nodeId?: string
-}
-
-export interface ApiRequestRetriesOptions {
-  /** Increment step for each retry delay */
-  apiRequestRetriesDelayIncrement?: number
-  /** Initial retry delay */
-  apiRequestRetriesDelay?: number
-  /** Max API request retry, set to 0 disable retries */
-  maxApiRequestRetries?: number
-}
-
-export interface SATSessionOptions
-  extends ApiRequestRetriesOptions,
-    SessionOptions {}
-
-export type FabricUserOptions = Omit<
-  UserOptions,
-  'onRefreshToken' | 'topics' | 'sessionChannel' | 'instanceMap'
-> &
-  SATSessionOptions
-
-export interface WSClientOptions extends DefaultCallParams, FabricUserOptions {
-  /** Call back function to receive the incoming call */
-  incomingCallHandlers?: IncomingCallHandlers
-}

package/src/fabric/utils/capabilitiesHelpers.test.ts

@@ -1,201 +0,0 @@
-import { stripNamespacePrefix } from "@signalwire/core"
-import { mapCapabilityPayload } from "./capabilitiesHelpers"
-
-describe('eventUtils', () => {
-  describe('stripNamespacePrefix', () => {
-    it('should strip first word before dot', () => {
-      const event1 = 'random.event.foo'
-      const event2 = 'random.event.bar'
-      expect(stripNamespacePrefix(event1)).toBe('event.foo')
-      expect(stripNamespacePrefix(event2)).toBe('event.bar')
-    })
-
-    it('should not strip if there is no dot', () => {
-      const event1 = 'randomeventfoo'
-      const event2 = 'randomeventbar'
-      expect(stripNamespacePrefix(event1)).toBe('randomeventfoo')
-      expect(stripNamespacePrefix(event2)).toBe('randomeventbar')
-    })
-
-    it('should strip the namespace if passed', () => {
-      const event1 = 'video.event.foo'
-      const event2 = 'voice.event.bar'
-      expect(stripNamespacePrefix(event1, 'video')).toBe('event.foo')
-      expect(stripNamespacePrefix(event2, 'voice')).toBe('event.bar')
-    })
-  })
-
-  describe('mapCapabilitiesPayload', () => {
-    it('should have all capabilities', () => {
-      const callCapabilities = mapCapabilityPayload([
-        'self',
-        'member',
-        'device',
-        'screenshare',
-        'lock',
-        'end',
-        'vmuted',
-        'layout',
-        'digit',
-        'lock',
-      ])
-      expect(callCapabilities.member?.deaf?.on).toEqual(true)
-      expect(callCapabilities.member?.deaf?.off).toEqual(true)
-      expect(callCapabilities.member?.raisehand?.on).toEqual(true)
-      expect(callCapabilities.member?.raisehand?.off).toEqual(true)
-      expect(callCapabilities.member?.muteVideo?.on).toEqual(true)
-      expect(callCapabilities.member?.muteVideo?.off).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.on).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.off).toEqual(true)
-      expect(callCapabilities.member?.meta).toEqual(true)
-      expect(callCapabilities.member?.position).toEqual(true)
-      expect(callCapabilities.member?.remove).toEqual(true)
-      expect(callCapabilities.member?.microphoneSensitivity).toEqual(true)
-      expect(callCapabilities.member?.microphoneVolume).toEqual(true)
-      expect(callCapabilities.member?.speakerVolume).toEqual(true)
-
-      expect(callCapabilities.self?.deaf?.on).toEqual(true)
-      expect(callCapabilities.self?.deaf?.off).toEqual(true)
-      expect(callCapabilities.self?.raisehand?.on).toEqual(true)
-      expect(callCapabilities.self?.raisehand?.off).toEqual(true)
-      expect(callCapabilities.self?.muteVideo?.on).toEqual(true)
-      expect(callCapabilities.self?.muteVideo?.off).toEqual(true)
-      expect(callCapabilities.self?.muteAudio?.on).toEqual(true)
-      expect(callCapabilities.self?.muteAudio?.off).toEqual(true)
-      expect(callCapabilities.self?.meta).toEqual(true)
-      expect(callCapabilities.self?.position).toEqual(true)
-      expect(callCapabilities.self?.remove).toEqual(true)
-      expect(callCapabilities.self?.microphoneSensitivity).toEqual(true)
-      expect(callCapabilities.self?.microphoneVolume).toEqual(true)
-      expect(callCapabilities.self?.speakerVolume).toEqual(true)
-
-      expect(callCapabilities.device).toEqual(true)
-      expect(callCapabilities.screenshare).toEqual(true)
-      expect(callCapabilities.sendDigit).toEqual(true)
-      expect(callCapabilities.setLayout).toEqual(true)
-      expect(callCapabilities.end).toEqual(true)
-      expect(callCapabilities.lock?.on).toEqual(true)
-      expect(callCapabilities.lock?.off).toEqual(true)
-      expect(callCapabilities.vmutedHide?.on).toEqual(true)
-      expect(callCapabilities.vmutedHide?.off).toEqual(true)
-    })
-
-    it('should have some self capabilities and others member capabilities', () => {
-      const callCapabilities = mapCapabilityPayload([
-        'member.deaf',
-        'member.mute.video',
-        'member.mute.audio.on',
-        'self.remove',
-        'self.microphone',
-      ])
-      expect(callCapabilities.member?.deaf?.on).toEqual(true)
-      expect(callCapabilities.member?.deaf?.off).toEqual(true)
-      expect(callCapabilities.member?.raisehand?.on).toEqual(false)
-      expect(callCapabilities.member?.raisehand?.off).toEqual(false)
-      expect(callCapabilities.member?.muteVideo?.on).toEqual(true)
-      expect(callCapabilities.member?.muteVideo?.off).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.on).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.off).toBeFalsy()
-      expect(callCapabilities.member?.meta).toBeFalsy()
-      expect(callCapabilities.member?.position).toBeFalsy()
-      expect(callCapabilities.member?.remove).toBeFalsy()
-      expect(callCapabilities.member?.microphoneSensitivity).toBeFalsy()
-      expect(callCapabilities.member?.microphoneVolume).toBeFalsy()
-      expect(callCapabilities.member?.speakerVolume).toBeFalsy()
-
-      expect(callCapabilities.self?.deaf?.on).toBeFalsy()
-      expect(callCapabilities.self?.deaf?.off).toBeFalsy()
-      expect(callCapabilities.self?.raisehand?.on).toEqual(false)
-      expect(callCapabilities.self?.raisehand?.off).toEqual(false)
-      expect(callCapabilities.self?.muteVideo?.on).toBeFalsy()
-      expect(callCapabilities.self?.muteVideo?.off).toBeFalsy()
-      expect(callCapabilities.self?.muteAudio?.on).toBeFalsy()
-      expect(callCapabilities.self?.muteAudio?.off).toBeFalsy()
-      expect(callCapabilities.self?.meta).toBeFalsy()
-      expect(callCapabilities.self?.position).toBeFalsy()
-      expect(callCapabilities.self?.remove).toEqual(true)
-      expect(callCapabilities.self?.microphoneSensitivity).toEqual(true)
-      expect(callCapabilities.self?.microphoneVolume).toEqual(true)
-      expect(callCapabilities.self?.speakerVolume).toBeFalsy()
-
-      expect(callCapabilities.device).toBeFalsy()
-      expect(callCapabilities.screenshare).toBeFalsy()
-      expect(callCapabilities.sendDigit).toBeFalsy()
-      expect(callCapabilities.setLayout).toBeFalsy()
-      expect(callCapabilities.end).toBeFalsy()
-      expect(callCapabilities.lock?.on).toBeFalsy()
-      expect(callCapabilities.lock?.off).toBeFalsy()
-      expect(callCapabilities.vmutedHide?.on).toBeFalsy()
-      expect(callCapabilities.vmutedHide?.off).toBeFalsy()
-    })
-
-    it('should have some both on and off', () => {
-      const callCapabilities = mapCapabilityPayload([
-        'member.mute.video',
-        'member.mute.audio.on',
-        'member.mute.audio.off',
-      ])
-      expect(callCapabilities.member?.muteVideo?.on).toEqual(true)
-      expect(callCapabilities.member?.muteVideo?.off).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.on).toEqual(true)
-      expect(callCapabilities.member?.muteAudio?.off).toEqual(true)
-    })
-  })
-
-  it('should not break if the server send redundant capability', () => {
-    const callCapabilities = mapCapabilityPayload([
-      'self',
-      'self.deaf',
-      'self.mute.audio',
-      'self.mute.audio.on',
-      'member',
-      'device',
-      'screenshare',
-      'lock',
-      'end',
-      'vmuted',
-      'layout',
-      'digit',
-      'lock',
-    ])
-    expect(callCapabilities.member?.deaf?.on).toEqual(true)
-    expect(callCapabilities.member?.deaf?.off).toEqual(true)
-    expect(callCapabilities.member?.raisehand?.on).toEqual(true)
-    expect(callCapabilities.member?.raisehand?.off).toEqual(true)
-    expect(callCapabilities.member?.muteVideo?.on).toEqual(true)
-    expect(callCapabilities.member?.muteVideo?.off).toEqual(true)
-    expect(callCapabilities.member?.muteAudio?.on).toEqual(true)
-    expect(callCapabilities.member?.muteAudio?.off).toEqual(true)
-    expect(callCapabilities.member?.meta).toEqual(true)
-    expect(callCapabilities.member?.position).toEqual(true)
-    expect(callCapabilities.member?.remove).toEqual(true)
-    expect(callCapabilities.member?.microphoneSensitivity).toEqual(true)
-    expect(callCapabilities.member?.microphoneVolume).toEqual(true)
-    expect(callCapabilities.member?.speakerVolume).toEqual(true)
-
-    expect(callCapabilities.self?.deaf?.on).toEqual(true)
-    expect(callCapabilities.self?.deaf?.off).toEqual(true)
-    expect(callCapabilities.self?.raisehand?.on).toEqual(true)
-    expect(callCapabilities.self?.raisehand?.off).toEqual(true)
-    expect(callCapabilities.self?.muteVideo?.on).toEqual(true)
-    expect(callCapabilities.self?.muteVideo?.off).toEqual(true)
-    expect(callCapabilities.self?.muteAudio?.on).toEqual(true)
-    expect(callCapabilities.self?.muteAudio?.off).toEqual(true)
-    expect(callCapabilities.self?.meta).toEqual(true)
-    expect(callCapabilities.self?.position).toEqual(true)
-    expect(callCapabilities.self?.remove).toEqual(true)
-    expect(callCapabilities.self?.microphoneSensitivity).toEqual(true)
-    expect(callCapabilities.self?.microphoneVolume).toEqual(true)
-    expect(callCapabilities.self?.speakerVolume).toEqual(true)
-
-    expect(callCapabilities.device).toEqual(true)
-    expect(callCapabilities.screenshare).toEqual(true)
-    expect(callCapabilities.sendDigit).toEqual(true)
-    expect(callCapabilities.setLayout).toEqual(true)
-    expect(callCapabilities.end).toEqual(true)
-    expect(callCapabilities.lock?.on).toEqual(true)
-    expect(callCapabilities.lock?.off).toEqual(true)
-    expect(callCapabilities.vmutedHide?.on).toEqual(true)
-    expect(callCapabilities.vmutedHide?.off).toEqual(true)
-  })
-})

package/src/fabric/utils/capabilitiesHelpers.ts

@@ -1,208 +0,0 @@
-import {
-  CallCapabilitiesContract,
-  CapabilityOnOffStateContract,
-  MemberCapabilityContract,
-} from '../interfaces/capabilities'
-
-class CapabilityOnOffState implements CapabilityOnOffStateContract {
-  constructor(private _flags: string[]) {}
-
-  get on() {
-    return this._flags.some((flag) => !flag.endsWith('.off'))
-  }
-
-  get off() {
-    return this._flags.some((flag) => !flag.endsWith('.on'))
-  }
-}
-
-class MemberCapability implements MemberCapabilityContract {
-  private _muteAudio?: CapabilityOnOffState
-  private _muteVideo?: CapabilityOnOffState
-  private _deaf?: CapabilityOnOffState
-  private _raisehand?: CapabilityOnOffState
-
-  constructor(
-    private _flags: string[],
-    private _memberType: 'self' | 'member'
-  ) {}
-
-  get muteAudio() {
-    this._muteAudio =
-      this._muteAudio ??
-      new CapabilityOnOffState(
-        this._flags.filter(
-          (flag) =>
-            flag === this._memberType ||
-            flag === `${this._memberType}.mute` ||
-            flag.startsWith(`${this._memberType}.mute.audio`)
-        )
-      )
-    return this._muteAudio
-  }
-
-  get muteVideo() {
-    this._muteVideo =
-      this._muteVideo ??
-      new CapabilityOnOffState(
-        this._flags.filter(
-          (flag) =>
-            flag === this._memberType ||
-            flag === `${this._memberType}.mute` ||
-            flag.startsWith(`${this._memberType}.mute.video`)
-        )
-      )
-    return this._muteVideo
-  }
-
-  get microphoneVolume() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag === `${this._memberType}.microphone` ||
-        flag.startsWith(`${this._memberType}.microphone.volume`)
-    )
-  }
-
-  get microphoneSensitivity() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag === `${this._memberType}.microphone` ||
-        flag.startsWith(`${this._memberType}.microphone.sensitivity`)
-    )
-  }
-
-  get speakerVolume() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag === `${this._memberType}.speaker` ||
-        flag.startsWith(`${this._memberType}.speaker.volume`)
-    )
-  }
-
-  get deaf() {
-    this._deaf =
-      this._deaf ??
-      new CapabilityOnOffState(
-        this._flags.filter(
-          (flag) =>
-            flag === this._memberType ||
-            flag.startsWith(`${this._memberType}.deaf`)
-        )
-      )
-    return this._deaf
-  }
-
-  get raisehand() {
-    this._raisehand =
-      this._raisehand ??
-      new CapabilityOnOffState(
-        this._flags.filter(
-          (flag) =>
-            flag === this._memberType ||
-            flag.startsWith(`${this._memberType}.raisehand`)
-        )
-      )
-    return this._raisehand
-  }
-
-  get position() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag.startsWith(`${this._memberType}.position`)
-    )
-  }
-
-  get meta() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType || flag.startsWith(`${this._memberType}.meta`)
-    )
-  }
-
-  get remove() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag.startsWith(`${this._memberType}.remove`)
-    )
-  }
-
-  get audioFlags() {
-    return this._flags.some(
-      (flag) =>
-        flag === this._memberType ||
-        flag.startsWith(`${this._memberType}.audioflags.set`)
-    )
-  }
-}
-
-export class CallCapabilities implements CallCapabilitiesContract {
-  private _self?: MemberCapabilityContract
-  private _member?: MemberCapabilityContract
-  private _vmutedHide?: CapabilityOnOffState
-  private _lock?: CapabilityOnOffState
-
-  constructor(private _flags: string[]) {}
-
-  private _buildMemberCapability(memberType: 'self' | 'member') {
-    return new MemberCapability(
-      this._flags.filter((flag) => flag.startsWith(memberType)),
-      memberType
-    )
-  }
-
-  get self() {
-    this._self = this._self ?? this._buildMemberCapability('self')
-    return this._self
-  }
-
-  get member() {
-    this._member = this._member ?? this._buildMemberCapability('member')
-    return this._member
-  }
-
-  get end() {
-    return this._flags.some((capability) => capability === 'end')
-  }
-
-  get setLayout() {
-    return this._flags.some((capability) => capability.startsWith('layout'))
-  }
-
-  get sendDigit() {
-    return this._flags.some((capability) => capability.startsWith('digit'))
-  }
-
-  get vmutedHide() {
-    this._vmutedHide =
-      this._vmutedHide ??
-      new CapabilityOnOffState(
-        this._flags.filter((flag) => flag.startsWith('vmuted'))
-      )
-    return this._vmutedHide
-  }
-
-  get lock() {
-    this._lock =
-      this._lock ??
-      new CapabilityOnOffState(
-        this._flags.filter((flag) => flag.startsWith('lock'))
-      )
-    return this._lock
-  }
-
-  get device() {
-    return this._flags.some((capability) => capability === 'device')
-  }
-
-  get screenshare() {
-    return this._flags.some((capability) => capability === 'screenshare')
-  }
-}
-
-export const mapCapabilityPayload = (capabilities: string[]) =>
-  new CallCapabilities(capabilities)

package/src/fabric/utils/constants.ts

@@ -1,4 +0,0 @@
-export const PREVIOUS_CALLID_STORAGE_KEY = 'ci-SAT';
-export  const DEFAULT_API_REQUEST_RETRIES = 10
-export  const DEFAULT_API_REQUEST_RETRIES_DELAY = 300
-export  const DEFAULT_API_REQUEST_RETRIES_DELAY_INCREMENT  = 100