@atlaskit/collab-provider 8.6.0 → 8.8.0

package/dist/es2019/disconnected-reason-mapper.js

@@ -11,15 +11,15 @@ export const socketIOReasons = {
   PING_TIMEOUT: 'ping timeout' // The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)
 };
 
-export let DisconnectReason;
-(function (DisconnectReason) {
+export let DisconnectReason = /*#__PURE__*/function (DisconnectReason) {
   DisconnectReason["CLIENT_DISCONNECT"] = "CLIENT_DISCONNECT";
   DisconnectReason["SERVER_DISCONNECT"] = "SERVER_DISCONNECT";
   DisconnectReason["SOCKET_CLOSED"] = "SOCKET_CLOSED";
   DisconnectReason["SOCKET_ERROR"] = "SOCKET_ERROR";
   DisconnectReason["SOCKET_TIMEOUT"] = "SOCKET_TIMEOUT";
   DisconnectReason["UNKNOWN_DISCONNECT"] = "UNKNOWN_DISCONNECT";
-})(DisconnectReason || (DisconnectReason = {}));
+  return DisconnectReason;
+}({});
 export const disconnectedReasonMapper = reason => {
   switch (reason) {
     case socketIOReasons.IO_CLIENT_DISCONNECT:

package/dist/es2019/document/document-service.js

@@ -15,8 +15,6 @@ const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 const noop = () => {};
 const logger = createLogger('documentService', 'black');
 export class DocumentService {
-  // Fires analytics to editor when collab editor cannot sync up
-
   // ClientID is the unique ID for a prosemirror client. Used for step-rebasing.
 
   /**
@@ -32,12 +30,21 @@ export class DocumentService {
    * @param onErrorHandled - Callback to handle
    */
   constructor(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+    // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
+    /**
+     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     */
     _defineProperty(this, "throttledCatchup", throttle(() => this.catchup(), CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
       trailing: true
     }));
+    /**
+     * Called when:
+     *   * session established(offline -> online)
+     *   * try to accept steps but version is behind.
+     */
     _defineProperty(this, "catchup", async () => {
       const start = new Date().getTime();
       // if the queue is already paused, we are busy with something else, so don't proceed.
@@ -140,6 +147,9 @@ export class DocumentService {
         steps
       });
     });
+    /**
+     * Called when we receive steps from the service
+     */
     _defineProperty(this, "onStepsAdded", data => {
       logger(`Received steps`, {
         steps: data.steps,
@@ -177,6 +187,7 @@ export class DocumentService {
         });
       }
     });
+    // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
     _defineProperty(this, "onRestore", ({
       doc,
       version,
@@ -259,6 +270,10 @@ export class DocumentService {
         } : {})
       });
     });
+    /**
+     * Commit the unconfirmed local steps to the back-end service
+     * @throws {Error} Couldn't sync the steps after retrying 30 times
+     */
     _defineProperty(this, "commitUnconfirmedSteps", async () => {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
@@ -339,17 +354,6 @@ export class DocumentService {
     this.metadataService = metadataService;
     this.stepQueue = new StepQueueState();
   }
-
-  /**
-   * To prevent calling catchup to often, use lodash throttle to reduce the frequency
-   */
-
-  /**
-   * Called when:
-   *   * session established(offline -> online)
-   *   * try to accept steps but version is behind.
-   */
-
   processQueue() {
     if (this.stepQueue.isPaused()) {
       logger(`Queue is paused. Aborting.`);
@@ -400,18 +404,6 @@ export class DocumentService {
       }
     }
   }
-
-  /**
-   * Called when we receive steps from the service
-   */
-
-  // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
-
-  /**
-   * Commit the unconfirmed local steps to the back-end service
-   * @throws {Error} Couldn't sync the steps after retrying 30 times
-   */
-
   setup({
     getState,
     onSyncUpError,

package/dist/es2019/document/step-queue-state.js

@@ -11,6 +11,10 @@ export class StepQueueState {
     _defineProperty(this, "filterQueue", condition => {
       this.queue = this.queue.filter(condition);
     });
+    /**
+     * Get whether the document service has stopped processing new steps whilst it carries out processes such as catchup.
+     * Exposed for testing
+     */
     _defineProperty(this, "isPaused", () => this.queuePaused);
     _defineProperty(this, "pauseQueue", () => {
       this.queuePaused = true;
@@ -27,9 +31,4 @@ export class StepQueueState {
     const orderedQueue = [...this.queue, data].sort((a, b) => a.version > b.version ? 1 : -1);
     this.queue = orderedQueue;
   }
-
-  /**
-   * Get whether the document service has stopped processing new steps whilst it carries out processes such as catchup.
-   * Exposed for testing
-   */
 }

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

@@ -1,8 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 // Internal error codes (generated by collab provider)
-export let INTERNAL_ERROR_CODE;
-// NCS error coded (generated by NCS)
-(function (INTERNAL_ERROR_CODE) {
+export let 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";
@@ -11,14 +9,10 @@ export let 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 let 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 let 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";
@@ -35,7 +29,14 @@ export let 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 = {})); // - Permission errors
+  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
@@ -45,7 +46,19 @@ export let NCS_ERROR_CODE;
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
 // Emitted errors
-export let PROVIDER_ERROR_CODE;
+export let 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:
@@ -70,18 +83,6 @@ export let 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.

package/dist/es2019/helpers/const.js

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

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

@@ -8,12 +8,27 @@ export class MetadataService {
       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", 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", metadata => {
+      this.broadcastMetadata(metadata);
+      this.metadata = metadata;
+    });
+    /**
+     * Emits a change in document's metadata
+     * @param metadata
+     */
     _defineProperty(this, "updateMetadata", metadata => {
       if (metadata && Object.keys(metadata).length > 0) {
         this.metadata = metadata;
@@ -23,11 +38,6 @@ export class MetadataService {
     this.providerEmitCallback = providerEmitCallback;
     this.broadcastMetadata = broadcastMetadata;
   }
-
-  /**
-   * Called when a metadata is changed externally from other clients/backend.
-   */
-
   setTitle(title, broadcast) {
     if (broadcast) {
       this.broadcastMetadata({
@@ -44,18 +54,4 @@ export class MetadataService {
     }
     this.metadata.editorWidth = editorWidth;
   }
-
-  /**
-   * Updates the local metadata and broadcasts the metadata to other clients/backend.
-   * @param metadata
-   */
-  setMetadata(metadata) {
-    this.broadcastMetadata(metadata);
-    this.metadata = metadata;
-  }
-
-  /**
-   * Emits a change in document's metadata
-   * @param metadata
-   */
 }

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

@@ -1,21 +1,16 @@
 export const PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
 export const createParticipantFromPayload = async (payload, getUser) => {
-  var _user, _user2, _user3;
   const {
     sessionId,
     timestamp,
     clientId,
     userId
   } = payload;
-  let user;
-  if (getUser) {
-    user = await getUser(userId);
-  }
+  const user = await (getUser === null || getUser === void 0 ? void 0 : getUser(userId));
   const 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) || '',
+    name: (user === null || user === void 0 ? void 0 : user.name) || '',
+    avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
     sessionId,
     lastActive: timestamp,
     userId,

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

@@ -6,6 +6,13 @@ import { createParticipantFromPayload as enrichParticipant, PARTICIPANT_UPDATE_I
 import { ParticipantsState } from './participants-state';
 export class ParticipantsService {
   constructor(analyticsHelper, participantsState = new ParticipantsState()) {
+    /**
+     * 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", async (payload, getUser, emit) => {
       const {
         userId
@@ -41,6 +48,11 @@ export class ParticipantsService {
         joined: [participant]
       }, emit, 'handling participant updated event');
     });
+    /**
+     * Called when a participant leaves the session.
+     *
+     * We emit the `presence` event to update the active avatars in the editor.
+     */
     _defineProperty(this, "participantLeft", ({
       sessionId
     }, emit) => {
@@ -70,7 +82,15 @@ export class ParticipantsService {
         }, emit, 'emitting presence update on disconnect');
       }
     });
+    /**
+     * Updates when users were last active
+     * @param userIds Users in most recent steps
+     */
     _defineProperty(this, "updateLastActive", (userIds = []) => this.participantsState.updateLastActive(Date.now(), userIds));
+    /**
+     * Called when we receive a telepointer update from another
+     * participant.
+     */
     _defineProperty(this, "participantTelepointer", (payload, thisSessionId, getUser, emit) => {
       const {
         sessionId,
@@ -93,6 +113,12 @@ export class ParticipantsService {
         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", (sessionId, emit) => {
       clearTimeout(this.participantUpdateTimeout);
       try {
@@ -103,6 +129,9 @@ export class ParticipantsService {
       }
       this.participantUpdateTimeout = window.setTimeout(() => this.removeInactiveParticipants(sessionId, emit), PARTICIPANT_UPDATE_INTERVAL);
     });
+    /**
+     * Keep list of participants up to date. Filter out inactive users etc.
+     */
     _defineProperty(this, "filterInactive", (sessionId, emit) => {
       const now = Date.now();
       const left = this.participantsState.getParticipants().filter(p => p.sessionId !== sessionId && now - p.lastActive > PARTICIPANT_UPDATE_INTERVAL);
@@ -111,6 +140,11 @@ export class ParticipantsService {
         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", (data, emit, errorMessage) => {
       try {
         var _this$analyticsHelper4;
@@ -124,6 +158,11 @@ export class ParticipantsService {
         (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, `Error while ${errorMessage}`);
       }
     });
+    /**
+     * Wrapper function to emit with error handling and analytics
+     * @param data Data to emit
+     * @param emit Emit function from Provider
+     */
     _defineProperty(this, "emitTelepointer", (data, emit, errorMessage) => {
       try {
         emit('telepointer', data);
@@ -133,32 +172,15 @@ export class ParticipantsService {
         (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(error, `Error while ${errorMessage}`);
       }
     });
+    /**
+     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
+     */
     _defineProperty(this, "clearTimers", () => {
       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
-   */
-
-  /**
-   * Called when a participant leaves the session.
-   *
-   * We emit the `presence` event to update the active avatars in the editor.
-   */
-
-  /**
-   * Updates when users were last active
-   * @param userIds Users in most recent steps
-   */
-
   /**
    * Called on receiving steps, emits each step's telepointer
    * @param steps Steps to extract telepointers from
@@ -172,36 +194,4 @@ export class ParticipantsService {
       }
     });
   }
-
-  /**
-   * Called when we receive a telepointer update from another
-   * participant.
-   */
-
-  /**
-   * 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
-   */
-
-  /**
-   * Keep list of participants up to date. Filter out inactive users etc.
-   */
-
-  /**
-   * Wrapper function to emit with error handling and analytics
-   * @param data Data to emit
-   * @param emit Emit function from Provider
-   */
-
-  /**
-   * Wrapper function to emit with error handling and analytics
-   * @param data Data to emit
-   * @param emit Emit function from Provider
-   */
-
-  /**
-   * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
-   */
 }

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

@@ -20,11 +20,10 @@ export class ParticipantsState {
     _defineProperty(this, "clear", () => this.participants.clear());
     _defineProperty(this, "doesntHave", sessionId => !this.participants.has(sessionId));
     _defineProperty(this, "size", () => this.participants.size);
+    // If userId of participant in userIds, set lastActive to now
     _defineProperty(this, "updateLastActive", (now, userIds) => this.participants.forEach(p => {
       p.lastActive = userIds.includes(p.userId) ? now : p.lastActive;
     }));
     this.participants = baseParticipants;
   }
-
-  // If userId of participant in userIds, set lastActive to now
 }