ue-softphone-sdk 2.2.2 → 2.2.4

package/dist/grammar/name-addr-header.d.ts

@@ -0,0 +1,24 @@
+import { Parameters } from "./parameters";
+import { URI } from "./uri";
+/**
+ * Name Address SIP header.
+ * @public
+ */
+export declare class NameAddrHeader extends Parameters {
+    uri: URI;
+    private _displayName;
+    /**
+     * Constructor
+     * @param uri -
+     * @param displayName -
+     * @param parameters -
+     */
+    constructor(uri: URI, displayName: string, parameters: {
+        [name: string]: string;
+    });
+    get friendlyName(): string;
+    get displayName(): string;
+    set displayName(value: string);
+    clone(): NameAddrHeader;
+    toString(): string;
+}

package/dist/grammar/parameters.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @internal
+ */
+export declare class Parameters {
+    parameters: {
+        [name: string]: string | null;
+    };
+    constructor(parameters: {
+        [name: string]: string | number | null | undefined;
+    });
+    setParam(key: string, value: string | number | null | undefined): void;
+    getParam(key: string): string | null | undefined;
+    hasParam(key: string): boolean;
+    deleteParam(key: string): string | null | undefined;
+    clearParams(): void;
+}

package/dist/grammar/pegjs/dist/grammar.d.ts

@@ -0,0 +1,50 @@
+export interface IFilePosition {
+    offset: number;
+    line: number;
+    column: number;
+}
+export interface IFileRange {
+    start: IFilePosition;
+    end: IFilePosition;
+}
+export interface ILiteralExpectation {
+    type: "literal";
+    text: string;
+    ignoreCase: boolean;
+}
+export interface IClassParts extends Array<string | IClassParts> {
+}
+export interface IClassExpectation {
+    type: "class";
+    parts: IClassParts;
+    inverted: boolean;
+    ignoreCase: boolean;
+}
+export interface IAnyExpectation {
+    type: "any";
+}
+export interface IEndExpectation {
+    type: "end";
+}
+export interface IOtherExpectation {
+    type: "other";
+    description: string;
+}
+export type Expectation = ILiteralExpectation | IClassExpectation | IAnyExpectation | IEndExpectation | IOtherExpectation;
+export declare class SyntaxError extends Error {
+    static buildMessage(expected: Expectation[], found: string | null): string;
+    message: string;
+    expected: Expectation[];
+    found: string | null;
+    location: IFileRange;
+    name: string;
+    constructor(message: string, expected: Expectation[], found: string | null, location: IFileRange);
+}
+export interface IParseOptions {
+    filename?: string;
+    startRule?: string;
+    tracer?: any;
+    [key: string]: any;
+}
+export type ParseFunction = (input: string, options?: IParseOptions) => any;
+export declare const parse: ParseFunction;

package/dist/grammar/uri.d.ts

@@ -0,0 +1,62 @@
+import { Parameters } from "./parameters";
+/**
+ * URI.
+ * @public
+ */
+export declare class URI extends Parameters {
+    headers: {
+        [name: string]: Array<string>;
+    };
+    private normal;
+    private raw;
+    /**
+     * Constructor
+     * @param scheme -
+     * @param user -
+     * @param host -
+     * @param port -
+     * @param parameters -
+     * @param headers -
+     */
+    constructor(scheme: string, user: string, host: string, port?: number, parameters?: {
+        [name: string]: string | number | null;
+    }, headers?: {
+        [name: string]: Array<string>;
+    });
+    get scheme(): string;
+    set scheme(value: string);
+    get user(): string | undefined;
+    set user(value: string | undefined);
+    get host(): string;
+    set host(value: string);
+    get aor(): string;
+    get port(): number | undefined;
+    set port(value: number | undefined);
+    setHeader(name: string, value: Array<string> | string): void;
+    getHeader(name: string): Array<string> | undefined;
+    hasHeader(name: string): boolean;
+    deleteHeader(header: string): Array<string> | undefined;
+    clearHeaders(): void;
+    clone(): URI;
+    toRaw(): string;
+    toString(): string;
+    private get _normal();
+    private get _raw();
+    private _toString;
+    private escapeUser;
+    private headerize;
+}
+/**
+ * Returns true if URIs are equivalent per RFC 3261 Section 19.1.4.
+ * @param a URI to compare
+ * @param b URI to compare
+ *
+ * @remarks
+ * 19.1.4 URI Comparison
+ * Some operations in this specification require determining whether two
+ * SIP or SIPS URIs are equivalent.
+ *
+ * https://tools.ietf.org/html/rfc3261#section-19.1.4
+ * @internal
+ */
+export declare function equivalentURI(a: URI, b: URI): boolean;

package/dist/{types/index.d.ts → index.d.ts}

@@ -54,7 +54,7 @@ interface MuteOrUnMuteParams {
     fail?: Function;
 }
 interface TransferParams {
-    type: String;
+    mode: String;
     number: String;
     agentNumber?: String;
     success?: Function;
@@ -92,6 +92,7 @@ interface consultParams {
     fail?: Function;
 }
 interface cancleConsultParams {
+    agentNumber: String;
     success?: Function;
     fail?: Function;
 }
@@ -100,14 +101,17 @@ interface stopConsultParams {
     fail?: Function;
 }
 interface resumeConsultParams {
+    agentNumber: String;
     success?: Function;
     fail?: Function;
 }
 interface consultTransferParams {
+    agentNumber: String;
     success?: Function;
     fail?: Function;
 }
 interface threeWayCallParams {
+    agentNumber: String;
     success?: Function;
     fail?: Function;
 }
@@ -164,7 +168,7 @@ export default class ueSoftphone {
         accept(): void;
         connect(): void;
         disconnect(): void;
-        isConnected(): any;
+        isConnected(): boolean;
         sendDTMF(tone: string): void;
     };
     get call(): {
@@ -188,7 +192,7 @@ export default class ueSoftphone {
         accept(): void;
         connect(): void;
         disconnect(): void;
-        isConnected(): any;
+        isConnected(): boolean;
         sendDTMF(tone: string): void;
     };
 }

package/dist/main.d.ts

@@ -0,0 +1,9 @@
+declare const version = "0.19.0";
+declare const name = "sip.js";
+export { name, version };
+export * from "./api";
+export * from "./grammar";
+import * as Core from "./core";
+export { Core };
+import * as Web from "./platform/web";
+export { Web };

package/dist/new-index.d.ts

@@ -0,0 +1,199 @@
+type DebugType = "trace" | "debug" | "log" | "warn" | "error" | "all";
+type ExtenType = "PSTN" | "SIP" | "WEBRTC";
+interface AudioInfo {
+    notOpenAudioMsg: string;
+    notOpenAudioCode: number;
+    notOpenAudioMsgEn: string;
+    forbiddenAudioMsg: string;
+    forbiddenAudioCode: number;
+    forbiddenAudioMsgEn: string;
+}
+interface InitOptions {
+    accountId?: string;
+    agentNumber?: string;
+    password?: string;
+    loginType?: ExtenType;
+    debug?: DebugType | DebugType[] | boolean;
+    success?: Function;
+    error?: Function;
+    server?: string;
+    audioInfo?: AudioInfo;
+}
+interface OnCallEventParams {
+    success?: Function;
+    message?: Function;
+    error?: Function;
+}
+interface DialoutParams {
+    agentNumber?: String;
+    accountId: String;
+    agentId: String;
+    loginType?: String;
+    customerNumber: String;
+    agentTimeout?: String;
+    customerTimeout?: String;
+    agentDisNumber?: String;
+    customerDisNumber?: String;
+    extras?: any;
+    success?: Function;
+    fail?: Function;
+}
+interface HangupParams {
+    success?: Function;
+    fail?: Function;
+}
+interface HoldOrUnHoldParams {
+    type: String;
+    success?: Function;
+    fail?: Function;
+}
+interface MuteOrUnMuteParams {
+    type: String;
+    direction: String;
+    success?: Function;
+    fail?: Function;
+}
+interface TransferParams {
+    mode: String;
+    number: String;
+    agentNumber?: String;
+    success?: Function;
+    fail?: Function;
+}
+interface UpdateLoginTypeParams {
+    loginType: ExtenType;
+    loginNumber?: String;
+    success?: Function;
+    fail?: Function;
+}
+interface GetAgentPhoneBarParams {
+    success?: Function;
+    fail?: Function;
+}
+interface GetQueueOnlineAgentsParams {
+    success?: Function;
+    fail?: Function;
+}
+interface AgentOfflineParams {
+    success?: Function;
+    fail?: Function;
+    toAnswerOffline?: String;
+}
+interface UpdateAgentStatusParams {
+    stateNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface consultParams {
+    mode: String;
+    number: String;
+    agentNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface cancleConsultParams {
+    agentNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface stopConsultParams {
+    success?: Function;
+    fail?: Function;
+}
+interface resumeConsultParams {
+    agentNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface consultTransferParams {
+    agentNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface threeWayCallParams {
+    agentNumber: String;
+    success?: Function;
+    fail?: Function;
+}
+interface satisfactionParams {
+    type: String;
+    success?: Function;
+    fail?: Function;
+}
+interface meetingParams {
+    number: String;
+    success?: Function;
+    fail?: Function;
+}
+export default class ueSoftphone {
+    static ueTimer: any;
+    static loginToken: String | undefined;
+    static agentInfo: any;
+    static initOptions: InitOptions;
+    static webPhone: any;
+    static callApiUrl: String;
+    static agentextras: any;
+    static Socketinstance: any;
+    static noop(): void;
+    static debug: (msg: any) => void;
+    static log: (msg: any) => void;
+    static warn: (msg: any) => void;
+    static error: (msg: any) => void;
+    static trace: (msg: any) => void;
+    static newWebSocket: (server: string, proto: any) => any;
+    static request: (server: string, proto: any) => any;
+    private attachEventCallbacks;
+    constructor(options?: InitOptions);
+    private init;
+    private login;
+    static createEventHandle(callbacks?: any): void;
+    private getWebrtcInfo;
+    private initAttachEvent;
+    static useDefaultDependencies(deps: any): {
+        newWebSocket(server: string, proto: any): any;
+        request(url: string, options: any): any;
+    };
+    private static initWebrtcEvent;
+    private openMediaAudio;
+    listenCallEvent: (callbacks: OnCallEventParams) => void;
+    get agent(): {
+        switchLoginType(params: UpdateLoginTypeParams): Promise<void>;
+        findPhoneBarList(params: GetAgentPhoneBarParams): void;
+        switchPhoneBar(params: UpdateAgentStatusParams): void;
+        logout(params: AgentOfflineParams): void;
+        findIdleAgentsForQueue(params: GetQueueOnlineAgentsParams): void;
+        getAvailableSipNumberList(params: any): void;
+    };
+    get webrtc(): {
+        accept(): void;
+        connect(): void;
+        disconnect(): void;
+        isConnected(): boolean;
+        sendDTMF(tone: string): void;
+    };
+    get call(): {
+        callout(params: DialoutParams): Promise<void>;
+        hangup(params: HangupParams): void;
+        holdOrUnHold(params: HoldOrUnHoldParams): void;
+        muteOrUnMute(params: MuteOrUnMuteParams): void;
+        transfer(params: TransferParams): void;
+        consult(params: consultParams): void;
+        cancelconsult(params: cancleConsultParams): void;
+        endConsult(params: stopConsultParams): void;
+        callbackConsult(params: resumeConsultParams): void;
+        consultTransfer(params: consultTransferParams): void;
+        threeWayCall(params: threeWayCallParams): void;
+        evaluate(params: satisfactionParams): void;
+        meeting(params: meetingParams): void;
+    };
+    private _callApi;
+    private _agentApi;
+    _webPhoneApi: () => {
+        accept(): void;
+        connect(): void;
+        disconnect(): void;
+        isConnected(): boolean;
+        sendDTMF(tone: string): void;
+    };
+}
+export {};

package/dist/platform/web/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./modifiers";
+export * from "./session-description-handler";
+export * from "./simple-user";
+export * from "./transport";

package/dist/platform/web/modifiers/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * SessionDescriptionHandlerModifer functions for web browsers.
+ * @packageDocumentation
+ */
+export * from "./modifiers";

package/dist/platform/web/modifiers/modifiers.d.ts

@@ -0,0 +1,41 @@
+import { SessionDescriptionHandlerModifier } from "../../../api";
+/**
+ * Modifier.
+ * @public
+ */
+export declare function stripTcpCandidates(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function stripTelephoneEvent(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function cleanJitsiSdpImageattr(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function stripG722(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function stripRtpPayload(payload: string): SessionDescriptionHandlerModifier;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function stripVideo(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * Modifier.
+ * @public
+ */
+export declare function addMidLines(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+/**
+ * The modifier that should be used when the session would like to place the call on hold.
+ * @param description - The description that will be modified.
+ */
+export declare function holdModifier(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;

package/dist/platform/web/session-description-handler/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A SessionDescriptionHandler for web browsers.
+ * @packageDocumentation
+ */
+export * from "./media-stream-factory-default";
+export * from "./media-stream-factory";
+export * from "./peer-connection-configuration-default";
+export * from "./peer-connection-delegate";
+export * from "./session-description-handler-configuration";
+export * from "./session-description-handler-factory-default";
+export * from "./session-description-handler-factory-options";
+export * from "./session-description-handler-factory";
+export * from "./session-description-handler-options";
+export * from "./session-description-handler";

package/dist/platform/web/session-description-handler/media-stream-factory-default.d.ts

@@ -0,0 +1,6 @@
+import { MediaStreamFactory } from "./media-stream-factory";
+/**
+ * Function which returns a MediaStreamFactory.
+ * @public
+ */
+export declare function defaultMediaStreamFactory(): MediaStreamFactory;

package/dist/platform/web/session-description-handler/media-stream-factory.d.ts

@@ -0,0 +1,6 @@
+import { SessionDescriptionHandler } from "./session-description-handler";
+/**
+ * Interface of factory function which produces a MediaStream.
+ * @public
+ */
+export type MediaStreamFactory = (constraints: MediaStreamConstraints, sessionDescriptionHandler: SessionDescriptionHandler) => Promise<MediaStream>;

package/dist/platform/web/session-description-handler/peer-connection-configuration-default.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Function which returns an RTCConfiguration.
+ * @public
+ */
+export declare function defaultPeerConnectionConfiguration(): RTCConfiguration;

package/dist/platform/web/session-description-handler/peer-connection-delegate.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Delegate to handle PeerConnection state changes.
+ * @public
+ */
+export interface PeerConnectionDelegate {
+    /**
+     * This happens whenever the aggregate state of the connection changes.
+     * The aggregate state is a combination of the states of all of the
+     * individual network transports being used by the connection.
+     * @param event - Event.
+     */
+    onconnectionstatechange?(event: Event): void;
+    /**
+     * Triggered when an RTCDataChannel is added to the connection by the
+     * remote peer calling createDataChannel().
+     * @param event - RTCDataChannelEvent.
+     */
+    ondatachannel?(event: RTCDataChannelEvent): void;
+    /**
+     * Triggered when a new ICE candidate has been found.
+     * @param event - RTCPeerConnectionIceEvent.
+     */
+    onicecandidate?(event: RTCPeerConnectionIceEvent): void;
+    /**
+     * Triggered when an error occurred during ICE candidate gathering.
+     * @param event - RTCPeerConnectionIceErrorEvent.
+     */
+    onicecandidateerror?(event: RTCPeerConnectionIceErrorEvent): void;
+    /**
+     * This happens whenever the local ICE agent needs to deliver a message to
+     * the other peer through the signaling server. This lets the ICE agent
+     * perform negotiation with the remote peer without the browser itself
+     * needing to know any specifics about the technology being used for
+     * signalingTriggered when the IceConnectionState changes.
+     * @param event - Event.
+     */
+    oniceconnectionstatechange?(event: Event): void;
+    /**
+     * Triggered when the ICE gathering state changes.
+     * @param event - Event.
+     */
+    onicegatheringstatechange?(event: Event): void;
+    /**
+     * Triggered when renegotiation is necessary.
+     * @param event - Event.
+     */
+    onnegotiationneeded?(event: Event): void;
+    /**
+     * Triggered when the SignalingState changes.
+     * @param event - Event.
+     */
+    onsignalingstatechange?(event: Event): void;
+    /**
+     * Triggered when when a statistics object being monitored is deleted.
+     * @param event - Event.
+     */
+    onstatsended?(event: Event): void;
+    /**
+     * Triggered when a new track is signaled by the remote peer, as a result of setRemoteDescription.
+     * @param event - Event.
+     */
+    ontrack?(event: Event): void;
+}

package/dist/platform/web/session-description-handler/session-description-handler-configuration.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Configuration for SessionDescriptionHandler.
+ * @public
+ */
+export interface SessionDescriptionHandlerConfiguration {
+    /**
+     * The maximum duration to wait in ms for ICE gathering to complete.
+     * If undefined, implementation dependent.
+     * If zero, no timeout.
+     */
+    iceGatheringTimeout?: number;
+    /**
+     * Peer connection options.
+     */
+    peerConnectionConfiguration?: RTCConfiguration;
+}

package/dist/platform/web/session-description-handler/session-description-handler-factory-default.d.ts

@@ -0,0 +1,11 @@
+import { SessionDescriptionHandler } from "./session-description-handler";
+import { SessionDescriptionHandlerFactory } from "./session-description-handler-factory";
+/**
+ * Function which returns a SessionDescriptionHandlerFactory.
+ * @remarks
+ * See {@link defaultPeerConnectionConfiguration} for the default peer connection configuration.
+ * The ICE gathering timeout defaults to 5000ms.
+ * @param mediaStreamFactory - MediaStream factory.
+ * @public
+ */
+export declare function defaultSessionDescriptionHandlerFactory(mediaStreamFactory?: (constraints: MediaStreamConstraints, sessionDescriptionHandler: SessionDescriptionHandler) => Promise<MediaStream>): SessionDescriptionHandlerFactory;

package/dist/platform/web/session-description-handler/session-description-handler-factory-options.d.ts

@@ -0,0 +1,9 @@
+import { SessionDescriptionHandlerConfiguration } from "./session-description-handler-configuration";
+/**
+ * Options for SessionDescriptionHandlerFactory.
+ * @remarks
+ * The "options" are provided as part of the UserAgent configuration and passed through
+ * on every call to SessionDescriptionHandlerFactory's constructor.
+ * @public
+ */
+export type SessionDescriptionHandlerFactoryOptions = SessionDescriptionHandlerConfiguration;

package/dist/platform/web/session-description-handler/session-description-handler-factory.d.ts

@@ -0,0 +1,16 @@
+import { Session, SessionDescriptionHandlerFactory as SessionDescriptionHandlerFactoryDefinition } from "../../../api";
+import { SessionDescriptionHandler } from "./session-description-handler";
+import { SessionDescriptionHandlerFactoryOptions } from "./session-description-handler-factory-options";
+/**
+ * Factory for {@link SessionDescriptionHandler}.
+ * @public
+ */
+export interface SessionDescriptionHandlerFactory extends SessionDescriptionHandlerFactoryDefinition {
+    /**
+     * 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?: SessionDescriptionHandlerFactoryOptions): SessionDescriptionHandler;
+}

package/dist/platform/web/session-description-handler/session-description-handler-options.d.ts

@@ -0,0 +1,47 @@
+import { SessionDescriptionHandlerOptions as SessionDescriptionHandlerOptionsDefinition } from "../../../api";
+/**
+ * Options for {@link SessionDescriptionHandler}.
+ * @public
+ */
+export interface SessionDescriptionHandlerOptions extends SessionDescriptionHandlerOptionsDefinition {
+    /**
+     * Answer options to use when creating an answer.
+     */
+    answerOptions?: RTCAnswerOptions;
+    /**
+     * Constraints to use when creating local media stream.
+     * @remarks
+     * If undefined, defaults to audio true and video false.
+     * If audio and video are false, media stream will have no tracks.
+     */
+    constraints?: MediaStreamConstraints;
+    /**
+     * If true, create a data channel when making initial offer.
+     */
+    dataChannel?: boolean;
+    /**
+     * A human-readable name to use when creating the data channel.
+     */
+    dataChannelLabel?: string;
+    /**
+     * Configuration options for creating the data channel.
+     */
+    dataChannelOptions?: RTCDataChannelInit;
+    /**
+     * If true, offer and answer directions will be set to place peer on hold.
+     */
+    hold?: boolean;
+    /**
+     * The maximum duration to wait in ms for ICE gathering to complete.
+     * No timeout if undefined or zero.
+     */
+    iceGatheringTimeout?: number;
+    /**
+     * Offer options to use when creating an offer.
+     */
+    offerOptions?: RTCOfferOptions;
+    /**
+     * Called upon creating a data channel.
+     */
+    onDataChannel?: (dataChannel: RTCDataChannel) => void;
+}