@wazo/sdk 0.38.0 → 0.38.3

package/src/simple/Softphone.js

@@ -1,40 +1,159 @@
 // @flow
 /* eslint-disable no-unused-vars */
 /* global window, document */
+const BRIDGE_CONFIG_RETRIEVED = 'bridge/CONFIG_RETRIEVED';
+const BRIDGE_CREATE_OR_UPDATE_CARD = 'bridge/BRIDGE_CREATE_OR_UPDATE_CARD';
+const BRIDGE_OPTIONS_FETCHED = 'bridge/BRIDGE_OPTIONS_FETCHED';
+const BRIDGE_OPTIONS_FOUND = 'bridge/BRIDGE_OPTIONS_FOUND';
+const BRIDGE_SEARCH_OPTIONS = 'bridge/BRIDGE_SEARCH_OPTIONS';
+const BRIDGE_DISPLAY_LINKED_OPTION = 'bridge/DISPLAY_LINKED_OPTION';
+const BRIDGE_UPDATE_FORM_SCHEMA = 'bridge/BRIDGE_UPDATE_FORM_SCHEMA';
+const BRIDGE_WAZO_CONTACT_SEARCH = 'bridge/BRIDGE_WAZO_CONTACT_SEARCH';
+const BRIDGE_ON_AGENT_LOGGED_IN = 'bridge/BRIDGE_ON_AGENT_LOGGED_IN';
+const BRIDGE_ON_AGENT_LOGGED_OUT = 'bridge/BRIDGE_ON_AGENT_LOGGED_OUT';
+const BRIDGE_ON_AGENT_PAUSED = 'bridge/BRIDGE_ON_AGENT_PAUSED';
+const BRIDGE_ON_AGENT_RESUMED = 'bridge/BRIDGE_ON_AGENT_RESUMED';
+const BRIDGE_ON_LANGUAGE_CHANGED = 'bridge/BRIDGE_ON_LANGUAGE_CHANGED';
+const BRIDGE_ON_CALL_LOCALLY_ACCEPTED = 'bridge/BRIDGE_ON_CALL_LOCALLY_ACCEPTED';
+const BRIDGE_ON_CALL_REJECTED = 'bridge/BRIDGE_ON_CALL_REJECTED';
+const BRIDGE_ON_CALL_REMOTELY_ACCEPTED = 'bridge/BRIDGE_ON_CALL_REMOTELY_ACCEPTED';
+const BRIDGE_ON_CALL_HELD = 'bridge/BRIDGE_ON_CALL_HELD';
+const BRIDGE_ON_CALL_RESUMED = 'bridge/BRIDGE_ON_CALL_RESUMED';
+const BRIDGE_ON_CALL_MUTED = 'bridge/BRIDGE_ON_CALL_MUTED';
+const BRIDGE_ON_CALL_UN_MUTED = 'bridge/BRIDGE_ON_CALL_UN_MUTED';
+const BRIDGE_ON_DTMF = 'bridge/BRIDGE_ON_DTMF';
+const BRIDGE_ON_DIRECT_TRANSFER = 'bridge/BRIDGE_ON_DIRECT_TRANSFER';
+const BRIDGE_ON_CREATE_INDIRECT_TRANSFER = 'bridge/BRIDGE_ON_CREATE_INDIRECT_TRANSFER';
+const BRIDGE_ON_CANCEL_INDIRECT_TRANSFER = 'bridge/BRIDGE_ON_CANCEL_INDIRECT_TRANSFER';
+const BRIDGE_ON_CONFIRM_INDIRECT_TRANSFER = 'bridge/BRIDGE_ON_CONFIRM_INDIRECT_TRANSFER';
+const BRIDGE_ON_INDIRECT_TRANSFER_CALL_MADE = 'bridge/BRIDGE_ON_INDIRECT_TRANSFER_CALL_MADE';
+const BRIDGE_ON_INDIRECT_TRANSFER_DONE = 'bridge/BRIDGE_ON_INDIRECT_TRANSFER_DONE';
+const BRIDGE_ON_START_RECORDING = 'bridge/BRIDGE_ON_START_RECORDING';
+const BRIDGE_ON_STOP_RECORDING = 'bridge/BRIDGE_ON_STOP_RECORDING';
+const BRIDGE_ON_CARD_CANCELED = 'bridge/BRIDGE_ON_CARD_CANCELED';
+const BRIDGE_ENABLE_AGENT = 'bridge/BRIDGE_ENABLE_AGENT';
+const BRIDGE_SET_CARD_CONTENT = 'bridge/BRIDGE_SET_CARD_CONTENT';
+const BRIDGE_ENABLE_DEBUG = 'bridge/BRIDGE_ENABLE_DEBUG';
+
+const BRIDGE_INJECT_CSS = 'bridge/BRIDGE_INJECT_CSS';
+const BRIDGE_CUSTOMIZE_APPEARANCE = 'bridge/BRIDGE_CUSTOMIZE_APPEARANCE';
+
 const SDK_CLICK_TO_CALL = 'sdk/CLICK_TO_CALL';
-const SDK_ON_CALL_MADE = 'sdk/SDK_ON_CALL_MADE';
+const SDK_ON_OUTGOING_CALL_MADE = 'sdk/SDK_ON_OUTGOING_CALL_MADE';
 const SDK_CALL_ENDED = 'sdk/ON_CALL_ENDED';
 const SDK_CALL_INCOMING = 'sdk/SDK_CALL_INCOMING';
 const SDK_AUTHENTICATED = 'sdk/SDK_AUTHENTICATED';
+const SDK_LOGGED_OUT = 'sdk/SDK_LOGGED_OUT';
 
 class Softphone {
-  url: string = 'https://softphone.wazo.io';
-  width: number = 500;
-  height: number = 600;
-  displayed: boolean = false;
-  iframe: ?Object = null;
+  url: string;
+  width: number;
+  height: number;
+  displayed: boolean;
+  iframe: ?Object;
+  iframeLoaded: boolean;
+
+  // Message waiting for the iframe to be loaded
+  _pendingMessages: Object[];
 
   onLinkEnabled(link: Object) {}
+  onIFrameLoaded() {}
 
-  onCallMade(call: Object) {}
+  onCallLocallyAnswered(call: Object) {}
+  onCallRemotelyAnswered(call: Object) {}
+  onOutgoingCallMade(call: Object) {}
   onCallIncoming(call: Object) {}
+  onCallRejected(call: Object) {}
   onCallEnded(call: Object, card: Object, direction: string, fromExtension: string) {}
+
+  onCardSaved(card: Object) {}
+  onCardCanceled() {}
   onAuthenticated(session: Object) {}
+  onLoggedOut() {}
+
+  onSearchOptions(fieldId: string, query: string) {
+    this.onOptionsResults(fieldId, []);
+  }
+
+  onDisplayLinkedOption(optionId: string) {}
+  onWazoContactSearch(query: string) {}
+  onAgentLoggedIn() {}
+  onAgentLoggedOut() {}
+  onAgentPaused() {}
+  onAgentResumed() {}
+  onLanguageChanged(language: string) {}
+  onCallHeld() {}
+  onCallResumed() {}
+  onCallMuted() {}
+  onCallUnMuted() {}
+  onDtmfSent(tone: string) {}
+  onDirectTransfer(number: string) {}
+  onCreateIndirectTransfer(number: string) {}
+  onCancelIndirectTransfer() {}
+  onConfirmIndirectTransfer() {}
+  onIndirectCallMade(call: Object) {}
+  onIndirectTransferDone(call: Object) {}
+  onStartRecording() {}
+  onStopRecording() {}
+  onUnHandledEvent(event: Object) {}
+
+  init({
+    url,
+    width,
+    height,
+    server,
+    port,
+    language,
+    wrapUpDuration,
+    enableAgent = true,
+    tenantId,
+    debug = false,
+  }: Object = {}) {
+    this.url = url || 'https://softphone.wazo.io';
+    this.width = width || 500;
+    this.height = height || 600;
+    this.displayed = false;
+    this.iframeLoaded = false;
+
+    this.iframeLoaded = false;
+    this._pendingMessages = [];
+    window.addEventListener('message', this._onMessage.bind(this), false);
+
+    if (!server) {
+      // eslint-disable-next-line no-param-reassign
+      server = 'stack.dev.wazo.io';
+    }
 
-  init(url: string, width: number, height: number) {
-    if (url) {
-      this.url = url;
+    const config: Object = { server };
+    if (language) {
+      config.language = language;
     }
-    if (width) {
-      this.width = width;
+    if (port) {
+      config.port = port;
     }
-    if (height) {
-      this.height = height;
+    if (tenantId) {
+      config.tenantId = tenantId;
+    }
+    if (wrapUpDuration) {
+      config.wrapUpDuration = wrapUpDuration;
     }
 
-    window.addEventListener('message', this._onMessage.bind(this), false);
+    this._sendMessage(BRIDGE_CONFIG_RETRIEVED, { config });
+
+    if (enableAgent) {
+      this._sendMessage(BRIDGE_ENABLE_AGENT);
+    }
+
+    if (debug) {
+      this._sendMessage(BRIDGE_ENABLE_DEBUG);
+    }
 
-    this._createIframe();
+    this._createIframe(() => {
+      this.iframeLoaded = true;
+      this._pendingMessages.forEach(([type, payload]) => this._sendMessage(type, payload));
+
+      this.onIFrameLoaded();
+    });
   }
 
   parseLinks() {
@@ -50,9 +169,7 @@ class Softphone {
   makeCall(number: string) {
     this.displaySoftphone();
 
-    if (this.iframe) {
-      this.iframe.contentWindow.postMessage({ type: SDK_CLICK_TO_CALL, number }, '*');
-    }
+    this._sendMessage(SDK_CLICK_TO_CALL, { number });
   }
 
   toggleSoftphoneDisplay() {
@@ -61,8 +178,6 @@ class Softphone {
     } else {
       this.displaySoftphone();
     }
-
-    this.displayed = !this.displayed;
   }
 
   displaySoftphone() {
@@ -73,15 +188,42 @@ class Softphone {
     if (this.iframe) {
       this.iframe.style.display = 'block';
     }
+
+    this.displayed = true;
   }
 
   hideSoftphone() {
     if (this.iframe) {
       this.iframe.style.display = 'none';
     }
+    this.displayed = false;
+  }
+
+  optionsFetched(fieldId: string, options: any[]) {
+    this._sendMessage(BRIDGE_OPTIONS_FETCHED, { fieldId, options });
+  }
+
+  onOptionsResults(fieldId: string, options: any[]) {
+    this._sendMessage(BRIDGE_OPTIONS_FOUND, { fieldId, options });
+  }
+
+  setFormSchema(schema: Object, uiSchema: Object) {
+    this._sendMessage(BRIDGE_UPDATE_FORM_SCHEMA, { schema, uiSchema });
+  }
+
+  setCardValue(field: string, value: any) {
+    this._sendMessage(BRIDGE_SET_CARD_CONTENT, { field, value });
+  }
+
+  injectCss(css: string) {
+    this._sendMessage(BRIDGE_INJECT_CSS, { css });
+  }
+
+  customizeAppearance(themes: Object, translations: Object, assets: Object) {
+    this._sendMessage(BRIDGE_CUSTOMIZE_APPEARANCE, { themes, translations, assets });
   }
 
-  _createIframe() {
+  _createIframe(cb: Function = () => {}) {
     this.iframe = document.createElement('iframe');
     // $FlowFixMe
     this.iframe.width = this.width;
@@ -93,10 +235,13 @@ class Softphone {
     this.iframe.style.left = '0';
     this.iframe.style.bottom = '0';
     this.iframe.style.border = '1px solid #aaa';
+    this.iframe.style.backgroundColor = 'white';
     this.iframe.src = this.url;
     this.iframe.style.display = 'none';
     this.iframe.id = 'wazo-softphone';
 
+    this.iframe.onload = cb;
+
     // $FlowFixMe
     document.body.appendChild(this.iframe);
   }
@@ -123,8 +268,8 @@ class Softphone {
     }
 
     switch (event.data.type) {
-      case SDK_ON_CALL_MADE:
-        this.onCallMade(event.data.callSession);
+      case SDK_ON_OUTGOING_CALL_MADE:
+        this.onOutgoingCallMade(event.data.callSession);
         break;
       case SDK_CALL_ENDED: {
         const { callSession, content, direction, userExtension } = event.data;
@@ -139,10 +284,105 @@ class Softphone {
         this._onAuthenticated(event.data.session);
         this.onAuthenticated(event.data.session);
         break;
+      case SDK_LOGGED_OUT:
+        this.onLoggedOut();
+        break;
+      case BRIDGE_CREATE_OR_UPDATE_CARD: {
+        const { content } = event.data;
+        this.onCardSaved(content);
+        break;
+      }
+      case BRIDGE_SEARCH_OPTIONS: {
+        const { fieldId, query } = event.data;
+        this.onSearchOptions(fieldId, query);
+        break;
+      }
+      case BRIDGE_DISPLAY_LINKED_OPTION:
+        this.onDisplayLinkedOption(event.data.linkedOptionId);
+        break;
+      case BRIDGE_WAZO_CONTACT_SEARCH:
+        this.onWazoContactSearch(event.data.query);
+        break;
+      case BRIDGE_ON_AGENT_LOGGED_IN:
+        this.onAgentLoggedIn();
+        break;
+      case BRIDGE_ON_AGENT_LOGGED_OUT:
+        this.onAgentLoggedOut();
+        break;
+      case BRIDGE_ON_AGENT_PAUSED:
+        this.onAgentPaused();
+        break;
+      case BRIDGE_ON_AGENT_RESUMED:
+        this.onAgentResumed();
+        break;
+      case BRIDGE_ON_LANGUAGE_CHANGED:
+        this.onLanguageChanged(event.data.language);
+        break;
+      case BRIDGE_ON_CALL_HELD:
+        this.onCallHeld();
+        break;
+      case BRIDGE_ON_CALL_RESUMED:
+        this.onCallResumed();
+        break;
+      case BRIDGE_ON_CALL_MUTED:
+        this.onCallMuted();
+        break;
+      case BRIDGE_ON_CALL_UN_MUTED:
+        this.onCallUnMuted();
+        break;
+      case BRIDGE_ON_DTMF:
+        this.onDtmfSent(event.data.tone);
+        break;
+      case BRIDGE_ON_DIRECT_TRANSFER:
+        this.onDirectTransfer(event.data.number);
+        break;
+      case BRIDGE_ON_CREATE_INDIRECT_TRANSFER:
+        this.onCreateIndirectTransfer(event.data.number);
+        break;
+      case BRIDGE_ON_CANCEL_INDIRECT_TRANSFER:
+        this.onCancelIndirectTransfer();
+        break;
+      case BRIDGE_ON_CONFIRM_INDIRECT_TRANSFER:
+        this.onConfirmIndirectTransfer();
+        break;
+      case BRIDGE_ON_INDIRECT_TRANSFER_CALL_MADE:
+        this.onIndirectCallMade(event.data.call);
+        break;
+      case BRIDGE_ON_INDIRECT_TRANSFER_DONE:
+        this.onIndirectTransferDone(event.data.call);
+        break;
+      case BRIDGE_ON_START_RECORDING:
+        this.onStartRecording();
+        break;
+      case BRIDGE_ON_STOP_RECORDING:
+        this.onStopRecording();
+        break;
+      case BRIDGE_ON_CARD_CANCELED:
+        this.onCardCanceled();
+        break;
+      case BRIDGE_ON_CALL_LOCALLY_ACCEPTED:
+        this.onCallLocallyAnswered(event.data.call);
+        break;
+      case BRIDGE_ON_CALL_REJECTED:
+        this.onCallRejected(event.data.call);
+        break;
+      case BRIDGE_ON_CALL_REMOTELY_ACCEPTED:
+        this.onCallRemotelyAnswered(event.data.call);
+        break;
       default:
+        this.onUnHandledEvent(event);
         break;
     }
   }
+
+  _sendMessage(type: string, payload: Object = {}) {
+    if (!this.iframe || !this.iframeLoaded) {
+      this._pendingMessages.push([type, payload]);
+      return;
+    }
+
+    this.iframe.contentWindow.postMessage({ type, ...payload }, '*');
+  }
 }
 
 export default new Softphone();

package/src/web-rtc-client.js

@@ -1617,7 +1617,7 @@ export default class WebRTCClient extends Emitter {
   }
 
   async _onHeartbeatTimeout() {
-    logger.info('sdk webrtc heartbeat timed out', { userAgent: !!this.userAgent, cb: !!this.heartbeatTimeoutCb });
+    logger.warn('sdk webrtc heartbeat timed out', { userAgent: !!this.userAgent, cb: !!this.heartbeatTimeoutCb });
 
     if (this.heartbeatTimeoutCb) {
       this.heartbeatTimeoutCb();