@livechat/customer-sdk 3.1.2 → 3.1.4

package/dist/customer-sdk.js

@@ -105,43 +105,125 @@
 
   var _ref = {},
     hasOwnProperty = _ref.hasOwnProperty;
+  /**
+   * returns true or false depending if the provided property is present inside the provided object
+   * @example
+   * hasOwn('a', { a: 1, b: 2 })
+   * // returns true
+   */
   function hasOwn(prop, obj) {
     return hasOwnProperty.call(obj, prop);
   }
 
+  /**
+   * returns a new array formed by applying a given callback function to each element of the array, and then flattening the result by one level
+   * @example
+   * const arr = [{ a: [1, 2] }, { a: [3, 4] }, { a: [5, 6] }]
+   * flatMap(el => el.a, arr)
+   * // returns [1, 2, 3, 4, 5, 6]
+   */
   function flatMap(iteratee, arr) {
     var _ref;
     return (_ref = []).concat.apply(_ref, arr.map(iteratee));
   }
 
-  var isArray = Array.isArray;
+  /**
+   * determines whether provided value is an array
+   * @example
+   * isArray([1, 2])
+   * // returns true
+   * isArray('hello')
+   * // returns false
+   */
+  function isArray(arr) {
+    return Array.isArray(arr);
+  }
 
+  /**
+   * returns true or false depending if the provided value is an object
+   * @example
+   * isObject({ a: 1 })
+   * // returns true
+   * isObject([1, 2])
+   * // returns false
+   */
   // eslint-disable-next-line @typescript-eslint/ban-types
   function isObject(obj) {
     return typeof obj === 'object' && obj !== null && !isArray(obj);
   }
 
+  /**
+   * returns an array of the provided object keys
+   * @example
+   * keys({ a: 1, b: 2, c: 3 })
+   * // returns ['a', 'b', 'c']
+   */
+  function keys(obj) {
+    if ('keys' in Object && typeof Object.keys === 'function') {
+      return Object.keys(obj);
+    }
+    var keysArray = [];
+    for (var property in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, property)) {
+        keysArray.push(property);
+      }
+    }
+    return keysArray;
+  }
+
+  /**
+   * maps values of the provided object
+   * @example
+   * mapValues(val => val.toUpperCase(), { a: 'foo', b: 'bar' })
+   * // returns { a: 'FOO', b: 'BAR' }
+   */
   function mapValues(mapper, obj) {
-    return Object.keys(obj).reduce(function (acc, key) {
+    return keys(obj).reduce(function (acc, key) {
       acc[key] = mapper(obj[key]);
       return acc;
     }, {});
   }
 
+  /**
+   * returns the provided value
+   * @example
+   * identity('hello')
+   * // returns 'hello'
+   */
   function identity(value) {
     return value;
   }
 
+  /**
+   * generates a random id
+   * @example
+   * generateRandomId()
+   * // returns 'd1rjknhhch8'
+   */
   function generateRandomId() {
     return Math.random().toString(36).substring(2);
   }
 
+  /**
+   * generates an unique id based on the provided object keys
+   * @example
+   * generateUniqueId({ xuvarw8cao: 1, b837g2nba1d: 2 })
+   * // returns 'd1rjknhhch8'
+   */
   function generateUniqueId(map) {
     var id = generateRandomId();
     return hasOwn(id, map) ? generateUniqueId(map) : id;
   }
 
-  // based on https://github.com/developit/dlv/blob/d7ec976d12665f1c25dec2acf955dfc2e8757a9c/index.js
+  /**
+   * returns the value from the specififed path from the provided object
+   * @example
+   * const obj = { a: { b: [1, 2, 3] } }
+   * get('a.b.1', obj)
+   * // returns 2
+   * get(['a', 'b', '1'], obj)
+   * // returns 2
+   */
   function get(propPath, obj) {
     var arrPath = typeof propPath === 'string' ? propPath.split('.') : propPath;
     var pathPartIndex = 0;
@@ -152,14 +234,40 @@
     return result;
   }
 
+  /**
+   * returns true or false depending if the provided value is present inside the provided array or string
+   * @example
+   * includes('a', ['a', 'b', 'c'])
+   * // returns true
+   * includes('d', 'abc')
+   * // returns false
+   */
+
   function includes(value, arrOrStr) {
     return arrOrStr.indexOf(value) !== -1;
   }
 
+  /**
+   * returns true or false depending if the provided value is an empty object or an empty array
+   * @example
+   * isEmpty({})
+   * // returns true
+   */
   function isEmpty(collection) {
     return (isArray(collection) ? collection : Object.keys(collection)).length === 0;
   }
 
+  /**
+   * constructs an object from the provided array of objects, grouped by the value of the specified key
+   * @example
+   * const arr = [
+   * 	{ a: 'foo', b: 'bar' },
+   * 	{ a: 'foo', b: 'baz' },
+   * 	{ a: 'test', b: 'bab' },
+   * ]
+   * keyBy('a', arr)
+   * // returns { foo: { a: 'foo', b: 'baz' }, test: { a: 'test', b: 'bab' } }
+   */
   function keyBy(prop, arr) {
     return arr.reduce(function (acc, el) {
       acc[el[prop]] = el;
@@ -167,20 +275,47 @@
     }, {});
   }
 
-  // TODO: this  should return `T | undefined` to match native behavior
+  /**
+   * returns the last element of the provided array or undefined when array is empty
+   * @example
+   * last([1, 2, 3])
+   * // returns 3
+   */
   function last(arr) {
-    return arr.length > 0 ? arr[arr.length - 1] : null;
+    return arr.length > 0 ? arr[arr.length - 1] : undefined;
   }
 
+  /**
+   * does literally nothing
+   * @example
+   * somethingAsyncAndDangerous().catch(noop)
+   */
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   function noop() {}
 
+  /**
+   * returns an array of values of the provided object
+   * @example
+   * values({ a: 1, b: 2, c: 3 })
+   * // returns [1, 2, 3]
+   */
   function values(obj) {
-    return Object.keys(obj).map(function (key) {
+    return keys(obj).map(function (key) {
       return obj[key];
     });
   }
 
+  /**
+   * sorts values of the provided object or array based on the provided mapping function or the provided prop string
+   * @example
+   * const obj = {
+   * 	a: { chats: 1 },
+   * 	b: { chats: 3 },
+   * 	c: { chats: 2 },
+   * }
+   * numericSortBy(el => el.chats * -1, obj)
+   * // returns [{ chats: 3 }, { chats: 2 }, { chats: 1 }]
+   */
   function numericSortBy(propOrMapper, collection) {
     var mapper = typeof propOrMapper === 'function' ? propOrMapper : function (element) {
       return get(propOrMapper, element);
@@ -190,13 +325,25 @@
     });
   }
 
-  function pick(props, obj) {
-    return props.reduce(function (acc, prop) {
+  /**
+   * picks specified properties from the object
+   * @example
+   * pick(['b'], { a: 1, b: 2 })
+   * // returns { b: 2 }
+   */
+  function pick(keys, obj) {
+    return keys.reduce(function (acc, prop) {
       acc[prop] = obj[prop];
       return acc;
     }, {});
   }
 
+  /**
+   * picks specified props only if they exist on the provided object
+   * @example
+   * pickOwn(['b'], { a: 1, b: 2 })
+   * // returns { b: 2 }
+   */
   function pickOwn(props, obj) {
     return props.reduce(function (acc, prop) {
       if (hasOwn(prop, obj)) {
@@ -206,19 +353,41 @@
     }, {});
   }
 
-  var toPairs = function toPairs(obj) {
-    return Object.keys(obj).map(function (key) {
+  /**
+   * returns an array of derived from the provided object key-value tuples
+   * @example
+   * toPairs({ a: 1, b: 2 })
+   * // returns [['a', 1], ['b', 2]]
+   */
+  function toPairs(obj) {
+    return keys(obj).map(function (key) {
       return [key, obj[key]];
     });
-  };
+  }
 
-  var stringCompare = function stringCompare(strA, strB) {
+  /**
+   * returns 0 for matching strings
+   * return -1 for string with lower char code at some position
+   * return 1 for string with greater char code at some position
+   * @example
+   * stringCompare('abc', 'abc')
+   * // returns 0
+   * stringCompare('abc', 'abd')
+   * // returns -1
+   */
+  function stringCompare(strA, strB) {
     if (strA === strB) {
       return 0;
     }
     return strA < strB ? -1 : 1;
-  };
+  }
 
+  /**
+   * returns an array with all the duplicates from the provided array removed based on the iteratee function
+   * @example
+   * uniqBy(el => el.toString(), [1, '1', 2, '3', 3])
+   * // returns [1, 2, '3']
+   */
   function uniqBy(iteratee, arr) {
     // with polyfills this could be just: return Array.from(new Set(arr.map(iteratee)))
     var seen = [];
@@ -309,25 +478,18 @@
     });
   }
 
-  function getRoot() {
-    return new Promise(function (resolve) {
-      var next = function next() {
-        if (!document.body) {
-          setTimeout(next, 100);
-          return;
-        }
-        resolve(document.body);
-      };
-      next();
-    });
-  }
-
-  function removeNode(node) {
-    var parentNode = node.parentNode;
-    if (parentNode) {
-      parentNode.removeChild(node);
-    }
-  }
+  var ACCOUNTS_URL = "https://accounts.livechatinc.com";
+  var buildPath = function buildPath(_ref) {
+    var uniqueGroups = _ref.uniqueGroups,
+      organizationId = _ref.organizationId,
+      groupId = _ref.groupId;
+    return "" + (uniqueGroups ? "/v2/customer/" + organizationId + "/" + groupId + "/token" : '/v2/customer/token');
+  };
+  var buildRequestUrl = function buildRequestUrl(config, env) {
+    var url = env === 'production' ? ACCOUNTS_URL : ACCOUNTS_URL.replace('accounts.', "accounts." + env + ".");
+    var path = buildPath(config);
+    return "" + url + path;
+  };
 
   var createError = function createError(_ref) {
     var code = _ref.code,
@@ -337,7 +499,7 @@
     return err;
   };
 
-  var parseTokenResponse = function parseTokenResponse(token, licenseId) {
+  var parseTokenResponse = function parseTokenResponse(token, organizationId) {
     if ('identity_exception' in token) {
       throw createError({
         code: 'SSO_IDENTITY_EXCEPTION',
@@ -356,119 +518,33 @@
       expiresIn: token.expires_in * 1000,
       tokenType: token.token_type,
       creationDate: Date.now(),
-      licenseId: licenseId
+      organizationId: organizationId
     };
   };
 
-  var ACCOUNTS_URL = "https://accounts.livechatinc.com";
-  var buildPath = function buildPath(_ref) {
-    var uniqueGroups = _ref.uniqueGroups,
-      licenseId = _ref.licenseId,
-      groupId = _ref.groupId;
-    return (uniqueGroups ? "/licence/g" + licenseId + "_" + groupId : '') + "/customer";
-  };
-  var buildRequestUrl = function buildRequestUrl(config, env) {
-    var url = env === 'production' ? ACCOUNTS_URL : ACCOUNTS_URL.replace('accounts.', "accounts." + env + ".");
-    var path = buildPath(config);
-    return "" + url + path;
-  };
-
-  var POST_MESSAGE_ORIGIN = 'https://accounts.livechatinc.com';
-  var CUSTOMER_AUTH_FOOTPRINT = '@livechat/customer-auth';
-  var getPostMessageOrigin = function getPostMessageOrigin(env) {
-    return env === 'production' ? POST_MESSAGE_ORIGIN : POST_MESSAGE_ORIGIN.replace('accounts.', "accounts." + env + ".");
-  };
-  var buildParams = function buildParams(_ref, redirectUri) {
-    var clientId = _ref.clientId,
-      licenseId = _ref.licenseId;
-    return {
-      license_id: String(licenseId),
-      flow: 'button',
-      response_type: 'token',
-      client_id: clientId,
-      redirect_uri: redirectUri,
-      post_message_uri: redirectUri,
-      state: CUSTOMER_AUTH_FOOTPRINT
-    };
-  };
-  var buildIframe = function buildIframe(config, env) {
-    var redirectUri = getOrigin(String(window.location)) + window.location.pathname;
-    var params = buildParams(config, redirectUri);
-    var iframe = document.createElement('iframe');
-    iframe.style.display = 'none';
-    iframe.setAttribute('src', buildRequestUrl(config, env) + "?" + buildQueryString(params));
-    return iframe;
-  };
-  var isTokenResponse = function isTokenResponse(data) {
-    return data && data.state === CUSTOMER_AUTH_FOOTPRINT;
-  };
-  function fetchUsingIframe(config, env) {
-    var licenseId = config.licenseId;
-    var postMessageOrigin = getPostMessageOrigin(env);
-    return new Promise(function (resolve, reject) {
-      var iframe = buildIframe(config, env);
-      var cleanup = function cleanup() {
-        removeNode(iframe);
-        // eslint-disable-next-line no-use-before-define
-        window.removeEventListener('message', listener, false);
-      };
-      var timeoutId = setTimeout(function () {
-        cleanup();
-        reject(createError({
-          message: 'Request timed out.',
-          code: 'REQUEST_TIMEOUT'
-        }));
-      }, 15 * 1000);
-      var listener = function listener(_ref2) {
-        var origin = _ref2.origin,
-          data = _ref2.data;
-        if (origin !== postMessageOrigin) {
-          return;
-        }
-        if (!isTokenResponse(data)) {
-          return;
-        }
-        clearTimeout(timeoutId);
-        cleanup();
-        try {
-          resolve(parseTokenResponse(data, licenseId));
-        } catch (err) {
-          reject(err);
-        }
-      };
-      window.addEventListener('message', listener, false);
-      getRoot().then(function (body) {
-        body.appendChild(iframe);
-      });
-    });
-  }
-
   var fetchToken = function fetchToken(config, env) {
-    if (config.uniqueGroups) {
-      return fetchUsingIframe(config, env);
-    }
-    return unfetch(buildRequestUrl(config, env) + "/token", {
+    return unfetch("" + buildRequestUrl(config, env), {
       method: 'POST',
       credentials: 'include',
       body: JSON.stringify({
         response_type: 'token',
         grant_type: 'cookie',
         client_id: config.clientId,
-        license_id: config.licenseId,
+        organization_id: config.organizationId,
         redirect_uri: getOrigin(String(window.location)) + window.location.pathname
       })
     }).then(function (res) {
       return res.json();
     }).then(function (token) {
-      return parseTokenResponse(token, config.licenseId);
+      return parseTokenResponse(token, config.organizationId);
     });
   };
 
   var validateConfig = function validateConfig(_ref) {
-    var licenseId = _ref.licenseId,
+    var organizationId = _ref.organizationId,
       clientId = _ref.clientId;
-    if (typeof licenseId !== 'number' || typeof clientId !== 'string') {
-      throw new Error('You need to pass valid configuration object: { licenseId, clientId }.');
+    if (typeof organizationId !== 'string' || typeof clientId !== 'string') {
+      throw new Error('You need to pass valid configuration object: { organizationId, clientId }.');
     }
   };
 
@@ -477,25 +553,39 @@
       expiresIn = _ref.expiresIn;
     return Date.now() >= creationDate + expiresIn;
   };
-  var createAuth = function createAuth(config, env) {
+  var createAuth = function createAuth(config, licenseId, env) {
     validateConfig(config);
-    var cacheKey = "" + "@@lc_auth_token:" + config.licenseId + (config.uniqueGroups ? ":" + config.groupId : '');
+    var tokenStoragePrefix = config.tokenStoragePrefix || "@@lc_auth_token:";
+    var oldCacheKey = "" + tokenStoragePrefix + licenseId + (config.uniqueGroups ? ":" + config.groupId : '');
+    var newCacheKey = "" + tokenStoragePrefix + config.organizationId + (config.uniqueGroups ? ":" + config.groupId : '');
     var pendingTokenRequest = null;
     var cachedToken = null;
-    var retrievingToken = storage.getItem(cacheKey).then(function (token) {
+    var retrievingToken = storage.getItem(oldCacheKey).then(function (token) {
       if (retrievingToken === null) {
         return;
       }
       retrievingToken = null;
       if (!token) {
+        storage.removeItem(oldCacheKey).then(function () {
+          return storage.getItem(newCacheKey).then(function (newKeyToken) {
+            if (!newKeyToken) {
+              return;
+            }
+            cachedToken = JSON.parse(newKeyToken);
+          });
+        });
         return;
       }
-      cachedToken = JSON.parse(token);
+      storage.setItem(newCacheKey, token).then(function () {
+        storage.removeItem(oldCacheKey).then(function () {
+          cachedToken = JSON.parse(token);
+        });
+      });
     });
     var getFreshToken = function getFreshToken() {
       pendingTokenRequest = fetchToken(config, env).then(function (token) {
         pendingTokenRequest = null;
-        storage.setItem(cacheKey, JSON.stringify(token));
+        storage.setItem(newCacheKey, JSON.stringify(token));
         cachedToken = token;
         return token;
       }, function (err) {
@@ -525,7 +615,7 @@
     var invalidate = function invalidate() {
       cachedToken = null;
       retrievingToken = null;
-      return storage.removeItem(cacheKey);
+      return storage.removeItem(newCacheKey);
     };
     return {
       getFreshToken: getFreshToken,
@@ -1094,13 +1184,47 @@
     return sideEffectsMiddleware;
   };
 
-  function deferred() {
-    var def = {};
-    def.promise = new Promise(function (resolve, reject) {
-      def.resolve = resolve;
-      def.reject = reject;
+  var createBackoff = function createBackoff(_ref) {
+    var _ref$min = _ref.min,
+      min = _ref$min === void 0 ? 1000 : _ref$min,
+      _ref$max = _ref.max,
+      max = _ref$max === void 0 ? 5000 : _ref$max,
+      _ref$jitter = _ref.jitter,
+      jitter = _ref$jitter === void 0 ? 0.5 : _ref$jitter;
+    var attempts = 0;
+    return {
+      duration: function duration() {
+        var ms = min * Math.pow(2, attempts++);
+        if (jitter) {
+          var rand = Math.random();
+          var deviation = Math.floor(rand * jitter * ms);
+          ms = (Math.floor(rand * 10) & 1) === 0 ? ms - deviation : ms + deviation;
+        }
+        return Math.min(ms, max) | 0;
+      },
+      reset: function reset() {
+        attempts = 0;
+      }
+    };
+  };
+
+  /**
+   * Creates a deferred object that can be resolved or rejected later.
+   * @returns A deferred object with a promise and resolve and reject functions.
+   * @example
+   * const def = promiseDeferred()
+   * const promise = def.promise
+   * def.resolve(1)
+   * return promise.then(res => console.log(res)) // 1
+   */
+
+  function promiseDeferred() {
+    var deferred = {};
+    deferred.promise = new Promise(function (resolve, reject) {
+      deferred.resolve = resolve;
+      deferred.reject = reject;
     });
-    return def;
+    return deferred;
   }
 
   var createReducer = function createReducer(initialState, reducersMap) {
@@ -1185,7 +1309,7 @@
     return {
       application: _extends({}, application, {
         name: "customer_sdk",
-        version: "3.1.2"
+        version: "3.1.4"
       }),
       licenseId: licenseId,
       env: env,
@@ -1638,6 +1762,15 @@
     };
   };
 
+  function deferred() {
+    var def = {};
+    def.promise = new Promise(function (resolve, reject) {
+      def.resolve = resolve;
+      def.reject = reject;
+    });
+    return def;
+  }
+
   // TODO: this thing is not really well typed and should be improved
   var sendRequestAction = function sendRequestAction(store, action) {
     action.payload.id = generateUniqueId(store.getState().requests);
@@ -1652,34 +1785,10 @@
     return promise;
   };
 
-  var promiseTry = (function (fn) {
+  var index$1 = function (fn) {
     return new Promise(function (resolve) {
       resolve(fn());
     });
-  });
-
-  var createBackoff = function createBackoff(_ref) {
-    var _ref$min = _ref.min,
-      min = _ref$min === void 0 ? 1000 : _ref$min,
-      _ref$max = _ref.max,
-      max = _ref$max === void 0 ? 5000 : _ref$max,
-      _ref$jitter = _ref.jitter,
-      jitter = _ref$jitter === void 0 ? 0.5 : _ref$jitter;
-    var attempts = 0;
-    return {
-      duration: function duration() {
-        var ms = min * Math.pow(2, attempts++);
-        if (jitter) {
-          var rand = Math.random();
-          var deviation = Math.floor(rand * jitter * ms);
-          ms = (Math.floor(rand * 10) & 1) === 0 ? ms - deviation : ms + deviation;
-        }
-        return Math.min(ms, max) | 0;
-      },
-      reset: function reset() {
-        attempts = 0;
-      }
-    };
   };
 
   var AUTHENTICATION = 'AUTHENTICATION';
@@ -1712,7 +1821,7 @@
     var cancelled = false;
     var next = function next(intermediateResult) {
       var step = steps.shift();
-      promiseTry(function () {
+      index$1(function () {
         return step(intermediateResult);
       }).then(function (result) {
         if (cancelled) {
@@ -2993,14 +3102,14 @@
         resolve = noop;
       },
       check: function check() {
-        var deferred$1 = deferred();
-        resolve = deferred$1.resolve;
+        var deferred = promiseDeferred();
+        resolve = deferred.resolve;
         timer = setTimeout(function () {
           var err = new Error('Timeout.');
           err.code = 'TIMEOUT';
-          deferred$1.reject(err);
+          deferred.reject(err);
         }, 2000);
-        return deferred$1.promise;
+        return deferred.promise;
       },
       resolve: function (_resolve) {
         function resolve() {
@@ -4154,7 +4263,7 @@
     var message = {
       event_name: eventName,
       severity: 'Informational',
-      sdkVersion: "3.1.2"
+      sdkVersion: "3.1.4"
     };
     var body = {
       licence_id: licenseId,