@signalwire/js 3.29.2 → 4.0.0-beta.1

package/src/fabric/createHttpClient.ts

@@ -1,188 +0,0 @@
-import {
-  asyncRetry,
-  AuthError,
-  HttpError,
-  increasingDelay,
-} from '@signalwire/core'
-import { ApiRequestRetriesOptions } from './interfaces'
-
-interface InternalHttpResponse<T> extends Response {
-  parsedBody?: T
-}
-
-const DEFAULT_MAX_RETRIES = 0
-const DEFAULT_INITIAL_DELAY = 0
-const DEFAULT_DELAY_VARIATION = 0
-const DEFAULT_TIMEOUT = 30000
-
-async function http<T>(
-  input: string,
-  init: RequestInit | undefined,
-  maxRetries?: number,
-  retriesDelay?: number,
-  retriesDelayIncrement?: number
-): Promise<InternalHttpResponse<T>> {
-  const response: InternalHttpResponse<T> = await asyncRetry({
-    asyncCallable: () => fetch(input, init),
-    maxRetries,
-    validator: (response) => {
-      // whe should retry only error above Http-500
-      if (!response.ok && response.status >= 500) {
-        throw new HttpError(response.status, response.statusText)
-      }
-    },
-    delayFn: increasingDelay({
-      initialDelay: retriesDelay,
-      variation: retriesDelayIncrement,
-    }),
-  })
-
-  if (!response.ok) {
-    if (response.status === 401) {
-      throw new AuthError(response.status, 'Unauthorized')
-    }
-
-    let errorResponse
-    try {
-      errorResponse = await response.json()
-    } catch (e) {}
-
-    const errorMessage = errorResponse?.errors
-      ? JSON.stringify(errorResponse.errors)
-      : 'Not Found'
-
-    throw new HttpError(response.status, errorMessage, errorResponse)
-  }
-
-  try {
-    // might throw if body is empty
-    response.parsedBody = await response.json()
-  } catch (e) {}
-
-  return response
-}
-
-type CreateHttpClientOptions = RequestInit &
-  Partial<ApiRequestRetriesOptions> & {
-    baseUrl: string
-    /**
-     * Timeout in milliseconds
-     */
-    timeout?: number
-  }
-
-interface HttpClientRequestInit extends Omit<RequestInit, 'body'> {
-  body?: Record<string, unknown>
-  searchParams?: Record<string, any>
-}
-
-export type CreateHttpClient = ReturnType<typeof createHttpClient>
-
-export const createHttpClient = (
-  {
-    baseUrl,
-    maxApiRequestRetries: retries = DEFAULT_MAX_RETRIES,
-    apiRequestRetriesDelay: retriesDelay = DEFAULT_INITIAL_DELAY,
-    apiRequestRetriesDelayIncrement:
-      retriesDelayIncrement = DEFAULT_DELAY_VARIATION,
-    timeout = DEFAULT_TIMEOUT,
-    ...globalOptions
-  }: CreateHttpClientOptions,
-  fetcher = http
-) => {
-  const apiClient = async <T>(
-    path: string,
-    options?: HttpClientRequestInit
-  ): Promise<{ body: T }> => {
-    const headers = {
-      ...(options?.body ? { 'Content-Type': 'application/json' } : {}),
-      ...globalOptions.headers,
-      ...options?.headers,
-    }
-
-    const reqInit = getRequestInit({
-      ...globalOptions,
-      ...options,
-      headers,
-    })
-    // reqInit.mode = 'no-cors'
-    // reqInit.credentials = 'include'
-
-    let timerId
-    if (timeout) {
-      const controller = new AbortController()
-      const signal = controller.signal
-
-      reqInit.signal = signal
-
-      timerId = setTimeout(() => {
-        controller.abort()
-      }, timeout)
-    }
-
-    try {
-      const response = await fetcher<T>(
-        getUrl({
-          path,
-          baseUrl,
-          searchParams: options?.searchParams,
-        }),
-        reqInit,
-        retries,
-        retriesDelay,
-        retriesDelayIncrement
-      )
-
-      return { body: response.parsedBody as T }
-    } catch (e) {
-      throw e
-    } finally {
-      timerId && clearTimeout(timerId)
-    }
-  }
-
-  return apiClient
-}
-
-const getBody = (body: unknown) => {
-  return typeof body === 'string' ? body : JSON.stringify(body)
-}
-
-const getRequestInit = (options: any): RequestInit => {
-  return Object.entries(options).reduce((reducer, [key, value]) => {
-    if (key === 'body') {
-      return {
-        ...reducer,
-        body: getBody(value),
-      }
-    } else if (value != undefined) {
-      return {
-        ...reducer,
-        [key]: value,
-      }
-    }
-
-    return reducer
-  }, {} as RequestInit)
-}
-
-const getUrl = ({
-  path,
-  baseUrl,
-  searchParams,
-}: {
-  baseUrl: string
-  path: string
-  searchParams?: Record<string, any>
-}) => {
-  const url = new URL(path, baseUrl)
-
-  if (searchParams) {
-    Object.entries(searchParams).forEach(([key, value]) => {
-      if (value != undefined) {
-        url.searchParams.append(key, value)
-      }
-    })
-  }
-  return url.toString()
-}

package/src/fabric/createWSClient.ts

@@ -1,12 +0,0 @@
-import { configureStore } from '@signalwire/core'
-import { SATSession } from './SATSession'
-import { WSClientOptions } from './interfaces'
-
-export const createWSClient = (options: WSClientOptions) => {
-  const store = configureStore({
-    userOptions: options,
-    SessionConstructor: SATSession,
-  })
-
-  return { ...options, store }
-}

package/src/fabric/index.ts

@@ -1,30 +0,0 @@
-/**
- * ============ CAUTION ============
- *
- * Anything we export from here in available on the Public interface.
- */
-
-export * from './SignalWire'
-export * from './interfaces/address'
-export * from './interfaces/capabilities'
-export * from './interfaces/conversation'
-export * from './interfaces/device'
-export * from './interfaces/incomingCallManager'
-
-export {
-  OnlineParams,
-  HandlePushNotificationParams,
-  HandlePushNotificationResult,
-  DialParams,
-  ReattachParams
-} from './interfaces/wsClient'
-export {
-  SignalWireClient,
-  SignalWireContract,
-  SignalWireClientParams,
-  GetSubscriberInfoResponse,
-  GetSubscriberInfoResult,
-  PaginatedResponse,
-  PaginatedResult,
-} from './interfaces'
-export { FabricRoomSession, isFabricRoomSession } from './FabricRoomSession'

package/src/fabric/interfaces/address.ts

@@ -1,46 +0,0 @@
-import { PaginatedResponse, PaginatedResult } from '.'
-
-export type ResourceType = 'app' | 'call' | 'room' | 'subscriber'
-
-export interface GetAddressResponse {
-  id: string
-  display_name: string
-  name: string
-  preview_url?: string
-  cover_url?: string
-  resource_id: string
-  type: ResourceType
-  channels: {
-    audio?: string
-    messaging?: string
-    video?: string
-  }
-  locked: boolean
-  created_at: string
-}
-
-export type Address = GetAddressResponse
-
-export interface GetAddressesParams {
-  type?: string
-  displayName?: string
-  pageSize?: number
-  sortBy?: 'name' | 'created_at'
-  sortOrder?: 'asc' | 'desc'
-}
-
-export interface GetAddressByIdParams {
-  id: string
-}
-
-export interface GetAddressByNameParams {
-  name: string
-}
-
-export type GetAddressParams = GetAddressByIdParams | GetAddressByNameParams
-
-export type GetAddressResult = GetAddressResponse
-
-export type GetAddressesResponse = PaginatedResponse<GetAddressResponse>
-
-export type GetAddressesResult = PaginatedResult<GetAddressResponse>

package/src/fabric/interfaces/capabilities.ts

@@ -1,30 +0,0 @@
-export interface CapabilityOnOffStateContract {
-  on: boolean
-  off: boolean
-}
-
-export interface MemberCapabilityContract {
-  muteAudio: CapabilityOnOffStateContract
-  muteVideo: CapabilityOnOffStateContract
-  microphoneVolume: boolean
-  microphoneSensitivity: boolean
-  speakerVolume: boolean
-  deaf: CapabilityOnOffStateContract
-  raisehand: CapabilityOnOffStateContract
-  position: boolean
-  meta: boolean
-  remove: boolean
-  audioFlags: boolean
-}
-
-export interface CallCapabilitiesContract {
-  self: MemberCapabilityContract
-  member: MemberCapabilityContract
-  end: boolean
-  setLayout: boolean
-  sendDigit: boolean
-  vmutedHide: CapabilityOnOffStateContract
-  lock: CapabilityOnOffStateContract
-  device: boolean
-  screenshare: boolean
-}

package/src/fabric/interfaces/conversation.ts

@@ -1,145 +0,0 @@
-import { PaginatedResponse, PaginatedResult } from '.'
-import type { ConversationEventParams } from '@signalwire/core'
-
-export interface ConversationContract {
-  readonly addressId: string
-  readonly createdAt: number
-  readonly id: string
-  readonly lastMessageAt: number
-  readonly metadata: Record<string, any>
-  readonly name: string
-  sendMessage(
-    params: ConversationAPISendMessageParams
-  ): Promise<SendConversationMessageResult>
-  getMessages(
-    params?: ConversationAPIGetMessagesParams
-  ): Promise<GetConversationMessagesResult>
-}
-
-export interface SendConversationMessageParams {
-  text: string
-  addressId: string
-  metadata?: Record<string, any>
-  details?: Record<string, any>
-}
-
-export interface SendConversationMessageResponse {
-  table: {
-    conversation_id: string
-    text: string
-  }
-}
-
-export type SendConversationMessageResult = SendConversationMessageResponse
-
-export interface GetConversationsParams {
-  pageSize?: number
-}
-
-export interface ConversationResponse {
-  address_id: string
-  created_at: number
-  id: string
-  last_message_at: number
-  metadata: Record<string, any>
-  name: string
-}
-
-export type GetConversationsResponse = PaginatedResponse<ConversationResponse>
-
-export type GetConversationsResult = PaginatedResult<ConversationContract>
-
-export type ConversationSubscribeCallback = (
-  event: ConversationEventParams
-) => unknown
-
-export interface ConversationSubscribeResult {
-  unsubscribe: () => void
-}
-
-export interface ConversationChatMessagesSubscribeParams {
-  addressId: string
-  onMessage: ConversationSubscribeCallback
-}
-
-export type ConversationChatMessagesSubscribeResult =
-  ConversationSubscribeResult
-
-export interface JoinConversationParams {
-  addressId: string
-}
-
-export interface JoinConversationResponse {
-  table: {
-    conversation_id: string
-    text: string
-  }
-}
-
-export type JoinConversationResult = JoinConversationResponse
-
-/**
- * Conversation Messages
- */
-export interface GetMessagesParams {
-  pageSize?: number
-}
-
-export interface ConversationMessage {
-  id: string
-  address_id: string
-  conversation_id: string
-  user_id: string
-  from_address_id: string
-  ts: number
-  metadata?: Record<string, any>
-  details: Record<string, any>
-  type: string
-  subtype: string
-  kind?: string
-  text?: string
-}
-
-export type GetMessagesResult = PaginatedResult<ConversationMessage>
-
-export type ConversationChatMessage = Omit<ConversationMessage, 'kind'> & {
-  text: string
-  user_name: string
-}
-
-export interface GetConversationChatMessageParams {
-  addressId: string
-  pageSize?: number
-}
-
-export type GetConversationChatMessageResult =
-  PaginatedResult<ConversationChatMessage>
-
-export interface GetConversationMessagesResponse
-  extends PaginatedResponse<ConversationMessage> {}
-
-export interface GetConversationMessagesParams {
-  addressId: string
-  pageSize?: number
-}
-
-export type GetConversationMessagesResult = PaginatedResult<ConversationMessage>
-
-/**
- * Conversation API
- */
-export interface ConversationAPISendMessageParams {
-  text: string
-}
-
-export interface ConversationAPIGetMessagesParams {
-  pageSize?: number
-}
-
-export type {
-  ConversationMessageEventName,
-  ConversationMessageEventParams,
-  ConversationMessageEvent,
-  ConversationEvent,
-  ConversationEventParams,
-} from '@signalwire/core'

package/src/fabric/interfaces/device.ts

@@ -1,21 +0,0 @@
-export type RegisterDeviceType = 'iOS' | 'Android' | 'Desktop'
-
-export interface RegisterDeviceParams {
-  deviceType: RegisterDeviceType
-  deviceToken: string
-}
-
-export interface UnregisterDeviceParams {
-  id: string
-}
-
-export interface RegisterDeviceResponse {
-  date_registered: Date
-  device_name?: string
-  device_token: string
-  device_type: RegisterDeviceType
-  id: string
-  push_notification_key: string
-}
-
-export type RegisterDeviceResult = RegisterDeviceResponse

package/src/fabric/interfaces/httpClient.ts

@@ -1,50 +0,0 @@
-import { GetSubscriberInfoResult } from '.'
-import {
-  GetAddressesParams,
-  GetAddressesResult,
-  GetAddressParams,
-  GetAddressResult,
-} from './address'
-import {
-  RegisterDeviceParams,
-  RegisterDeviceResult,
-  UnregisterDeviceParams,
-} from './device'
-
-export interface HTTPClientContract {
-  /**
-   * Retrieve a resource by its ID or Name.
-   *
-   * @param params - The parameters for fetching the resource {@link GetAddressParams}.
-   * @returns A promise that resolves to the resource {@link GetAddressResult}.
-   */
-  getAddress(params: GetAddressParams): Promise<GetAddressResult>
-  /**
-   * Retrieve all resources defined in your SignalWire dashboard.
-   * Supports optional resource filtering.
-   *
-   * @param params - The parameters for filtering resources {@link GetAddressesParams}.
-   * @returns A promise that resolves to the list of resources {@link GetAddressesResult}.
-   */
-  getAddresses(params?: GetAddressesParams): Promise<GetAddressesResult>
-  /**
-   * Register a device to receive incoming call requests.
-   *
-   * @param params - The parameters required to register the device {@link RegisterDeviceParams}.
-   * @returns A promise that resolves to the registration result {@link RegisterDeviceResult}.
-   */
-  registerDevice(params: RegisterDeviceParams): Promise<RegisterDeviceResult>
-  /**
-   * Unregister a device to stop receiving incoming call requests.
-   *
-   * @param params - The parameters required to unregister the device {@link UnregisterDeviceParams}.
-   * @returns A promise that resolves when the device is successfully unregistered.
-   */
-  unregisterDevice(params: UnregisterDeviceParams): Promise<void>
-  /**
-   * Retrieve information about the current subscriber.
-   *
-   * @returns A promise that resolves to the subscriber information object {@link GetSubscriberInfoResult}.
-   */
-  getSubscriberInfo(): Promise<GetSubscriberInfoResult>
-}

package/src/fabric/interfaces/incomingCallManager.ts

@@ -1,36 +0,0 @@
-import { FabricRoomSession } from '../FabricRoomSession'
-import { CallParams } from './wsClient'
-
-export type IncomingInviteSource = 'websocket' | 'pushNotification'
-
-export interface IncomingInvite {
-  callID: string
-  sdp: string
-  caller_id_name: string
-  caller_id_number: string
-  callee_id_name: string
-  callee_id_number: string
-  display_direction: string
-  nodeId: string
-}
-
-export interface IncomingInviteWithSource extends IncomingInvite {
-  source: IncomingInviteSource
-}
-
-export interface IncomingCallNotification {
-  invite: {
-    details: IncomingInvite
-    accept: (param: CallParams) => Promise<FabricRoomSession>
-    reject: () => Promise<void>
-  }
-}
-export type IncomingCallHandler = (
-  notification: IncomingCallNotification
-) => void
-
-export interface IncomingCallHandlers {
-  all?: IncomingCallHandler
-  pushNotification?: IncomingCallHandler
-  websocket?: IncomingCallHandler
-}

package/src/fabric/interfaces/index.ts

@@ -1,118 +0,0 @@
-import {
-  ConversationChatMessagesSubscribeParams,
-  ConversationChatMessagesSubscribeResult,
-  ConversationSubscribeCallback,
-  ConversationSubscribeResult,
-  GetConversationChatMessageParams,
-  GetConversationChatMessageResult,
-  GetConversationMessagesParams,
-  GetConversationMessagesResult,
-  GetConversationsParams,
-  GetConversationsResult,
-  GetMessagesParams,
-  GetMessagesResult,
-  JoinConversationParams,
-  JoinConversationResult,
-  SendConversationMessageParams,
-  SendConversationMessageResult,
-} from './conversation'
-import { Address } from './address'
-import { HTTPClientContract } from './httpClient'
-import { WSClientContract, WSClientOptions } from './wsClient'
-
-export interface SignalWireClientParams extends WSClientOptions {}
-
-export interface SignalWireContract
-  extends WSClientContract,
-    Omit<HTTPClientContract, 'getAddresses' | 'getAddress'> {
-  address: Pick<HTTPClientContract, 'getAddresses' | 'getAddress'>
-  /** @deprecated */
-  conversation: {
-    getConversations: (
-      _params?: GetConversationsParams
-    ) => Promise<GetConversationsResult>
-    getMessages: (_params?: GetMessagesParams) => Promise<GetMessagesResult>
-    getConversationMessages: (
-      _params: GetConversationMessagesParams
-    ) => Promise<GetConversationMessagesResult>
-    subscribe: (
-      _callback: ConversationSubscribeCallback
-    ) => Promise<ConversationSubscribeResult>
-    sendMessage: (
-      params: SendConversationMessageParams
-    ) => Promise<SendConversationMessageResult>
-    join: (_params: JoinConversationParams) => Promise<JoinConversationResult>
-  }
-  /** @deprecated */
-  chat: {
-    getMessages: (
-      _params: GetConversationChatMessageParams
-    ) => Promise<GetConversationChatMessageResult>
-    subscribe: (
-      _params: ConversationChatMessagesSubscribeParams
-    ) => Promise<ConversationChatMessagesSubscribeResult>
-    sendMessage: (
-      params: SendConversationMessageParams
-    ) => Promise<SendConversationMessageResult>
-    join: (_params: JoinConversationParams) => Promise<JoinConversationResult>
-  }
-}
-
-export type SignalWireClient = SignalWireContract
-
-// #region Paginated response and result
-
-export interface PaginatedResponse<T> {
-  data: Array<T>
-  links: {
-    first?: string
-    self?: string
-    next?: string
-    prev?: string
-  }
-}
-
-export interface PaginatedResult<T> {
-  data: Array<T>
-  self(): Promise<PaginatedResult<T> | undefined>
-  nextPage(): Promise<PaginatedResult<T> | undefined>
-  prevPage(): Promise<PaginatedResult<T> | undefined>
-  firstPage(): Promise<PaginatedResult<T> | undefined>
-  hasNext: boolean
-  hasPrev: boolean
-}
-
-// #endregion Paginated response and result
-
-// #region Subscriber info
-
-export interface GetSubscriberInfoResponse {
-  id: string
-  email: string
-  first_name?: string
-  last_name?: string
-  display_name?: string
-  job_title?: string
-  time_zone?: number
-  country?: string
-  region?: string
-  company_name?: string
-  push_notification_key: string
-  app_settings?: {
-    display_name: string
-    scopes: string[]
-  }
-  fabric_addresses: Address[]
-}
-
-export type GetSubscriberInfoResult = GetSubscriberInfoResponse
-
-// #endregion Subscriber info
-
-export * from './capabilities'
-export * from './address'
-export * from './conversation'
-export * from './device'
-export * from './httpClient'
-export * from './incomingCallManager'
-export * from './wsClient'