@telnyx/webrtc 2.26.1-beta.4 → 2.26.2

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

@@ -1,7 +1,11 @@
 import type { Logger } from 'loglevel';
 import BaseMessage from './messages/BaseMessage';
 import Connection from './services/Connection';
+import { SwEvent } from './util/constants';
+import type { ITelnyxErrorEvent } from './util/errors';
 import { BroadcastParams, ILoginParams, IVertoOptions } from './util/interfaces';
+import type { INotification } from '../../utils/interfaces';
+import type { ITelnyxWarningEvent } from './util/constants/warnings';
 export default abstract class BaseSession {
     options: IVertoOptions;
     uuid: string;
@@ -41,7 +45,13 @@ export default abstract class BaseSession {
     validateOptions(): boolean;
     broadcast(_params: BroadcastParams): void;
     disconnect(): Promise<void>;
+    on(eventName: SwEvent.Error | 'telnyx.error', callback: (event: ITelnyxErrorEvent) => void): this;
+    on(eventName: SwEvent.Warning | 'telnyx.warning', callback: (event: ITelnyxWarningEvent) => void): this;
+    on(eventName: SwEvent.Notification | 'telnyx.notification', callback: (event: INotification) => void): this;
     on(eventName: string, callback: Function): this;
+    off(eventName: SwEvent.Error | 'telnyx.error', callback?: (event: ITelnyxErrorEvent) => void): this;
+    off(eventName: SwEvent.Warning | 'telnyx.warning', callback?: (event: ITelnyxWarningEvent) => void): this;
+    off(eventName: SwEvent.Notification | 'telnyx.notification', callback?: (event: INotification) => void): this;
     off(eventName: string, callback?: Function): this;
     connect(): Promise<void>;
     protected _handleLoginError(error: any): void;

package/lib/src/Modules/Verto/BrowserSession.d.ts

@@ -31,6 +31,7 @@ export default abstract class BrowserSession extends BaseSession {
     checkPermissions(audio?: boolean, video?: boolean): Promise<boolean>;
     logout(): void;
     disconnect(): Promise<void>;
+    serverDisconnect(): Promise<void>;
     socketDisconnect(): void;
     handleLoginError(error: any): void;
     speedTest(bytes: number): Promise<unknown>;

package/lib/src/Modules/Verto/util/constants/errorCodes.d.ts

@@ -1,36 +1,41 @@
-import type { SdkErrorCode } from './errors';
-import type { SdkWarningCode } from './warnings';
-export declare const SDP_CREATE_OFFER_FAILED: SdkErrorCode;
-export declare const SDP_CREATE_ANSWER_FAILED: SdkErrorCode;
-export declare const SDP_SET_LOCAL_DESCRIPTION_FAILED: SdkErrorCode;
-export declare const SDP_SET_REMOTE_DESCRIPTION_FAILED: SdkErrorCode;
-export declare const SDP_SEND_FAILED: SdkErrorCode;
-export declare const MEDIA_MICROPHONE_PERMISSION_DENIED: SdkErrorCode;
-export declare const MEDIA_DEVICE_NOT_FOUND: SdkErrorCode;
-export declare const MEDIA_GET_USER_MEDIA_FAILED: SdkErrorCode;
-export declare const HOLD_FAILED: SdkErrorCode;
-export declare const INVALID_CALL_PARAMETERS: SdkErrorCode;
-export declare const BYE_SEND_FAILED: SdkErrorCode;
-export declare const SUBSCRIBE_FAILED: SdkErrorCode;
-export declare const WEBSOCKET_CONNECTION_FAILED: SdkErrorCode;
-export declare const WEBSOCKET_ERROR: SdkErrorCode;
-export declare const RECONNECTION_EXHAUSTED: SdkErrorCode;
-export declare const GATEWAY_FAILED: SdkErrorCode;
-export declare const LOGIN_FAILED: SdkErrorCode;
-export declare const INVALID_CREDENTIALS: SdkErrorCode;
-export declare const AUTHENTICATION_REQUIRED: SdkErrorCode;
-export declare const NETWORK_OFFLINE: SdkErrorCode;
-export declare const HIGH_RTT: SdkWarningCode;
-export declare const HIGH_JITTER: SdkWarningCode;
-export declare const HIGH_PACKET_LOSS: SdkWarningCode;
-export declare const LOW_MOS: SdkWarningCode;
-export declare const LOW_BYTES_RECEIVED: SdkWarningCode;
-export declare const LOW_BYTES_SENT: SdkWarningCode;
-export declare const ICE_CONNECTIVITY_LOST: SdkWarningCode;
-export declare const ICE_GATHERING_TIMEOUT: SdkWarningCode;
-export declare const ICE_GATHERING_EMPTY: SdkWarningCode;
-export declare const PEER_CONNECTION_FAILED: SdkWarningCode;
-export declare const ONLY_HOST_ICE_CANDIDATES: SdkWarningCode;
-export declare const TOKEN_EXPIRING_SOON: SdkWarningCode;
-export declare const SESSION_NOT_REATTACHED: SdkWarningCode;
+export declare const TELNYX_ERROR_CODES: {
+    readonly SDP_CREATE_OFFER_FAILED: 40001;
+    readonly SDP_CREATE_ANSWER_FAILED: 40002;
+    readonly SDP_SET_LOCAL_DESCRIPTION_FAILED: 40003;
+    readonly SDP_SET_REMOTE_DESCRIPTION_FAILED: 40004;
+    readonly SDP_SEND_FAILED: 40005;
+    readonly MEDIA_MICROPHONE_PERMISSION_DENIED: 42001;
+    readonly MEDIA_DEVICE_NOT_FOUND: 42002;
+    readonly MEDIA_GET_USER_MEDIA_FAILED: 42003;
+    readonly HOLD_FAILED: 44001;
+    readonly INVALID_CALL_PARAMETERS: 44002;
+    readonly BYE_SEND_FAILED: 44003;
+    readonly SUBSCRIBE_FAILED: 44004;
+    readonly WEBSOCKET_CONNECTION_FAILED: 45001;
+    readonly WEBSOCKET_ERROR: 45002;
+    readonly RECONNECTION_EXHAUSTED: 45003;
+    readonly GATEWAY_FAILED: 45004;
+    readonly LOGIN_FAILED: 46001;
+    readonly INVALID_CREDENTIALS: 46002;
+    readonly AUTHENTICATION_REQUIRED: 46003;
+    readonly NETWORK_OFFLINE: 48001;
+    readonly UNEXPECTED_ERROR: 49001;
+};
+export declare const TELNYX_WARNING_CODES: {
+    readonly HIGH_RTT: 31001;
+    readonly HIGH_JITTER: 31002;
+    readonly HIGH_PACKET_LOSS: 31003;
+    readonly LOW_MOS: 31004;
+    readonly LOW_BYTES_RECEIVED: 32001;
+    readonly LOW_BYTES_SENT: 32002;
+    readonly ICE_CONNECTIVITY_LOST: 33001;
+    readonly ICE_GATHERING_TIMEOUT: 33002;
+    readonly ICE_GATHERING_EMPTY: 33003;
+    readonly PEER_CONNECTION_FAILED: 33004;
+    readonly ONLY_HOST_ICE_CANDIDATES: 33005;
+    readonly TOKEN_EXPIRING_SOON: 34001;
+    readonly SESSION_NOT_REATTACHED: 35001;
+};
+export declare const SDP_CREATE_OFFER_FAILED: 40001, SDP_CREATE_ANSWER_FAILED: 40002, SDP_SET_LOCAL_DESCRIPTION_FAILED: 40003, SDP_SET_REMOTE_DESCRIPTION_FAILED: 40004, SDP_SEND_FAILED: 40005, MEDIA_MICROPHONE_PERMISSION_DENIED: 42001, MEDIA_DEVICE_NOT_FOUND: 42002, MEDIA_GET_USER_MEDIA_FAILED: 42003, HOLD_FAILED: 44001, INVALID_CALL_PARAMETERS: 44002, BYE_SEND_FAILED: 44003, SUBSCRIBE_FAILED: 44004, WEBSOCKET_CONNECTION_FAILED: 45001, WEBSOCKET_ERROR: 45002, RECONNECTION_EXHAUSTED: 45003, GATEWAY_FAILED: 45004, LOGIN_FAILED: 46001, INVALID_CREDENTIALS: 46002, AUTHENTICATION_REQUIRED: 46003, NETWORK_OFFLINE: 48001, UNEXPECTED_ERROR: 49001;
+export declare const HIGH_RTT: 31001, HIGH_JITTER: 31002, HIGH_PACKET_LOSS: 31003, LOW_MOS: 31004, LOW_BYTES_RECEIVED: 32001, LOW_BYTES_SENT: 32002, ICE_CONNECTIVITY_LOST: 33001, ICE_GATHERING_TIMEOUT: 33002, ICE_GATHERING_EMPTY: 33003, PEER_CONNECTION_FAILED: 33004, ONLY_HOST_ICE_CANDIDATES: 33005, TOKEN_EXPIRING_SOON: 34001, SESSION_NOT_REATTACHED: 35001;
 export declare const HAS_NON_HOST_ICE_CANDIDATE_REGEX: RegExp;

package/lib/src/Modules/Verto/util/constants/errors.d.ts

@@ -139,5 +139,12 @@ export declare const SDK_ERRORS: {
         readonly causes: readonly ["Wi-Fi or ethernet disconnected", "Airplane mode enabled", "Network interface went down"];
         readonly solutions: readonly ["Check network connectivity", "Reconnect to Wi-Fi or ethernet", "Disable airplane mode"];
     };
+    readonly 49001: {
+        readonly name: "UNEXPECTED_ERROR";
+        readonly message: "An unexpected error occurred";
+        readonly description: "An error was thrown that does not match any known SDK error category. This is a catch-all for unclassified failures.";
+        readonly causes: readonly ["Unknown or unhandled error condition"];
+        readonly solutions: readonly ["Check the originalError property for the underlying cause", "Report the issue if it persists"];
+    };
 };
 export declare type SdkErrorCode = keyof typeof SDK_ERRORS;

package/lib/src/Modules/Verto/util/constants/warnings.d.ts

@@ -6,6 +6,11 @@ export interface ITelnyxWarning {
     causes: string[];
     solutions: string[];
 }
+export interface ITelnyxWarningEvent {
+    warning: ITelnyxWarning;
+    sessionId: string;
+    callId?: string;
+}
 export declare const SDK_WARNINGS: {
     readonly 31001: {
         readonly name: "HIGH_RTT";

package/lib/src/Modules/Verto/util/errors.d.ts

@@ -3,8 +3,9 @@ import { SDK_WARNINGS, SdkWarningCode, ITelnyxWarning, createTelnyxWarning } fro
 import { MEDIA_MICROPHONE_PERMISSION_DENIED, MEDIA_DEVICE_NOT_FOUND, MEDIA_GET_USER_MEDIA_FAILED } from './constants/errorCodes';
 export { SDK_ERRORS, SdkErrorCode };
 export { SDK_WARNINGS, SdkWarningCode, ITelnyxWarning, createTelnyxWarning };
+export declare type TelnyxMediaErrorCode = typeof MEDIA_MICROPHONE_PERMISSION_DENIED | typeof MEDIA_DEVICE_NOT_FOUND | typeof MEDIA_GET_USER_MEDIA_FAILED;
 export interface ITelnyxError {
-    code: number;
+    code: SdkErrorCode;
     name: string;
     description: string;
     message: string;
@@ -12,8 +13,27 @@ export interface ITelnyxError {
     solutions: string[];
     originalError?: unknown;
 }
+export interface ITelnyxMediaError extends Omit<ITelnyxError, 'code'> {
+    code: TelnyxMediaErrorCode;
+}
+export interface ITelnyxStandardErrorEvent {
+    error: ITelnyxError;
+    sessionId: string;
+    callId?: string;
+    recoverable?: false;
+}
+export interface ITelnyxMediaRecoveryErrorEvent {
+    error: ITelnyxMediaError;
+    sessionId: string;
+    callId: string;
+    recoverable: true;
+    retryDeadline: number;
+    resume: () => void;
+    reject: () => void;
+}
+export declare type ITelnyxErrorEvent = ITelnyxStandardErrorEvent | ITelnyxMediaRecoveryErrorEvent;
 export declare class TelnyxError extends Error implements ITelnyxError {
-    readonly code: number;
+    readonly code: SdkErrorCode;
     readonly description: string;
     readonly causes: string[];
     readonly solutions: string[];
@@ -23,5 +43,6 @@ export declare class TelnyxError extends Error implements ITelnyxError {
     });
     toJSON(): ITelnyxError;
 }
+export declare function isMediaRecoveryErrorEvent(event: ITelnyxErrorEvent): event is ITelnyxMediaRecoveryErrorEvent;
 export declare function classifyMediaErrorCode(error: unknown): typeof MEDIA_MICROPHONE_PERMISSION_DENIED | typeof MEDIA_DEVICE_NOT_FOUND | typeof MEDIA_GET_USER_MEDIA_FAILED;
 export declare function createTelnyxError(code: SdkErrorCode, originalError?: unknown, message?: string): TelnyxError;

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

@@ -21,7 +21,6 @@ export interface IVertoOptions {
     prefetchIceCandidates?: boolean;
     forceRelayCandidate?: boolean;
     trickleIce?: boolean;
-    singleInterfaceIce?: boolean;
     keepConnectionAliveOnSocketClose?: boolean;
     useCanaryRtcServer?: boolean;
     region?: string;
@@ -38,6 +37,12 @@ export interface IVertoOptions {
     callReportInterval?: number;
     debugLogLevel?: 'debug' | 'info' | 'warn' | 'error';
     debugLogMaxEntries?: number;
+    mediaPermissionsRecovery?: {
+        enabled: boolean;
+        timeout: number;
+        onSuccess?: () => void;
+        onError?: (error: Error) => void;
+    };
 }
 export interface ILoginParams {
     login?: string;

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

@@ -43,7 +43,6 @@ export default abstract class BaseCall implements IWebRTCCall {
     private _firstCandidateSent;
     private _firstNonHostCandidateSent;
     private _isRecovering;
-    private _candidateFilter;
     constructor(session: BrowserSession, opts?: IVertoCallOptions);
     get nodeId(): string;
     set nodeId(what: string);

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

@@ -66,7 +66,6 @@ export interface IVertoCallOptions {
     prefetchIceCandidates?: boolean;
     forceRelayCandidate?: boolean;
     trickleIce?: boolean;
-    singleInterfaceIce?: boolean;
     keepConnectionAliveOnSocketClose?: boolean;
     mutedMicOnStart?: boolean;
     recoveredCallId?: string;

package/lib/src/index.d.ts

@@ -4,6 +4,8 @@ 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, NOTIFICATION_TYPE, ERROR_TYPE, };
-export type { ITelnyxError } from './Modules/Verto/util/errors';
-export type { ITelnyxWarning } from './Modules/Verto/util/constants/warnings';
+export { SDK_ERRORS, SDK_WARNINGS, TelnyxError, isMediaRecoveryErrorEvent, } from './Modules/Verto/util/errors';
+export { TELNYX_ERROR_CODES, TELNYX_WARNING_CODES, } from './Modules/Verto/util/constants/errorCodes';
+export type { ITelnyxError, ITelnyxMediaError, ITelnyxErrorEvent, ITelnyxMediaRecoveryErrorEvent, ITelnyxStandardErrorEvent, TelnyxMediaErrorCode, } from './Modules/Verto/util/errors';
+export type { ITelnyxWarning, ITelnyxWarningEvent, } from './Modules/Verto/util/constants/warnings';
 export * from './PreCallDiagnosis';

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

@@ -36,6 +36,12 @@ export interface IClientOptions {
     mutedMicOnStart?: boolean;
     enableCallReports?: boolean;
     callReportInterval?: number;
+    mediaPermissionsRecovery?: {
+        enabled: boolean;
+        timeout: number;
+        onSuccess?: () => void;
+        onError?: (error: Error) => void;
+    };
 }
 export interface ICallOptions {
     destinationNumber?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telnyx/webrtc",
-  "version": "2.26.1-beta.4",
+  "version": "2.26.2",
   "description": "Telnyx WebRTC Client",
   "keywords": [
     "telnyx",
@@ -15,7 +15,7 @@
   ],
   "main": "lib/bundle.js",
   "module": "lib/bundle.mjs",
-  "types": "lib/packages/js/src/index.d.ts",
+  "types": "lib/src/index.d.ts",
   "files": [
     "lib",
     "README.md"

package/lib/src/Modules/Verto/webrtc/CandidateFilter.d.ts

@@ -1,14 +0,0 @@
-export declare class CandidateFilter {
-    private _lockedInterface;
-    private _enabled;
-    private _onCandidate;
-    private _onEndOfCandidates;
-    private _filteredCount;
-    private _passedCount;
-    constructor(enabled: boolean, onCandidate: (candidate: RTCIceCandidate) => void, onEndOfCandidates: () => void);
-    add(event: RTCPeerConnectionIceEvent): void;
-    reset(): void;
-    private _extractRaddr;
-    private _extractNetworkId;
-    private _isTcpCandidate;
-}