ue-softphone-sdk 4.0.3 → 4.0.5

package/dist/lib/types/lib/sip.js/api/ack.d.ts

@@ -0,0 +1,12 @@
+import { IncomingRequestMessage, IncomingAckRequest } from "../core";
+/**
+ * A request to confirm a {@link Session} (incoming ACK).
+ * @public
+ */
+export declare class Ack {
+    private incomingAckRequest;
+    /** @internal */
+    constructor(incomingAckRequest: IncomingAckRequest);
+    /** Incoming ACK request message. */
+    get request(): IncomingRequestMessage;
+}

package/dist/lib/types/lib/sip.js/api/bye.d.ts

@@ -0,0 +1,16 @@
+import { IncomingByeRequest, IncomingRequestMessage, ResponseOptions } from "../core";
+/**
+ * A request to end a {@link Session} (incoming BYE).
+ * @public
+ */
+export declare class Bye {
+    private incomingByeRequest;
+    /** @internal */
+    constructor(incomingByeRequest: IncomingByeRequest);
+    /** Incoming BYE request message. */
+    get request(): IncomingRequestMessage;
+    /** Accept the request. */
+    accept(options?: ResponseOptions): Promise<void>;
+    /** Reject the request. */
+    reject(options?: ResponseOptions): Promise<void>;
+}

package/dist/lib/types/lib/sip.js/api/dtmf.d.ts

@@ -0,0 +1,15 @@
+import { IncomingInfoRequest } from "../core";
+import { Info } from "./info";
+/**
+ * A DTMF signal (incoming INFO).
+ * @deprecated Use `Info`.
+ * @internal
+ */
+export declare class DTMF extends Info {
+    private _tone;
+    private _duration;
+    /** @internal */
+    constructor(incomingInfoRequest: IncomingInfoRequest, tone: string, duration: number);
+    get tone(): string;
+    get duration(): number;
+}

package/dist/lib/types/lib/sip.js/api/emitter.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Generic observable.
+ * @public
+ */
+export interface Emitter<T> {
+    /**
+     * Sets up a function that will be called whenever the target changes.
+     * @param listener - Callback function.
+     * @param options - An options object that specifies characteristics about the listener.
+     *                  If once true, indicates that the listener should be invoked at most once after being added.
+     *                  If once true, the listener would be automatically removed when invoked.
+     */
+    addListener(listener: (data: T) => void, options?: {
+        once?: boolean;
+    }): void;
+    /**
+     * Removes from the listener previously registered with addListener.
+     * @param listener - Callback function.
+     */
+    removeListener(listener: (data: T) => void): void;
+    /**
+     * Registers a listener.
+     * @param listener - Callback function.
+     * @deprecated Use addListener.
+     */
+    on(listener: (data: T) => void): void;
+    /**
+     * Unregisters a listener.
+     * @param listener - Callback function.
+     * @deprecated Use removeListener.
+     */
+    off(listener: (data: T) => void): void;
+    /**
+     * Registers a listener then unregisters the listener after one event emission.
+     * @param listener - Callback function.
+     * @deprecated Use addListener.
+     */
+    once(listener: (data: T) => void): void;
+}
+/**
+ * An {@link Emitter} implementation.
+ * @internal
+ */
+export declare class EmitterImpl<T> implements Emitter<T> {
+    private listeners;
+    /**
+     * Sets up a function that will be called whenever the target changes.
+     * @param listener - Callback function.
+     * @param options - An options object that specifies characteristics about the listener.
+     *                  If once true, indicates that the listener should be invoked at most once after being added.
+     *                  If once true, the listener would be automatically removed when invoked.
+     */
+    addListener(listener: (data: T) => void, options?: {
+        once?: boolean;
+    }): void;
+    /**
+     * Emit change.
+     * @param data - Data to emit.
+     */
+    emit(data: T): void;
+    /**
+     * Removes all listeners previously registered with addListener.
+     */
+    removeAllListeners(): void;
+    /**
+     * Removes a listener previously registered with addListener.
+     * @param listener - Callback function.
+     */
+    removeListener(listener: (data: T) => void): void;
+    /**
+     * Registers a listener.
+     * @param listener - Callback function.
+     * @deprecated Use addListener.
+     */
+    on(listener: (data: T) => void): void;
+    /**
+     * Unregisters a listener.
+     * @param listener - Callback function.
+     * @deprecated Use removeListener.
+     */
+    off(listener: (data: T) => void): void;
+    /**
+     * Registers a listener then unregisters the listener after one event emission.
+     * @param listener - Callback function.
+     * @deprecated Use addListener.
+     */
+    once(listener: (data: T) => void): void;
+}

package/dist/lib/types/lib/sip.js/api/exceptions/content-type-unsupported.d.ts

@@ -0,0 +1,8 @@
+import { Exception } from "../../core";
+/**
+ * An exception indicating an unsupported content type prevented execution.
+ * @public
+ */
+export declare class ContentTypeUnsupportedError extends Exception {
+    constructor(message?: string);
+}

package/dist/lib/types/lib/sip.js/api/exceptions/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./content-type-unsupported";
+export * from "./request-pending";
+export * from "./session-description-handler";
+export * from "./session-terminated";
+export * from "./state-transition";

package/dist/lib/types/lib/sip.js/api/exceptions/request-pending.d.ts

@@ -0,0 +1,9 @@
+import { Exception } from "../../core";
+/**
+ * An exception indicating an outstanding prior request prevented execution.
+ * @public
+ */
+export declare class RequestPendingError extends Exception {
+    /** @internal */
+    constructor(message?: string);
+}

package/dist/lib/types/lib/sip.js/api/exceptions/session-description-handler.d.ts

@@ -0,0 +1,8 @@
+import { Exception } from "../../core";
+/**
+ * An exception indicating a session description handler error occured.
+ * @public
+ */
+export declare class SessionDescriptionHandlerError extends Exception {
+    constructor(message?: string);
+}

package/dist/lib/types/lib/sip.js/api/exceptions/session-terminated.d.ts

@@ -0,0 +1,8 @@
+import { Exception } from "../../core";
+/**
+ * An exception indicating the session terminated before the action completed.
+ * @public
+ */
+export declare class SessionTerminatedError extends Exception {
+    constructor();
+}

package/dist/lib/types/lib/sip.js/api/exceptions/state-transition.d.ts

@@ -0,0 +1,8 @@
+import { Exception } from "../../core";
+/**
+ * An exception indicating an invalid state transition error occured.
+ * @public
+ */
+export declare class StateTransitionError extends Exception {
+    constructor(message?: string);
+}

package/dist/lib/types/lib/sip.js/api/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * A simple yet powerful API which takes care of SIP signaling and WebRTC media sessions for you.
+ * @packageDocumentation
+ */
+export * from "./exceptions";
+export * from "./ack";
+export * from "./bye";
+export * from "./emitter";
+export * from "./info";
+export * from "./invitation-accept-options";
+export * from "./invitation-progress-options";
+export * from "./invitation-reject-options";
+export * from "./invitation";
+export * from "./inviter-cancel-options";
+export * from "./inviter-invite-options";
+export * from "./inviter-options";
+export * from "./inviter";
+export * from "./message";
+export * from "./messager-message-options";
+export * from "./messager-options";
+export * from "./messager";
+export * from "./notification";
+export * from "./publisher-options";
+export * from "./publisher-publish-options";
+export * from "./publisher-state";
+export * from "./publisher-unpublish-options";
+export * from "./publisher";
+export * from "./referral";
+export * from "./registerer-options";
+export * from "./registerer-register-options";
+export * from "./registerer-state";
+export * from "./registerer-unregister-options";
+export * from "./registerer";
+export * from "./session-bye-options";
+export * from "./session-delegate";
+export * from "./session-description-handler-factory";
+export * from "./session-description-handler";
+export * from "./session-info-options";
+export * from "./session-invite-options";
+export * from "./session-message-options";
+export * from "./session-options";
+export * from "./session-refer-options";
+export * from "./session-state";
+export * from "./session";
+export * from "./subscriber-options";
+export * from "./subscriber-subscribe-options";
+export * from "./subscriber";
+export * from "./subscription-delegate";
+export * from "./subscription-options";
+export * from "./subscription-state";
+export * from "./subscription-subscribe-options";
+export * from "./subscription-unsubscribe-options";
+export * from "./subscription";
+export * from "./transport";
+export * from "./transport-state";
+export * from "./user-agent-delegate";
+export * from "./user-agent-options";
+export * from "./user-agent-state";
+export * from "./user-agent";

package/dist/lib/types/lib/sip.js/api/info.d.ts

@@ -0,0 +1,16 @@
+import { IncomingInfoRequest, IncomingRequestMessage, ResponseOptions } from "../core";
+/**
+ * An exchange of information (incoming INFO).
+ * @public
+ */
+export declare class Info {
+    private incomingInfoRequest;
+    /** @internal */
+    constructor(incomingInfoRequest: IncomingInfoRequest);
+    /** Incoming MESSAGE request message. */
+    get request(): IncomingRequestMessage;
+    /** Accept the request. */
+    accept(options?: ResponseOptions): Promise<void>;
+    /** Reject the request. */
+    reject(options?: ResponseOptions): Promise<void>;
+}

package/dist/lib/types/lib/sip.js/api/invitation-accept-options.d.ts

@@ -0,0 +1,19 @@
+import { SessionDescriptionHandlerModifier, SessionDescriptionHandlerOptions } from "./session-description-handler";
+/**
+ * Options for {@link Invitation.accept}.
+ * @public
+ */
+export interface InvitationAcceptOptions {
+    /**
+     * Array of extra headers added to the response.
+     */
+    extraHeaders?: Array<string>;
+    /**
+     * Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+    /**
+     * Options to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+}

package/dist/lib/types/lib/sip.js/api/invitation-progress-options.d.ts

@@ -0,0 +1,38 @@
+import { SessionDescriptionHandlerModifier, SessionDescriptionHandlerOptions } from "./session-description-handler";
+/**
+ * Options for {@link Invitation.progress}.
+ * @public
+ */
+export interface InvitationProgressOptions {
+    /**
+     * Body
+     */
+    body?: string | {
+        body: string;
+        contentType: string;
+    };
+    /**
+     * Array of extra headers added to the response.
+     */
+    extraHeaders?: Array<string>;
+    /**
+     * Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+    /**
+     * Options to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+    /**
+     * Status code for response.
+     */
+    statusCode?: number;
+    /**
+     * Reason phrase for response.
+     */
+    reasonPhrase?: string;
+    /**
+     * Send reliable response.
+     */
+    rel100?: boolean;
+}

package/dist/lib/types/lib/sip.js/api/invitation-reject-options.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Options for {@link Invitation.reject}.
+ * @public
+ */
+export interface InvitationRejectOptions {
+    /**
+     * Body
+     */
+    body?: string | {
+        body: string;
+        contentType: string;
+    };
+    /**
+     * Array of extra headers added to the response.
+     */
+    extraHeaders?: Array<string>;
+    /**
+     * Status code for response.
+     */
+    statusCode?: number;
+    /**
+     * Reason phrase for response.
+     */
+    reasonPhrase?: string;
+}

package/dist/lib/types/lib/sip.js/api/invitation.d.ts

@@ -0,0 +1,179 @@
+import { IncomingInviteRequest, IncomingRequestMessage, Logger, NameAddrHeader } from '../core';
+import { InvitationAcceptOptions } from './invitation-accept-options';
+import { InvitationProgressOptions } from './invitation-progress-options';
+import { InvitationRejectOptions } from './invitation-reject-options';
+import { Session } from './session';
+import { UserAgent } from './user-agent';
+/**
+ * An invitation is an offer to establish a {@link Session} (incoming INVITE).
+ * @public
+ */
+export declare class Invitation extends Session {
+    private incomingInviteRequest;
+    /**
+     * Logger.
+     */
+    protected logger: Logger;
+    /** @internal */
+    protected _id: string;
+    /** True if dispose() has been called. */
+    private disposed;
+    /** INVITE will be rejected if not accepted within a certain period time. */
+    private expiresTimer;
+    /** True if this Session has been Terminated due to a CANCEL request. */
+    private isCanceled;
+    /** Are reliable provisional responses required or supported. */
+    private rel100;
+    /** The current RSeq header value. */
+    private rseq;
+    /** INVITE will be rejected if final response not sent in a certain period time. */
+    private userNoAnswerTimer;
+    /** True if waiting for a PRACK before sending a 200 Ok. */
+    private waitingForPrack;
+    /** A Promise providing a defer when waiting for a PRACK. */
+    private waitingForPrackPromise;
+    /** Function to resolve when PRACK arrives. */
+    private waitingForPrackResolve;
+    /** Function to reject when PRACK never arrives. */
+    private waitingForPrackReject;
+    /** @internal */
+    constructor(userAgent: UserAgent, incomingInviteRequest: IncomingInviteRequest);
+    /**
+     * Destructor.
+     */
+    dispose(): Promise<void>;
+    /**
+     * If true, a first provisional response after the 100 Trying
+     * will be sent automatically. This is false it the UAC required
+     * reliable provisional responses (100rel in Require header) or
+     * the user agent configuration has specified to not send an
+     * initial response, otherwise it is true. The provisional is sent by
+     * calling `progress()` without any options.
+     */
+    get autoSendAnInitialProvisionalResponse(): boolean;
+    /**
+     * Initial incoming INVITE request message body.
+     */
+    get body(): string | undefined;
+    /**
+     * The identity of the local user.
+     */
+    get localIdentity(): NameAddrHeader;
+    /**
+     * The identity of the remote user.
+     */
+    get remoteIdentity(): NameAddrHeader;
+    /**
+     * Initial incoming INVITE request message.
+     */
+    get request(): IncomingRequestMessage;
+    /**
+     * Accept the invitation.
+     *
+     * @remarks
+     * Accept the incoming INVITE request to start a Session.
+     * Replies to the INVITE request with a 200 Ok response.
+     * Resolves once the response sent, otherwise rejects.
+     *
+     * This method may reject for a variety of reasons including
+     * the receipt of a CANCEL request before `accept` is able
+     * to construct a response.
+     * @param options - Options bucket.
+     */
+    accept(options?: InvitationAcceptOptions): Promise<void>;
+    /**
+     * Indicate progress processing the invitation.
+     *
+     * @remarks
+     * Report progress to the the caller.
+     * Replies to the INVITE request with a 1xx provisional response.
+     * Resolves once the response sent, otherwise rejects.
+     * @param options - Options bucket.
+     */
+    progress(options?: InvitationProgressOptions): Promise<void>;
+    /**
+     * Reject the invitation.
+     *
+     * @remarks
+     * Replies to the INVITE request with a 4xx, 5xx, or 6xx final response.
+     * Resolves once the response sent, otherwise rejects.
+     *
+     * The expectation is that this method is used to reject an INVITE request.
+     * That is indeed the case - a call to `progress` followed by `reject` is
+     * a typical way to "decline" an incoming INVITE request. However it may
+     * also be called after calling `accept` (but only before it completes)
+     * which will reject the call and cause `accept` to reject.
+     * @param options - Options bucket.
+     */
+    reject(options?: InvitationRejectOptions): Promise<void>;
+    /**
+     * Handle CANCEL request.
+     *
+     * @param message - CANCEL message.
+     * @internal
+     */
+    _onCancel(message: IncomingRequestMessage): void;
+    /**
+     * Helper function to handle offer/answer in a PRACK.
+     */
+    private handlePrackOfferAnswer;
+    /**
+     * A handler for errors which occur while attempting to send 1xx and 2xx responses.
+     * In all cases, an attempt is made to reject the request if it is still outstanding.
+     * And while there are a variety of things which can go wrong and we log something here
+     * for all errors, there are a handful of common exceptions we pay some extra attention to.
+     * @param error - The error which occurred.
+     */
+    private handleResponseError;
+    /**
+     * Callback for when ACK for a 2xx response is never received.
+     * @param session - Session the ACK never arrived for.
+     */
+    private onAckTimeout;
+    /**
+     * A version of `accept` which resolves a session when the 200 Ok response is sent.
+     * @param options - Options bucket.
+     */
+    private sendAccept;
+    /**
+     * A version of `progress` which resolves when the provisional response is sent.
+     * @param options - Options bucket.
+     */
+    private sendProgress;
+    /**
+     * A version of `progress` which resolves when the provisional response with sdp is sent.
+     * @param options - Options bucket.
+     */
+    private sendProgressWithSDP;
+    /**
+     * A version of `progress` which resolves when the reliable provisional response is sent.
+     * @param options - Options bucket.
+     */
+    private sendProgressReliable;
+    /**
+     * A version of `progress` which resolves when the reliable provisional response is acknowledged.
+     * @param options - Options bucket.
+     */
+    private sendProgressReliableWaitForPrack;
+    /**
+     * A version of `progress` which resolves when a 100 Trying provisional response is sent.
+     */
+    private sendProgressTrying;
+    /**
+     * When attempting to accept the INVITE, an invitation waits
+     * for any outstanding PRACK to arrive before sending the 200 Ok.
+     * It will be waiting on this Promise to resolve which lets it know
+     * the PRACK has arrived and it may proceed to send the 200 Ok.
+     */
+    private waitForArrivalOfPrack;
+    /**
+     * Here we are resolving the promise which in turn will cause
+     * the accept to proceed (it may still fail for other reasons, but...).
+     */
+    private prackArrived;
+    /**
+     * Here we are rejecting the promise which in turn will cause
+     * the accept to fail and the session to transition to "terminated".
+     */
+    private prackNeverArrived;
+}

package/dist/lib/types/lib/sip.js/api/inviter-cancel-options.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Options for {@link Inviter.cancel}.
+ * @public
+ */
+export interface InviterCancelOptions {
+    extraHeaders?: Array<string>;
+    reasonPhrase?: string;
+    statusCode?: number;
+}

package/dist/lib/types/lib/sip.js/api/inviter-invite-options.d.ts

@@ -0,0 +1,28 @@
+import { OutgoingRequestDelegate, RequestOptions } from "../core";
+import { SessionDescriptionHandlerModifier, SessionDescriptionHandlerOptions } from "./session-description-handler";
+/**
+ * Options for {@link Inviter.invite}.
+ * @public
+ */
+export interface InviterInviteOptions {
+    /**
+     * See `core` API.
+     */
+    requestDelegate?: OutgoingRequestDelegate;
+    /**
+     * See `core` API.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+    /**
+     * Options to pass to SessionDescriptionHandler during the initial INVITE transaction.
+     */
+    sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+    /**
+     * If true, send INVITE without SDP. Default is false.
+     */
+    withoutSdp?: boolean;
+}

package/dist/lib/types/lib/sip.js/api/inviter-options.d.ts

@@ -0,0 +1,43 @@
+import { URI } from "../core";
+import { SessionDescriptionHandlerModifier } from "./session-description-handler";
+import { SessionDescriptionHandlerOptions } from "./session-description-handler";
+import { SessionOptions } from "./session-options";
+/**
+ * Options for {@link Inviter} constructor.
+ * @public
+ */
+export interface InviterOptions extends SessionOptions {
+    /** If true, an anonymous call. */
+    anonymous?: boolean;
+    /**
+     * If true, the first answer to the local offer is immediately utilized for media.
+     * Requires that the INVITE request MUST NOT fork.
+     * Has no effect if `inviteWithoutSdp` is true.
+     * Default is false.
+     */
+    earlyMedia?: boolean;
+    /** Array of extra headers added to the INVITE. */
+    extraHeaders?: Array<string>;
+    /** If true, send INVITE without SDP. Default is false. */
+    inviteWithoutSdp?: boolean;
+    /** @deprecated TODO: provide alternative. */
+    params?: {
+        fromDisplayName?: string;
+        fromTag?: string;
+        fromUri?: string | URI;
+        toDisplayName?: string;
+        toUri?: string | URI;
+    };
+    /** @deprecated TODO: provide alternative. */
+    renderbody?: string;
+    /** @deprecated TODO: provide alternative. */
+    rendertype?: string;
+    /** Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. */
+    sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+    /** Options to pass to SessionDescriptionHandler during the initial INVITE transaction. */
+    sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+    /** Modifiers to pass to SessionDescriptionHandler during re-INVITE transactions. */
+    sessionDescriptionHandlerModifiersReInvite?: Array<SessionDescriptionHandlerModifier>;
+    /** Options to pass to SessionDescriptionHandler during re-INVITE transactions. */
+    sessionDescriptionHandlerOptionsReInvite?: SessionDescriptionHandlerOptions;
+}