@iadvize-oss/boxed-tag

Boxed tag

The “iAdvize Boxed Tag” is a way to include the iAdvize Tag in the most secure way, without it having access to the client’s website.

With this solution, the iAdvize tag can be loaded in an isolated box (a sandboxed iframe). This way, the main page context cannot be accessed by the iAdvize tag: the main page only sends controlled, relevant data to the boxed tag.

Installation

Install the lib on your project

npm i @iadvize-oss/boxed-tag

Create the iframe script

Create a js file that will import the iframe script. Then call initIAdvizeIframe to listen the host messages. The initIAdvizeIframe comes with 2 arguments :

• sid : your iAdvize sid.
• iAdvizePlatform : the iadvize platform (default: ha).

import { initIAdvizeIframe } from '@iadvize-oss/boxed-tag';

initIAdvizeIframe(<sid>, <iAdvizePlatform>);

Add a boxed iframe

Add a boxed iframe on your site's main page.

<iframe
  title="iAdvize chat notification frame"
  sandbox="allow-scripts allow-same-origin"
  src="https://my-iframe-script-url"
  id="myIframeId"
></iframe>

Add the host script on your site's main page

Create a js file with the host lib import. Then call initIAdvizeHost to listen the iframe messages.

import { initIAdvizeHost } from '@iadvize-oss/boxed-tag';

initIAdvizeHost('myIframeId');

Communication

From iframe to host

Sending message from the isolated boxed iframe to the host window. Use the iAdvizeInterface to add callbacks, that will be handled once the iadvize tag is loaded.

window.iAdvizeInterface.push(function () {
  window.parent.postMessage({ foo: 'bar' });
});

Receiving message on the main host page.

window.addEventListener('message', (e) => {
  if (e.data.foo) {
    // Do something with the data sent
  }
});

From host to iframe

Sending message from the host window to the isolated boxed iframe.

const iAdvizeSandbox = document.getElementById('myIframeId');

iAdvizeSandbox.onload = function () {
  iAdvizeSandbox.contentWindow.postMessage({ foo: 'bar' }, '*');
};

Receiving message on the iframe

window.addEventListener('message', ({ data: { foo } }) => {
  // Do something with the data sent
});

Call web SDK methods from host

Web SDK methods cannot be called from host context because the iAdvize tag is isolated in the iframe. So we need to tell the iframe what we want to call.
After having called initIAdvizeHost, a iAdvizeBoxedInterface object is available in the host window context.
This object sends the method name and args to the iframe, that will call the web SDK. The activate and get and on methods can return a value to the host :
to retrieve it, add a window.addEventListener("message") and check the e.data.method property to recognize the method called.

Navigate

// Web SDK navigate
window.iAdvizeBoxedInterface.push({
  method: 'navigate',
  args: [window.location.href],
});

Activate

The host can listen to the result of the activate call.

For an anonymous authentication:

// Web SDK activate anonymous
window.iAdvizeBoxedInterface.push({
  method: 'activate',
  args: {
    authenticationOption: { type: 'ANONYMOUS' },
  },
});

// Listen to activate result
window.addEventListener('message', ({ data: { method, activation } }) => {
  if (method === 'activate') {
    console.log(activation); // activation return object : success or failure
  }
});

For a secured authentication:
The JWE token should be generated on the host side and sent to the iframe.

• The host should listen a get-activate-auth-token message initiated by the iframe.
• Then call your backend api to get the JWE token,
• Then send the token to the iframe as a set-activate-auth-token message.

The get-activate-auth-token listener allows the iframe to ask for a token refresh if needed.

Example of secured authentication implementation:

// Web SDK activate secured auth
const getJweToken = Promise.resolve('myJWEToken');// your backend logic to generate a JWE

window.iAdvizeBoxedInterface.push({
  method: 'activate',
  args: {
    authenticationOption: {
      type: 'SECURED_AUTHENTICATION',
    },
  },
});

// Listen to activate result
window.addEventListener('message', ({ data: { method, activation } }) => {
  // Handle authentication token
  if (method === 'get-activate-auth-token') {
    getJweToken().then((token) =>
      window.iAdvizeBoxedInterface.push({
        method: 'set-activate-auth-token',
        args: `${token}`,
      }),
    );
  }
  if (method === 'activate') {
    console.log(activation); // activation return object : success or failure
  }
});

Logout

The host can listen to the result of the logout call.

Example of implementation:

// Web SDK logout
window.iAdvizeBoxedInterface.push({
  method: 'logout',
});

// Listen to logout
window.addEventListener('message', ({ data: { method } }) => {
  if (method === 'logout') {
    // Do something after logout
  }
});

On

The host can listen to the result of the on call.

Example of implementation:

// Web SDK on
window.iAdvizeBoxedInterface.push({
  method: 'on',
  args: ['visitor:cookiesConsentChanged'],
});

// Listen to cookiesConsentChanged result
window.addEventListener('message', ({ data: { method, args, value } }) => {
  if (method === 'on' && args.includes('visitor:cookiesConsentChanged')) {
    console.log(value); // cookiesConsentChanged value
  }
});

Off

// Web SDK off
window.iAdvizeBoxedInterface.push({
  method: 'off',
  args: ['visitor:cookiesConsentChanged'],
});

Set

// Web SDK set
window.iAdvizeBoxedInterface.push({
  method: 'set',
  args: ['visitor:GDPRConsent', true],
});

Get

The host can listen to the result of the get call.

Example of implementation:

// Web SDK get
window.iAdvizeBoxedInterface.push({
  method: 'get',
  args: ['visitor:cookiesConsent'],
});

// Listen to cookiesConsent get
window.addEventListener('message', ({ data: { method, args, value } }) => {
  if (method === 'get' && args.includes('visitor:cookiesConsent')) {
    console.log(value); // cookiesConsent value
  }
});

Changelog

[0.4.2]

Fixed

• Fix ci readme
• Fix ci changelog