@atlaskit/collab-provider 7.4.2 → 7.5.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/collab-provider
 
+## 7.5.0
+
+### Minor Changes
+
+- [`1c555e79e56`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1c555e79e56) - Added the capability to pass product information (product & sub-product) to the collab service
+- [`247420a48f7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/247420a48f7) - [ESS-1050] Return ADF document from getFinalAcknowledgedState
+- [`17f1b0b87cc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/17f1b0b87cc) - ESS-1019 changes the reconnectionDelayMax to 128s to reduce the reconnection storm.
+
+### Patch Changes
+
+- [`bf848f39cb1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bf848f39cb1) - ESS-2419 Emit the reason of permission errors to the consumers of collab-provider
+- [`680dc155ebc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/680dc155ebc) - Raise errors in the collab provider when the server fails loading initilisation data
+- Updated dependencies
+
+## 7.4.4
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.4.3
+
+### Patch Changes
+
+- [`ec2f2d0b804`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ec2f2d0b804) - ED-14734: Add analytics to track time to connect to collab service, as well as tracking document initial load time.
+
 ## 7.4.2
 
 ### Patch Changes

package/config/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/collab-provider/config",
+  "main": "../dist/cjs/config.js",
+  "module": "../dist/esm/config.js",
+  "module:es2019": "../dist/es2019/config.js",
+  "sideEffects": false,
+  "types": "../dist/types/config.d.ts"
+}

package/dist/cjs/analytics/index.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.triggerAnalyticsForStepsRejected = exports.triggerAnalyticsForStepsAddedSuccessfully = exports.triggerAnalyticsForCatchupSuccessfulWithLatency = exports.triggerAnalyticsForCatchupFailed = exports.fireAnalyticsEvent = exports.buildAnalyticsPayload = void 0;
+exports.triggerCollabAnalyticsEvent = exports.fireAnalyticsEvent = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -15,22 +15,8 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-var buildAnalyticsPayload = function buildAnalyticsPayload(subject, payload) {
-  return {
-    action: 'collab',
-    actionSubject: subject,
-    source: 'unknown',
-    attributes: {
-      packageName: _const.ATTRIBUTES_PACKAGE,
-      payload: payload
-    }
-  };
-};
-
-exports.buildAnalyticsPayload = buildAnalyticsPayload;
-
-var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, analyticsEvent) {
-  if (!analyticsClient || !analyticsEvent) {
+var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, payload) {
+  if (!analyticsClient || !payload) {
     return;
   }
 
@@ -42,38 +28,25 @@ var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, analyticsE
   runItLater(function () {
     client.sendOperationalEvent(_objectSpread(_objectSpread({
       action: 'collab'
-    }, analyticsEvent), {}, {
-      source: analyticsEvent.source || 'unknown'
+    }, payload), {}, {
+      source: payload.source || 'unknown',
+      tags: ['editor']
     }));
   });
 };
 
 exports.fireAnalyticsEvent = fireAnalyticsEvent;
 
-var triggerAnalyticsForStepsAddedSuccessfully = function triggerAnalyticsForStepsAddedSuccessfully(analyticsClient) {
-  var stepAddedEvent = buildAnalyticsPayload(_const.STEPS_ADDED);
-  fireAnalyticsEvent(analyticsClient, stepAddedEvent);
-};
-
-exports.triggerAnalyticsForStepsAddedSuccessfully = triggerAnalyticsForStepsAddedSuccessfully;
-
-var triggerAnalyticsForStepsRejected = function triggerAnalyticsForStepsRejected(analyticsClient, error) {
-  var stepRejectedEvent = buildAnalyticsPayload(_const.STEPS_REJECTED, error);
-  fireAnalyticsEvent(analyticsClient, stepRejectedEvent);
-};
-
-exports.triggerAnalyticsForStepsRejected = triggerAnalyticsForStepsRejected;
-
-var triggerAnalyticsForCatchupFailed = function triggerAnalyticsForCatchupFailed(analyticsClient, error) {
-  var catchupFailedEvent = buildAnalyticsPayload(_const.CATCHUP_FAILURE, error);
-  fireAnalyticsEvent(analyticsClient, catchupFailedEvent);
-};
-
-exports.triggerAnalyticsForCatchupFailed = triggerAnalyticsForCatchupFailed;
-
-var triggerAnalyticsForCatchupSuccessfulWithLatency = function triggerAnalyticsForCatchupSuccessfulWithLatency(analyticsClient, latency) {
-  var callCatchupLatency = buildAnalyticsPayload(_const.CATCHUP_SUCCESS, latency);
-  fireAnalyticsEvent(analyticsClient, callCatchupLatency);
+var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(analyticsEvent, analyticsClient) {
+  var payload = {
+    action: analyticsEvent.eventAction,
+    actionSubject: _const.EVENT_SUBJECT,
+    source: 'unknown',
+    attributes: _objectSpread({
+      packageName: _const.ATTRIBUTES_PACKAGE
+    }, analyticsEvent.attributes)
+  };
+  fireAnalyticsEvent(analyticsClient, payload);
 };
 
-exports.triggerAnalyticsForCatchupSuccessfulWithLatency = triggerAnalyticsForCatchupSuccessfulWithLatency;
+exports.triggerCollabAnalyticsEvent = triggerCollabAnalyticsEvent;

package/dist/cjs/analytics/performance.js

@@ -3,9 +3,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.MEASURE_NAME = void 0;
 exports.clearMeasure = clearMeasure;
 exports.startMeasure = startMeasure;
 exports.stopMeasure = stopMeasure;
+var MEASURE_NAME;
+exports.MEASURE_NAME = MEASURE_NAME;
+
+(function (MEASURE_NAME) {
+  MEASURE_NAME["CALLING_CATCHUP_API"] = "callingCatchupApi";
+  MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
+  MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
+  MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+})(MEASURE_NAME || (exports.MEASURE_NAME = MEASURE_NAME = {}));
 
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(function (api) {
@@ -40,19 +50,29 @@ function stopMeasure(measureName, onMeasureComplete) {
 
   try {
     performance.measure(measureName, "".concat(measureName, "::start"), "".concat(measureName, "::end"));
-  } catch (error) {} finally {
-    if (onMeasureComplete) {
-      var entry = performance.getEntriesByName(measureName).pop();
-
-      if (entry) {
-        onMeasureComplete(entry.duration, entry.startTime);
-      } else if (start) {
-        onMeasureComplete(performance.now() - start, start);
-      }
-    }
-
-    clearMeasure(measureName);
+  } catch (e) {}
+
+  var entry = performance.getEntriesByName(measureName).pop();
+  clearMeasure(measureName);
+  var measure;
+
+  if (entry) {
+    measure = {
+      duration: entry.duration,
+      startTime: entry.startTime
+    };
+  } else if (start) {
+    measure = {
+      duration: performance.now() - start,
+      startTime: start
+    };
   }
+
+  if (measure && onMeasureComplete) {
+    onMeasureComplete(measure.duration, measure.startTime);
+  }
+
+  return measure;
 }
 
 function clearMeasure(measureName) {

package/dist/cjs/channel.js

@@ -37,6 +37,8 @@ var _performance = require("./analytics/performance");
 
 var _analytics = require("./analytics");
 
+var _const = require("./helpers/const");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -72,6 +74,14 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnect", function () {
       _this.connected = true;
       logger('Connected.', _this.socket.id);
+      var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
+      (0, _analytics.triggerCollabAnalyticsEvent)({
+        eventAction: _const.EVENT_ACTION.CONNECTION,
+        attributes: {
+          eventStatus: _const.EVENT_STATUS.SUCCESS,
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        }
+      }, _this.analyticsClient);
 
       _this.emit('connected', {
         sid: _this.socket.id,
@@ -84,6 +94,15 @@ var Channel = /*#__PURE__*/function (_Emitter) {
 
       if (data.type === 'initial') {
         if (!_this.initialized) {
+          var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
+          (0, _analytics.triggerCollabAnalyticsEvent)({
+            eventAction: _const.EVENT_ACTION.DOCUMENT_INIT,
+            attributes: {
+              eventStatus: _const.EVENT_STATUS.SUCCESS,
+              // TODO: detect when document init fails and fire corresponding event for it
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            }
+          }, _this.analyticsClient);
           var doc = data.doc,
               version = data.version,
               userId = data.userId,
@@ -120,14 +139,21 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     function connect() {
       var _this2 = this;
 
+      (0, _performance.startMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
+
+      if (!this.initialized) {
+        (0, _performance.startMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
+      }
+
       var _this$config = this.config,
           documentAri = _this$config.documentAri,
           url = _this$config.url;
       var createSocket = this.config.createSocket;
       var permissionTokenRefresh = this.config.permissionTokenRefresh;
+      var authCb = null;
 
       if (permissionTokenRefresh) {
-        var authCb = function authCb(cb) {
+        authCb = function authCb(cb) {
           permissionTokenRefresh().then(function (token) {
             cb({
               // The permission token.
@@ -141,10 +167,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             _this2.emit('error', err);
           });
         };
-
-        this.socket = createSocket("".concat(url, "/session/").concat(documentAri), authCb);
       } else {
-        var _authCb = function _authCb(cb) {
+        authCb = function authCb(cb) {
           cb({
             // The initialized status. If false, BE will send document, otherwise not.
             initialized: _this2.initialized,
@@ -152,13 +176,12 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             need404: _this2.config.need404
           });
         };
+      }
 
-        this.socket = createSocket("".concat(url, "/session/").concat(documentAri), _authCb);
-      } // Due to https://github.com/socketio/socket.io-client/issues/1473,
+      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), authCb, this.config.productInfo); // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
       // We should use `connect` for better cross platform compatibility(Mobile/Web).
 
-
       this.socket.on('connect', this.onConnect);
       this.socket.on('data', this.onReceiveData);
       this.socket.on('steps:added', function (data) {
@@ -228,10 +251,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       // Ensure the error emit to the provider has the same structure, so we can handle them unified.
 
       this.socket.on('connect_error', function (error) {
-        // If error received with `data`, it means the connection is rejected
+        var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
+        (0, _analytics.triggerCollabAnalyticsEvent)({
+          eventAction: _const.EVENT_ACTION.CONNECTION,
+          attributes: {
+            eventStatus: _const.EVENT_STATUS.FAILURE,
+            error: error,
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+          }
+        }, _this2.analyticsClient); // If error received with `data`, it means the connection is rejected
         // by the server on purpose for example no permission, so no need to
         // keep the underneath connection, need to close. But some error like
         // `xhr polling error` needs to retry.
+
         if (!!error.data) {
           var _this2$socket;
 
@@ -248,8 +280,6 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     key: "fetchCatchup",
     value: function () {
       var _fetchCatchup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(fromVersion) {
-        var _this3 = this;
-
         var _yield$utils$requestS, doc, version, stepMaps, metadata, errorCatchup;
 
         return _regenerator.default.wrap(function _callee2$(_context2) {
@@ -257,49 +287,56 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             switch (_context2.prev = _context2.next) {
               case 0:
                 _context2.prev = 0;
-                (0, _performance.startMeasure)('callingCatchupApi');
                 _context2.t0 = _utilServiceSupport.utils;
                 _context2.t1 = this.config;
-                _context2.t2 = _objectSpread;
+                _context2.t2 = "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup");
                 _context2.t3 = {
-                  path: "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup"),
-                  queryParams: {
-                    version: fromVersion
-                  }
+                  version: fromVersion
                 };
+                _context2.t4 = _objectSpread;
+                _context2.t5 = _objectSpread;
+                _context2.t6 = {};
 
                 if (!this.config.permissionTokenRefresh) {
                   _context2.next = 15;
                   break;
                 }
 
-                _context2.next = 9;
+                _context2.next = 11;
                 return this.config.permissionTokenRefresh();
 
-              case 9:
-                _context2.t5 = _context2.sent;
-                _context2.t6 = {
-                  'x-token': _context2.t5
-                };
+              case 11:
+                _context2.t8 = _context2.sent;
                 _context2.t7 = {
-                  headers: _context2.t6
-                };
-                _context2.t4 = {
-                  requestInit: _context2.t7
+                  'x-token': _context2.t8
                 };
                 _context2.next = 16;
                 break;
 
               case 15:
-                _context2.t4 = {};
+                _context2.t7 = {};
 
               case 16:
-                _context2.t8 = _context2.t4;
-                _context2.t9 = (0, _context2.t2)(_context2.t3, _context2.t8);
-                _context2.next = 20;
-                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t9);
+                _context2.t9 = _context2.t7;
+                _context2.t10 = (0, _context2.t5)(_context2.t6, _context2.t9);
+                _context2.t11 = {};
+                _context2.t12 = {
+                  'x-product': (0, _utils.getProduct)(this.config.productInfo),
+                  'x-subproduct': (0, _utils.getSubProduct)(this.config.productInfo)
+                };
+                _context2.t13 = (0, _context2.t4)(_context2.t10, _context2.t11, _context2.t12);
+                _context2.t14 = {
+                  headers: _context2.t13
+                };
+                _context2.t15 = {
+                  path: _context2.t2,
+                  queryParams: _context2.t3,
+                  requestInit: _context2.t14
+                };
+                _context2.next = 25;
+                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t15);
 
-              case 20:
+              case 25:
                 _yield$utils$requestS = _context2.sent;
                 doc = _yield$utils$requestS.doc;
                 version = _yield$utils$requestS.version;
@@ -312,33 +349,26 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   metadata: metadata
                 });
 
-              case 28:
-                _context2.prev = 28;
-                _context2.t10 = _context2["catch"](0);
-                logger("Can't fetch the catchup", _context2.t10.message);
+              case 33:
+                _context2.prev = 33;
+                _context2.t16 = _context2["catch"](0);
+                logger("Can't fetch the catchup", _context2.t16.message);
                 errorCatchup = {
                   message: _errorCodeMapper.ErrorCodeMapper.catchupFail.message,
                   data: {
-                    status: _context2.t10.status,
+                    status: _context2.t16.status,
                     code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
                   }
                 };
                 this.emit('error', errorCatchup);
                 return _context2.abrupt("return", {});
 
-              case 34:
-                _context2.prev = 34;
-                (0, _performance.stopMeasure)('callingCatchupApi', function (duration, _) {
-                  (0, _analytics.triggerAnalyticsForCatchupSuccessfulWithLatency)(_this3.analyticsClient, duration);
-                });
-                return _context2.finish(34);
-
-              case 37:
+              case 39:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[0, 28, 34, 37]]);
+        }, _callee2, this, [[0, 33]]);
       }));
 
       function fetchCatchup(_x2) {

package/dist/cjs/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SOCKET_IO_OPTIONS = void 0;
+var SOCKET_IO_OPTIONS = {
+  RECONNECTION_DELAY_MAX: 128 * 1000,
+  RECONNECTION_DELAY: 1000,
+  RANDOMIZATION_FACTOR: 0.1
+};
+exports.SOCKET_IO_OPTIONS = SOCKET_IO_OPTIONS;

package/dist/cjs/error-code-mapper.js

@@ -1,9 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.errorCodeMapper = exports.ErrorCodeMapper = void 0;
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
 var ErrorCodeMapper = {
   noPermissionError: {
     code: 'NO_PERMISSION_ERROR',
@@ -37,41 +42,44 @@ var ErrorCodeMapper = {
 exports.ErrorCodeMapper = ErrorCodeMapper;
 
 var errorCodeMapper = function errorCodeMapper(error) {
-  if (error.data) {
-    switch (error.data.code) {
-      case 'INSUFFICIENT_EDITING_PERMISSION':
-        return {
-          status: 403,
-          code: ErrorCodeMapper.noPermissionError.code,
-          message: ErrorCodeMapper.noPermissionError.message
-        };
+  var _error$data;
+
+  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
+    case 'INSUFFICIENT_EDITING_PERMISSION':
+      return {
+        status: 403,
+        code: ErrorCodeMapper.noPermissionError.code,
+        message: ErrorCodeMapper.noPermissionError.message,
+        reason: // Typescript magic so it detects the union type
+        (0, _typeof2.default)(error.data.meta) === 'object' ? error.data.meta.reason : undefined
+      };
 
-      case 'DOCUMENT_NOT_FOUND':
-        return {
-          status: 404,
-          code: ErrorCodeMapper.documentNotFound.code,
-          message: ErrorCodeMapper.documentNotFound.message
-        };
+    case 'DOCUMENT_NOT_FOUND':
+      return {
+        status: 404,
+        code: ErrorCodeMapper.documentNotFound.code,
+        message: ErrorCodeMapper.documentNotFound.message
+      };
 
-      case 'FAILED_ON_S3':
-      case 'DYNAMO_ERROR':
-        return {
-          status: 500,
-          code: ErrorCodeMapper.failToSave.code,
-          message: ErrorCodeMapper.failToSave.message
-        };
+    case 'FAILED_ON_S3':
+    case 'DYNAMO_ERROR':
+      return {
+        status: 500,
+        code: ErrorCodeMapper.failToSave.code,
+        message: ErrorCodeMapper.failToSave.message
+      };
 
-      case 'CATCHUP_FAILED':
-      case 'GET_QUERY_TIME_OUT':
-        return {
-          status: 500,
-          code: ErrorCodeMapper.internalError.code,
-          message: ErrorCodeMapper.internalError.message
-        };
+    case 'CATCHUP_FAILED':
+    case 'GET_QUERY_TIME_OUT':
+    case 'INIT_DATA_LOAD_FAILED':
+      return {
+        status: 500,
+        code: ErrorCodeMapper.internalError.code,
+        message: ErrorCodeMapper.internalError.message
+      };
 
-      default:
-        break;
-    }
+    default:
+      break;
   }
 };
 

package/dist/cjs/helpers/const.js

@@ -3,16 +3,29 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.STEPS_REJECTED = exports.STEPS_ADDED = exports.CATCHUP_SUCCESS = exports.CATCHUP_FAILURE = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
-var STEPS_ADDED = 'collabStepsAddedSuccess';
-exports.STEPS_ADDED = STEPS_ADDED;
-var STEPS_REJECTED = 'collabStepsAddedRejected';
-exports.STEPS_REJECTED = STEPS_REJECTED;
+exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
 var ATTRIBUTES_PACKAGE = 'collabProvider';
 exports.ATTRIBUTES_PACKAGE = ATTRIBUTES_PACKAGE;
-var CATCHUP_SUCCESS = 'collabCatchupSuccess';
-exports.CATCHUP_SUCCESS = CATCHUP_SUCCESS;
-var CATCHUP_FAILURE = 'collabCatchupFailure';
-exports.CATCHUP_FAILURE = CATCHUP_FAILURE;
+var EVENT_SUBJECT = 'collab';
+exports.EVENT_SUBJECT = EVENT_SUBJECT;
+var EVENT_ACTION;
+exports.EVENT_ACTION = EVENT_ACTION;
+
+(function (EVENT_ACTION) {
+  EVENT_ACTION["CONNECTION"] = "connection";
+  EVENT_ACTION["CATCHUP"] = "catchup";
+  EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
+  EVENT_ACTION["ADD_STEPS"] = "addSteps";
+  EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+})(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
+
+var EVENT_STATUS;
+exports.EVENT_STATUS = EVENT_STATUS;
+
+(function (EVENT_STATUS) {
+  EVENT_STATUS["SUCCESS"] = "SUCCESS";
+  EVENT_STATUS["FAILURE"] = "FAILURE";
+})(EVENT_STATUS || (exports.EVENT_STATUS = EVENT_STATUS = {}));
+
 var ACK_MAX_TRY = 10;
 exports.ACK_MAX_TRY = ACK_MAX_TRY;

package/dist/cjs/helpers/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getParticipant = exports.createLogger = void 0;
+exports.getSubProduct = exports.getProduct = exports.getParticipant = exports.createLogger = void 0;
 exports.sleep = sleep;
 
 var createLogger = function createLogger(prefix) {
@@ -37,4 +37,20 @@ function sleep(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);
   });
-}
+}
+
+var getProduct = function getProduct(productInfo) {
+  var _productInfo$product;
+
+  return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';
+};
+
+exports.getProduct = getProduct;
+
+var getSubProduct = function getSubProduct(productInfo) {
+  var _productInfo$subProdu;
+
+  return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
+};
+
+exports.getSubProduct = getSubProduct;