@telnyx/react-voice-commons-sdk 0.1.2 → 0.1.4

package/lib/models/call-state.js

@@ -1,5 +1,5 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.CallStateHelpers = exports.TelnyxCallState = void 0;
 exports.isTelnyxCallState = isTelnyxCallState;
 /**
@@ -10,80 +10,82 @@ exports.isTelnyxCallState = isTelnyxCallState;
  */
 var TelnyxCallState;
 (function (TelnyxCallState) {
-  /** Call is being initiated (outgoing) or received (incoming) */
-  TelnyxCallState['RINGING'] = 'RINGING';
-  /** Call is connecting after being answered (usually from push notification) */
-  TelnyxCallState['CONNECTING'] = 'CONNECTING';
-  /** Call has been answered and media is flowing */
-  TelnyxCallState['ACTIVE'] = 'ACTIVE';
-  /** Call is on hold */
-  TelnyxCallState['HELD'] = 'HELD';
-  /** Call has ended normally */
-  TelnyxCallState['ENDED'] = 'ENDED';
-  /** Call failed to connect or was rejected */
-  TelnyxCallState['FAILED'] = 'FAILED';
+    /** Call is being initiated (outgoing) or received (incoming) */
+    TelnyxCallState["RINGING"] = "RINGING";
+    /** Call is connecting after being answered (usually from push notification) */
+    TelnyxCallState["CONNECTING"] = "CONNECTING";
+    /** Call has been answered and media is flowing */
+    TelnyxCallState["ACTIVE"] = "ACTIVE";
+    /** Call is on hold */
+    TelnyxCallState["HELD"] = "HELD";
+    /** Call has ended normally */
+    TelnyxCallState["ENDED"] = "ENDED";
+    /** Call failed to connect or was rejected */
+    TelnyxCallState["FAILED"] = "FAILED";
+    /** Call was dropped due to network issues */
+    TelnyxCallState["DROPPED"] = "DROPPED";
 })(TelnyxCallState || (exports.TelnyxCallState = TelnyxCallState = {}));
 /**
  * Type guard to check if a value is a valid TelnyxCallState
  */
 function isTelnyxCallState(value) {
-  return Object.values(TelnyxCallState).includes(value);
+    return Object.values(TelnyxCallState).includes(value);
 }
 /**
  * Helper functions to determine what actions are available in each state
  */
 exports.CallStateHelpers = {
-  /**
-   * Can the call be answered in this state?
-   */
-  canAnswer(state) {
-    return state === TelnyxCallState.RINGING;
-  },
-  /**
-   * Can the call be hung up in this state?
-   */
-  canHangup(state) {
-    return (
-      state === TelnyxCallState.RINGING ||
-      state === TelnyxCallState.CONNECTING ||
-      state === TelnyxCallState.ACTIVE ||
-      state === TelnyxCallState.HELD
-    );
-  },
-  /**
-   * Can the call be put on hold in this state?
-   */
-  canHold(state) {
-    return state === TelnyxCallState.ACTIVE;
-  },
-  /**
-   * Can the call be resumed from hold in this state?
-   */
-  canResume(state) {
-    return state === TelnyxCallState.HELD;
-  },
-  /**
-   * Can the call be muted/unmuted in this state?
-   */
-  canToggleMute(state) {
-    return state === TelnyxCallState.ACTIVE || state === TelnyxCallState.HELD;
-  },
-  /**
-   * Is the call in a terminated state?
-   */
-  isTerminated(state) {
-    return state === TelnyxCallState.ENDED || state === TelnyxCallState.FAILED;
-  },
-  /**
-   * Is the call in an active state (can have media)?
-   */
-  isActive(state) {
-    return state === TelnyxCallState.ACTIVE || state === TelnyxCallState.HELD;
-  },
-  /**
-   * Is the call in a connecting state (answered but not yet active)?
-   */
-  isConnecting(state) {
-    return state === TelnyxCallState.CONNECTING;
-  },
+    /**
+     * Can the call be answered in this state?
+     */
+    canAnswer(state) {
+        return state === TelnyxCallState.RINGING;
+    },
+    /**
+     * Can the call be hung up in this state?
+     */
+    canHangup(state) {
+        return (state === TelnyxCallState.RINGING ||
+            state === TelnyxCallState.CONNECTING ||
+            state === TelnyxCallState.ACTIVE ||
+            state === TelnyxCallState.HELD);
+    },
+    /**
+     * Can the call be put on hold in this state?
+     */
+    canHold(state) {
+        return state === TelnyxCallState.ACTIVE;
+    },
+    /**
+     * Can the call be resumed from hold in this state?
+     */
+    canResume(state) {
+        return state === TelnyxCallState.HELD;
+    },
+    /**
+     * Can the call be muted/unmuted in this state?
+     */
+    canToggleMute(state) {
+        return state === TelnyxCallState.ACTIVE || state === TelnyxCallState.HELD;
+    },
+    /**
+     * Is the call in a terminated state?
+     */
+    isTerminated(state) {
+        return (state === TelnyxCallState.ENDED ||
+            state === TelnyxCallState.FAILED ||
+            state === TelnyxCallState.DROPPED);
+    },
+    /**
+     * Is the call in an active state (can have media)?
+     */
+    isActive(state) {
+        return state === TelnyxCallState.ACTIVE || state === TelnyxCallState.HELD;
+    },
+    /**
+     * Is the call in a connecting state (answered but not yet active)?
+     */
+    isConnecting(state) {
+        return state === TelnyxCallState.CONNECTING;
+    },
 };

package/lib/models/call.d.ts

@@ -9,137 +9,165 @@ import { Call as TelnyxCall } from '@telnyx/react-native-voice-sdk';
  * integrate with any state management solution.
  */
 export declare class Call {
-  private readonly _telnyxCall;
-  private readonly _callId;
-  private readonly _destination;
-  private readonly _isIncoming;
-  private readonly _callState;
-  private readonly _isMuted;
-  private readonly _isHeld;
-  private readonly _duration;
-  private _durationTimer?;
-  private _startTime?;
-  constructor(_telnyxCall: TelnyxCall, _callId: string, _destination: string, _isIncoming: boolean);
-  /**
-   * Unique identifier for this call
-   */
-  get callId(): string;
-  /**
-   * The destination number or SIP URI
-   */
-  get destination(): string;
-  /**
-   * Whether this is an incoming call
-   */
-  get isIncoming(): boolean;
-  /**
-   * Whether this is an outgoing call
-   */
-  get isOutgoing(): boolean;
-  /**
-   * Current call state (synchronous access)
-   */
-  get currentState(): TelnyxCallState;
-  /**
-   * Current mute state (synchronous access)
-   */
-  get currentIsMuted(): boolean;
-  /**
-   * Current hold state (synchronous access)
-   */
-  get currentIsHeld(): boolean;
-  /**
-   * Current call duration in seconds (synchronous access)
-   */
-  get currentDuration(): number;
-  /**
-   * Get the underlying Telnyx Call object (for internal use)
-   * @internal
-   */
-  get telnyxCall(): TelnyxCall;
-  /**
-   * Observable stream of call state changes
-   */
-  get callState$(): Observable<TelnyxCallState>;
-  /**
-   * Observable stream of mute state changes
-   */
-  get isMuted$(): Observable<boolean>;
-  /**
-   * Observable stream of hold state changes
-   */
-  get isHeld$(): Observable<boolean>;
-  /**
-   * Observable stream of call duration changes (in seconds)
-   */
-  get duration$(): Observable<number>;
-  /**
-   * Observable that emits true when the call can be answered
-   */
-  get canAnswer$(): Observable<boolean>;
-  /**
-   * Observable that emits true when the call can be hung up
-   */
-  get canHangup$(): Observable<boolean>;
-  /**
-   * Observable that emits true when the call can be put on hold
-   */
-  get canHold$(): Observable<boolean>;
-  /**
-   * Observable that emits true when the call can be resumed from hold
-   */
-  get canResume$(): Observable<boolean>;
-  /**
-   * Answer the incoming call
-   */
-  answer(): Promise<void>;
-  /**
-   * Hang up the call
-   */
-  hangup(): Promise<void>;
-  /**
-   * Put the call on hold
-   */
-  hold(): Promise<void>;
-  /**
-   * Resume the call from hold
-   */
-  resume(): Promise<void>;
-  /**
-   * Mute the call
-   */
-  mute(): Promise<void>;
-  /**
-   * Unmute the call
-   */
-  unmute(): Promise<void>;
-  /**
-   * Toggle mute state
-   */
-  toggleMute(): Promise<void>;
-  /**
-   * Set the call to connecting state (used for push notification calls when answered via CallKit)
-   * @internal
-   */
-  setConnecting(): void;
-  /**
-   * Clean up resources when the call is disposed
-   */
-  dispose(): void;
-  /**
-   * Set up listeners for the underlying Telnyx call
-   */
-  private _setupCallListeners;
-  /**
-   * Map Telnyx SDK call states to our simplified call states
-   */
-  private _mapToTelnyxCallState;
-  /**
-   * Start the duration timer
-   */
-  private _startDurationTimer;
-  /**
-   * Stop the duration timer
-   */
-  private _stopDurationTimer;
+    private readonly _telnyxCall;
+    private readonly _callId;
+    private readonly _destination;
+    private readonly _isIncoming;
+    private readonly _originalCallerName?;
+    private readonly _originalCallerNumber?;
+    private readonly _callState;
+    private readonly _isMuted;
+    private readonly _isHeld;
+    private readonly _duration;
+    private _durationTimer?;
+    private _startTime?;
+    constructor(_telnyxCall: TelnyxCall, _callId: string, _destination: string, _isIncoming: boolean, isReattached?: boolean, _originalCallerName?: string, _originalCallerNumber?: string);
+    /**
+     * Unique identifier for this call
+     */
+    get callId(): string;
+    /**
+     * The destination number or SIP URI
+     */
+    get destination(): string;
+    /**
+     * Whether this is an incoming call
+     */
+    get isIncoming(): boolean;
+    /**
+     * Whether this is an outgoing call
+     */
+    get isOutgoing(): boolean;
+    /**
+     * Current call state (synchronous access)
+     */
+    get currentState(): TelnyxCallState;
+    /**
+     * Current mute state (synchronous access)
+     */
+    get currentIsMuted(): boolean;
+    /**
+     * Current hold state (synchronous access)
+     */
+    get currentIsHeld(): boolean;
+    /**
+     * Current call duration in seconds (synchronous access)
+     */
+    get currentDuration(): number;
+    /**
+     * Custom headers received from the WebRTC INVITE message.
+     * These headers are passed during call initiation and can contain application-specific information.
+     * Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".
+     */
+    get inviteCustomHeaders(): {
+        name: string;
+        value: string;
+    }[] | null;
+    /**
+     * Custom headers received from the WebRTC ANSWER message.
+     * These headers are passed during call acceptance and can contain application-specific information.
+     * Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".
+     */
+    get answerCustomHeaders(): {
+        name: string;
+        value: string;
+    }[] | null;
+    /**
+     * Get the underlying Telnyx Call object (for internal use)
+     * @internal
+     */
+    get telnyxCall(): TelnyxCall;
+    /**
+     * Observable stream of call state changes
+     */
+    get callState$(): Observable<TelnyxCallState>;
+    /**
+     * Observable stream of mute state changes
+     */
+    get isMuted$(): Observable<boolean>;
+    /**
+     * Observable stream of hold state changes
+     */
+    get isHeld$(): Observable<boolean>;
+    /**
+     * Observable stream of call duration changes (in seconds)
+     */
+    get duration$(): Observable<number>;
+    /**
+     * Observable that emits true when the call can be answered
+     */
+    get canAnswer$(): Observable<boolean>;
+    /**
+     * Observable that emits true when the call can be hung up
+     */
+    get canHangup$(): Observable<boolean>;
+    /**
+     * Observable that emits true when the call can be put on hold
+     */
+    get canHold$(): Observable<boolean>;
+    /**
+     * Observable that emits true when the call can be resumed from hold
+     */
+    get canResume$(): Observable<boolean>;
+    /**
+     * Answer the incoming call
+     * @param customHeaders Optional custom headers to include with the answer
+     */
+    answer(customHeaders?: {
+        name: string;
+        value: string;
+    }[]): Promise<void>;
+    /**
+     * Hang up the call
+     * @param customHeaders Optional custom headers to include with the hangup request
+     */
+    hangup(customHeaders?: {
+        name: string;
+        value: string;
+    }[]): Promise<void>;
+    /**
+     * Put the call on hold
+     */
+    hold(): Promise<void>;
+    /**
+     * Resume the call from hold
+     */
+    resume(): Promise<void>;
+    /**
+     * Mute the call
+     */
+    mute(): Promise<void>;
+    /**
+     * Unmute the call
+     */
+    unmute(): Promise<void>;
+    /**
+     * Toggle mute state
+     */
+    toggleMute(): Promise<void>;
+    /**
+     * Set the call to connecting state (used for push notification calls when answered via CallKit)
+     * @internal
+     */
+    setConnecting(): void;
+    /**
+     * Clean up resources when the call is disposed
+     */
+    dispose(): void;
+    /**
+     * Set up listeners for the underlying Telnyx call
+     */
+    private _setupCallListeners;
+    /**
+     * Map Telnyx SDK call states to our simplified call states
+     */
+    private _mapToTelnyxCallState;
+    /**
+     * Start the duration timer
+     */
+    private _startDurationTimer;
+    /**
+     * Stop the duration timer
+     */
+    private _stopDurationTimer;
 }