ue-softphone-sdk 2.2.4 → 2.2.6

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 {
-}

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

@@ -1,21 +0,0 @@
-/**
- * {@link Publisher} state.
- * @remarks
- * The {@link Publisher} behaves in a deterministic manner according to the following
- * Finite State Machine (FSM).
- * ```txt
- *                  __________________________________________
- *                 |  __________________________              |
- * Publisher       | |                          v             v
- * Constructed -> Initial -> Published -> Unpublished -> Terminated
- *                              |   ^____________|             ^
- *                              |______________________________|
- * ```
- * @public
- */
-export declare enum PublisherState {
-    Initial = "Initial",
-    Published = "Published",
-    Unpublished = "Unpublished",
-    Terminated = "Terminated"
-}

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

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

package/dist/api/publisher.d.ts

@@ -1,65 +0,0 @@
-import { IncomingResponseMessage, OutgoingPublishRequest, URI } from "../core";
-import { Emitter } from "./emitter";
-import { PublisherOptions } from "./publisher-options";
-import { PublisherPublishOptions } from "./publisher-publish-options";
-import { PublisherState } from "./publisher-state";
-import { PublisherUnpublishOptions } from "./publisher-unpublish-options";
-import { UserAgent } from "./user-agent";
-/**
- * A publisher publishes a publication (outgoing PUBLISH).
- * @public
- */
-export declare class Publisher {
-    private event;
-    private options;
-    private target;
-    private pubRequestBody;
-    private pubRequestExpires;
-    private pubRequestEtag;
-    private publishRefreshTimer;
-    private disposed;
-    private id;
-    private logger;
-    private request;
-    private userAgent;
-    /** The publication state. */
-    private _state;
-    /** Emits when the registration state changes. */
-    private _stateEventEmitter;
-    /**
-     * Constructs a new instance of the `Publisher` class.
-     *
-     * @param userAgent - User agent. See {@link UserAgent} for details.
-     * @param targetURI - Request URI identifying the target of the message.
-     * @param eventType - The event type identifying the published document.
-     * @param options - Options bucket. See {@link PublisherOptions} for details.
-     */
-    constructor(userAgent: UserAgent, targetURI: URI, eventType: string, options?: PublisherOptions);
-    /**
-     * Destructor.
-     */
-    dispose(): Promise<void>;
-    /** The publication state. */
-    get state(): PublisherState;
-    /** Emits when the publisher state changes. */
-    get stateChange(): Emitter<PublisherState>;
-    /**
-     * Publish.
-     * @param content - Body to publish
-     */
-    publish(content: string, options?: PublisherPublishOptions): Promise<void>;
-    /**
-     * Unpublish.
-     */
-    unpublish(options?: PublisherUnpublishOptions): Promise<void>;
-    /** @internal */
-    protected receiveResponse(response: IncomingResponseMessage): void;
-    /** @internal */
-    protected send(): OutgoingPublishRequest;
-    private refreshRequest;
-    private sendPublishRequest;
-    /**
-     * Transition publication state.
-     */
-    private stateTransition;
-}

package/dist/api/referral.d.ts

@@ -1,38 +0,0 @@
-import { IncomingReferRequest, IncomingRequestMessage, NameAddrHeader, ResponseOptions } from "../core";
-import { Inviter } from "./inviter";
-import { InviterOptions } from "./inviter-options";
-import { Session } from "./session";
-/**
- * A request to establish a {@link Session} elsewhere (incoming REFER).
- * @public
- */
-export declare class Referral {
-    private incomingReferRequest;
-    private session;
-    private inviter;
-    /** @internal */
-    constructor(incomingReferRequest: IncomingReferRequest, session: Session);
-    get referTo(): NameAddrHeader;
-    get referredBy(): string | undefined;
-    get replaces(): string | undefined;
-    /** Incoming REFER request message. */
-    get request(): IncomingRequestMessage;
-    /** Accept the request. */
-    accept(options?: ResponseOptions): Promise<void>;
-    /** Reject the request. */
-    reject(options?: ResponseOptions): Promise<void>;
-    /**
-     * Creates an inviter which may be used to send an out of dialog INVITE request.
-     *
-     * @remarks
-     * This a helper method to create an Inviter which will execute the referral
-     * of the `Session` which was referred. The appropriate headers are set and
-     * the referred `Session` is linked to the new `Session`. Note that only a
-     * single instance of the `Inviter` will be created and returned (if called
-     * more than once a reference to the same `Inviter` will be returned every time).
-     *
-     * @param options - Options bucket.
-     * @param modifiers - Session description handler modifiers.
-     */
-    makeInviter(options?: InviterOptions): Inviter;
-}

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

@@ -1,46 +0,0 @@
-import { URI } from "../core";
-/**
- * Options for {@link Registerer} constructor.
- * @public
- */
-export interface RegistererOptions {
-    /** Registration expiration time in seconds. */
-    expires?: number;
-    /** Array of extra Contact header parameters. */
-    extraContactHeaderParams?: Array<string>;
-    /** Array of extra headers added to the REGISTER. */
-    extraHeaders?: Array<string>;
-    /**
-     * UUID to provide with "+sip.instance" Contact parameter.
-     * @defaultValue a randomly generated uuid
-     */
-    instanceId?: string;
-    /**
-     * If true, constructor logs the registerer configuration.
-     * @defaultValue `true`
-     */
-    logConfiguration?: boolean;
-    /** @deprecated TODO: provide alternative. */
-    params?: {
-        fromDisplayName?: string;
-        fromTag?: string;
-        fromUri?: URI;
-        toDisplayName?: string;
-        toUri?: URI;
-    };
-    /**
-     * Value to provide with "reg-id" Contact parameter.
-     * @defaultValue 1
-     */
-    regId?: number;
-    /**
-     * The URI of the registrar to send the REGISTER requests.
-     * @defaultValue domain portion of the user agent's uri
-     */
-    registrar?: URI;
-    /**
-     * Determines when a re-REGISTER request is sent. The value should be specified as a percentage of the expiration time (between 50 and 99).
-     * @defaultValue 99
-     */
-    refreshFrequency?: number;
-}

package/dist/api/registerer-register-options.d.ts

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

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

@@ -1,21 +0,0 @@
-/**
- * {@link Registerer} state.
- * @remarks
- * The {@link Registerer} behaves in a deterministic manner according to the following
- * Finite State Machine (FSM).
- * ```txt
- *                   __________________________________________
- *                  |  __________________________              |
- * Registerer       | |                          v             v
- * Constructed -> Initial -> Registered -> Unregistered -> Terminated
- *                              |   ^____________|             ^
- *                              |______________________________|
- * ```
- * @public
- */
-export declare enum RegistererState {
-    Initial = "Initial",
-    Registered = "Registered",
-    Unregistered = "Unregistered",
-    Terminated = "Terminated"
-}

package/dist/api/registerer-unregister-options.d.ts

@@ -1,16 +0,0 @@
-import { OutgoingRequestDelegate, RequestOptions } from "../core";
-/**
- * Options for {@link Registerer.unregister}.
- * @public
- */
-export interface RegistererUnregisterOptions {
-    /**
-     * If true, unregister all contacts.
-     * @defaultValue false
-     */
-    all?: boolean;
-    /** See `core` API. */
-    requestDelegate?: OutgoingRequestDelegate;
-    /** See `core` API. */
-    requestOptions?: RequestOptions;
-}

package/dist/api/registerer.d.ts

@@ -1,144 +0,0 @@
-import { OutgoingRegisterRequest } from "../core";
-import { Emitter } from "./emitter";
-import { RegistererOptions } from "./registerer-options";
-import { RegistererRegisterOptions } from "./registerer-register-options";
-import { RegistererState } from "./registerer-state";
-import { RegistererUnregisterOptions } from "./registerer-unregister-options";
-import { UserAgent } from "./user-agent";
-/**
- * A registerer registers a contact for an address of record (outgoing REGISTER).
- * @public
- */
-export declare class Registerer {
-    private static readonly defaultExpires;
-    private static readonly defaultRefreshFrequency;
-    private disposed;
-    private id;
-    private expires;
-    private refreshFrequency;
-    private logger;
-    private options;
-    private request;
-    private userAgent;
-    private registrationExpiredTimer;
-    private registrationTimer;
-    /** The contacts returned from the most recent accepted REGISTER request. */
-    private _contacts;
-    /** The number of seconds to wait before retrying to register. */
-    private _retryAfter;
-    /** The registration state. */
-    private _state;
-    /** Emits when the registration state changes. */
-    private _stateEventEmitter;
-    /** True is waiting for final response to outstanding REGISTER request. */
-    private _waiting;
-    /** Emits when waiting changes. */
-    private _waitingEventEmitter;
-    /**
-     * Constructs a new instance of the `Registerer` class.
-     * @param userAgent - User agent. See {@link UserAgent} for details.
-     * @param options - Options bucket. See {@link RegistererOptions} for details.
-     */
-    constructor(userAgent: UserAgent, options?: RegistererOptions);
-    /** Default registerer options. */
-    private static defaultOptions;
-    private static newUUID;
-    /**
-     * Strip properties with undefined values from options.
-     * This is a work around while waiting for missing vs undefined to be addressed (or not)...
-     * https://github.com/Microsoft/TypeScript/issues/13195
-     * @param options - Options to reduce
-     */
-    private static stripUndefinedProperties;
-    /** The registered contacts. */
-    get contacts(): Array<string>;
-    /**
-     * The number of seconds to wait before retrying to register.
-     * @defaultValue `undefined`
-     * @remarks
-     * When the server rejects a registration request, if it provides a suggested
-     * duration to wait before retrying, that value is available here when and if
-     * the state transitions to `Unsubscribed`. It is also available during the
-     * callback to `onReject` after a call to `register`. (Note that if the state
-     * if already `Unsubscribed`, a rejected request created by `register` will
-     * not cause the state to transition to `Unsubscribed`. One way to avoid this
-     * case is to dispose of `Registerer` when unregistered and create a new
-     * `Registerer` for any attempts to retry registering.)
-     * @example
-     * ```ts
-     * // Checking for retry after on state change
-     * registerer.stateChange.addListener((newState) => {
-     *   switch (newState) {
-     *     case RegistererState.Unregistered:
-     *       const retryAfter = registerer.retryAfter;
-     *       break;
-     *   }
-     * });
-     *
-     * // Checking for retry after on request rejection
-     * registerer.register({
-     *   requestDelegate: {
-     *     onReject: () => {
-     *       const retryAfter = registerer.retryAfter;
-     *     }
-     *   }
-     * });
-     * ```
-     */
-    get retryAfter(): number | undefined;
-    /** The registration state. */
-    get state(): RegistererState;
-    /** Emits when the registerer state changes. */
-    get stateChange(): Emitter<RegistererState>;
-    /** Destructor. */
-    dispose(): Promise<void>;
-    /**
-     * Sends the REGISTER request.
-     * @remarks
-     * If successful, sends re-REGISTER requests prior to registration expiration until `unsubscribe()` is called.
-     * Rejects with `RequestPendingError` if a REGISTER request is already in progress.
-     */
-    register(options?: RegistererRegisterOptions): Promise<OutgoingRegisterRequest>;
-    /**
-     * Sends the REGISTER request with expires equal to zero.
-     * @remarks
-     * Rejects with `RequestPendingError` if a REGISTER request is already in progress.
-     */
-    unregister(options?: RegistererUnregisterOptions): Promise<OutgoingRegisterRequest>;
-    /**
-     * Clear registration timers.
-     */
-    private clearTimers;
-    /**
-     * Generate Contact Header
-     */
-    private generateContactHeader;
-    /**
-     * Helper function, called when registered.
-     */
-    private registered;
-    /**
-     * Helper function, called when unregistered.
-     */
-    private unregistered;
-    /**
-     * Helper function, called when terminated.
-     */
-    private terminated;
-    /**
-     * Transition registration state.
-     */
-    private stateTransition;
-    /** True if the registerer is currently waiting for final response to a REGISTER request. */
-    private get waiting();
-    /** Emits when the registerer waiting state changes. */
-    private get waitingChange();
-    /**
-     * Toggle waiting.
-     */
-    private waitingToggle;
-    /** Hopefully helpful as the standard behavior has been found to be unexpected. */
-    private waitingWarning;
-    /** Hopefully helpful as the standard behavior has been found to be unexpected. */
-    private stateError;
-}

package/dist/api/session-bye-options.d.ts

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

package/dist/api/session-delegate.d.ts

@@ -1,73 +0,0 @@
-import { IncomingRequestMessage } from "../core";
-import { Bye } from "./bye";
-import { Info } from "./info";
-import { Message } from "./message";
-import { Notification } from "./notification";
-import { Referral } from "./referral";
-import { SessionDescriptionHandler } from "./session-description-handler";
-/**
- * Delegate for {@link Session}.
- * @public
- */
-export interface SessionDelegate {
-    /**
-     * Called upon receiving an incoming in dialog BYE request.
-     * @param bye - The bye.
-     */
-    onBye?(bye: Bye): void;
-    /**
-     * Called upon receiving an incoming in dialog INFO request.
-     * @param info - The info.
-     */
-    onInfo?(info: Info): void;
-    /**
-     * Called upon receiving an incoming in dialog INVITE request.
-     * @param invite - The invite.
-     */
-    onInvite?(request: IncomingRequestMessage, response: string, statusCode: number): void;
-    /**
-     * Called upon receiving an incoming in dialog MESSAGE request.
-     * @param message - The message.
-     */
-    onMessage?(message: Message): void;
-    /**
-     * Called upon receiving an incoming in dialog NOTIFY request.
-     *
-     * @remarks
-     * If a refer is in progress notifications are delivered to the referrers delegate.
-     *
-     * @param notification - The notification.
-     */
-    onNotify?(notification: Notification): void;
-    /**
-     * Called upon receiving an incoming in dialog REFER request.
-     * @param referral - The referral.
-     */
-    onRefer?(referral: Referral): void;
-    /**
-     * Called upon creating a SessionDescriptionHandler.
-     *
-     * @remarks
-     * It's recommended that the SessionDescriptionHandler be accessed via the `Session.sessionDescriptionHandler` property.
-     * However there are use cases where one needs access immediately after it is constructed and before it is utilized.
-     * Thus this callback.
-     *
-     * In most scenarios a single SessionDescriptionHandler will be created per Session
-     * in which case this callback will be called at most once and `provisional` will be `false`.
-     *
-     * However if reliable provisional responses are being supported and an INVITE is sent without SDP,
-     * one or more session description handlers will be created if remote offers are received in reliable provisional responses.
-     * When remote offers are received in reliable provisional responses, the `provisional` parameter will be `true`.
-     * When the `provisional` paramter is `true`, this callback may (or may not) be called again.
-     * If the session is ultimately established using a SessionDescriptionHandler which was not created provisionally,
-     * this callback will be called again and the `provisional` parameter will be `false`.
-     * If the session is ultimately established using a SessionDescriptionHandler which was created provisionally,
-     * this callback will not be called again.
-     * Note that if the session is ultimately established using a SessionDescriptionHandler which was created provisionally,
-     * the provisional SessionDescriptionHandler being utilized will be available via the `Session.sessionDescriptionHandler` property.
-     *
-     * @param sessionDescriptionHandler - The handler.
-     * @param provisional - True if created provisionally.
-     */
-    onSessionDescriptionHandler?(sessionDescriptionHandler: SessionDescriptionHandler, provisional: boolean): void;
-}

package/dist/api/session-description-handler-factory.d.ts

@@ -1,15 +0,0 @@
-import { Session } from "./session";
-import { SessionDescriptionHandler } from "./session-description-handler";
-/**
- * Factory for {@link SessionDescriptionHandler}.
- * @public
- */
-export interface SessionDescriptionHandlerFactory {
-    /**
-     * SessionDescriptionHandler factory function.
-     * @remarks
-     * The `options` are provided as part of the UserAgent configuration
-     * and passed through on every call to SessionDescriptionHandlerFactory's constructor.
-     */
-    (session: Session, options?: object): SessionDescriptionHandler;
-}

package/dist/api/session-description-handler.d.ts

@@ -1,74 +0,0 @@
-/**
- * Delegate for {@link Session} offer/answer exchange.
- * @public
- */
-export interface SessionDescriptionHandler {
-    /**
-     * Destructor.
-     */
-    close(): void;
-    /**
-     * Gets the local description from the underlying media implementation.
-     * @param options - Options object to be used by getDescription.
-     * @param modifiers - Array with one time use description modifiers.
-     * @returns Promise that resolves with the local description to be used for the session.
-     * Rejects with `ClosedSessionDescriptionHandlerError` when this method
-     * is called after close or when close occurs before complete.
-     */
-    getDescription(options?: SessionDescriptionHandlerOptions, modifiers?: Array<SessionDescriptionHandlerModifier>): Promise<BodyAndContentType>;
-    /**
-     * Returns true if the Session Description Handler can handle the Content-Type described by a SIP message.
-     * @param contentType - The content type that is in the SIP Message.
-     * @returns True if the content type is  handled by this session description handler. False otherwise.
-     */
-    hasDescription(contentType: string): boolean;
-    /**
-     * Rolls back the current local/remote offer to the prior stable state.
-     */
-    rollbackDescription?(): Promise<void>;
-    /**
-     * Sets the remote description to the underlying media implementation.
-     * @param  sessionDescription - The description provided by a SIP message to be set on the media implementation.
-     * @param options - Options object to be used by setDescription.
-     * @param modifiers - Array with one time use description modifiers.
-     * @returns Promise that resolves once the description is set.
-     * Rejects with `ClosedSessionDescriptionHandlerError` when this method
-     * is called after close or when close occurs before complete.
-     */
-    setDescription(sdp: string, options?: SessionDescriptionHandlerOptions, modifiers?: Array<SessionDescriptionHandlerModifier>): Promise<void>;
-    /**
-     * Send DTMF via RTP (RFC 4733).
-     * Returns true if DTMF send is successful, false otherwise.
-     * @param tones - A string containing DTMF digits.
-     * @param options - Options object to be used by sendDtmf.
-     * @returns True if DTMF send is successful, false otherwise.
-     */
-    sendDtmf(tones: string, options?: unknown): boolean;
-}
-/**
- * Modifier for {@link SessionDescriptionHandler} offer/answer.
- * @public
- */
-export interface SessionDescriptionHandlerModifier {
-    (sessionDescription: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
-}
-/**
- * Options for {@link SessionDescriptionHandler} methods.
- * @remarks
- * These options are provided to various UserAgent methods (invite() for example)
- * and passed through on calls to getDescription() and setDescription().
- * @public
- */
-export interface SessionDescriptionHandlerOptions {
-    constraints?: object;
-}
-/**
- * Message body content and type.
- * @public
- */
-export interface BodyAndContentType {
-    /** Message body content. */
-    body: string;
-    /** Message body content type. */
-    contentType: string;
-}

package/dist/api/session-info-options.d.ts

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

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

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

package/dist/api/session-message-options.d.ts

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

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

@@ -1,8 +0,0 @@
-import { SessionDelegate } from "./session-delegate";
-/**
- * Options for {@link Session} constructor.
- * @public
- */
-export interface SessionOptions {
-    delegate?: SessionDelegate;
-}

package/dist/api/session-refer-options.d.ts

@@ -1,14 +0,0 @@
-import { OutgoingRequestDelegate, RequestOptions } from "../core";
-import { Notification } from "./notification";
-/**
- * Options for {@link Session.refer}.
- * @public
- */
-export interface SessionReferOptions {
-    /** Called upon receiving an incoming NOTIFY associated with a REFER. */
-    onNotify?: (notification: Notification) => void;
-    /** See `core` API. */
-    requestDelegate?: OutgoingRequestDelegate;
-    /** See `core` API. */
-    requestOptions?: RequestOptions;
-}