ue-softphone-sdk 4.0.0 → 4.0.2

package/dist/lib/types/lib/sip.js/core/dialogs/subscription-dialog.d.ts

@@ -1,120 +0,0 @@
-import { IncomingRequestMessage, OutgoingRequestMessage, OutgoingSubscribeRequest, OutgoingSubscribeRequestDelegate, RequestOptions } from '../messages';
-import { Subscription, SubscriptionDelegate, SubscriptionState } from '../subscription';
-import { UserAgentCore } from '../user-agent-core/user-agent-core';
-import { Dialog } from './dialog';
-import { DialogState } from './dialog-state';
-/**
- * Subscription Dialog.
- * @remarks
- * SIP-Specific Event Notification
- *
- * Abstract
- *
- *    This document describes an extension to the Session Initiation
- *    Protocol (SIP) defined by RFC 3261.  The purpose of this extension is
- *    to provide an extensible framework by which SIP nodes can request
- *    notification from remote nodes indicating that certain events have
- *    occurred.
- *
- *    Note that the event notification mechanisms defined herein are NOT
- *    intended to be a general-purpose infrastructure for all classes of
- *    event subscription and notification.
- *
- *    This document represents a backwards-compatible improvement on the
- *    original mechanism described by RFC 3265, taking into account several
- *    years of implementation experience.  Accordingly, this document
- *    obsoletes RFC 3265.  This document also updates RFC 4660 slightly to
- *    accommodate some small changes to the mechanism that were discussed
- *    in that document.
- *
- *  https://tools.ietf.org/html/rfc6665
- * @public
- */
-export declare class SubscriptionDialog extends Dialog implements Subscription {
-    delegate: SubscriptionDelegate | undefined;
-    private _autoRefresh;
-    private _subscriptionEvent;
-    private _subscriptionExpires;
-    private _subscriptionExpiresInitial;
-    private _subscriptionExpiresLastSet;
-    private _subscriptionRefresh;
-    private _subscriptionRefreshLastSet;
-    private _subscriptionState;
-    private logger;
-    private N;
-    private refreshTimer;
-    constructor(subscriptionEvent: string, subscriptionExpires: number, subscriptionState: SubscriptionState, core: UserAgentCore, state: DialogState, delegate?: SubscriptionDelegate);
-    /**
-     * When a UAC receives a response that establishes a dialog, it
-     * constructs the state of the dialog.  This state MUST be maintained
-     * for the duration of the dialog.
-     * https://tools.ietf.org/html/rfc3261#section-12.1.2
-     * @param outgoingRequestMessage - Outgoing request message for dialog.
-     * @param incomingResponseMessage - Incoming response message creating dialog.
-     */
-    static initialDialogStateForSubscription(outgoingSubscribeRequestMessage: OutgoingRequestMessage, incomingNotifyRequestMessage: IncomingRequestMessage): DialogState;
-    dispose(): void;
-    get autoRefresh(): boolean;
-    set autoRefresh(autoRefresh: boolean);
-    get subscriptionEvent(): string;
-    /** Number of seconds until subscription expires. */
-    get subscriptionExpires(): number;
-    set subscriptionExpires(expires: number);
-    get subscriptionExpiresInitial(): number;
-    /** Number of seconds until subscription auto refresh. */
-    get subscriptionRefresh(): number | undefined;
-    get subscriptionState(): SubscriptionState;
-    /**
-     * Receive in dialog request message from transport.
-     * @param message -  The incoming request message.
-     */
-    receiveRequest(message: IncomingRequestMessage): void;
-    /**
-     * 4.1.2.2.  Refreshing of Subscriptions
-     * https://tools.ietf.org/html/rfc6665#section-4.1.2.2
-     */
-    refresh(): OutgoingSubscribeRequest;
-    /**
-     * 4.1.2.2.  Refreshing of Subscriptions
-     * https://tools.ietf.org/html/rfc6665#section-4.1.2.2
-     * @param delegate - Delegate to handle responses.
-     * @param options - Options bucket.
-     */
-    subscribe(delegate?: OutgoingSubscribeRequestDelegate, options?: RequestOptions): OutgoingSubscribeRequest;
-    /**
-     * 4.4.1.  Dialog Creation and Termination
-     * A subscription is destroyed after a notifier sends a NOTIFY request
-     * with a "Subscription-State" of "terminated", or in certain error
-     * situations described elsewhere in this document.
-     * https://tools.ietf.org/html/rfc6665#section-4.4.1
-     */
-    terminate(): void;
-    /**
-     * 4.1.2.3.  Unsubscribing
-     * https://tools.ietf.org/html/rfc6665#section-4.1.2.3
-     */
-    unsubscribe(): OutgoingSubscribeRequest;
-    /**
-     * Handle in dialog NOTIFY requests.
-     * This does not include the first NOTIFY which created the dialog.
-     * @param message - The incoming NOTIFY request message.
-     */
-    private onNotify;
-    private onRefresh;
-    private onTerminated;
-    private refreshTimerClear;
-    private refreshTimerSet;
-    private stateTransition;
-    /**
-     * When refreshing a subscription, a subscriber starts Timer N, set to
-     * 64*T1, when it sends the SUBSCRIBE request.  If this Timer N expires
-     * prior to the receipt of a NOTIFY request, the subscriber considers
-     * the subscription terminated.  If the subscriber receives a success
-     * response to the SUBSCRIBE request that indicates that no NOTIFY
-     * request will be generated -- such as the 204 response defined for use
-     * with the optional extension described in [RFC5839] -- then it MUST
-     * cancel Timer N.
-     * https://tools.ietf.org/html/rfc6665#section-4.1.2.2
-     */
-    private timerN;
-}

package/dist/lib/types/lib/sip.js/core/exceptions/exception.d.ts

@@ -1,8 +0,0 @@
-/**
- * An Exception is considered a condition that a reasonable application may wish to catch.
- * An Error indicates serious problems that a reasonable application should not try to catch.
- * @public
- */
-export declare abstract class Exception extends Error {
-    protected constructor(message?: string);
-}

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

@@ -1,3 +0,0 @@
-export * from "./exception";
-export * from "./transaction-state-error";
-export * from "./transport-error";

package/dist/lib/types/lib/sip.js/core/exceptions/transaction-state-error.d.ts

@@ -1,8 +0,0 @@
-import { Exception } from "./exception";
-/**
- * Indicates that the operation could not be completed given the current transaction state.
- * @public
- */
-export declare class TransactionStateError extends Exception {
-    constructor(message?: string);
-}

package/dist/lib/types/lib/sip.js/core/exceptions/transport-error.d.ts

@@ -1,8 +0,0 @@
-import { Exception } from "./exception";
-/**
- * Transport error.
- * @public
- */
-export declare class TransportError extends Exception {
-    constructor(message?: string);
-}

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

@@ -1,15 +0,0 @@
-/**
- * A core library implementing low level SIP protocol elements.
- * @packageDocumentation
- */
-export * from "./dialogs";
-export * from "./exceptions";
-export * from "./log";
-export * from "./messages";
-export * from "./session";
-export * from "./subscription";
-export * from "./transactions";
-export * from "./user-agent-core";
-export * from "./user-agents";
-export * from "./timers";
-export * from "./transport";

package/dist/lib/types/lib/sip.js/core/log/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./levels";
-export * from "./logger-factory";
-export * from "./logger";

package/dist/lib/types/lib/sip.js/core/log/levels.d.ts

@@ -1,10 +0,0 @@
-/**
- * Log levels.
- * @public
- */
-export declare enum Levels {
-    error = 0,
-    warn = 1,
-    log = 2,
-    debug = 3
-}

package/dist/lib/types/lib/sip.js/core/log/logger-factory.d.ts

@@ -1,21 +0,0 @@
-import { Levels } from "./levels";
-import { Logger } from "./logger";
-/**
- * Logger.
- * @public
- */
-export declare class LoggerFactory {
-    builtinEnabled: boolean;
-    private _level;
-    private _connector;
-    private loggers;
-    private logger;
-    constructor();
-    get level(): Levels;
-    set level(newLevel: Levels);
-    get connector(): ((level: string, category: string, label: string | undefined, content: any) => void) | undefined;
-    set connector(value: ((level: string, category: string, label: string | undefined, content: any) => void) | undefined);
-    getLogger(category: string, label?: string): Logger;
-    genericLog(levelToLog: Levels, category: string, label: string | undefined, content: any): void;
-    private print;
-}

package/dist/lib/types/lib/sip.js/core/log/logger.d.ts

@@ -1,19 +0,0 @@
-import { Levels } from "./levels";
-import { LoggerFactory } from "./logger-factory";
-/**
- * Logger.
- * @public
- */
-export declare class Logger {
-    private logger;
-    private category;
-    private label;
-    constructor(logger: LoggerFactory, category: string, label?: string);
-    error(content: string): void;
-    warn(content: string): void;
-    log(content: string): void;
-    debug(content: string): void;
-    private genericLog;
-    get level(): Levels;
-    set level(newLevel: Levels);
-}

package/dist/lib/types/lib/sip.js/core/messages/body.d.ts

@@ -1,64 +0,0 @@
-import { IncomingRequestMessage } from "./incoming-request-message";
-import { IncomingResponseMessage } from "./incoming-response-message";
-import { OutgoingRequestMessage } from "./outgoing-request-message";
-/**
- * Message body.
- * @remarks
- * https://tools.ietf.org/html/rfc3261#section-7.4
- * @public
- */
-export interface Body {
-    /**
-     * If the Content-Disposition header field is missing, bodies of
-     * Content-Type application/sdp imply the disposition "session", while
-     * other content types imply "render".
-     * https://tools.ietf.org/html/rfc3261#section-13.2.1
-     * For backward-compatibility, if the Content-Disposition header field
-     * is missing, the server SHOULD assume bodies of Content-Type
-     * application/sdp are the disposition "session", while other content
-     * types are "render".
-     * https://tools.ietf.org/html/rfc3261#section-20.11
-     */
-    contentDisposition: string;
-    /**
-     * The Content-Type header field indicates the media type of the
-     * message-body sent to the recipient.  The Content-Type header field
-     * MUST be present if the body is not empty.  If the body is empty,
-     * and a Content-Type header field is present, it indicates that the body
-     * of the specific type has zero length (for example, an empty audio file).
-     * https://tools.ietf.org/html/rfc3261#section-20.15
-     */
-    contentType: string;
-    /**
-     * Requests, including new requests defined in extensions to this
-     * specification, MAY contain message bodies unless otherwise noted.
-     * The interpretation of the body depends on the request method.
-     * For response messages, the request method and the response status
-     * code determine the type and interpretation of any message body.  All
-     * responses MAY include a body.
-     * https://tools.ietf.org/html/rfc3261#section-7.4
-     */
-    content: string;
-}
-/**
- * Create a Body given a legacy body type.
- * @param bodyLegacy - Body Object
- * @internal
- */
-export declare function fromBodyLegacy(bodyLegacy: string | {
-    body: string;
-    contentType: string;
-}): Body;
-/**
- * User-Defined Type Guard for Body.
- * @param body - Body to check.
- * @internal
- */
-export declare function isBody(body: any): body is Body;
-/**
- * Given a message, get a normalized body.
- * The content disposition is inferred if not set.
- * @param message - The message.
- * @internal
- */
-export declare function getBody(message: IncomingRequestMessage | IncomingResponseMessage | OutgoingRequestMessage | Body): Body | undefined;

package/dist/lib/types/lib/sip.js/core/messages/digest-authentication.d.ts

@@ -1,51 +0,0 @@
-import { LoggerFactory } from "../log";
-import { OutgoingRequestMessage } from "./outgoing-request-message";
-/**
- * Digest Authentication.
- * @internal
- */
-export declare class DigestAuthentication {
-    stale: boolean | undefined;
-    private logger;
-    private ha1;
-    private username;
-    private password;
-    private cnonce;
-    private nc;
-    private ncHex;
-    private response;
-    private algorithm;
-    private realm;
-    private nonce;
-    private opaque;
-    private qop;
-    private method;
-    private uri;
-    /**
-     * Constructor.
-     * @param loggerFactory - LoggerFactory.
-     * @param username - Username.
-     * @param password - Password.
-     */
-    constructor(loggerFactory: LoggerFactory, ha1: string | undefined, username: string | undefined, password: string | undefined);
-    /**
-     * Performs Digest authentication given a SIP request and the challenge
-     * received in a response to that request.
-     * @param request -
-     * @param challenge -
-     * @returns true if credentials were successfully generated, false otherwise.
-     */
-    authenticate(request: OutgoingRequestMessage, challenge: any, body?: string): boolean;
-    /**
-     * Return the Proxy-Authorization or WWW-Authorization header value.
-     */
-    toString(): string;
-    /**
-     * Generate the 'nc' value as required by Digest in this.ncHex by reading this.nc.
-     */
-    private updateNcHex;
-    /**
-     * Generate Digest 'response' value.
-     */
-    private calculateResponse;
-}

package/dist/lib/types/lib/sip.js/core/messages/incoming-message.d.ts

@@ -1,79 +0,0 @@
-import { NameAddrHeader } from "../../grammar";
-/**
- * Incoming message.
- * @public
- */
-export declare class IncomingMessage {
-    viaBranch: string;
-    method: string;
-    body: string;
-    toTag: string;
-    to: NameAddrHeader;
-    fromTag: string;
-    from: NameAddrHeader;
-    callId: string;
-    cseq: number;
-    via: {
-        host: string;
-        port: number;
-    };
-    headers: {
-        [name: string]: Array<{
-            parsed?: any;
-            raw: string;
-        }>;
-    };
-    referTo: string | undefined;
-    data: string;
-    /**
-     * Insert a header of the given name and value into the last position of the
-     * header array.
-     * @param name - header name
-     * @param value - header value
-     */
-    addHeader(name: string, value: string): void;
-    /**
-     * Get the value of the given header name at the given position.
-     * @param name - header name
-     * @returns Returns the specified header, undefined if header doesn't exist.
-     */
-    getHeader(name: string): string | undefined;
-    /**
-     * Get the header/s of the given name.
-     * @param name - header name
-     * @returns Array - with all the headers of the specified name.
-     */
-    getHeaders(name: string): Array<string>;
-    /**
-     * Verify the existence of the given header.
-     * @param name - header name
-     * @returns true if header with given name exists, false otherwise
-     */
-    hasHeader(name: string): boolean;
-    /**
-     * Parse the given header on the given index.
-     * @param name - header name
-     * @param idx - header index
-     * @returns Parsed header object, undefined if the
-     *   header is not present or in case of a parsing error.
-     */
-    parseHeader(name: string, idx?: number): any | undefined;
-    /**
-     * Message Header attribute selector. Alias of parseHeader.
-     * @param name - header name
-     * @param idx - header index
-     * @returns Parsed header object, undefined if the
-     *   header is not present or in case of a parsing error.
-     *
-     * @example
-     * message.s('via',3).port
-     */
-    s(name: string, idx?: number): any | undefined;
-    /**
-     * Replace the value of the given header by the value.
-     * @param name - header name
-     * @param value - header value
-     */
-    setHeader(name: string, value: string): void;
-    toString(): string;
-}

package/dist/lib/types/lib/sip.js/core/messages/incoming-request-message.d.ts

@@ -1,10 +0,0 @@
-import { URI } from '.';
-import { IncomingMessage } from './incoming-message';
-/**
- * Incoming request message.
- * @public
- */
-export declare class IncomingRequestMessage extends IncomingMessage {
-    ruri: URI | undefined;
-    constructor();
-}

package/dist/lib/types/lib/sip.js/core/messages/incoming-request.d.ts

@@ -1,67 +0,0 @@
-import { TransportError } from '../exceptions';
-import { URI } from '.';
-import { IncomingRequestMessage } from './incoming-request-message';
-import { OutgoingResponse, ResponseOptions } from './outgoing-response';
-/**
- * A SIP message sent from a remote client to a local server.
- * @remarks
- * For the purpose of invoking a particular operation.
- * https://tools.ietf.org/html/rfc3261#section-7.1
- * @public
- */
-export interface IncomingRequest {
-    /** Delegate providing custom handling of this incoming request. */
-    delegate?: IncomingRequestDelegate;
-    /** The incoming message. */
-    readonly message: IncomingRequestMessage;
-    /**
-     * Send a 2xx positive final response to this request. Defaults to 200.
-     * @param options - Response options bucket.
-     */
-    accept(options?: ResponseOptions): OutgoingResponse;
-    /**
-     * Send a 1xx provisional response to this request. Defaults to 180. Excludes 100.
-     * Note that per RFC 4320, this method may only be used to respond to INVITE requests.
-     * @param options - Response options bucket.
-     */
-    progress(options?: ResponseOptions): OutgoingResponse;
-    /**
-     * Send a 3xx negative final response to this request. Defaults to 302.
-     * @param contacts - Contacts to redirect the UAC to.
-     * @param options - Response options bucket.
-     */
-    redirect(contacts: Array<URI>, options?: ResponseOptions): OutgoingResponse;
-    /**
-     * Send a 4xx, 5xx, or 6xx negative final response to this request. Defaults to 480.
-     * @param options -  Response options bucket.
-     */
-    reject(options?: ResponseOptions): OutgoingResponse;
-    /**
-     * Send a 100 outgoing response to this request.
-     * @param options - Response options bucket.
-     */
-    trying(options?: ResponseOptions): OutgoingResponse;
-}
-/**
- * Delegate providing custom handling of incoming requests.
- * @public
- */
-export interface IncomingRequestDelegate {
-    /**
-     * Receive CANCEL request.
-     * https://tools.ietf.org/html/rfc3261#section-9.2
-     * Note: Currently CANCEL is being handled as a special case.
-     * No UAS is created to handle the CANCEL and the response to
-     * it CANCEL is being handled statelessly by the user agent core.
-     * As such, there is currently no way to externally impact the
-     * response to the a CANCEL request and thus the method here is
-     * receiving a "message" (as apposed to a "uas").
-     * @param message - Incoming CANCEL request message.
-     */
-    onCancel?(message: IncomingRequestMessage): void;
-    /**
-     * A transport error occurred attempted to send a response.
-     * @param error - Transport error.
-     */
-    onTransportError?(error: TransportError): void;
-}

package/dist/lib/types/lib/sip.js/core/messages/incoming-response-message.d.ts

@@ -1,10 +0,0 @@
-import { IncomingMessage } from "./incoming-message";
-/**
- * Incoming response message.
- * @public
- */
-export declare class IncomingResponseMessage extends IncomingMessage {
-    statusCode: number | undefined;
-    reasonPhrase: string | undefined;
-    constructor();
-}

package/dist/lib/types/lib/sip.js/core/messages/incoming-response.d.ts

@@ -1,12 +0,0 @@
-import { IncomingResponseMessage } from "./incoming-response-message";
-/**
- * A SIP message sent from a remote server to a local client.
- * @remarks
- * For indicating the status of a request sent from the client to the server.
- * https://tools.ietf.org/html/rfc3261#section-7.2
- * @public
- */
-export interface IncomingResponse {
-    /** The incoming message. */
-    readonly message: IncomingResponseMessage;
-}

package/dist/lib/types/lib/sip.js/core/messages/index.d.ts

@@ -1,13 +0,0 @@
-export * from "../../grammar";
-export * from "./methods";
-export * from "./body";
-export * from "./digest-authentication";
-export * from "./incoming-message";
-export * from "./incoming-request-message";
-export * from "./incoming-request";
-export * from "./incoming-response-message";
-export * from "./incoming-response";
-export * from "./outgoing-request-message";
-export * from "./outgoing-request";
-export * from "./outgoing-response";
-export * from "./parser";

package/dist/lib/types/lib/sip.js/core/messages/md5.d.ts

@@ -1,32 +0,0 @@
-export declare class Md5 {
-    static hashStr(str: string, raw?: false): string;
-    static hashStr(str: string, raw?: true): Int32Array;
-    static hashAsciiStr(str: string, raw?: false): string;
-    static hashAsciiStr(str: string, raw?: true): Int32Array;
-    private static stateIdentity;
-    private static buffer32Identity;
-    private static hexChars;
-    private static hexOut;
-    private static onePassHasher;
-    private static _hex;
-    private static _md5cycle;
-    private _dataLength;
-    private _bufferLength;
-    private _state;
-    private _buffer;
-    private _buffer8;
-    private _buffer32;
-    constructor();
-    start(): this;
-    appendStr(str: string): this;
-    appendAsciiStr(str: string): this;
-    appendByteArray(input: Uint8Array): this;
-    getState(): {
-        buffer: any;
-        buflen: number;
-        length: number;
-        state: number[];
-    };
-    setState(state: any): void;
-    end(raw?: boolean): string | Int32Array;
-}

package/dist/lib/types/lib/sip.js/core/messages/methods/ack.d.ts

@@ -1,18 +0,0 @@
-import { IncomingRequestMessage } from "../incoming-request-message";
-import { OutgoingRequestMessage } from "../outgoing-request-message";
-/**
- * Incoming ACK request.
- * @public
- */
-export interface IncomingAckRequest {
-    /** The incoming message. */
-    readonly message: IncomingRequestMessage;
-}
-/**
- * Outgoing ACK request.
- * @public
- */
-export interface OutgoingAckRequest {
-    /** The outgoing message. */
-    readonly message: OutgoingRequestMessage;
-}

package/dist/lib/types/lib/sip.js/core/messages/methods/bye.d.ts

@@ -1,21 +0,0 @@
-import { IncomingRequest } from "../incoming-request";
-import { IncomingResponse } from "../incoming-response";
-import { OutgoingRequest } from "../outgoing-request";
-/**
- * Incoming BYE request.
- * @public
- */
-export interface IncomingByeRequest extends IncomingRequest {
-}
-/**
- * Incoming BYE response.
- * @public
- */
-export interface IncomingByeResponse extends IncomingResponse {
-}
-/**
- * Outgoing BYE request.
- * @public
- */
-export interface OutgoingByeRequest extends OutgoingRequest {
-}

package/dist/lib/types/lib/sip.js/core/messages/methods/cancel.d.ts

@@ -1,21 +0,0 @@
-import { IncomingRequest } from "../incoming-request";
-import { IncomingResponse } from "../incoming-response";
-import { OutgoingRequest } from "../outgoing-request";
-/**
- * Incoming CANCEL request.
- * @public
- */
-export interface IncomingCancelRequest extends IncomingRequest {
-}
-/**
- * Incoming CANCEL response.
- * @public
- */
-export interface IncomingCancelResponse extends IncomingResponse {
-}
-/**
- * Outgoing CANCEL request.
- * @public
- */
-export interface OutgoingCancelRequest extends OutgoingRequest {
-}

package/dist/lib/types/lib/sip.js/core/messages/methods/constants.d.ts

@@ -1,20 +0,0 @@
-/**
- * SIP Methods
- * @internal
- */
-export declare namespace C {
-    const ACK = "ACK";
-    const BYE = "BYE";
-    const CANCEL = "CANCEL";
-    const INFO = "INFO";
-    const INVITE = "INVITE";
-    const MESSAGE = "MESSAGE";
-    const NOTIFY = "NOTIFY";
-    const OPTIONS = "OPTIONS";
-    const REGISTER = "REGISTER";
-    const UPDATE = "UPDATE";
-    const SUBSCRIBE = "SUBSCRIBE";
-    const PUBLISH = "PUBLISH";
-    const REFER = "REFER";
-    const PRACK = "PRACK";
-}