ue-softphone-sdk-beta 4.0.1 → 4.0.2

package/src/lib/sip.js/core/session/session.ts

@@ -1,158 +0,0 @@
-import {
-  Body,
-  OutgoingByeRequest,
-  OutgoingInfoRequest,
-  OutgoingInviteRequest,
-  OutgoingInviteRequestDelegate,
-  OutgoingMessageRequest,
-  OutgoingNotifyRequest,
-  OutgoingPrackRequest,
-  OutgoingReferRequest,
-  OutgoingRequestDelegate,
-  RequestOptions,
-  URI
-} from "../messages";
-import { SessionDelegate } from "./session-delegate";
-
-/**
- * Session.
- * @remarks
- * https://tools.ietf.org/html/rfc3261#section-13
- * @public
- */
-export interface Session {
-  /** Session delegate. */
-  delegate: SessionDelegate | undefined;
-  /** The session id. Equal to callId + localTag + remoteTag. */
-  readonly id: string;
-  /** Call Id. */
-  readonly callId: string;
-  /** Local Tag. */
-  readonly localTag: string;
-  /** Local URI. */
-  readonly localURI: URI;
-  /** Remote Tag. */
-  readonly remoteTag: string;
-  /** Remote Target. */
-  readonly remoteTarget: URI;
-  /** Remote URI. */
-  readonly remoteURI: URI;
-  /** Session state. */
-  readonly sessionState: SessionState;
-  /** Current state of the offer/answer exchange. */
-  readonly signalingState: SignalingState;
-  /** The current answer if signalingState is stable. Otherwise undefined. */
-  readonly answer: Body | undefined;
-  /** The current offer if signalingState is not initial or closed. Otherwise undefined. */
-  readonly offer: Body | undefined;
-
-  /**
-   * Destroy session.
-   */
-  dispose(): void;
-
-  /**
-   * Send a BYE request.
-   * Terminating a session.
-   * https://tools.ietf.org/html/rfc3261#section-15
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  bye(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingByeRequest;
-
-  /**
-   * Send an INFO request.
-   * Exchange information during a session.
-   * https://tools.ietf.org/html/rfc6086#section-4.2.1
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  info(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingInfoRequest;
-
-  /**
-   * Send re-INVITE request.
-   * Modifying a session.
-   * https://tools.ietf.org/html/rfc3261#section-14.1
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  invite(delegate?: OutgoingInviteRequestDelegate, options?: RequestOptions): OutgoingInviteRequest;
-
-  /**
-   * Send MESSAGE request.
-   * Deliver a message during a session.
-   * https://tools.ietf.org/html/rfc3428#section-4
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  message(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingMessageRequest;
-
-  /**
-   * Send NOTIFY request.
-   * Inform referrer of transfer progress.
-   * The use of this is limited to the implicit creation of subscription by REFER (historical).
-   * Otherwise, notifiers MUST NOT create subscriptions except upon receipt of a SUBSCRIBE request.
-   * https://tools.ietf.org/html/rfc3515#section-3.7
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  notify(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingNotifyRequest;
-
-  /**
-   * Send PRACK request.
-   * Acknowledge a reliable provisional response.
-   * https://tools.ietf.org/html/rfc3262#section-4
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  prack(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingPrackRequest;
-
-  /**
-   * Send REFER request.
-   * Transfer a session.
-   * https://tools.ietf.org/html/rfc3515#section-2.4.1
-   * @param delegate - Request delegate.
-   * @param options - Options bucket.
-   */
-  refer(delegate?: OutgoingRequestDelegate, options?: RequestOptions): OutgoingReferRequest;
-}
-
-/**
- * Session state.
- * @remarks
- * https://tools.ietf.org/html/rfc3261#section-13
- * @public
- */
-export enum SessionState {
-  Initial = "Initial",
-  Early = "Early",
-  AckWait = "AckWait",
-  Confirmed = "Confirmed",
-  Terminated = "Terminated"
-}
-
-/**
- * Offer/Answer state.
- * @remarks
- * ```txt
- *         Offer                Answer             RFC    Ini Est Early
- *  -------------------------------------------------------------------
- *  1. INVITE Req.          2xx INVITE Resp.     RFC 3261  Y   Y    N
- *  2. 2xx INVITE Resp.     ACK Req.             RFC 3261  Y   Y    N
- *  3. INVITE Req.          1xx-rel INVITE Resp. RFC 3262  Y   Y    N
- *  4. 1xx-rel INVITE Resp. PRACK Req.           RFC 3262  Y   Y    N
- *  5. PRACK Req.           200 PRACK Resp.      RFC 3262  N   Y    Y
- *  6. UPDATE Req.          2xx UPDATE Resp.     RFC 3311  N   Y    Y
- *
- *       Table 1: Summary of SIP Usage of the Offer/Answer Model
- * ```
- * https://tools.ietf.org/html/rfc6337#section-2.2
- * @public
- */
-export enum SignalingState {
-  Initial = "Initial", // Initial state
-  HaveLocalOffer = "HaveLocalOffer", // Patterns 1, 3, 5, 6
-  HaveRemoteOffer = "HaveRemoteOffer", // Patterns 2, 4
-  Stable = "Stable",
-  Closed = "Closed"
-}

package/src/lib/sip.js/core/subscription/index.ts

@@ -1,2 +0,0 @@
-export * from "./subscription";
-export * from "./subscription-delegate";

package/src/lib/sip.js/core/subscription/subscription-delegate.ts

@@ -1,30 +0,0 @@
-import { IncomingNotifyRequest, OutgoingSubscribeRequest } from "../messages";
-
-/**
- * Subscription delegate.
- * @public
- */
-export interface SubscriptionDelegate {
-  /**
-   * Receive NOTIFY request. This includes in dialog NOTIFY requests only.
-   * Thus the first NOTIFY (the subscription creating NOTIFY) will not be provided.
-   * https://tools.ietf.org/html/rfc6665#section-4.1.3
-   * @param request - Incoming NOTIFY request.
-   */
-  onNotify?(request: IncomingNotifyRequest): void;
-
-  /**
-   * Sent a SUBSCRIBE request. This includes "auto refresh" in dialog SUBSCRIBE requests only.
-   * Thus SUBSCRIBE requests triggered by calls to `refresh()` or `subscribe()` will not be provided.
-   * Thus the first SUBSCRIBE (the subscription creating SUBSCRIBE) will not be provided.
-   * @param request - Outgoing SUBSCRIBE request.
-   */
-  onRefresh?(request: OutgoingSubscribeRequest): void;
-
-  /**
-   * Subscription termination. This includes non-NOTIFY termination causes only.
-   * Thus this will not be called if a NOTIFY is the cause of termination.
-   * https://tools.ietf.org/html/rfc6665#section-4.4.1
-   */
-  onTerminated?(): void;
-}

package/src/lib/sip.js/core/subscription/subscription.ts

@@ -1,61 +0,0 @@
-import { OutgoingSubscribeRequest, OutgoingSubscribeRequestDelegate, RequestOptions } from "../messages";
-import { SubscriptionDelegate } from "./subscription-delegate";
-
-/**
- * Subscription.
- * @remarks
- * https://tools.ietf.org/html/rfc6665
- * @public
- */
-export interface Subscription {
-  /** Subscription delegate. */
-  delegate: SubscriptionDelegate | undefined;
-  /** The subscription id. */
-  readonly id: string;
-  /** Subscription expires. Number of seconds until the subscription expires. */
-  readonly subscriptionExpires: number;
-  /** Subscription state. */
-  readonly subscriptionState: SubscriptionState;
-  /** If true, refresh subscription prior to expiration. Default is false. */
-  autoRefresh: boolean;
-
-  /**
-   * Destroy subscription.
-   */
-  dispose(): void;
-
-  /**
-   * Send re-SUBSCRIBE request.
-   * Refreshing a subscription and unsubscribing.
-   * https://tools.ietf.org/html/rfc6665#section-4.1.2.2
-   * @param delegate - Request delegate.
-   * @param options - Options bucket
-   */
-  subscribe(delegate?: OutgoingSubscribeRequestDelegate, options?: RequestOptions): OutgoingSubscribeRequest;
-
-  /**
-   * 4.1.2.2.  Refreshing of Subscriptions
-   * https://tools.ietf.org/html/rfc6665#section-4.1.2.2
-   */
-  refresh(): OutgoingSubscribeRequest;
-
-  /**
-   * 4.1.2.3.  Unsubscribing
-   * https://tools.ietf.org/html/rfc6665#section-4.1.2.3
-   */
-  unsubscribe(): OutgoingSubscribeRequest;
-}
-
-/**
- * Subscription state.
- * @remarks
- * https://tools.ietf.org/html/rfc6665#section-4.1.2
- * @public
- */
-export enum SubscriptionState {
-  Initial = "Initial",
-  NotifyWait = "NotifyWait",
-  Pending = "Pending",
-  Active = "Active",
-  Terminated = "Terminated"
-}

package/src/lib/sip.js/core/timers.ts

@@ -1,24 +0,0 @@
-const T1 = 500
-const T2 = 4000
-const T4 = 5000
-
-/**
- * Timers.
- * @public
- */
-export const Timers = {
-  T1,
-  T2,
-  T4,
-  TIMER_B: 64 * T1,
-  TIMER_D: 0 * T1, // Not correct for unreliable transports
-  TIMER_F: 6 * T1,
-  TIMER_H: 64 * T1,
-  TIMER_I: 0 * T4, // Not correct for unreliable transports
-  TIMER_J: 0 * T1, // Not correct for unreliable transports
-  TIMER_K: 0 * T4, // Not correct for unreliable transports
-  TIMER_L: 64 * T1,
-  TIMER_M: 64 * T1,
-  TIMER_N: 64 * T1,
-  PROVISIONAL_RESPONSE_INTERVAL: 60000 // See RFC 3261 Section 13.3.1.1
-}

package/src/lib/sip.js/core/transactions/client-transaction.ts

@@ -1,78 +0,0 @@
-import { IncomingResponseMessage, OutgoingRequestMessage } from "../messages";
-import { Transport } from "../transport";
-import { Transaction } from "./transaction";
-import { TransactionState } from "./transaction-state";
-import { ClientTransactionUser } from "./transaction-user";
-
-/**
- * Client Transaction.
- * @remarks
- * The client transaction provides its functionality through the
- * maintenance of a state machine.
- *
- * The TU communicates with the client transaction through a simple
- * interface.  When the TU wishes to initiate a new transaction, it
- * creates a client transaction and passes it the SIP request to send
- * and an IP address, port, and transport to which to send it.  The
- * client transaction begins execution of its state machine.  Valid
- * responses are passed up to the TU from the client transaction.
- * https://tools.ietf.org/html/rfc3261#section-17.1
- * @public
- */
-export abstract class ClientTransaction extends Transaction {
-  protected constructor(
-    private _request: OutgoingRequestMessage,
-    transport: Transport,
-    protected user: ClientTransactionUser,
-    state: TransactionState,
-    loggerCategory: string
-  ) {
-    super(transport, user, ClientTransaction.makeId(_request), state, loggerCategory);
-    // The Via header field indicates the transport used for the transaction
-    // and identifies the location where the response is to be sent.  A Via
-    // header field value is added only after the transport that will be
-    // used to reach the next hop has been selected (which may involve the
-    // usage of the procedures in [4]).
-    // https://tools.ietf.org/html/rfc3261#section-8.1.1.7
-    _request.setViaHeader(this.id, transport.protocol);
-  }
-
-  private static makeId(request: OutgoingRequestMessage): string {
-    if (request.method === "CANCEL") {
-      if (!request.branch) {
-        throw new Error("Outgoing CANCEL request without a branch.");
-      }
-      return request.branch;
-    } else {
-      return "z9hG4bK" + Math.floor(Math.random() * 10000000);
-    }
-  }
-
-  /** The outgoing request the transaction handling. */
-  get request(): OutgoingRequestMessage {
-    return this._request;
-  }
-
-  /**
-   * A 408 to non-INVITE will always arrive too late to be useful ([3]),
-   * The client already has full knowledge of the timeout. The only
-   * information this message would convey is whether or not the server
-   * believed the transaction timed out. However, with the current design
-   * of the NIT, a client cannot do anything with this knowledge. Thus,
-   * the 408 is simply wasting network resources and contributes to the
-   * response bombardment illustrated in [3].
-   * https://tools.ietf.org/html/rfc4320#section-4.1
-   */
-  protected onRequestTimeout(): void {
-    if (this.user.onRequestTimeout) {
-      this.user.onRequestTimeout();
-    }
-  }
-
-  /**
-   * Receive incoming responses from the transport which match this transaction.
-   * Responses will be delivered to the transaction user as necessary.
-   * @param response - The incoming response.
-   */
-  public abstract receiveResponse(response: IncomingResponseMessage): void;
-}

package/src/lib/sip.js/core/transactions/index.ts

@@ -1,10 +0,0 @@
-export * from "./client-transaction";
-export * from "./invite-client-transaction";
-export * from "./invite-server-transaction";
-export * from "./non-invite-client-transaction";
-export * from "./non-invite-server-transaction";
-export * from "./invite-client-transaction";
-export * from "./server-transaction";
-export * from "./transaction-state";
-export * from "./transaction-user";
-export * from "./transaction";