ue-softphone-sdk 2.1.9 → 2.2.1

package/dist/api/invitation-reject-options.d.ts

@@ -1,25 +0,0 @@
-/**
- * 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/api/invitation.d.ts

@@ -1,179 +0,0 @@
-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 {
-    incomingInviteRequest: 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/api/inviter-cancel-options.d.ts

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

package/dist/api/inviter-invite-options.d.ts

@@ -1,28 +0,0 @@
-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/api/inviter-options.d.ts

@@ -1,43 +0,0 @@
-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;
-}

package/dist/api/inviter.d.ts

@@ -1,236 +0,0 @@
-import { Logger, NameAddrHeader, OutgoingInviteRequest, OutgoingRequestMessage, URI } from "../core";
-import { InviterCancelOptions } from "./inviter-cancel-options";
-import { InviterInviteOptions } from "./inviter-invite-options";
-import { InviterOptions } from "./inviter-options";
-import { Session } from "./session";
-import { BodyAndContentType } from "./session-description-handler";
-import { UserAgent } from "./user-agent";
-/**
- * An inviter offers to establish a {@link Session} (outgoing INVITE).
- * @public
- */
-export declare class Inviter extends Session {
-    /**
-     * If this Inviter was created as a result of a REFER, the referred Session. Otherwise undefined.
-     * @internal
-     */
-    _referred: Session | undefined;
-    /**
-     * Logger.
-     */
-    protected logger: Logger;
-    /** @internal */
-    protected _id: string;
-    /** True if dispose() has been called. */
-    private disposed;
-    /** True if early media use is enabled. */
-    private earlyMedia;
-    /** The early media session. */
-    private earlyMediaDialog;
-    /** The early media session description handlers. */
-    private earlyMediaSessionDescriptionHandlers;
-    /** Our From tag. */
-    private fromTag;
-    /** True if cancel() was called. */
-    private isCanceled;
-    /** True if initial INVITE without SDP. */
-    private inviteWithoutSdp;
-    /** Initial INVITE request sent by core. Undefined until sent. */
-    private outgoingInviteRequest;
-    /** Initial INVITE message provided to core to send. */
-    private outgoingRequestMessage;
-    /**
-     * Constructs a new instance of the `Inviter` class.
-     * @param userAgent - User agent. See {@link UserAgent} for details.
-     * @param targetURI - Request URI identifying the target of the message.
-     * @param options - Options bucket. See {@link InviterOptions} for details.
-     */
-    constructor(userAgent: UserAgent, targetURI: URI, options?: InviterOptions);
-    /**
-     * Destructor.
-     */
-    dispose(): Promise<void>;
-    /**
-     * Initial outgoing INVITE request message body.
-     */
-    get body(): BodyAndContentType | undefined;
-    /**
-     * The identity of the local user.
-     */
-    get localIdentity(): NameAddrHeader;
-    /**
-     * The identity of the remote user.
-     */
-    get remoteIdentity(): NameAddrHeader;
-    /**
-     * Initial outgoing INVITE request message.
-     */
-    get request(): OutgoingRequestMessage;
-    /**
-     * Cancels the INVITE request.
-     *
-     * @remarks
-     * Sends a CANCEL request.
-     * Resolves once the response sent, otherwise rejects.
-     *
-     * After sending a CANCEL request the expectation is that a 487 final response
-     * will be received for the INVITE. However a 200 final response to the INVITE
-     * may nonetheless arrive (it's a race between the CANCEL reaching the UAS before
-     * the UAS sends a 200) in which case an ACK & BYE will be sent. The net effect
-     * is that this method will terminate the session regardless of the race.
-     * @param options - Options bucket.
-     */
-    cancel(options?: InviterCancelOptions): Promise<void>;
-    /**
-     * Sends the INVITE request.
-     *
-     * @remarks
-     * TLDR...
-     *  1) Only one offer/answer exchange permitted during initial INVITE.
-     *  2) No "early media" if the initial offer is in an INVITE (default behavior).
-     *  3) If "early media" and the initial offer is in an INVITE, no INVITE forking.
-     *
-     * 1) Only one offer/answer exchange permitted during initial INVITE.
-     *
-     * Our implementation replaces the following bullet point...
-     *
-     * o  After having sent or received an answer to the first offer, the
-     *    UAC MAY generate subsequent offers in requests based on rules
-     *    specified for that method, but only if it has received answers
-     *    to any previous offers, and has not sent any offers to which it
-     *    hasn't gotten an answer.
-     * https://tools.ietf.org/html/rfc3261#section-13.2.1
-     *
-     * ...with...
-     *
-     * o  After having sent or received an answer to the first offer, the
-     *    UAC MUST NOT generate subsequent offers in requests based on rules
-     *    specified for that method.
-     *
-     * ...which in combination with this bullet point...
-     *
-     * o  Once the UAS has sent or received an answer to the initial
-     *    offer, it MUST NOT generate subsequent offers in any responses
-     *    to the initial INVITE.  This means that a UAS based on this
-     *    specification alone can never generate subsequent offers until
-     *    completion of the initial transaction.
-     * https://tools.ietf.org/html/rfc3261#section-13.2.1
-     *
-     * ...ensures that EXACTLY ONE offer/answer exchange will occur
-     * during an initial out of dialog INVITE request made by our UAC.
-     *
-     *
-     * 2) No "early media" if the initial offer is in an INVITE (default behavior).
-     *
-     * While our implementation adheres to the following bullet point...
-     *
-     * o  If the initial offer is in an INVITE, the answer MUST be in a
-     *    reliable non-failure message from UAS back to UAC which is
-     *    correlated to that INVITE.  For this specification, that is
-     *    only the final 2xx response to that INVITE.  That same exact
-     *    answer MAY also be placed in any provisional responses sent
-     *    prior to the answer.  The UAC MUST treat the first session
-     *    description it receives as the answer, and MUST ignore any
-     *    session descriptions in subsequent responses to the initial
-     *    INVITE.
-     * https://tools.ietf.org/html/rfc3261#section-13.2.1
-     *
-     * We have made the following implementation decision with regard to early media...
-     *
-     * o  If the initial offer is in the INVITE, the answer from the
-     *    UAS back to the UAC will establish a media session only
-     *    only after the final 2xx response to that INVITE is received.
-     *
-     * The reason for this decision is rooted in a restriction currently
-     * inherent in WebRTC. Specifically, while a SIP INVITE request with an
-     * initial offer may fork resulting in more than one provisional answer,
-     * there is currently no easy/good way to to "fork" an offer generated
-     * by a peer connection. In particular, a WebRTC offer currently may only
-     * be matched with one answer and we have no good way to know which
-     * "provisional answer" is going to be the "final answer". So we have
-     * decided to punt and not create any "early media" sessions in this case.
-     *
-     * The upshot is that if you want "early media", you must not put the
-     * initial offer in the INVITE. Instead, force the UAS to provide the
-     * initial offer by sending an INVITE without an offer. In the WebRTC
-     * case this allows us to create a unique peer connection with a unique
-     * answer for every provisional offer with "early media" on all of them.
-     *
-     *
-     * 3) If "early media" and the initial offer is in an INVITE, no INVITE forking.
-     *
-     * The default behavior may be altered and "early media" utilized if the
-     * initial offer is in the an INVITE by setting the `earlyMedia` options.
-     * However in that case the INVITE request MUST NOT fork. This allows for
-     * "early media" in environments where the forking behavior of the SIP
-     * servers being utilized is configured to disallow forking.
-     */
-    invite(options?: InviterInviteOptions): Promise<OutgoingInviteRequest>;
-    /**
-     * 13.2.1 Creating the Initial INVITE
-     *
-     * Since the initial INVITE represents a request outside of a dialog,
-     * its construction follows the procedures of Section 8.1.1.  Additional
-     * processing is required for the specific case of INVITE.
-     *
-     * An Allow header field (Section 20.5) SHOULD be present in the INVITE.
-     * It indicates what methods can be invoked within a dialog, on the UA
-     * sending the INVITE, for the duration of the dialog.  For example, a
-     * UA capable of receiving INFO requests within a dialog [34] SHOULD
-     * include an Allow header field listing the INFO method.
-     *
-     * A Supported header field (Section 20.37) SHOULD be present in the
-     * INVITE.  It enumerates all the extensions understood by the UAC.
-     *
-     * An Accept (Section 20.1) header field MAY be present in the INVITE.
-     * It indicates which Content-Types are acceptable to the UA, in both
-     * the response received by it, and in any subsequent requests sent to
-     * it within dialogs established by the INVITE.  The Accept header field
-     * is especially useful for indicating support of various session
-     * description formats.
-     *
-     * The UAC MAY add an Expires header field (Section 20.19) to limit the
-     * validity of the invitation.  If the time indicated in the Expires
-     * header field is reached and no final answer for the INVITE has been
-     * received, the UAC core SHOULD generate a CANCEL request for the
-     * INVITE, as per Section 9.
-     *
-     * A UAC MAY also find it useful to add, among others, Subject (Section
-     * 20.36), Organization (Section 20.25) and User-Agent (Section 20.41)
-     * header fields.  They all contain information related to the INVITE.
-     *
-     * The UAC MAY choose to add a message body to the INVITE.  Section
-     * 8.1.1.10 deals with how to construct the header fields -- Content-
-     * Type among others -- needed to describe the message body.
-     *
-     * https://tools.ietf.org/html/rfc3261#section-13.2.1
-     */
-    private sendInvite;
-    private disposeEarlyMedia;
-    private notifyReferer;
-    /**
-     * Handle final response to initial INVITE.
-     * @param inviteResponse - 2xx response.
-     */
-    private onAccept;
-    /**
-     * Handle provisional response to initial INVITE.
-     * @param inviteResponse - 1xx response.
-     */
-    private onProgress;
-    /**
-     * Handle final response to initial INVITE.
-     * @param inviteResponse - 3xx response.
-     */
-    private onRedirect;
-    /**
-     * Handle final response to initial INVITE.
-     * @param inviteResponse - 4xx, 5xx, or 6xx response.
-     */
-    private onReject;
-    /**
-     * Handle final response to initial INVITE.
-     * @param inviteResponse - 100 response.
-     */
-    private onTrying;
-}

package/dist/api/message.d.ts

@@ -1,16 +0,0 @@
-import { IncomingMessageRequest, IncomingRequestMessage, ResponseOptions } from "../core";
-/**
- * A received message (incoming MESSAGE).
- * @public
- */
-export declare class Message {
-    private incomingMessageRequest;
-    /** @internal */
-    constructor(incomingMessageRequest: IncomingMessageRequest);
-    /** 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/api/messager-message-options.d.ts

@@ -1,11 +0,0 @@
-import { OutgoingRequestDelegate, RequestOptions } from "../core";
-/**
- * Options for {@link Messager.message}.
- * @public
- */
-export interface MessagerMessageOptions {
-    /** See `core` API. */
-    requestDelegate?: OutgoingRequestDelegate;
-    /** See `core` API. */
-    requestOptions?: RequestOptions;
-}

package/dist/api/messager-options.d.ts

@@ -1,17 +0,0 @@
-import { URI } from "../core";
-/**
- * Options for {@link Messager} constructor.
- * @public
- */
-export interface MessagerOptions {
-    /** Array of extra headers added to the MESSAGE. */
-    extraHeaders?: Array<string>;
-    /** @deprecated TODO: provide alternative. */
-    params?: {
-        fromDisplayName?: string;
-        fromTag?: string;
-        fromUri?: string | URI;
-        toDisplayName?: string;
-        toUri?: string | URI;
-    };
-}

package/dist/api/messager.d.ts

@@ -1,26 +0,0 @@
-import { URI } from "../core";
-import { MessagerMessageOptions } from "./messager-message-options";
-import { MessagerOptions } from "./messager-options";
-import { UserAgent } from "./user-agent";
-/**
- * A messager sends a {@link Message} (outgoing MESSAGE).
- * @public
- */
-export declare class Messager {
-    private logger;
-    private request;
-    private userAgent;
-    /**
-     * Constructs a new instance of the `Messager` class.
-     * @param userAgent - User agent. See {@link UserAgent} for details.
-     * @param targetURI - Request URI identifying the target of the message.
-     * @param content - Content for the body of the message.
-     * @param contentType - Content type of the body of the message.
-     * @param options - Options bucket. See {@link MessagerOptions} for details.
-     */
-    constructor(userAgent: UserAgent, targetURI: URI, content: string, contentType?: string, options?: MessagerOptions);
-    /**
-     * Send the message.
-     */
-    message(options?: MessagerMessageOptions): Promise<void>;
-}

package/dist/api/notification.d.ts

@@ -1,16 +0,0 @@
-import { IncomingNotifyRequest, IncomingRequestMessage, ResponseOptions } from "../core";
-/**
- * A notification of an event (incoming NOTIFY).
- * @public
- */
-export declare class Notification {
-    private incomingNotifyRequest;
-    /** @internal */
-    constructor(incomingNotifyRequest: IncomingNotifyRequest);
-    /** Incoming NOTIFY request message. */
-    get request(): IncomingRequestMessage;
-    /** Accept the request. */
-    accept(options?: ResponseOptions): Promise<void>;
-    /** Reject the request. */
-    reject(options?: ResponseOptions): Promise<void>;
-}

package/dist/api/notifier.d.ts

@@ -1,8 +0,0 @@
-/**
- * TODO: This is currently just a placeholder.
- * Notifier is the peer of a Subscriber.
- * That is, a Notifier sends NOTIFY requests.
- * @internal
- */
-export declare class Notifier {
-}

package/dist/api/publisher-options.d.ts

@@ -1,33 +0,0 @@
-import { URI } from "../core";
-/**
- * Options for {@link Publisher} constructor.
- * @public
- */
-export interface PublisherOptions {
-    /** @deprecated TODO: provide alternative. */
-    body?: string;
-    /** @deprecated TODO: provide alternative. */
-    contentType?: string;
-    /**
-     * Expire value for the published event.
-     * @defaultValue 3600
-     */
-    expires?: number;
-    /**
-     * Array of extra headers added to the PUBLISH request message.
-     */
-    extraHeaders?: Array<string>;
-    /** @deprecated TODO: provide alternative. */
-    params?: {
-        fromDisplayName?: string;
-        fromTag?: string;
-        fromUri?: URI;
-        toDisplayName?: string;
-        toUri?: URI;
-    };
-    /**
-     * If set true, UA will gracefully unpublish for the event on UA close.
-     * @defaultValue true
-     */
-    unpublishOnClose?: boolean;
-}

package/dist/api/publisher-publish-options.d.ts

@@ -1,6 +0,0 @@
-/**
- * Options for {@link Publisher.publish}.
- * @public
- */
-export interface PublisherPublishOptions {
-}