@viibe/impulse-integration-js 2.3.10 → 2.3.12

package/README.md

@@ -62,6 +62,27 @@ The contact itself;
 - for `phone` category, should be a full phone number (including national prefix)
 - for `expertise` category, should be an `id_expertise`
 
+`suggestions[]` **(array, optional)**
+
+A list of suggested contacts to call.
+Each item is an object with the following format:
+
+`category` **(string, mandatory)**
+
+The type of contact (`email` or `phone`)
+
+`value` **(string, mandatory)**
+
+The contact itself;
+
+- for `email` category, should be a valid email
+- for `phone` category, should be a full phone number (including national prefix)
+
+`description` **(string, optional)**
+
+An optional text to add information about the contact (his name for example).
+Displayed between brackets after the `value` field.
+
 `ticket`
 
 Represents the host application entity the call will be attached to. Viibe calls should typically be attached to a ticket, conversation or issue within the host application 

package/dist/index.js

@@ -1 +1 @@
-(()=>{var t={579:t=>{function n(t,n){if(!(t instanceof n))throw new TypeError("Cannot call a class as a function")}function e(t,n){for(var e=0;e<n.length;e++){var o=n[e];o.enumerable=o.enumerable||!1,o.configurable=!0,"value"in o&&(o.writable=!0),Object.defineProperty(t,o.key,o)}}function o(t,n,o){return n&&e(t.prototype,n),o&&e(t,o),t}function i(t){return function(n){return Boolean(n.isTrusted&&0===n.origin.indexOf(t))}}function a(t){var n=new URL(t),e="".concat(n.protocol,"//").concat(n.host),o=window.screen.width/2-240,a=window.screen.height/2-300,r=["toolbar=no","location=no","directories=no","status=no","menubar=no","scrollbars=no","resizable=no","copyhistory=no","width=".concat(480),"height=".concat(600),"top=".concat(a),"left=".concat(o)];return new Promise((function(n,o){var a=window.open(t,"Authorization",r.join(", "));a||o("Failed to open window");var c=setInterval((function(){a.closed&&(s(),o("User closed window"))}),100);function s(){window.removeEventListener("message",u),clearInterval(c)}function u(t){if(!i(e)(t))return null;if(t.data.token&&(s(),n(t.data.token)),t.data.error&&(s(),o(t.data.error)),t.data&&t.data.event&&t.data.payload)switch(t.data.event){case"authentication:success":return s(),n(t.data);case"authentication:failure":return s(),o(t.data)}return null}window.addEventListener("message",u)}))}var r="auth.viibe.pro",c=1e4,s=function(){function t(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:r;n(this,t),this.host=e}return o(t,[{key:"loginZendesk",value:function(t){var n=document.location.origin;return a("https://".concat(this.host,"/auth/zendesk/login?subdomain=").concat(t,"&origin=").concat(n))}}]),t}(),u=function(){function t(e){n(this,t),this.handlers=[],this.host=e.host,this.origin=/^localhost/.test(this.host)?"http://".concat(this.host):"https://".concat(this.host),this.apiOrigin=/^localhost/.test(this.host)?"http://".concat(this.host):"https://api-".concat(this.host),this.source=e.source,this.isViibeEvent=i(this.origin),window.addEventListener("message",this.onMessage.bind(this))}return o(t,[{key:"createNotificationIframe",value:function(){if(!this.host)throw new Error("fillHost");if(!this.source)throw new Error("fillSource");var t=document.createElement("iframe");return t.name="viibe-".concat(Math.floor(Math.random()*c)),t.style="border: 0;width: 0;",t.src="".concat(this.origin,"/integration/features/notifications"),t}},{key:"createCallIframe",value:function(){var t=this,n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(!this.host)throw new Error("fillHost");if(!this.source)throw new Error("fillSource");var e=this.generateIframeSrc(n),o=document.createElement("iframe");return o.name="viibe-".concat(Math.floor(Math.random()*c)),o.style="border: 0;width: calc(100% - 1rem);margin: 0.5rem;",o.src=e,o.allow="geolocation;autoplay;microphone;camera;midi;encrypted-media;clipboard-write;",this.on(o,"document",(function(n){return t.onDocument(n)})),o}},{key:"generateIframeSrc",value:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},n=t.clipboard,e=void 0!==n&&n,o=t.components,i=t.links,a=t.o2m,r=void 0!==a&&a,c=t.ticket,s=t.token,u=t.locale,l=t.standalone,h=t.suggestions,d="".concat(this.origin,"/integration/features/ticket"),f=new URLSearchParams({origin:document.location.origin,resize:"true",source:this.source});if(c&&c.title&&f.set("title",c.title),c&&c.integration&&f.set("thirdPartyId",c.integration.id),i){var v=i instanceof Array?i.map((function(t){return"".concat(t.category,":").concat(t.value)})).join(","):String(i);f.set("links",v)}if(h){var m=h instanceof Array?h.map((function(t){var n=t.category,e=t.value,o=t.description,i="".concat(n,":").concat(e);return o&&(i+=":".concat(o)),i})).join(","):String(h);f.set("suggestions",m)}if(s&&f.set("token",s),u&&f.set("locale",u),o){var w=o instanceof Array?o.join(","):String(o);f.set("components",w)}return l&&f.set("standalone",Boolean(l)),f.set("clipboard",Boolean(e)),f.set("o2m",Boolean(r)),d+"?".concat(f)}},{key:"dispatch",value:function(t,n,e){return this.handlers.filter((function(n){return n.eventName===t&&(!n.windowName||n.windowName===e)})).map((function(t){return t.func(n)}))}},{key:"onMessage",value:function(t){return this.isViibeEvent(t)?t.data&&t.data.event&&t.data.payload?this.dispatch(t.data.event,t.data.payload,t.data.windowName):t.data&&t.data.token?this.dispatch("authentication:token",t.data.token):t.data&&t.data.error?this.dispatch("authentication:error",t.data.error):null:null}},{key:"on",value:function(t,n,e){"string"==typeof t&&"function"==typeof n&&void 0===e&&(e=n,n=t,t=null);var o={eventName:n,func:e,windowName:t?t.name:null};this.handlers.push(o)}},{key:"onDocument",value:function(t){window.open(t.signed_url,"_blank")}},{key:"authenticate",value:function(t){var n=document.location,e=n.protocol,o=n.host;return a("".concat(e,"//api-").concat(o,"/auth/login/").concat(t,"?origin=").concat(origin))}}]),t}();u.Auth=s,"undefined"!=typeof window&&(window.Viibe=u),t.exports=u}},n={},e=function e(o){var i=n[o];if(void 0!==i)return i.exports;var a=n[o]={exports:{}};return t[o](a,a.exports,e),a.exports}(579);module.exports=e})();
+(()=>{var t={579:t=>{var n=["token"];function e(t,n){if(!(t instanceof n))throw new TypeError("Cannot call a class as a function")}function o(t,n){for(var e=0;e<n.length;e++){var o=n[e];o.enumerable=o.enumerable||!1,o.configurable=!0,"value"in o&&(o.writable=!0),Object.defineProperty(t,o.key,o)}}function i(t,n,e){return n&&o(t.prototype,n),e&&o(t,e),t}function r(t){return function(n){return Boolean(n.isTrusted&&0===n.origin.indexOf(t))}}function a(t){var n=new URL(t),e="".concat(n.protocol,"//").concat(n.host),o=window.screen.width/2-240,i=window.screen.height/2-300,a=["toolbar=no","location=no","directories=no","status=no","menubar=no","scrollbars=no","resizable=no","copyhistory=no","width=".concat(480),"height=".concat(600),"top=".concat(i),"left=".concat(o)];return new Promise((function(n,o){var i=window.open(t,"Authorization",a.join(", "));i||o("Failed to open window");var c=setInterval((function(){i.closed&&(s(),o("User closed window"))}),100);function s(){window.removeEventListener("message",u),clearInterval(c)}function u(t){if(!r(e)(t))return null;if(t.data.token&&(s(),n(t.data.token)),t.data.error&&(s(),o(t.data.error)),t.data&&t.data.event&&t.data.payload)switch(t.data.event){case"authentication:success":return s(),n(t.data);case"authentication:failure":return s(),o(t.data)}return null}window.addEventListener("message",u)}))}var c=function(){function t(){var n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"auth.viibe.pro";e(this,t),this.host=n}return i(t,[{key:"loginZendesk",value:function(t){var n=document.location.origin;return a("https://".concat(this.host,"/auth/zendesk/login?subdomain=").concat(t,"&origin=").concat(n))}}]),t}(),s=function(){function t(n){e(this,t),this.handlers=[],this.host=n.host,this.origin=/^localhost/.test(this.host)?"http://".concat(this.host):"https://".concat(this.host),this.apiOrigin=/^localhost/.test(this.host)?"http://".concat(this.host):"https://api-".concat(this.host),this.source=n.source,this.isViibeEvent=r(this.origin),window.addEventListener("message",this.onMessage.bind(this))}return i(t,[{key:"createNotificationIframe",value:function(){if(!this.host)throw new Error("fillHost");if(!this.source)throw new Error("fillSource");var t=document.createElement("iframe");return t.name="viibe-".concat(Math.floor(1e4*Math.random())),t.style="border: 0;width: 0;",t.src="".concat(this.origin,"/integration/features/notifications"),t}},{key:"createCallIframe",value:function(){var t=this,e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(!this.host)throw new Error("fillHost");if(!this.source)throw new Error("fillSource");e.token;var o=function(t,n){if(null==t)return{};var e,o,i=function(t,n){if(null==t)return{};var e,o,i={},r=Object.keys(t);for(o=0;o<r.length;o++)e=r[o],n.indexOf(e)>=0||(i[e]=t[e]);return i}(t,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(o=0;o<r.length;o++)e=r[o],n.indexOf(e)>=0||Object.prototype.propertyIsEnumerable.call(t,e)&&(i[e]=t[e])}return i}(e,n),i=this.generateIframeSrc(o),r=document.createElement("iframe");return r.name="viibe-".concat(Math.floor(1e4*Math.random())),r.style="border: 0;width: calc(100% - 1rem);margin: 0.5rem;",r.src=i,r.allow="geolocation;autoplay;microphone;camera;midi;encrypted-media;clipboard-write;",this.on(r,"document",(function(n){return t.onDocument(n)})),r}},{key:"generateIframeSrc",value:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},n=t.clipboard,e=void 0!==n&&n,o=t.components,i=t.links,r=t.o2m,a=void 0!==r&&r,c=t.ticket,s=(t.token,t.locale),u=t.standalone,l=t.suggestions,h="".concat(this.origin,"/integration/features/ticket"),d=new URLSearchParams({origin:document.location.origin,resize:"true",source:this.source});if(c&&c.title&&d.set("title",c.title),c&&c.integration&&d.set("thirdPartyId",c.integration.id),i){var f=i instanceof Array?i.map((function(t){return"".concat(t.category,":").concat(t.value)})).join(","):String(i);d.set("links",f)}if(l){var v=l instanceof Array?l.map((function(t){var n=t.category,e=t.value,o=t.description,i="".concat(n,":").concat(e);return o&&(i+=":".concat(o)),i})).join(","):String(l);d.set("suggestions",v)}if(s&&d.set("locale",s),o){var m=o instanceof Array?o.join(","):String(o);d.set("components",m)}return u&&d.set("standalone",Boolean(u)),d.set("clipboard",Boolean(e)),d.set("o2m",Boolean(a)),h+"?".concat(d)}},{key:"dispatch",value:function(t,n,e,o){return this.handlers.filter((function(n){return n.eventName===t&&(!n.windowName||n.windowName===o)})).map((function(t){return t.func(n,e)}))}},{key:"onMessage",value:function(t){return this.isViibeEvent(t)?t.data&&t.data.event?this.dispatch(t.data.event,t.data.payload,t,t.data.windowName):t.data&&t.data.token?this.dispatch("authentication:token",t.data.token,t):t.data&&t.data.error?this.dispatch("authentication:error",t.data.error,t):null:null}},{key:"on",value:function(t,n,e){"string"==typeof t&&"function"==typeof n&&void 0===e&&(e=n,n=t,t=null);var o={eventName:n,func:e,windowName:t?t.name:null};this.handlers.push(o)}},{key:"onDocument",value:function(t){window.open(t.signed_url,"_blank")}},{key:"authenticate",value:function(t){var n=document.location,e=n.protocol,o=n.host;return a("".concat(e,"//api-").concat(o,"/auth/login/").concat(t,"?origin=").concat(origin))}}]),t}();s.Auth=c,"undefined"!=typeof window&&(window.Viibe=s),t.exports=s}},n={},e=function e(o){var i=n[o];if(void 0!==i)return i.exports;var r=n[o]={exports:{}};return t[o](r,r.exports,e),r.exports}(579);module.exports=e})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viibe/impulse-integration-js",
-  "version": "2.3.10",
+  "version": "2.3.12",
   "engines": {
     "node": ">= 10.0.0"
   },
@@ -25,7 +25,7 @@
     "core-js": "^3.18.2",
     "jest": "^28.1.1",
     "jest-environment-jsdom": "^28.1.1",
-    "webpack": "^5.58.1",
+    "webpack": "5.82.0",
     "webpack-cli": "^4.9.0"
   }
 }

package/src/index.js

@@ -83,18 +83,18 @@ function openAuthPopup(src) {
         switch (event.data.event) {
         case 'authentication:success':
           destroy();
-          
+
           return resolve(event.data);
         case 'authentication:failure':
           destroy();
-          
+
           return reject(event.data);
         default:
-          
+
         }
-      
+
       }
-      
+
       return null;
     }
 
@@ -114,7 +114,7 @@ class ViibeAuth {
   loginZendesk(subdomain) {
     const { origin } = document.location;
     const url = `https://${this.host}/auth/zendesk/login?subdomain=${subdomain}&origin=${origin}`;
-    
+
     return openAuthPopup(url);
   }
 }
@@ -164,7 +164,7 @@ class Viibe {
     iframe.name = `viibe-${Math.floor(Math.random() * IFRAME_NAME_RANGE)}`;
     iframe.style = 'border: 0;width: 0;';
     iframe.src = `${this.origin}/integration/features/notifications`;
-    
+
     return iframe;
   }
 
@@ -177,7 +177,9 @@ class Viibe {
       throw new Error('fillSource');
     }
 
-    const src = this.generateIframeSrc(options);
+    // eslint-no-unused-vars
+    const { token, ...params } = options;
+    const src = this.generateIframeSrc(params);
 
     const iframe = document.createElement('iframe');
 
@@ -191,33 +193,32 @@ class Viibe {
     return iframe;
   }
 
-  generateIframeSrc(options = {}) {
+  generateIframeSrc(params = {}) {
     const {
       clipboard = false,
       components,
       links,
       o2m = false,
       ticket,
-      token,
       locale,
       standalone,
       suggestions,
-    } = options;
+    } = params;
 
     let src = `${this.origin}/integration/features/ticket`;
 
-    const params = new URLSearchParams({
+    const urlParams = new URLSearchParams({
       origin: document.location.origin,
       resize: 'true',
       source: this.source,
     });
 
     if (ticket && ticket.title) {
-      params.set('title', ticket.title);
+      urlParams.set('title', ticket.title);
     }
 
     if (ticket && ticket.integration) {
-      params.set('thirdPartyId', ticket.integration.id);
+      urlParams.set('thirdPartyId', ticket.integration.id);
     }
 
     if (links) {
@@ -225,27 +226,27 @@ class Viibe {
         ? links.map(link => `${link.category}:${link.value}`).join(',')
         : String(links);
 
-      params.set('links', linksParams);
+      urlParams.set('links', linksParams);
     }
 
     if (suggestions) {
       const suggestionsParams = (suggestions instanceof Array)
-          ? suggestions.map(({ category, value, description }) => {
-            let res = `${category}:${value}`
-            if (description) res += `:${description}`
-            return res
-          }).join(',')
-          : String(suggestions);
-
-      params.set('suggestions', suggestionsParams);
-    }
+        ? suggestions.map(({ category, value, description }) => {
+          let res = `${category}:${value}`;
 
-    if (token) {
-      params.set('token', token);
+          if (description) {
+            res += `:${description}`;
+          }
+          
+          return res;
+        }).join(',')
+        : String(suggestions);
+
+      urlParams.set('suggestions', suggestionsParams);
     }
 
     if (locale) {
-      params.set('locale', locale);
+      urlParams.set('locale', locale);
     }
 
     if (components) {
@@ -253,17 +254,17 @@ class Viibe {
         ? components.join(',')
         : String(components);
 
-      params.set('components', componentsParams);
+      urlParams.set('components', componentsParams);
     }
 
     if (standalone) {
-      params.set('standalone', Boolean(standalone));
+      urlParams.set('standalone', Boolean(standalone));
     }
 
-    params.set('clipboard', Boolean(clipboard));
-    params.set('o2m', Boolean(o2m));
+    urlParams.set('clipboard', Boolean(clipboard));
+    urlParams.set('o2m', Boolean(o2m));
 
-    src += `?${params}`;
+    src += `?${urlParams}`;
 
     return src;
   }
@@ -275,16 +276,14 @@ class Viibe {
    *
    * @param {string} eventName
    * @param {any} payload
+   * @param {any} event
    * @param {string} windowName
    * @returns
    */
-  dispatch(eventName, payload, windowName) {
+  dispatch(eventName, payload, event, windowName) {
     return this.handlers
-      .filter(handler =>
-        handler.eventName === eventName &&
-        (!handler.windowName || (handler.windowName === windowName)),
-      )
-      .map(handler => handler.func(payload));
+      .filter(handler => handler.eventName === eventName && (!handler.windowName || (handler.windowName === windowName)))
+      .map(handler => handler.func(payload, event));
   }
 
   /**
@@ -297,17 +296,17 @@ class Viibe {
       return null;
     }
 
-    if (event.data && event.data.event && event.data.payload) {
-      return this.dispatch(event.data.event, event.data.payload, event.data.windowName);
+    if (event.data && event.data.event) {
+      return this.dispatch(event.data.event, event.data.payload, event, event.data.windowName);
     }
 
     // FIXME: legacy authentication messages
     if (event.data && event.data.token) {
-      return this.dispatch('authentication:token', event.data.token);
+      return this.dispatch('authentication:token', event.data.token, event);
     }
 
     if (event.data && event.data.error) {
-      return this.dispatch('authentication:error', event.data.error);
+      return this.dispatch('authentication:error', event.data.error, event);
     }
 
     return null;
@@ -323,8 +322,8 @@ class Viibe {
    */
   on(iframe, eventName, func) {
     if (typeof iframe === 'string' &&
-      typeof eventName === 'function' &&
-      typeof func === 'undefined') {
+        typeof eventName === 'function' &&
+        typeof func === 'undefined') {
       func = eventName;
       eventName = iframe;
       iframe = null;

package/test/dist.test.js

@@ -62,7 +62,6 @@ describe('dist', () => {
       source: 'jest',
     });
     const iframe = viibe.createCallIframe();
-    // const callUrl = viibe.createCallUrl();
 
     expect(iframe).toBeInstanceOf(HTMLIFrameElement);
     expect(iframe.name).toMatch(/^viibe-[0-9]{1,4}$/);
@@ -70,6 +69,5 @@ describe('dist', () => {
     expect(iframe.style.border).toBe('0px');
     expect(iframe.style.margin).toBe('0.5rem');
     expect(iframe.style.width).toBe('calc(100% - 1rem)');
-    // expect(iframe.src).toEqual(callUrl);
   });
 });