@atlaskit/collab-provider 8.5.0 → 8.7.0

package/dist/esm/errors/error-types.js

@@ -9,9 +9,7 @@ import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 // Internal error codes (generated by collab provider)
-export var INTERNAL_ERROR_CODE;
-// NCS error coded (generated by NCS)
-(function (INTERNAL_ERROR_CODE) {
+export var INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
   INTERNAL_ERROR_CODE["TOKEN_PERMISSION_ERROR"] = "TOKEN_PERMISSION_ERROR";
   INTERNAL_ERROR_CODE["RECONNECTION_NETWORK_ISSUE"] = "RECONNECTION_NETWORK_ISSUE";
   INTERNAL_ERROR_CODE["CONNECTION_ERROR"] = "CONNECTION_ERROR";
@@ -20,14 +18,10 @@ export var INTERNAL_ERROR_CODE;
   INTERNAL_ERROR_CODE["CATCHUP_FAILED"] = "CATCHUP_FAILED";
   INTERNAL_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
   INTERNAL_ERROR_CODE["ADD_STEPS_ERROR"] = "ADD_STEPS_ERROR";
-})(INTERNAL_ERROR_CODE || (INTERNAL_ERROR_CODE = {}));
-export var NCS_ERROR_CODE;
-
-// TODO: Import emitted error codes from NCS
-
-// NCS Errors
-// - Step rejection errors
-(function (NCS_ERROR_CODE) {
+  return INTERNAL_ERROR_CODE;
+}({});
+// NCS error coded (generated by NCS)
+export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
   NCS_ERROR_CODE["VERSION_NUMBER_ALREADY_EXISTS"] = "VERSION_NUMBER_ALREADY_EXISTS";
   NCS_ERROR_CODE["INSUFFICIENT_EDITING_PERMISSION"] = "INSUFFICIENT_EDITING_PERMISSION";
@@ -44,9 +38,36 @@ export var NCS_ERROR_CODE;
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
-})(NCS_ERROR_CODE || (NCS_ERROR_CODE = {}));
+  return NCS_ERROR_CODE;
+}({});
+
+// TODO: Import emitted error codes from NCS
+
+// NCS Errors
+// - Step rejection errors
+// - Permission errors
+// - Page missing / TTL errors
+// - Server errors
+// - Less common back-end errors
+// Provider Errors
+// Channel Errors
+/**
+ * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
+ */
 // Emitted errors
-export var PROVIDER_ERROR_CODE;
+export var PROVIDER_ERROR_CODE = /*#__PURE__*/function (PROVIDER_ERROR_CODE) {
+  PROVIDER_ERROR_CODE["NO_PERMISSION_ERROR"] = "NO_PERMISSION_ERROR";
+  PROVIDER_ERROR_CODE["INVALID_USER_TOKEN"] = "INVALID_USER_TOKEN";
+  PROVIDER_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
+  PROVIDER_ERROR_CODE["LOCKED"] = "LOCKED";
+  PROVIDER_ERROR_CODE["FAIL_TO_SAVE"] = "FAIL_TO_SAVE";
+  PROVIDER_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
+  PROVIDER_ERROR_CODE["INITIALISATION_ERROR"] = "INITIALISATION_ERROR";
+  PROVIDER_ERROR_CODE["NETWORK_ISSUE"] = "NETWORK_ISSUE";
+  PROVIDER_ERROR_CODE["INVALID_PROVIDER_CONFIGURATION"] = "INVALID_PROVIDER_CONFIGURATION";
+  PROVIDER_ERROR_CODE["INTERNAL_SERVICE_ERROR"] = "INTERNAL_SERVICE_ERROR";
+  return PROVIDER_ERROR_CODE;
+}({});
 
 /*
  * This is what a generic ProviderError type would look like:
@@ -71,18 +92,76 @@ export var PROVIDER_ERROR_CODE;
  * @message Message returned to editor, i.e User does not have permissions to access this document or document is not found
  * @recoverable It is recoverable, as we will try to refresh the token.
  */
-(function (PROVIDER_ERROR_CODE) {
-  PROVIDER_ERROR_CODE["NO_PERMISSION_ERROR"] = "NO_PERMISSION_ERROR";
-  PROVIDER_ERROR_CODE["INVALID_USER_TOKEN"] = "INVALID_USER_TOKEN";
-  PROVIDER_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  PROVIDER_ERROR_CODE["LOCKED"] = "LOCKED";
-  PROVIDER_ERROR_CODE["FAIL_TO_SAVE"] = "FAIL_TO_SAVE";
-  PROVIDER_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
-  PROVIDER_ERROR_CODE["INITIALISATION_ERROR"] = "INITIALISATION_ERROR";
-  PROVIDER_ERROR_CODE["NETWORK_ISSUE"] = "NETWORK_ISSUE";
-  PROVIDER_ERROR_CODE["INVALID_PROVIDER_CONFIGURATION"] = "INVALID_PROVIDER_CONFIGURATION";
-  PROVIDER_ERROR_CODE["INTERNAL_SERVICE_ERROR"] = "INTERNAL_SERVICE_ERROR";
-})(PROVIDER_ERROR_CODE || (PROVIDER_ERROR_CODE = {}));
+/**
+ * Similiar to InsufficientEditingPermission, but the user token is invalid because it has expired or been revoked.
+ * It may also be an invalid token format.
+ * This error is given to the provider by NCS.
+ * @message Message returned to editor, i.e. The user token was invalid
+ * @recoverable It is recoverable, as we will try to refresh the token.
+ */
+/**
+ * Document not found error, thrown when the provider is unable to find a document with the given ARI and user token.
+ * It occurs during fetchCatchup, a function that fetches the latest document state during catchup.
+ * We need to recieve a 404 from the document service to throw this error.
+ * @message Message returned to editor, i.e. The requested document is not found
+ * @recoverable It is recoverable, as the provider can try again later.
+ */
+/**
+ * This error is thrown when the document is locked by another user.
+ * The error is passed to us by NCS.
+ * @message Message returned to editor, i.e. The document is currently not available, please try again later
+ * @recoverable It is recoverable, as the provider can try again later.
+ */
+/**
+ * This error is thrown when the provider is unable to save the document.
+ * This can happen when the connection to dynamoDB is lost, or when we do not have sufficient permissions (DYNAMO ERROR).
+ * This error is given to us by NCS.
+ * @message Message returned to editor, i.e. Collab service is not able to save changes
+ * @recoverable It is not recoverable, as we don't want the user to continue editing a document that is not being saved.
+ */
+/**
+ * This error is thrown when the provider is unable to restore the document.
+ * It occurs during onRestore, a function that restores the document to a previous version and reapplies unconfirmed steps.
+ * onRestore is called when page recovery has emitted an 'init' event on a page client is currently connected to.
+ * It could mean we failed to update the page metadata, or we failed to reapply unconfirmed steps.
+ * @message Message returned to editor, i.e. Collab service unable to restore document
+ * @recoverable It is not recoverable, as the provider has no further options after this.
+ * The user will need to refresh the page to try again.
+ */
+/**
+ * The initial document couldn't be loaded from the collab service.
+ * This error is given to us by NCS.
+ * It could indicate either a network issue, or an internal service error in NCS.
+ * @message Message returned to editor, i.e. The initial document couldn't be loaded from the collab service
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ * The user will need to refresh the page to try again.
+ */
+/**
+ * Couldn't reconnect to the collab service (NCS) due to network issues.
+ * NCS could be down, or the user could be offline. It's also possible the url is incorrect, or the user is behind a proxy blocking the connection.
+ * Fired upon a reconnection attempt error (from Socket.IO Manager)
+ * @message Message returned to editor, i.e. Couldn't reconnect to the collab service due to network issues
+ * @recoverable It is recoverable, as the provider will try to reconnect.
+ */
+/**
+ * This error is thrown when the provider has an invalid configuration.
+ * It could happen due to these errors from NCS:
+ *  NAMESPACE_INVALID
+    INVALID_ACTIVATION_ID
+    INVALID_DOCUMENT_ARI
+    INVALID_CLOUD_ID
+ * @message Message returned to editor, i.e. Invalid provider configuration
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ * The service using the provider will need to fix the configuration.
+ */
+/**
+ * This error is thrown when the provider encounters an internal service error, not otherwise accounted for.
+ * @message Message returned to editor, i.e. Collab Provider experienced an unrecoverable error
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ */
+/**
+ * A union of all possible provider errors that can be emitted back to the editor.
+ */
 // Custom Errors
 var CustomError = /*#__PURE__*/function (_Error) {
   _inherits(CustomError, _Error);

package/dist/esm/helpers/const.js

@@ -1,5 +1,4 @@
-export var EVENT_ACTION;
-(function (EVENT_ACTION) {
+export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["CONNECTION"] = "connection";
   EVENT_ACTION["CATCHUP"] = "catchup";
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
@@ -11,17 +10,18 @@ export var EVENT_ACTION;
   EVENT_ACTION["PUBLISH_PAGE"] = "publishPage";
   EVENT_ACTION["GET_CURRENT_STATE"] = "getCurrentState";
   EVENT_ACTION["INVALIDATE_TOKEN"] = "invalidateToken";
-})(EVENT_ACTION || (EVENT_ACTION = {}));
-export var EVENT_STATUS;
-(function (EVENT_STATUS) {
+  return EVENT_ACTION;
+}({});
+export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
-})(EVENT_STATUS || (EVENT_STATUS = {}));
-export var ADD_STEPS_TYPE;
-(function (ADD_STEPS_TYPE) {
+  return EVENT_STATUS;
+}({});
+export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {
   ADD_STEPS_TYPE["ACCEPTED"] = "ACCEPTED";
   ADD_STEPS_TYPE["REJECTED"] = "REJECTED";
   ADD_STEPS_TYPE["ERROR"] = "ERROR";
-})(ADD_STEPS_TYPE || (ADD_STEPS_TYPE = {}));
+  return ADD_STEPS_TYPE;
+}({});
 export var ACK_MAX_TRY = 30;
 export var CONFLUENCE = 'confluence';

package/dist/esm/index.js

@@ -1 +1,2 @@
-export { Provider } from './provider';
+export { Provider } from './provider';
+export { PROVIDER_ERROR_CODE } from './errors/error-types';

package/dist/esm/metadata/metadata-service.js

@@ -0,0 +1,69 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import isEqual from 'lodash/isEqual';
+export var MetadataService = /*#__PURE__*/function () {
+  function MetadataService(providerEmitCallback, broadcastMetadata) {
+    var _this = this;
+    _classCallCheck(this, MetadataService);
+    _defineProperty(this, "metadata", {});
+    _defineProperty(this, "getMetaData", function () {
+      return _this.metadata;
+    });
+    _defineProperty(this, "getTitle", function () {
+      var _this$metadata$title;
+      return (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString();
+    });
+    /**
+     * Called when a metadata is changed externally from other clients/backend.
+     */
+    _defineProperty(this, "onMetadataChanged", function (metadata) {
+      if (metadata !== undefined && !isEqual(_this.metadata, metadata) && Object.keys(metadata).length > 0) {
+        _this.metadata = metadata;
+        _this.providerEmitCallback('metadata:changed', metadata);
+      }
+    });
+    /**
+     * Updates the local metadata and broadcasts the metadata to other clients/backend.
+     * @param metadata
+     */
+    _defineProperty(this, "setMetadata", function (metadata) {
+      _this.broadcastMetadata(metadata);
+      _this.metadata = metadata;
+    });
+    /**
+     * Emits a change in document's metadata
+     * @param metadata
+     */
+    _defineProperty(this, "updateMetadata", function (metadata) {
+      if (metadata && Object.keys(metadata).length > 0) {
+        _this.metadata = metadata;
+        _this.providerEmitCallback('metadata:changed', metadata);
+      }
+    });
+    this.providerEmitCallback = providerEmitCallback;
+    this.broadcastMetadata = broadcastMetadata;
+  }
+  _createClass(MetadataService, [{
+    key: "setTitle",
+    value: function setTitle(title, broadcast) {
+      if (broadcast) {
+        this.broadcastMetadata({
+          title: title
+        });
+      }
+      this.metadata.title = title;
+    }
+  }, {
+    key: "setEditorWidth",
+    value: function setEditorWidth(editorWidth, broadcast) {
+      if (broadcast) {
+        this.broadcastMetadata({
+          editorWidth: editorWidth
+        });
+      }
+      this.metadata.editorWidth = editorWidth;
+    }
+  }]);
+  return MetadataService;
+}();

package/dist/esm/participants/participants-helper.js

@@ -4,36 +4,27 @@ export var PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
 export var createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser) {
-    var _user, _user2, _user3;
     var sessionId, timestamp, clientId, userId, user, participant;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId;
-            if (!getUser) {
-              _context.next = 5;
-              break;
-            }
-            _context.next = 4;
-            return getUser(userId);
-          case 4:
-            user = _context.sent;
-          case 5:
-            participant = {
-              name: ((_user = user) === null || _user === void 0 ? void 0 : _user.name) || '',
-              email: ((_user2 = user) === null || _user2 === void 0 ? void 0 : _user2.email) || '',
-              avatar: ((_user3 = user) === null || _user3 === void 0 ? void 0 : _user3.avatar) || '',
-              sessionId: sessionId,
-              lastActive: timestamp,
-              userId: userId,
-              clientId: clientId
-            };
-            return _context.abrupt("return", participant);
-          case 7:
-          case "end":
-            return _context.stop();
-        }
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId;
+          _context.next = 3;
+          return getUser === null || getUser === void 0 ? void 0 : getUser(userId);
+        case 3:
+          user = _context.sent;
+          participant = {
+            name: (user === null || user === void 0 ? void 0 : user.name) || '',
+            avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
+            sessionId: sessionId,
+            lastActive: timestamp,
+            userId: userId,
+            clientId: clientId
+          };
+          return _context.abrupt("return", participant);
+        case 6:
+        case "end":
+          return _context.stop();
       }
     }, _callee);
   }));

package/dist/esm/participants/participants-service.js

@@ -15,57 +15,62 @@ export var ParticipantsService = /*#__PURE__*/function () {
     var _this = this;
     var participantsState = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new ParticipantsState();
     _classCallCheck(this, ParticipantsService);
+    /**
+     * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
+     * @param payload Payload from incoming socket event
+     * @param getUser Function to get user data from confluence
+     * @param emit Function to execute emit from provider socket
+     * @returns Awaitable Promise, due to getUser
+     */
     _defineProperty(this, "updateParticipant", /*#__PURE__*/function () {
       var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser, emit) {
         var userId, participant, _this$analyticsHelper, isNewParticipant;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                userId = payload.userId; // If userId does not exist, does nothing here to prevent duplication.
-                if (userId) {
-                  _context.next = 3;
-                  break;
-                }
-                return _context.abrupt("return");
-              case 3:
-                _context.prev = 3;
-                _context.next = 6;
-                return enrichParticipant( // userId _must_ be defined, this lets the compiler know
-                _objectSpread(_objectSpread({}, payload), {}, {
-                  userId: userId
-                }), getUser);
-              case 6:
-                participant = _context.sent;
-                _context.next = 12;
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              userId = payload.userId; // If userId does not exist, does nothing here to prevent duplication.
+              if (userId) {
+                _context.next = 3;
+                break;
+              }
+              return _context.abrupt("return");
+            case 3:
+              _context.prev = 3;
+              _context.next = 6;
+              return enrichParticipant( // userId _must_ be defined, this lets the compiler know
+              _objectSpread(_objectSpread({}, payload), {}, {
+                userId: userId
+              }), getUser);
+            case 6:
+              participant = _context.sent;
+              _context.next = 12;
+              break;
+            case 9:
+              _context.prev = 9;
+              _context.t0 = _context["catch"](3);
+              // We don't want to throw errors for Presence features as they tend to self-restore
+              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(_context.t0, 'enriching participant');
+            case 12:
+              if (participant) {
+                _context.next = 14;
+                break;
+              }
+              return _context.abrupt("return");
+            case 14:
+              isNewParticipant = _this.participantsState.doesntHave(participant.sessionId);
+              _this.participantsState.setBySessionId(participant.sessionId, participant);
+              if (isNewParticipant) {
+                _context.next = 18;
                 break;
-              case 9:
-                _context.prev = 9;
-                _context.t0 = _context["catch"](3);
-                // We don't want to throw errors for Presence features as they tend to self-restore
-                (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(_context.t0, 'enriching participant');
-              case 12:
-                if (participant) {
-                  _context.next = 14;
-                  break;
-                }
-                return _context.abrupt("return");
-              case 14:
-                isNewParticipant = _this.participantsState.doesntHave(participant.sessionId);
-                _this.participantsState.setBySessionId(participant.sessionId, participant);
-                if (isNewParticipant) {
-                  _context.next = 18;
-                  break;
-                }
-                return _context.abrupt("return");
-              case 18:
-                _this.emitPresence({
-                  joined: [participant]
-                }, emit, 'handling participant updated event');
-              case 19:
-              case "end":
-                return _context.stop();
-            }
+              }
+              return _context.abrupt("return");
+            case 18:
+              _this.emitPresence({
+                joined: [participant]
+              }, emit, 'handling participant updated event');
+            case 19:
+            case "end":
+              return _context.stop();
           }
         }, _callee, null, [[3, 9]]);
       }));
@@ -73,6 +78,11 @@ export var ParticipantsService = /*#__PURE__*/function () {
         return _ref.apply(this, arguments);
       };
     }());
+    /**
+     * Called when a participant leaves the session.
+     *
+     * We emit the `presence` event to update the active avatars in the editor.
+     */
     _defineProperty(this, "participantLeft", function (_ref2, emit) {
       var sessionId = _ref2.sessionId;
       _this.participantsState.removeBySessionId(sessionId);
@@ -101,10 +111,18 @@ export var ParticipantsService = /*#__PURE__*/function () {
         }, emit, 'emitting presence update on disconnect');
       }
     });
+    /**
+     * Updates when users were last active
+     * @param userIds Users in most recent steps
+     */
     _defineProperty(this, "updateLastActive", function () {
       var userIds = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
       return _this.participantsState.updateLastActive(Date.now(), userIds);
     });
+    /**
+     * Called when we receive a telepointer update from another
+     * participant.
+     */
     _defineProperty(this, "participantTelepointer", function (payload, thisSessionId, getUser, emit) {
       var sessionId = payload.sessionId,
         selection = payload.selection,
@@ -125,6 +143,12 @@ export var ParticipantsService = /*#__PURE__*/function () {
         sessionId: sessionId
       }, emit, 'handling participant telepointer event');
     });
+    /**
+     * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
+     * Needs to be kicked off in the Provider.
+     * @param sessionId SessionId from provider's connection
+     * @param emit Function to execute emit from provider socket
+     */
     _defineProperty(this, "removeInactiveParticipants", function (sessionId, emit) {
       clearTimeout(_this.participantUpdateTimeout);
       try {
@@ -137,6 +161,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
         return _this.removeInactiveParticipants(sessionId, emit);
       }, PARTICIPANT_UPDATE_INTERVAL);
     });
+    /**
+     * Keep list of participants up to date. Filter out inactive users etc.
+     */
     _defineProperty(this, "filterInactive", function (sessionId, emit) {
       var now = Date.now();
       var left = _this.participantsState.getParticipants().filter(function (p) {
@@ -145,10 +172,15 @@ export var ParticipantsService = /*#__PURE__*/function () {
       left.forEach(function (p) {
         return _this.participantsState.removeBySessionId(p.sessionId);
       });
-      _this.emitPresence({
+      left.length && _this.emitPresence({
         left: left
       }, emit, 'filtering inactive participants');
     });
+    /**
+     * Wrapper function to emit with error handling and analytics
+     * @param data Data to emit
+     * @param emit Emit function from Provider
+     */
     _defineProperty(this, "emitPresence", function (data, emit, errorMessage) {
       try {
         var _this$analyticsHelper4;
@@ -162,6 +194,11 @@ export var ParticipantsService = /*#__PURE__*/function () {
         (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, "Error while ".concat(errorMessage));
       }
     });
+    /**
+     * Wrapper function to emit with error handling and analytics
+     * @param data Data to emit
+     * @param emit Emit function from Provider
+     */
     _defineProperty(this, "emitTelepointer", function (data, emit, errorMessage) {
       try {
         emit('telepointer', data);
@@ -171,17 +208,15 @@ export var ParticipantsService = /*#__PURE__*/function () {
         (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(error, "Error while ".concat(errorMessage));
       }
     });
+    /**
+     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
+     */
+    _defineProperty(this, "clearTimers", function () {
+      clearTimeout(_this.participantUpdateTimeout);
+    });
     this.participantsState = participantsState;
     this.analyticsHelper = analyticsHelper;
   }
-
-  /**
-   * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
-   * @param payload Payload from incoming socket event
-   * @param getUser Function to get user data from confluence
-   * @param emit Function to execute emit from provider socket
-   * @returns Awaitable Promise, due to getUser
-   */
   _createClass(ParticipantsService, [{
     key: "emitTelepointersFromSteps",
     value:
@@ -199,11 +234,6 @@ export var ParticipantsService = /*#__PURE__*/function () {
         }
       });
     }
-
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
   }]);
   return ParticipantsService;
 }();

package/dist/esm/participants/participants-state.js

@@ -36,6 +36,7 @@ export var ParticipantsState = /*#__PURE__*/_createClass(function ParticipantsSt
   _defineProperty(this, "size", function () {
     return _this.participants.size;
   });
+  // If userId of participant in userIds, set lastActive to now
   _defineProperty(this, "updateLastActive", function (now, userIds) {
     return _this.participants.forEach(function (p) {
       p.lastActive = userIds.includes(p.userId) ? now : p.lastActive;

package/dist/esm/provider/commit-step.js

@@ -2,9 +2,12 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _defineProperty(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; }
 import countBy from 'lodash/countBy';
+import throttle from 'lodash/throttle';
 import { ADD_STEPS_TYPE, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { AcknowledgementResponseTypes } from '../types';
 import { NCS_ERROR_CODE } from '../errors/error-types';
+var SEND_STEPS_THROTTLE = 500; // 0.5 second
+
 export var commitStep = function commitStep(_ref) {
   var broadcast = _ref.broadcast,
     steps = _ref.steps,
@@ -59,4 +62,8 @@ export var commitStep = function commitStep(_ref) {
   } catch (error) {
     analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
   }
-};
+};
+export var throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
+  leading: false,
+  trailing: true
+});