@koi-design/callkit 2.0.6-beta.1 → 2.1.0-beta.2

package/README.md

@@ -35,7 +35,7 @@ This package requires the following peer dependencies:
 <script>
   const callKit = new WebCall.CallKit({
     host: 'https://example.com',
-    log: 'info',
+    log: 'debug',
     audioRef: () => document.querySelector('#audioRef'),
     socket: 'wss://example.com/ws/in-call'
   });
@@ -49,7 +49,7 @@ import { CallKit } from '@koi-design/callkit';
 
 const callKit = new CallKit({
   host: 'https://example.com',
-  log: 'info',
+  log: 'debug',
   audioRef: () => document.querySelector('#audioRef'),
   socket: 'wss://example.com/ws/in-call'
 });

package/dist/index.d.ts

@@ -8,11 +8,13 @@ declare class Api {
     login(params: {
         userName: string;
         password: string;
+        timestamp: number;
     }): Promise<any>;
     loginOut(params: {
         sessionId: string;
+        timestamp: number;
     }): Promise<any>;
-    trackLogs(log: string): Promise<any>;
+    trackLogs(log: string): Promise<void>;
     /**
      *
      * @param params agentId status
@@ -50,6 +52,72 @@ declare class Logger {
     private catchLog;
 }
 
+type SocketSendEventType = (typeof SocketSendEvent)[keyof typeof SocketSendEvent];
+interface SocketConfig {
+    enabled: boolean;
+    maxAttempts: number;
+    delay: number;
+    pingInterval: number;
+    pingTimeout: number;
+}
+declare class Socket {
+    private callKit;
+    private ws?;
+    lastPingTime: any;
+    pingTimer?: ReturnType<typeof setInterval>;
+    /**
+     * @description reconnect timer
+     */
+    private reconnectTimer?;
+    /**
+     * @description reconnect attempts
+     */
+    private reconnectAttempts;
+    /**
+     * @description connect auth state
+     * @default {
+     *   startConfirm: false,
+     *   isConnected: false,
+     *   isReconnecting: false,
+     *   isAuthenticated: false,
+     *   isError: false
+     * }
+     */
+    private connectAuthState;
+    get startConfirm(): boolean;
+    get isError(): boolean;
+    constructor(callKit: CallKit);
+    get reconnectConfig(): {
+        enabled?: boolean;
+        maxAttempts?: number;
+        delay?: number;
+        pingInterval?: number;
+        pingTimeout?: number;
+    };
+    init(): void;
+    private setConnectAuthState;
+    private handleDisconnect;
+    private clearWebSocket;
+    private connect;
+    private onOpen;
+    private cleanReconnectState;
+    private resetConnectState;
+    private onClose;
+    private onError;
+    private confirmAck;
+    private onMessage;
+    send(event: SocketSendEventType, message?: any): void;
+    private ping;
+    private checkPing;
+    /**
+     * reset socket connection and all states
+     */
+    reset(config?: {
+        force?: boolean;
+    }): Promise<void>;
+    private attemptReconnect;
+}
+
 interface WebrtcConstranis {
     audio: {
         autoGainControl?: boolean;
@@ -67,7 +135,7 @@ interface IConfig {
     constrains: WebrtcConstranis;
     socket: string;
     reconnect?: {
-        sip?: Partial<SipConfig>;
+        sip?: Partial<SocketConfig>;
         incall?: Partial<SocketConfig>;
     };
     userInfo: {
@@ -98,7 +166,7 @@ declare class Config {
     getConfig: () => IConfig;
     setConfig: (key: string, value: any) => Promise<void>;
     setUserInfo: (key: string, value: any) => Promise<void>;
-    reset: () => Promise<void>;
+    reset: (form: string) => Promise<void>;
     validate: () => boolean;
     isLogin: () => boolean;
     check(): boolean;
@@ -107,7 +175,13 @@ declare class Config {
         interval: number;
         maxSize: number;
     };
-    getReconnectConfig(type: 'sip' | 'incall'): SipConfig | SocketConfig;
+    getReconnectConfig(type: 'sip' | 'incall'): {
+        enabled?: boolean;
+        maxAttempts?: number;
+        delay?: number;
+        pingInterval?: number;
+        pingTimeout?: number;
+    };
     enableTrackLogs(enabled: boolean): void;
 }
 
@@ -283,20 +357,6 @@ interface TrackLogsConfig {
     enabled: boolean;
     interval: number;
     maxSize: number;
-}
-interface SocketConfig {
-    enabled: boolean;
-    maxAttempts: number;
-    delay: number;
-    pingInterval: number;
-    pingTimeout: number;
-}
-interface SipConfig {
-    enabled: boolean;
-    maxAttempts: number;
-    delay: number;
-    enableMessageKeepalive: boolean;
-    messageKeepaliveInterval: number;
 }
 
 interface CallParams {
@@ -356,6 +416,10 @@ declare class Connect {
      *@description  Whether it's a re-connected
      */
     isReConnected: boolean;
+    /**
+     *@description  Whether it's a referring
+     */
+    isRefering: boolean;
     /**
      *@description  Whether it's an outgoing call
      */
@@ -369,8 +433,18 @@ declare class Connect {
      */
     hasInvite: boolean;
     constructor(callKit: CallKit);
-    get reconnectConfig(): SipConfig;
-    currentCallId: string | null;
+    get reconnectConfig(): {
+        enabled?: boolean;
+        maxAttempts?: number;
+        delay?: number;
+        pingInterval?: number;
+        pingTimeout?: number;
+    };
+    private currentCallId;
+    getCurrentCallId(): string | null;
+    setRefering(refering: boolean): void;
+    private setIsReConnected;
+    setOutgoing(outgoing: boolean): void;
     setCallId(callId: string | null): void;
     reset(): Promise<void>;
     private getAduioReference;
@@ -406,15 +480,12 @@ declare class Connect {
      * @returns
      */
     isInit(): boolean;
-    private heartbeatInterval?;
-    private heartbeatFlag;
-    private messageKeepaliveTimer?;
-    clearHeartbeat(): void;
-    startHeartbeat(): void;
-    private stopMessageKeepalive;
-    private startMessageKeepalive;
-    private sendKeepaliveMessage;
     socketTriggerHangup(callId: string): void;
+    /**
+     * Setup registerer and bind stateChange listener
+     * @private
+     */
+    private setupRegisterer;
     register(): Promise<void>;
     private reconnectTimer?;
     private reconnectAttempts;
@@ -450,59 +521,6 @@ declare class Connect {
     refer(referTo: string, extra?: any): Promise<void>;
 }
 
-type SocketSendEventType = (typeof SocketSendEvent)[keyof typeof SocketSendEvent];
-declare class Socket {
-    private callKit;
-    private ws?;
-    lastPingTime: any;
-    pingTimer?: ReturnType<typeof setInterval>;
-    /**
-     * @description reconnect timer
-     */
-    private reconnectTimer?;
-    /**
-     * @description reconnect attempts
-     */
-    private reconnectAttempts;
-    /**
-     * @description connect auth state
-     * @default {
-     *   startConfirm: false,
-     *   isConnected: false,
-     *   isReconnecting: false,
-     *   isAuthenticated: false,
-     *   isError: false
-     * }
-     */
-    private connectAuthState;
-    get startConfirm(): boolean;
-    get isError(): boolean;
-    constructor(callKit: CallKit);
-    get reconnectConfig(): SocketConfig;
-    init(): void;
-    private setConnectAuthState;
-    private handleDisconnect;
-    private clearWebSocket;
-    private connect;
-    private onOpen;
-    private cleanReconnectState;
-    private resetConnectState;
-    private onClose;
-    private onError;
-    private confirmAck;
-    private onMessage;
-    send(event: SocketSendEventType, message?: any): void;
-    private ping;
-    private checkPing;
-    /**
-     * reset socket connection and all states
-     */
-    reset(config?: {
-        force?: boolean;
-    }): Promise<void>;
-    private attemptReconnect;
-}
-
 interface CallKitConfig {
     host: string;
     audioRef: HTMLAudioElement | (() => HTMLAudioElement);
@@ -510,7 +528,7 @@ interface CallKitConfig {
     constrains?: WebrtcConstranis;
     log?: LoggerLevel;
     reconnect?: {
-        sip?: Partial<SipConfig>;
+        sip?: Partial<SocketConfig>;
         incall?: Partial<SocketConfig>;
     };
 }
@@ -548,7 +566,9 @@ declare class CallKit {
      * set userstatus
      * @param status
      */
-    setUserStatus(status: number): Promise<void>;
+    setUserStatus(status: number, extra?: {
+        [key: string]: any;
+    }): Promise<void>;
     /**
      * reset callkit
      * @description recover the callkit to the initial state