@telnyx/webrtc 2.25.17-beta.2 → 2.25.18

package/lib/packages/js/src/Modules/Verto/BaseSession.d.ts

@@ -1,7 +1,7 @@
 import * as log from 'loglevel';
 import BaseMessage from './messages/BaseMessage';
 import Connection from './services/Connection';
-import { BroadcastParams, IVertoOptions } from './util/interfaces';
+import { BroadcastParams, ILoginParams, IVertoOptions } from './util/interfaces';
 export default abstract class BaseSession {
     options: IVertoOptions;
     uuid: string;
@@ -17,7 +17,6 @@ export default abstract class BaseSession {
     timeoutErrorCode: number;
     invalidMethodErrorCode: number;
     authenticationRequiredErrorCode: number;
-    callReportId: string | null;
     connection: Connection;
     protected _jwtAuth: boolean;
     protected _keepAliveTimeout: any;
@@ -41,6 +40,12 @@ export default abstract class BaseSession {
     off(eventName: string, callback?: Function): this;
     connect(): Promise<void>;
     protected _handleLoginError(error: any): void;
+    login({ creds, onSuccess, onError, }?: {
+        creds?: ILoginParams;
+        onSuccess?: () => void;
+        onError?: (error: any) => void;
+    }): Promise<void>;
+    private _login;
     protected _onSocketOpen(): Promise<void>;
     onNetworkClose(): void;
     protected _onSocketMessage(response: any): void;

package/lib/packages/js/src/Modules/Verto/messages/verto/AnonymousLogin.d.ts

@@ -4,7 +4,7 @@ declare type AnonymousLoginConstructorParams = {
     target_type: string;
     target_version_id?: string;
     sessionId?: string;
-    userVariables?: Object;
+    userVariables?: Record<string, any>;
     reconnection?: boolean;
 };
 declare class AnonymousLogin extends BaseRequest {

package/lib/packages/js/src/Modules/Verto/messages/verto/Login.d.ts

@@ -1,6 +1,6 @@
 import BaseRequest from './BaseRequest';
 declare class Login extends BaseRequest {
     method: string;
-    constructor(login: string, passwd: string, login_token: string, sessionid: string, userVariables: Object, reconnection: boolean);
+    constructor(login: string, passwd: string, login_token: string, sessionid: string, userVariables: Record<string, any>, reconnection: boolean);
 }
 export { Login };

package/lib/packages/js/src/Modules/Verto/services/Connection.d.ts

@@ -17,7 +17,6 @@ export default class Connection {
     get closed(): boolean;
     get isAlive(): boolean;
     get isDead(): boolean;
-    get host(): string;
     connect(): void;
     sendRawText(request: string): void;
     send(bladeObj: any): Promise<any>;

package/lib/packages/js/src/Modules/Verto/util/constants/index.d.ts

@@ -18,12 +18,12 @@ export declare const TURN_SERVER: {
     urls: string;
     username: string;
     credential: string;
-};
+}[];
 export declare const TURN_DEV_SERVER: {
     urls: string;
     username: string;
     credential: string;
-};
+}[];
 export declare const DEFAULT_PROD_ICE_SERVERS: RTCIceServer[];
 export declare const DEFAULT_DEV_ICE_SERVERS: RTCIceServer[];
 export declare enum SwEvent {

package/lib/packages/js/src/Modules/Verto/util/interfaces.d.ts

@@ -8,7 +8,7 @@ export interface IVertoOptions {
     passwd?: string;
     password?: string;
     login_token?: string;
-    userVariables?: Object;
+    userVariables?: Record<string, any>;
     ringtoneFile?: string;
     ringbackFile?: string;
     env?: Environment;
@@ -31,10 +31,18 @@ export interface IVertoOptions {
     rtcIp?: string;
     rtcPort?: number;
     mutedMicOnStart?: boolean;
-    enableCallReports?: boolean;
-    callReportInterval?: number;
-    debugLogLevel?: 'debug' | 'info' | 'warn' | 'error';
-    debugLogMaxEntries?: number;
+}
+export interface ILoginParams {
+    login?: string;
+    password?: string;
+    passwd?: string;
+    login_token?: string;
+    userVariables?: Record<string, any>;
+    anonymous_login?: {
+        target_type: string;
+        target_id: string;
+        target_version_id?: string;
+    };
 }
 export interface SubscribeParams {
     channels?: string[];

package/lib/packages/js/src/Modules/Verto/webrtc/BaseCall.d.ts

@@ -2,11 +2,11 @@ import BrowserSession from '../BrowserSession';
 import Call from './Call';
 import Peer from './Peer';
 import { Direction, State } from './constants';
-import { AnswerParams, IVertoCallOptions, IWebRTCCall } from './interfaces';
+import { AnswerParams, IHangupParams, IVertoCallOptions, IWebRTCCall } from './interfaces';
 export default abstract class BaseCall implements IWebRTCCall {
     protected session: BrowserSession;
+    private _isRecovering;
     private _webRTCStats;
-    private _callReportCollector;
     id: string;
     state: string;
     prevState: string;
@@ -39,7 +39,7 @@ export default abstract class BaseCall implements IWebRTCCall {
     private _isRemoteDescriptionSet;
     private _signalingStateClosed;
     private _creatingPeer;
-    constructor(session: BrowserSession, opts?: IVertoCallOptions);
+    constructor(session: BrowserSession, opts?: IVertoCallOptions, _isRecovering?: boolean);
     private get performanceMetrics();
     get nodeId(): string;
     set nodeId(what: string);
@@ -60,7 +60,7 @@ export default abstract class BaseCall implements IWebRTCCall {
     playRingback(): void;
     stopRingback(): void;
     hangup(): void;
-    hangup(hangupParams: any, hangupExecute: any): void;
+    hangup(hangupParams: IHangupParams, hangupExecute: boolean): void;
     hold(): Promise<any>;
     unhold(): Promise<any>;
     toggleHold(): Promise<any>;
@@ -113,7 +113,6 @@ export default abstract class BaseCall implements IWebRTCCall {
     private _execute;
     private _init;
     protected _finalize(): void;
-    private _postCallReport;
     private _startStats;
     private _stopStats;
     private _doStats;

package/lib/packages/js/src/Modules/Verto/webrtc/Peer.d.ts

@@ -6,7 +6,7 @@ export default class Peer {
     type: PeerType;
     private options;
     instance: RTCPeerConnection;
-    onSdpReadyTwice: Function;
+    onSdpReadyTwice: ((data: RTCSessionDescription) => void) | null;
     statsReporter: WebRTCStatsReporter | null;
     private _constraints;
     private _session;
@@ -21,8 +21,8 @@ export default class Peer {
     get isAnswer(): boolean;
     get isDebugEnabled(): boolean;
     get debugOutput(): "socket" | "file";
-    get keepConnectionAliveOnSocketClose(): boolean;
     get restartedIceOnConnectionStateFailed(): boolean;
+    isConnectionHealthy(): boolean;
     startNegotiation(): void;
     startTrickleIceNegotiation(): Promise<void>;
     private _logTransceivers;

package/lib/packages/js/src/Modules/Verto/webrtc/VertoHandler.d.ts

@@ -8,8 +8,6 @@ declare class VertoHandler {
     constructor(session: BrowserSession);
     private _ack;
     private reconnectDelay;
-    private handleLogin;
-    private handleAnonymousLogin;
     handleMessage(msg: any): Promise<void>;
     private _retrieveCallId;
     private _handlePvtEvent;

package/lib/packages/js/src/Modules/Verto/webrtc/constants.d.ts

@@ -40,6 +40,9 @@ export declare const NOTIFICATION_TYPE: {
     peerConnectionFailureError: string;
     signalingStateClosed: string;
 };
+export declare const ERROR_TYPE: {
+    invalidCredentialsOptions: string;
+};
 export declare const DEFAULT_CALL_OPTIONS: IVertoCallOptions;
 export declare enum State {
     New = 0,

package/lib/packages/js/src/Modules/Verto/webrtc/interfaces.d.ts

@@ -1,7 +1,22 @@
+import { State } from './constants';
 export interface IMediaSettings {
     useSdpASBandwidthKbps?: boolean;
     sdpASBandwidthKbps?: number;
 }
+export interface IHangupParams {
+    cause?: string;
+    causeCode?: number;
+    sipCode?: number;
+    sipReason?: string;
+    sip_call_id?: string;
+    dialogParams?: {
+        customHeaders?: Array<{
+            name: string;
+            value: string;
+        }>;
+    };
+    isRecovering?: boolean;
+}
 export interface IVertoCallOptions {
     destinationNumber?: string;
     remoteCallerName?: string;
@@ -24,9 +39,7 @@ export interface IVertoCallOptions {
     camId?: string;
     camLabel?: string;
     speakerId?: string;
-    userVariables?: {
-        [key: string]: any;
-    };
+    userVariables?: Record<string, any>;
     screenShare?: boolean;
     onNotification?: Function;
     googleMaxBitrate?: number;
@@ -75,6 +88,8 @@ export interface IWebRTCCall {
         instance?: RTCPeerConnection | null;
         restartedIceOnConnectionStateFailed?: boolean;
         restartStatsReporter?: () => Promise<void>;
+        isConnectionHealthy?: () => boolean;
+        close?: () => Promise<void>;
     } | null;
     options: IVertoCallOptions;
     cause: string;
@@ -89,7 +104,7 @@ export interface IWebRTCCall {
     signalingStateClosed: boolean;
     invite: () => void;
     answer: (params: AnswerParams) => void;
-    hangup: (params: any, execute: boolean) => void;
+    hangup: (params: IHangupParams, execute: boolean) => void;
     hold: () => void;
     unhold: () => void;
     toggleHold: () => void;
@@ -109,7 +124,7 @@ export interface IWebRTCCall {
     setAudioBandwidthEncodingsMaxBps: (max: number) => void;
     setVideoBandwidthEncodingsMaxBps: (max: number) => void;
     getStats: (callback: Function, constraints: any) => void;
-    setState: (state: any) => void;
+    setState: (state: State) => void;
     handleMessage: (msg: any) => void;
     _addChannel: (laChannel: any) => void;
     handleConferenceUpdate: (packet: any, pvtData: any) => Promise<string>;

package/lib/packages/js/src/index.d.ts

@@ -1,6 +1,7 @@
 import TelnyxRTC from './TelnyxRTC';
 import { IClientOptions, ICallOptions, ICredentials, INotification } from './utils/interfaces';
 import { SwEvent } from './Modules/Verto/util/constants';
+import { NOTIFICATION_TYPE, ERROR_TYPE } from './Modules/Verto/webrtc/constants';
 import Call from './Modules/Verto/webrtc/Call';
-export { Call, TelnyxRTC, IClientOptions, ICallOptions, ICredentials, INotification, SwEvent, };
+export { Call, TelnyxRTC, IClientOptions, ICallOptions, ICredentials, INotification, SwEvent, NOTIFICATION_TYPE, ERROR_TYPE, };
 export * from './PreCallDiagnosis';

package/lib/packages/js/src/utils/interfaces.d.ts

@@ -29,8 +29,6 @@ export interface IClientOptions {
     env?: Environment;
     iceServers?: RTCIceServer[];
     mutedMicOnStart?: boolean;
-    enableCallReports?: boolean;
-    callReportInterval?: number;
 }
 export interface ICallOptions {
     destinationNumber?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telnyx/webrtc",
-  "version": "2.25.17-beta.2",
+  "version": "2.25.18",
   "description": "Telnyx WebRTC Client",
   "keywords": [
     "telnyx",
@@ -105,7 +105,7 @@
       "yarn eslint --fix",
       "yarn prettier --write"
     ],
-    "**/*.{md}": [
+    "**/*.md": [
       "yarn eslint",
       "yarn prettier --write"
     ]

package/lib/packages/js/src/Modules/Verto/util/LogCollector.d.ts

@@ -1,29 +0,0 @@
-export declare type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-export interface ILogEntry {
-    timestamp: string;
-    level: LogLevel;
-    message: string;
-    context?: Record<string, unknown>;
-}
-export interface ILogCollectorOptions {
-    enabled: boolean;
-    level: LogLevel;
-    maxEntries: number;
-}
-export declare class LogCollector {
-    private options;
-    private buffer;
-    private isCapturing;
-    constructor(options?: Partial<ILogCollectorOptions>);
-    start(): void;
-    stop(): void;
-    addEntry(level: LogLevel, message: string, context?: Record<string, unknown>): void;
-    getLogs(): ILogEntry[];
-    getLogCount(): number;
-    clear(): void;
-    isActive(): boolean;
-    isEnabled(): boolean;
-}
-export declare function getGlobalLogCollector(): LogCollector | null;
-export declare function setGlobalLogCollector(collector: LogCollector | null): void;
-export declare function createLogCollector(options: Partial<ILogCollectorOptions>): LogCollector;

package/lib/packages/js/src/Modules/Verto/webrtc/CallReportCollector.d.ts

@@ -1,91 +0,0 @@
-import { ILogEntry } from '../../../Modules/Verto/util/LogCollector';
-export interface ICallReportOptions {
-    enabled: boolean;
-    interval: number;
-}
-export interface ILogCollectorOptions {
-    enabled: boolean;
-    level: 'debug' | 'info' | 'warn' | 'error';
-    maxEntries: number;
-}
-export interface IStatsInterval {
-    intervalStartUtc: string;
-    intervalEndUtc: string;
-    audio?: {
-        outbound?: {
-            packetsSent?: number;
-            bytesSent?: number;
-            audioLevelAvg?: number;
-            bitrateAvg?: number;
-        };
-        inbound?: {
-            packetsReceived?: number;
-            bytesReceived?: number;
-            packetsLost?: number;
-            packetsDiscarded?: number;
-            jitterBufferDelay?: number;
-            jitterBufferEmittedCount?: number;
-            totalSamplesReceived?: number;
-            concealedSamples?: number;
-            concealmentEvents?: number;
-            audioLevelAvg?: number;
-            jitterAvg?: number;
-            bitrateAvg?: number;
-        };
-    };
-    connection?: {
-        roundTripTimeAvg?: number;
-        packetsSent?: number;
-        packetsReceived?: number;
-        bytesSent?: number;
-        bytesReceived?: number;
-    };
-}
-export interface ICallSummary {
-    callId: string;
-    destinationNumber?: string;
-    callerNumber?: string;
-    direction?: 'inbound' | 'outbound';
-    state?: string;
-    durationSeconds?: number;
-    telnyxSessionId?: string;
-    telnyxLegId?: string;
-    voiceSdkSessionId?: string;
-    sdkVersion?: string;
-    startTimestamp?: string;
-    endTimestamp?: string;
-}
-export interface ICallReportPayload {
-    summary: ICallSummary;
-    stats: IStatsInterval[];
-    logs?: ILogEntry[];
-}
-export declare class CallReportCollector {
-    private options;
-    private logCollectorOptions;
-    private peerConnection;
-    private intervalId;
-    private statsBuffer;
-    private intervalStartTime;
-    private callStartTime;
-    private callEndTime;
-    private logCollector;
-    private intervalAudioLevels;
-    private intervalJitters;
-    private intervalRTTs;
-    private intervalBitrates;
-    private previousStats;
-    private readonly MAX_BUFFER_SIZE;
-    constructor(options: ICallReportOptions, logCollectorOptions?: ILogCollectorOptions);
-    start(peerConnection: RTCPeerConnection): void;
-    stop(): void;
-    postReport(summary: ICallSummary, callReportId: string, host: string, voiceSdkId?: string): Promise<void>;
-    getStatsBuffer(): IStatsInterval[];
-    getLogs(): ILogEntry[];
-    cleanup(): void;
-    private _collectStats;
-    private _createStatsEntry;
-    private _getTrackAudioLevel;
-    private _average;
-    private _resetIntervalAccumulators;
-}