@livechat/customer-sdk 3.1.2 → 3.1.3

package/README.md

@@ -69,21 +69,21 @@ If you just want to look around and play with the SDK, check out our
 [sample chat widget implementation](https://codesandbox.io/s/rm3prxw88n).
 
 For the time being you need to register your application in the <a href="https://developers.livechat.com/console" target="_blank">Developers Console</a>
-as a "Web app (frontend, eg. JavaScript)" type. Then, you have to pass the configured `redirectUri` to the `init`, along with the regular required properties (`licenseId` and `clientId`).
+as a "Web app (frontend, eg. JavaScript)" type. Then, you have to pass the configured `redirectUri` to the `init`, along with the regular required properties (`organizationId` and `clientId`).
 
 ## Using the API
 
 To use the API you will first need to create an instance using the `init` function.
-You will need to provide your licenseId and clientId when creating a Customer SDK instance.
+You will need to provide your organizationId and clientId when creating a Customer SDK instance.
 
 Other optional configuration parameters are also available:
 
 | parameters           | type               | default | description                                                                                                                                                                                                                                                         |
 | -------------------- | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| licenseId            | number             |         | Your license number, you receive this value when creating a new livechat account.                                                                                                                                                                                   |
+| organizationId       | number             |         | Your Organization ID, you receive this value when creating a new livechat account.                                                                                                                                                                                  |
 | clientId             | string             |         | Your client id, you receive this value when you register your application in the LiveChat Developer Console.                                                                                                                                                        |
 | autoConnect          | boolean            | true    | Optional; should the library try to reconnect on it's own.                                                                                                                                                                                                          |
-| groupId              | number             |         | Optional; the id of the group you wish to connect to.                                                                                                                                                                                                               |
+| groupId              | number             | 0       | Optional; the id of the group you wish to connect to.                                                                                                                                                                                                               |
 | uniqueGroups         | boolean            | false   | Optional; by default, the customer's identity is the same for all groups. If you want to create a separate customer identity for each group, set this parameter to `true`. When set to `true`, passing a `groupId` is required.                                     |
 | region               | 'dal' \| 'fra'     | 'dal'   | Optional; the server region your license is at.                                                                                                                                                                                                                     |
 | redirectUri          | string             |         | Optional; should only be used inside ReactNative, this is the URI which your webview is redirected to after authorization.                                                                                                                                          |
@@ -111,7 +111,7 @@ The `init` function will return a Customer SDK instance:
 
 ```js
 const customerSDK = CustomerSDK.init({
-  licenseId: LICENSE_ID,
+  organizationId: ORGANIZATION_ID,
   clientId: CLIENT_ID,
 })
 ```
@@ -163,7 +163,7 @@ export default class App extends React.Component {
 
   componentDidMount() {
     this.customerSDK = init({
-      licenseId: LICENSE_ID,
+      organizationId: ORGANIZATION_ID,
       clientId: CLIENT_ID,
       redirectUri: REDIRECT_URI,
     })
@@ -1003,7 +1003,7 @@ Parameters:
 ### Errors
 
 - `CHAT_ALREADY_ACTIVE` - the chat is already active and you can't activate it again.
-- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen for licenses without continuous chats enabled.
+- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen when asynchronous communication is disabled.
 
 ## sendEvent
 
@@ -1212,7 +1212,7 @@ Parameters:
 ### Errors
 
 - `CHAT_LIMIT_REACHED` - the maximum limit of chats per Customer has been reached, and it's not possible to start a new one. You should activate one of the existing chats. The limit is 1.
-- `GROUPS_OFFLINE` - a group in the target chat is offline. It can happen for licenses, which don't allow Customers to chat during their unavailability.
+- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen when asynchronous communication is disabled.
 
 ## updateChatProperties
 
@@ -2085,11 +2085,11 @@ Internal error. Customer SDK reconnects on its own.
 
 ## License expired
 
-The license with the specified ID has expired. You should make sure that there are no unpaid invoices for it.
+The subscription for LiveChat product associated with the specified ID has expired. You should make sure that there are no unpaid invoices for it.
 
 ## License not found
 
-The license with the specified ID doesn't exist. You should check the options passed in to Customer SDK and make sure that the license parameter is correct.
+The LiveChat product associated with the specified ID doesn't exist. You should check the options passed in to Customer SDK and make sure that the parameters provided are correct.
 
 This internally destroys the current instance of Customer SDK, so it won't be possible to reuse it.
 
@@ -2197,6 +2197,14 @@ customerSDK.on('disconnected', ({ reason }) => {
 
 # Changelog
 
+## [v4.0.0] - XXXX-XX-X
+
+### Changed
+
+Switched to using Customer API 3.4:
+
+- Drop support for the `licenseId` parameter in the `init` method. It has been replaced by the `organizationId`.
+
 ## [v3.1.2] - 2023-02-28
 
 ### Fixed

package/dist/customer-sdk.cjs.js

@@ -7,8 +7,7 @@ var mitt = require('@livechat/mitt');
 var dataUtils = require('@livechat/data-utils');
 var redux = require('redux');
 var createSideEffectsMiddleware = require('@livechat/side-effects-middleware');
-var deferred = require('@livechat/deferred');
-var promiseTry = require('@livechat/promise-try');
+var promiseUtils = require('@livechat/promise-utils');
 var createBackoff = require('@livechat/backoff');
 var storage = require('@livechat/isomorphic-storage');
 var unfetch = require('unfetch');
@@ -21,8 +20,6 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var createAuth__default = /*#__PURE__*/_interopDefaultLegacy(createAuth);
 var mitt__default = /*#__PURE__*/_interopDefaultLegacy(mitt);
 var createSideEffectsMiddleware__default = /*#__PURE__*/_interopDefaultLegacy(createSideEffectsMiddleware);
-var deferred__default = /*#__PURE__*/_interopDefaultLegacy(deferred);
-var promiseTry__default = /*#__PURE__*/_interopDefaultLegacy(promiseTry);
 var createBackoff__default = /*#__PURE__*/_interopDefaultLegacy(createBackoff);
 var storage__default = /*#__PURE__*/_interopDefaultLegacy(storage);
 var unfetch__default = /*#__PURE__*/_interopDefaultLegacy(unfetch);
@@ -157,6 +154,8 @@ var RECONNECTING = 'reconnecting';
 var AGENT = 'agent';
 var CUSTOMER = 'customer';
 
+var LIVECHAT_ORGANIZATION_ID = 'feaf6c0e-9f43-48ff-9ad0-8e24e0350932';
+
 var getAllRequests = function getAllRequests(state) {
   return state.requests;
 };
@@ -180,9 +179,9 @@ var isDestroyed = function isDestroyed(state) {
   return getConnectionStatus(state) === DESTROYED;
 };
 var getEnvPart = function getEnvPart(_ref) {
-  var licenseId = _ref.licenseId,
+  var organizationId = _ref.organizationId,
     env = _ref.env;
-  if (licenseId === 1520) {
+  if (organizationId === LIVECHAT_ORGANIZATION_ID) {
     return '.staging';
   }
   if (env === 'production') {
@@ -196,12 +195,12 @@ var getApiOrigin = function getApiOrigin(state) {
   return "https://api" + regionPart + getEnvPart(state) + ".livechatinc.com";
 };
 var getServerUrl = function getServerUrl(state) {
-  return getApiOrigin(state) + "/v3.3/customer";
+  return getApiOrigin(state) + "/v3.4/customer";
 };
 var createInitialState = function createInitialState(initialStateData) {
   var _initialStateData$app = initialStateData.application,
     application = _initialStateData$app === void 0 ? {} : _initialStateData$app,
-    licenseId = initialStateData.licenseId,
+    organizationId = initialStateData.organizationId,
     _initialStateData$gro = initialStateData.groupId,
     groupId = _initialStateData$gro === void 0 ? null : _initialStateData$gro,
     env = initialStateData.env,
@@ -218,9 +217,9 @@ var createInitialState = function createInitialState(initialStateData) {
   return {
     application: _extends({}, application, {
       name: "customer_sdk",
-      version: "3.1.2"
+      version: "3.1.3"
     }),
-    licenseId: licenseId,
+    organizationId: organizationId,
     env: env,
     groupId: groupId,
     chats: {},
@@ -674,10 +673,10 @@ var socketDisconnected = function socketDisconnected() {
 // TODO: this thing is not really well typed and should be improved
 var sendRequestAction = function sendRequestAction(store, action) {
   action.payload.id = dataUtils.generateUniqueId(store.getState().requests);
-  var _deferred = deferred__default['default'](),
-    resolve = _deferred.resolve,
-    reject = _deferred.reject,
-    promise = _deferred.promise;
+  var _promiseDeferred = promiseUtils.promiseDeferred(),
+    resolve = _promiseDeferred.resolve,
+    reject = _promiseDeferred.reject,
+    promise = _promiseDeferred.promise;
   action.payload.promise = promise;
   action.payload.resolve = resolve;
   action.payload.reject = reject;
@@ -690,24 +689,39 @@ var CUSTOMER_BANNED$1 = 'CUSTOMER_BANNED';
 var USERS_LIMIT_REACHED = 'USERS_LIMIT_REACHED';
 var WRONG_PRODUCT_VERSION = 'WRONG_PRODUCT_VERSION';
 
-var getSideStorageKey = function getSideStorageKey(store) {
+var getSideStorageKeyByLicense = function getSideStorageKeyByLicense(store, licenseId) {
   var _store$getState = store.getState(),
-    licenseId = _store$getState.licenseId,
     groupId = _store$getState.groupId,
     uniqueGroups = _store$getState.uniqueGroups;
   return "side_storage_" + licenseId + (uniqueGroups ? ":" + groupId : '');
 };
-var getSideStorage = function getSideStorage(store) {
-  return storage__default['default'].getItem(getSideStorageKey(store))["catch"](dataUtils.noop).then(function (sideStorage) {
-    return JSON.parse(sideStorage || '{}');
+var getSideStorageKeyByOrganization = function getSideStorageKeyByOrganization(store) {
+  var _store$getState2 = store.getState(),
+    organizationId = _store$getState2.organizationId,
+    groupId = _store$getState2.groupId,
+    uniqueGroups = _store$getState2.uniqueGroups;
+  return "side_storage_" + organizationId + (uniqueGroups ? ":" + groupId : '');
+};
+var getSideStorage = function getSideStorage(store, licenseId) {
+  var sideStorageLicenseKey = getSideStorageKeyByLicense(store, licenseId);
+  var sideStorageOrganizationKey = getSideStorageKeyByOrganization(store);
+  return storage__default['default'].getItem(sideStorageLicenseKey)["catch"](dataUtils.noop).then(function (sideStorage) {
+    if (!sideStorage) {
+      return storage__default['default'].getItem(sideStorageOrganizationKey)["catch"](dataUtils.noop).then(function (organizationSideStorage) {
+        return JSON.parse(organizationSideStorage || '{}');
+      })["catch"](dataUtils.noop);
+    }
+    return storage__default['default'].setItem(sideStorageOrganizationKey, sideStorage)["catch"](dataUtils.noop).then(function () {
+      return storage__default['default'].removeItem(sideStorageLicenseKey)["catch"](dataUtils.noop).then(function () {
+        return JSON.parse(sideStorage);
+      })["catch"](dataUtils.noop);
+    });
   })
   // shouldnt get triggered, just a defensive measure against malformed storage entries
-  ["catch"](function () {
-    return {};
-  });
+  ["catch"](dataUtils.noop);
 };
 var saveSideStorage = function saveSideStorage(store, sideStorage) {
-  return storage__default['default'].setItem(getSideStorageKey(store), JSON.stringify(sideStorage))["catch"](dataUtils.noop);
+  storage__default['default'].setItem(getSideStorageKeyByOrganization(store), JSON.stringify(sideStorage))["catch"](dataUtils.noop);
 };
 
 var taskChain = function taskChain(_ref, onSuccess, onError) {
@@ -715,7 +729,7 @@ var taskChain = function taskChain(_ref, onSuccess, onError) {
   var cancelled = false;
   var next = function next(intermediateResult) {
     var step = steps.shift();
-    promiseTry__default['default'](function () {
+    promiseUtils.promiseTry(function () {
       return step(intermediateResult);
     }).then(function (result) {
       if (cancelled) {
@@ -748,7 +762,7 @@ var delay = function delay(ms) {
     setTimeout(resolve, ms);
   });
 };
-function createLoginTask(auth, customerDataProvider) {
+function createLoginTask(auth, customerDataProvider, licenseId) {
   var store;
   var sentPage = null;
   var task;
@@ -769,7 +783,7 @@ function createLoginTask(auth, customerDataProvider) {
     return store.dispatch(reconnect(currentBackoffStrategy.duration()));
   };
   var getTokenAndSideStorage = function getTokenAndSideStorage() {
-    return Promise.all([auth.getToken(), getSideStorage(store)]);
+    return Promise.all([auth.getToken(), getSideStorage(store, licenseId)]);
   };
   var dispatchSelfId = function dispatchSelfId(_ref2) {
     var token = _ref2[0],
@@ -909,7 +923,7 @@ var checkGoals = function checkGoals(store, auth, sessionFields) {
       return;
     }
     var query = urlUtils.buildQueryString({
-      license_id: state.licenseId
+      organization_id: state.organizationId
     });
     var payload = {
       session_fields: parseCustomerSessionFields(sessionFields || {}),
@@ -1408,11 +1422,11 @@ var sendRequest$1 = function sendRequest(socket, _ref3) {
       {
         var upgradedPushes = [];
         socket.emit(_extends({}, frame, {
-          version: '3.3',
+          version: '3.4',
           payload: _extends({}, frame.payload, {
             pushes: {
-              // '3.4': upgradedPushes,
-              '3.3': dataUtils.values(serverPushActions).filter(function (pushAction) {
+              // '3.5': upgradedPushes,
+              '3.4': dataUtils.values(serverPushActions).filter(function (pushAction) {
                 return (
                   // `customer_disconnected` can be sent immediately after opening the connection, before it even received login request
                   // therefore it's not possible to subscribe for a particular version of this push - the "connection version" is always used
@@ -1582,9 +1596,10 @@ var createSideEffectsHandler = (function (_ref9) {
   var auth = _ref9.auth,
     customerDataProvider = _ref9.customerDataProvider,
     emitter = _ref9.emitter,
-    socket = _ref9.socket;
+    socket = _ref9.socket,
+    licenseId = _ref9.licenseId;
   var emit = emitter.emit;
-  var loginTask = createLoginTask(auth, customerDataProvider);
+  var loginTask = createLoginTask(auth, customerDataProvider, licenseId);
 
   // TODO: using Store type here is a lie, middleware only provides MiddlewareAPI here
   return function (action, store) {
@@ -1881,7 +1896,7 @@ var initialize = function initialize(store, emitter) {
   var url = (getServerUrl(state) + "/rtm/ws").replace(/^https/, 'wss');
   return createPlatformClient__default['default'](url, {
     query: {
-      license_id: state.licenseId
+      organization_id: state.organizationId
     },
     emitter: emitter
   });
@@ -2173,16 +2188,17 @@ var parseListChatsResponse = function parseListChatsResponse(payload) {
     var lastEventSummary = dataUtils.last(lastEventSummariesArray.sort(function (eventSummaryA, eventSummaryB) {
       return eventSummaryA.thread_id === eventSummaryB.thread_id ? dataUtils.stringCompare(eventSummaryA.event.created_at, eventSummaryB.event.created_at) : dataUtils.stringCompare(eventSummaryA.thread_created_at, eventSummaryB.thread_created_at);
     }));
-    if (lastEventSummary) {
+    if (lastEventSummary && chatSummary.lastEventsPerType) {
       chatSummary.lastEvent = chatSummary.lastEventsPerType[lastEventSummary.event.type];
     }
     return chatSummary;
   });
   return {
     chatsSummary: dataUtils.numericSortBy(function (_ref4) {
+      var _ref5;
       var lastEvent = _ref4.lastEvent,
         order = _ref4.order;
-      return -1 * (lastEvent !== undefined ? lastEvent.timestamp : order);
+      return -1 * ((_ref5 = lastEvent !== undefined ? lastEvent.timestamp : order) != null ? _ref5 : 0);
     }, chatsSummary),
     totalChats: payload.total_chats,
     users: dataUtils.uniqBy(function (user) {
@@ -2359,9 +2375,9 @@ var parsePush = function parsePush(push) {
       };
   }
 };
-var parseResponse = function parseResponse(_ref5) {
-  var request = _ref5.request,
-    response = _ref5.response;
+var parseResponse = function parseResponse(_ref6) {
+  var request = _ref6.request,
+    response = _ref6.response;
   switch (response.action) {
     case ACCEPT_GREETING:
       return {
@@ -2615,9 +2631,10 @@ var createTicketBody = function createTicketBody(state, _ref) {
     customerId = _ref.customerId,
     _ref$groupId = _ref.groupId,
     groupId = _ref$groupId === void 0 ? state.groupId : _ref$groupId,
+    licenseId = _ref.licenseId,
     timeZone = _ref.timeZone;
   var ticketBody = _extends({
-    licence_id: state.licenseId,
+    licence_id: licenseId,
     ticket_message: '',
     offline_message: '',
     visitor_id: customerId,
@@ -2697,6 +2714,7 @@ var createTicketBody = function createTicketBody(state, _ref) {
 var sendTicketForm = function sendTicketForm(store, auth, _ref2) {
   var filledForm = _ref2.filledForm,
     groupId = _ref2.groupId,
+    licenseId = _ref2.licenseId,
     timeZone = _ref2.timeZone;
   return auth.getToken().then(function (token) {
     var state = store.getState();
@@ -2708,6 +2726,7 @@ var sendTicketForm = function sendTicketForm(store, auth, _ref2) {
       fields: filledForm.fields,
       customerId: token.entityId,
       groupId: groupId,
+      licenseId: licenseId,
       timeZone: timeZone
     });
     return unfetch__default['default'](url, {
@@ -2792,7 +2811,7 @@ var uploadFile = function uploadFile(_ref, _ref2) {
     validateFile(file);
     var state = store.getState();
     var query = urlUtils.buildQueryString({
-      license_id: state.licenseId
+      organization_id: state.organizationId
     });
     var url = getServerUrl(state) + "/action/" + UPLOAD_FILE + "?" + query;
     var payload = {
@@ -2858,7 +2877,7 @@ var makeGraylogRequest = function makeGraylogRequest(url, body) {
  */
 var log = function log(_ref) {
   var env = _ref.env,
-    licenseId = _ref.licenseId,
+    organizationId = _ref.organizationId,
     eventName = _ref.eventName;
   if (env !== 'production' || "customer_sdk" !== 'customer_sdk') {
     return Promise.resolve();
@@ -2866,10 +2885,10 @@ var log = function log(_ref) {
   var message = {
     event_name: eventName,
     severity: 'Informational',
-    sdkVersion: "3.1.2"
+    sdkVersion: "3.1.3"
   };
   var body = {
-    licence_id: licenseId,
+    organizationId: organizationId,
     event_id: 'chat_widget_customer_sdk',
     message: JSON.stringify(message)
   };
@@ -2987,7 +3006,7 @@ var debug = (function (_sdk) {
 });
 
 var CHATS_PAGINATION_MAX_LIMIT = 25;
-var init = function init(config, env) {
+var init = function init(config, env, licenseId) {
   if (env === void 0) {
     env = 'production';
   }
@@ -3002,12 +3021,13 @@ var init = function init(config, env) {
   }));
   var emitter = mitt__default['default']();
   var socket = createSocketClient(store);
-  var auth = typeof identityProvider === 'function' ? identityProvider() : createAuth__default['default'](instanceConfig, env);
+  var auth = typeof identityProvider === 'function' ? identityProvider() : createAuth__default['default'](instanceConfig, licenseId, env);
   store.addSideEffectsHandler(createSideEffectsHandler({
     emitter: emitter,
     socket: socket,
     auth: auth,
-    customerDataProvider: customerDataProvider
+    customerDataProvider: customerDataProvider,
+    licenseId: licenseId
   }));
   socketListener(store, socket);
   var sendRequestAction$1 = sendRequestAction.bind(null, store);
@@ -3206,7 +3226,7 @@ var init = function init(config, env) {
     resumeChat: function resumeChat(data) {
       log({
         env: env,
-        licenseId: config.licenseId,
+        organizationId: config.organizationId,
         eventName: 'chat_started'
       });
       return sendRequestAction$1(sendRequest(RESUME_CHAT, parseResumeChatData(data)));
@@ -3261,7 +3281,7 @@ var init = function init(config, env) {
       }
       log({
         env: env,
-        licenseId: config.licenseId,
+        organizationId: config.organizationId,
         eventName: 'chat_started'
       });
       return sendRequestAction$1(sendRequest(START_CHAT, parseStartChatData(data)));