ue-softphone-sdk 2.2.4 → 2.2.6

package/dist/api/transport-state.d.ts

@@ -1,37 +0,0 @@
-/**
- * {@link Transport} state.
- *
- * @remarks
- * The {@link Transport} behaves in a deterministic manner according to the following
- * Finite State Machine (FSM).
- * ```txt
- *                    ______________________________
- *                   |    ____________              |
- * Transport         v   v            |             |
- * Constructed -> Disconnected -> Connecting -> Connected -> Disconnecting
- *                     ^            ^    |_____________________^  |  |
- *                     |            |_____________________________|  |
- *                     |_____________________________________________|
- * ```
- * @public
- */
-export declare enum TransportState {
-    /**
-     * The `connect()` method was called.
-     */
-    Connecting = "Connecting",
-    /**
-     * The `connect()` method resolved.
-     */
-    Connected = "Connected",
-    /**
-     * The `disconnect()` method was called.
-     */
-    Disconnecting = "Disconnecting",
-    /**
-     * The `connect()` method was rejected, or
-     * the `disconnect()` method completed, or
-     * network connectivity was lost.
-     */
-    Disconnected = "Disconnected"
-}

package/dist/api/transport.d.ts

@@ -1,159 +0,0 @@
-import { Transport as CoreTransport } from "../core";
-import { Emitter } from "./emitter";
-import { TransportState } from "./transport-state";
-/**
- * Transport layer interface expected by the `UserAgent`.
- *
- * @remarks
- * The transport behaves in a deterministic manner according to the
- * the state defined in {@link TransportState}.
- *
- * The "Connecting" state is ONLY entered in response to the user calling `connect()`.
- * The "Disconnecting" state is ONLY entered in response to the user calling `disconnect()`.
- * The `onConnect` callback is ALWAYS called upon transitioning to the "Connected" state.
- * The `onDisconnect` callback is ALWAYS called upon transitioning from the "Connected" state.
- *
- * Adherence to the state machine by the transport implementation is critical as the
- * UserAgent depends on this behavior. Furthermore it is critical that the transport
- * transition to the "Disconnected" state in all instances where network connectivity
- * is lost as the UserAgent, API, and application layer more generally depend on knowing
- * network was lost. For example, from a practical standpoint registrations and subscriptions are invalidated
- * when network is lost - particularly in the case of connection oriented transport
- * protocols such as a secure WebSocket transport.
- *
- * Proper handling the application level protocol recovery must be left to the application layer,
- * thus the transport MUST NOT attempt to "auto-recover" from or otherwise hide loss of network.
- * Note that callbacks and emitters such as `onConnect`  and `onDisconnect` MUST NOT call methods
- * `connect()` and `direct()` synchronously (state change handlers must not loop back). They may
- * however do so asynchronously using a Promise resolution, `setTimeout`, or some other method.
- * For example...
- * ```ts
- * transport.onDisconnect = () => {
- *   Promise.resolve().then(() => transport.connect());
- * }
- * ```
- * @public
- */
-export interface Transport extends CoreTransport {
-    /**
-     * Transport state.
-     *
-     * @remarks
-     * The initial Transport state MUST be "disconnected" (after calling constructor).
-     */
-    readonly state: TransportState;
-    /**
-     * Transport state change emitter.
-     */
-    readonly stateChange: Emitter<TransportState>;
-    /**
-     * Callback on state transition to "Connected".
-     *
-     * @remarks
-     * When the `UserAgent` is constructed, this property is set.
-     * ```txt
-     * - The `state` MUST be "Connected" when called.
-     * ```
-     */
-    onConnect: (() => void) | undefined;
-    /**
-     * Callback on state transition from "Connected".
-     *
-     * @remarks
-     * When the `UserAgent` is constructed, this property is set.
-     * ```txt
-     * - The `state` MUST NOT "Connected" when called.
-     * - If prior `state` is "Connecting" or "Connected", `error` MUST be defined.
-     * - If prior `state` is "Disconnecting", `error` MUST NOT be undefined.
-     * ```
-     * If the transition from "Connected" occurs because the transport
-     * user requested it by calling `disconnect`, then `error` will be undefined.
-     * Otherwise `error` will be defined to provide an indication that the
-     * transport initiated the transition from "Connected" - for example,
-     * perhaps network connectivity was lost.
-     */
-    onDisconnect: ((error?: Error) => void) | undefined;
-    /**
-     * Callback on receipt of a message.
-     *
-     * @remarks
-     * When the `UserAgent` is constructed, this property is set.
-     * The `state` MUST be "Connected" when this is called.
-     */
-    onMessage: ((message: string) => void) | undefined;
-    /**
-     * Connect to network.
-     *
-     * @remarks
-     * ```txt
-     * - If `state` is "Connecting", `state` MUST NOT transition before returning.
-     * - If `state` is "Connected", `state` MUST NOT transition before returning.
-     * - If `state` is "Disconnecting", `state` MUST transition to "Connecting" before returning.
-     * - If `state` is "Disconnected" `state` MUST transition to "Connecting" before returning.
-     * - The `state` MUST transition to "Connected" before resolving (assuming `state` is not already "Connected").
-     * - The `state` MUST transition to "Disconnecting" or "Disconnected" before rejecting and MUST reject with an Error.
-     * ```
-     * Resolves when the transport connects. Rejects if transport fails to connect.
-     * Rejects with {@link StateTransitionError} if a loop is detected.
-     * In particular, callbacks and emitters MUST NOT call this method synchronously.
-     */
-    connect(): Promise<void>;
-    /**
-     * Disconnect from network.
-     *
-     * @remarks
-     * ```txt
-     * - If `state` is "Connecting", `state` MUST transition to "Disconnecting" before returning.
-     * - If `state` is "Connected", `state` MUST transition to "Disconnecting" before returning.
-     * - If `state` is "Disconnecting", `state` MUST NOT transition before returning.
-     * - If `state` is "Disconnected", `state` MUST NOT transition before returning.
-     * - The `state` MUST transition to "Disconnected" before resolving (assuming `state` is not already "Disconnected").
-     * - The `state` MUST transition to "Connecting" or "Connected" before rejecting and MUST reject with an Error.
-     * ```
-     * Resolves when the transport disconnects. Rejects if transport fails to disconnect.
-     * Rejects with {@link StateTransitionError} if a loop is detected.
-     * In particular, callbacks and emitters MUST NOT call this method synchronously.
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Dispose.
-     *
-     * @remarks
-     * When the `UserAgent` is disposed or stopped, this method is called.
-     * The `UserAgent` MUST NOT continue to utilize the instance after calling this method.
-     */
-    dispose(): Promise<void>;
-    /**
-     * Returns true if the `state` equals "Connected".
-     *
-     * @remarks
-     * This is equivalent to `state === TransportState.Connected`.
-     * It is convenient. A common paradigm is, for example...
-     *
-     * @example
-     * ```ts
-     * // Monitor transport connectivity
-     * userAgent.transport.stateChange.addListener(() => {
-     *   if (userAgent.transport.isConnected()) {
-     *     // handle transport connect
-     *   } else {
-     *     // handle transport disconnect
-     *   }
-     * });
-     * ```
-     */
-    isConnected(): boolean;
-    /**
-     * Send a message.
-     *
-     * @remarks
-     * ```txt
-     * - If `state` is "Connecting", rejects with an Error.
-     * - If `state` is "Connected", resolves when the message is sent otherwise rejects with an Error.
-     * - If `state` is "Disconnecting", rejects with an Error.
-     * - If `state` is "Disconnected", rejects with an Error.
-     * ```
-     * @param message - Message to send.
-     */
-    send(message: string): Promise<void>;
-}

package/dist/api/user-agent-delegate.d.ts

@@ -1,84 +0,0 @@
-import { IncomingReferRequest, IncomingRegisterRequest, IncomingSubscribeRequest } from "../core";
-import { Invitation } from "./invitation";
-import { Message } from "./message";
-import { Notification } from "./notification";
-import { Referral } from "./referral";
-import { Subscription } from "./subscription";
-/**
- * Delegate for {@link UserAgent}.
- * @public
- */
-export interface UserAgentDelegate {
-    /**
-     * Called upon transport transitioning to connected state.
-     */
-    onConnect?(): void;
-    /**
-     * Called upon transport transitioning from connected state.
-     * @param error - An error if disconnect triggered by transport. Otherwise undefined.
-     */
-    onDisconnect?(error?: Error): void;
-    /**
-     * Called upon receipt of an invitation.
-     * @remarks
-     * Handler for incoming out of dialog INVITE requests.
-     * @param invitation - The invitation.
-     */
-    onInvite?(invitation: Invitation): void;
-    /**
-     * Called upon receipt of a message.
-     * @remarks
-     * Handler for incoming out of dialog MESSAGE requests.
-     * @param message - The message.
-     */
-    onMessage?(message: Message): void;
-    /**
-     * Called upon receipt of a notification.
-     * @remarks
-     * Handler for incoming out of dialog NOTIFY requests.
-     * @param notification - The notification.
-     */
-    onNotify?(notification: Notification): void;
-    /**
-     * @alpha
-     * Called upon receipt of a referral.
-     * @remarks
-     * Handler for incoming out of dialog REFER requests.
-     * @param referral - The referral.
-     */
-    onRefer?(referral: Referral): void;
-    /**
-     * @alpha
-     * Called upon receipt of a registration.
-     * @remarks
-     * Handler for incoming out of dialog REGISTER requests.
-     * @param registration - The registration.
-     */
-    onRegister?(registration: unknown): void;
-    /**
-     * @alpha
-     * Called upon receipt of a subscription.
-     * @remarks
-     * Handler for incoming out of dialog SUBSCRIBE requests.
-     * @param subscription - The subscription.
-     */
-    onSubscribe?(subscription: Subscription): void;
-    /**
-     * @internal
-     * Called upon receipt of an out of dialog REFER. Used by test suite.
-     * @param request - The request.
-     */
-    onReferRequest?(request: IncomingReferRequest): void;
-    /**
-     * @internal
-     * Called upon receipt of a REGISTER request. Used by test suite.
-     * @param request - The request.
-     */
-    onRegisterRequest?(request: IncomingRegisterRequest): void;
-    /**
-     * @internal
-     * Called upon receipt of an out of dialog SUBSCRIBE request. Used by test suite.
-     * @param request - The request.
-     */
-    onSubscribeRequest?(request: IncomingSubscribeRequest): void;
-}

package/dist/api/user-agent-options.d.ts

@@ -1,253 +0,0 @@
-import { Logger, URI } from "../core";
-import { SessionDescriptionHandlerFactory } from "./session-description-handler-factory";
-import { Transport } from "./transport";
-import { UserAgentDelegate } from "./user-agent-delegate";
-/**
- * Log level.
- * @public
- */
-export type LogLevel = "debug" | "log" | "warn" | "error";
-/**
- * Log connector function.
- * @public
- */
-export type LogConnector = (level: LogLevel, category: string, label: string | undefined, content: string) => void;
-/**
- * SIP extension support level.
- * @public
- */
-export declare enum SIPExtension {
-    Required = "Required",
-    Supported = "Supported",
-    Unsupported = "Unsupported"
-}
-/**
- * Options for {@link UserAgent} constructor.
- * @public
- */
-export interface UserAgentOptions {
-    /**
-     * If `true`, the user agent will accept out of dialog NOTIFY.
-     * @remarks
-     * RFC 6665 obsoletes the use of out of dialog NOTIFY from RFC 3265.
-     * @defaultValue `false`
-     */
-    allowLegacyNotifications?: boolean;
-    /**
-     * Authorization ha1.
-     * @defaultValue `""`
-     */
-    authorizationHa1?: string;
-    /**
-     * Authorization password.
-     * @defaultValue `""`
-     */
-    authorizationPassword?: string;
-    /**
-     * Authorization username.
-     * @defaultValue `""`
-     */
-    authorizationUsername?: string;
-    /**
-     * @deprecated
-     * If `true`, the user agent calls the `start()` method in the constructor.
-     * @defaultValue `false`
-     * @remarks
-     * The call to start() resolves when the user agent connects, so if this
-     * option is set to `true` an alternative method of connection detection
-     * must be used.
-     */
-    autoStart?: boolean;
-    /**
-     * If `true`, the user agent calls the `stop()` method on unload (if running in browser window).
-     * @defaultValue `true`
-     */
-    autoStop?: boolean;
-    /**
-     * The user portion of user agent's contact URI.
-     * @remarks
-     * If not specifed a random string will be generated and utilized as the user portion of the contact URI.
-     * @defaultValue `""`
-     */
-    contactName?: string;
-    /**
-     * The URI parameters of the user agent's contact URI.
-     * @defaultValue `{ transport: "ws" }`
-     */
-    contactParams?: {
-        [name: string]: string;
-    };
-    /**
-     * Delegate for {@link UserAgent}.
-     * @defaultValue `{}`
-     */
-    delegate?: UserAgentDelegate;
-    /**
-     * The display name associated with the user agent.
-     * @remarks
-     * Descriptive name to be shown to the called party when calling or sending IM messages
-     * (the display name portion of the From header).
-     * It must NOT be enclosed between double quotes even if the given name contains multi-byte symbols
-     * (SIPjs will always enclose the `displayName` value between double quotes).
-     * @defaultValue `""`
-     */
-    displayName?: string;
-    /**
-     * Force adding rport to Via header.
-     * @defaultValue `false`
-     */
-    forceRport?: boolean;
-    /**
-     * Hack
-     * @deprecated TBD
-     */
-    hackIpInContact?: boolean | string;
-    /**
-     * Hack
-     * @deprecated TBD
-     */
-    hackAllowUnregisteredOptionTags?: boolean;
-    /**
-     * Hack
-     * @deprecated TBD
-     */
-    hackViaTcp?: boolean;
-    /**
-     * Indicates whether log messages should be written to the browser console.
-     * @defaultValue `true`
-     */
-    logBuiltinEnabled?: boolean;
-    /**
-     * If true, constructor logs the user agent configuration.
-     * @defaultValue `true`
-     */
-    logConfiguration?: boolean;
-    /**
-     * A function which will be called every time a log is generated.
-     * @defaultValue A noop
-     */
-    logConnector?: LogConnector;
-    /**
-     * Indicates the verbosity level of the log messages.
-     * @defaultValue `"log"`
-     */
-    logLevel?: LogLevel;
-    /**
-     * Number of seconds after which an incoming call is rejected if not answered.
-     * @defaultValue 60
-     */
-    noAnswerTimeout?: number;
-    /**
-     * Adds a Route header(s) to outgoing requests.
-     * @defaultValue `[]`
-     */
-    preloadedRouteSet?: Array<string>;
-    /**
-     * @deprecated
-     * Maximum number of times to attempt to reconnect when the transport connection drops.
-     * @defaultValue 0
-     */
-    reconnectionAttempts?: number;
-    /**
-     * @deprecated
-     * Seconds to wait between reconnection attempts when the transport connection drops.
-     * @defaultValue 4
-     */
-    reconnectionDelay?: number;
-    /**
-     * If true, a first provisional response after the 100 Trying will be sent automatically if UAC does not
-     * require reliable provisional responses.
-     * @defaultValue `true`
-     */
-    sendInitialProvisionalResponse?: boolean;
-    /**
-     * A factory for generating `SessionDescriptionHandler` instances.
-     * @remarks
-     * The factory will be passed a `Session` object for the current session
-     * and the `sessionDescriptionHandlerFactoryOptions` object.
-     * @defaultValue `Web.SessionDescriptionHandler.defaultFactory`
-     */
-    sessionDescriptionHandlerFactory?: SessionDescriptionHandlerFactory;
-    /**
-     * Options to passed to `sessionDescriptionHandlerFactory`.
-     * @remarks
-     * See `Web.SessionDescriptionHandlerOptions` for details.
-     * @defaultValue `{}`
-     */
-    sessionDescriptionHandlerFactoryOptions?: object;
-    /**
-     * Reliable provisional responses.
-     * https://tools.ietf.org/html/rfc3262
-     * @defaultValue `SIPExtension.Unsupported`
-     */
-    sipExtension100rel?: SIPExtension;
-    /**
-     * Replaces header.
-     * https://tools.ietf.org/html/rfc3891
-     * @defaultValue `SIPExtension.Unsupported`
-     */
-    sipExtensionReplaces?: SIPExtension;
-    /**
-     * Extra option tags to claim support for.
-     * @remarks
-     * Setting an extra option tag does not enable support for the associated extension
-     * it simply adds the tag to the list of supported options.
-     * See {@link UserAgentRegisteredOptionTags} for valid option tags.
-     * @defaultValue `[]`
-     */
-    sipExtensionExtraSupported?: Array<string>;
-    /**
-     * An id uniquely identify this user agent instance.
-     * @defaultValue
-     * A random id generated by default.
-     */
-    sipjsId?: string;
-    /**
-     * A constructor function for the user agent's `Transport`.
-     * @remarks
-     * For more information about creating your own transport see `Transport`.
-     * @defaultValue `WebSocketTransport`
-     */
-    transportConstructor?: new (logger: Logger, options: any) => Transport;
-    /**
-     * An options bucket object passed to `transportConstructor` when instantiated.
-     * @remarks
-     * See WebSocket Transport Configuration Parameters for the full list of options for the default transport.
-     * @defaultValue `{}`
-     */
-    transportOptions?: unknown;
-    /**
-     * SIP Addresses-of-Record URI associated with the user agent.
-     * @remarks
-     * This is a SIP address given to you by your provider.
-     * If the user agent registers, it is the address-of-record which the user agent registers a contact for.
-     * An address-of-record represents an identity of the user, generally a long-term identity,
-     * and it does not have a dependency on any device; users can move between devices or even
-     * be associated with multiple devices at one time while retaining the same address-of-record.
-     * A simple URI, generally of the form `sip:egdar@example.com`, is used for an address-of-record.
-     * @defaultValue
-     * By default, URI is set to `sip:anonymous.X@anonymous.invalid`, where X is a random token generated for each UA.
-     */
-    uri?: URI;
-    /**
-     * User agent string used in the UserAgent header.
-     * @defaultValue
-     * A reasonable value is utilized.
-     */
-    userAgentString?: string;
-    /**
-     * Hostname to use in Via header.
-     * @defaultValue
-     * A random hostname in the .invalid domain.
-     */
-    viaHost?: any;
-}
-/**
- * SIP Option Tags
- * @remarks
- * http://www.iana.org/assignments/sip-parameters/sip-parameters.xhtml#sip-parameters-4
- * @public
- */
-export declare const UserAgentRegisteredOptionTags: {
-    [option: string]: boolean;
-};

package/dist/api/user-agent-state.d.ts

@@ -1,14 +0,0 @@
-/**
- * {@link UserAgent} state.
- * @remarks
- * Valid state transitions:
- * ```
- * 1. "Started" --> "Stopped"
- * 2. "Stopped" --> "Started"
- * ```
- * @public
- */
-export declare enum UserAgentState {
-    Started = "Started",
-    Stopped = "Stopped"
-}