@atlaskit/collab-provider 8.3.0 → 8.4.0

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

@@ -20,39 +20,43 @@ export var commitStep = function commitStep(_ref) {
     });
   });
   var start = new Date().getTime();
-  channel.broadcast('steps:commit', {
-    steps: stepsWithClientAndUserId,
-    version: version,
-    userId: userId
-  }, function (response) {
-    var latency = new Date().getTime() - start;
-    if (response.type === AcknowledgementResponseTypes.SUCCESS) {
-      onStepsAdded({
-        steps: stepsWithClientAndUserId,
-        version: response.version
-      });
-      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS, {
-        type: ADD_STEPS_TYPE.ACCEPTED,
-        latency: latency,
-        stepType: countBy(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
-          return stepWithClientAndUserId.stepType;
-        })
-      });
-    } else if (response.type === AcknowledgementResponseTypes.ERROR) {
-      var _response$error, _response$error$data, _response$error2, _response$error2$data;
-      onErrorHandled(response.error);
-      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.FAILURE, {
-        // User tried committing steps but they were rejected because:
-        // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
-        // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
-        type: ((_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$data = _response$error.data) === null || _response$error$data === void 0 ? void 0 : _response$error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_response$error2 = response.error) === null || _response$error2 === void 0 ? void 0 : (_response$error2$data = _response$error2.data) === null || _response$error2$data === void 0 ? void 0 : _response$error2$data.code) === 'VERSION_NUMBER_ALREADY_EXISTS' ? ADD_STEPS_TYPE.REJECTED : ADD_STEPS_TYPE.ERROR,
-        latency: latency
-      });
-      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
-    } else {
-      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
-      // @ts-expect-error We didn't type the invalid type case
-      new Error("Response type: ".concat((response === null || response === void 0 ? void 0 : response.type) || 'No response type')), 'Error while adding steps - Invalid Acknowledgement');
-    }
-  });
+  try {
+    channel.broadcast('steps:commit', {
+      steps: stepsWithClientAndUserId,
+      version: version,
+      userId: userId
+    }, function (response) {
+      var latency = new Date().getTime() - start;
+      if (response.type === AcknowledgementResponseTypes.SUCCESS) {
+        onStepsAdded({
+          steps: stepsWithClientAndUserId,
+          version: response.version
+        });
+        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS, {
+          type: ADD_STEPS_TYPE.ACCEPTED,
+          latency: latency,
+          stepType: countBy(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+            return stepWithClientAndUserId.stepType;
+          })
+        });
+      } else if (response.type === AcknowledgementResponseTypes.ERROR) {
+        var _response$error, _response$error$data, _response$error2, _response$error2$data;
+        onErrorHandled(response.error);
+        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.FAILURE, {
+          // User tried committing steps but they were rejected because:
+          // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+          // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
+          type: ((_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$data = _response$error.data) === null || _response$error$data === void 0 ? void 0 : _response$error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_response$error2 = response.error) === null || _response$error2 === void 0 ? void 0 : (_response$error2$data = _response$error2.data) === null || _response$error2$data === void 0 ? void 0 : _response$error2$data.code) === 'VERSION_NUMBER_ALREADY_EXISTS' ? ADD_STEPS_TYPE.REJECTED : ADD_STEPS_TYPE.ERROR,
+          latency: latency
+        });
+        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+      } else {
+        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
+        // @ts-expect-error We didn't type the invalid type case
+        new Error("Response type: ".concat((response === null || response === void 0 ? void 0 : response.type) || 'No response type')), 'Error while adding steps - Invalid Acknowledgement');
+      }
+    });
+  } catch (error) {
+    analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
+  }
 };

package/dist/esm/provider/index.js

@@ -23,7 +23,7 @@ import { createLogger, getParticipant, sleep } from '../helpers/utils';
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import AnalyticsHelper from '../analytics';
 import { catchup } from './catchup';
-import { ErrorCodeMapper, errorCodeMapper } from '../error-code-mapper';
+import { ErrorCodeMapper, errorCodeMapper } from '../errors/error-code-mapper';
 import { disconnectedReasonMapper } from '../disconnected-reason-mapper';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { commitStep } from './commit-step';
@@ -36,7 +36,7 @@ var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 var noop = function noop() {};
 export var MAX_STEP_REJECTED_ERROR = 15;
-var throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
+export var throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
   leading: false,
   trailing: true
 });
@@ -544,68 +544,79 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     });
     _defineProperty(_assertThisInitialized(_this), "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-      var _this$metadata$title, state, adfDocument, _this$analyticsHelper20;
+      var _this$metadata$title, _this$analyticsHelper20, state, adfDocument, currentState, measure, _this$analyticsHelper21, _this$analyticsHelper22, _measure;
       return _regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) {
           switch (_context3.prev = _context3.next) {
             case 0:
               _context3.prev = 0;
+              startMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+
               // Convert ProseMirror document in Editor state to ADF document
               state = _this.getState();
               adfDocument = new JSONTransformer().encode(state.doc);
-              return _context3.abrupt("return", {
+              currentState = {
                 content: adfDocument,
                 title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
                 stepVersion: getVersion(state)
+              };
+              measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+              (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.SUCCESS, {
+                latency: measure === null || measure === void 0 ? void 0 : measure.duration
               });
-            case 6:
-              _context3.prev = 6;
+              return _context3.abrupt("return", currentState);
+            case 10:
+              _context3.prev = 10;
               _context3.t0 = _context3["catch"](0);
-              (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(_context3.t0, 'Error while returning ADF version of current draft document');
+              _measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+              (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.FAILURE, {
+                latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
+              });
+              (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(_context3.t0, 'Error while returning ADF version of current draft document');
               throw _context3.t0;
-            case 10:
+            case 16:
             case "end":
               return _context3.stop();
           }
         }
-      }, _callee3, null, [[0, 6]]);
+      }, _callee3, null, [[0, 10]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "commitUnconfirmedSteps", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5() {
-      var count, unconfirmedSteps;
+      var unconfirmedSteps, _this$analyticsHelper24, _this$analyticsHelper25, measure;
       return _regeneratorRuntime.wrap(function _callee5$(_context5) {
         while (1) {
           switch (_context5.prev = _context5.next) {
             case 0:
-              count = 0;
               unconfirmedSteps = _this.getUnconfirmedSteps();
+              _context5.prev = 1;
               if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
                 _context5.next = 4;
                 break;
               }
               return _context5.delegateYield( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
-                var _this$analyticsHelper22;
-                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$analyticsHelper21, state, _measure, measure;
+                var _this$analyticsHelper23;
+                var count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure;
                 return _regeneratorRuntime.wrap(function _callee4$(_context4) {
                   while (1) {
                     switch (_context4.prev = _context4.next) {
                       case 0:
                         startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+                        count = 0; // We use origins here as steps can be rebased. When steps are rebased a new step is created.
                         // This means that we can not track if it has been removed from the unconfirmed array or not.
                         // Origins points to the original transaction that the step was created in. This is never changed
                         // and gets passed down when a step is rebased.
                         unconfirmedTrs = _this.getUnconfirmedStepsOrigins();
                         lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
                         isLastTrConfirmed = false;
-                      case 4:
+                      case 5:
                         if (isLastTrConfirmed) {
-                          _context4.next = 17;
+                          _context4.next = 16;
                           break;
                         }
                         _this.sendStepsFromCurrentState();
-                        _context4.next = 8;
+                        _context4.next = 9;
                         return sleep(1000);
-                      case 8:
+                      case 9:
                         nextUnconfirmedSteps = _this.getUnconfirmedSteps();
                         if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
                           nextUnconfirmedTrs = _this.getUnconfirmedStepsOrigins();
@@ -616,7 +627,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                           isLastTrConfirmed = true;
                         }
                         if (!(!isLastTrConfirmed && count++ >= ACK_MAX_TRY)) {
-                          _context4.next = 15;
+                          _context4.next = 14;
                           break;
                         }
                         if (_this.onSyncUpError) {
@@ -629,24 +640,18 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                             version: getVersion(state)
                           });
                         }
-                        _measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
-                          latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration,
-                          // upon failure, emit the number of unconfirmed steps we attempted to sync
-                          numUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length
-                        });
                         throw new Error("Can't sync up with Collab Service");
-                      case 15:
-                        _context4.next = 4;
+                      case 14:
+                        _context4.next = 5;
                         break;
-                      case 17:
+                      case 16:
                         measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+                        (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
                           latency: measure === null || measure === void 0 ? void 0 : measure.duration,
                           // upon success, emit the total number of unconfirmed steps we synced
                           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
                         });
-                      case 19:
+                      case 18:
                       case "end":
                         return _context4.stop();
                     }
@@ -654,53 +659,60 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                 }, _callee4);
               })(), "t0", 4);
             case 4:
+              _context5.next = 12;
+              break;
+            case 6:
+              _context5.prev = 6;
+              _context5.t1 = _context5["catch"](1);
+              measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+              (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+                latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+              });
+              (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendErrorEvent(_context5.t1, 'Error while committing unconfirmed steps');
+              throw _context5.t1;
+            case 12:
             case "end":
               return _context5.stop();
           }
         }
-      }, _callee5);
+      }, _callee5, null, [[1, 6]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6() {
-      var _this$analyticsHelper23, currentState, measure, _this$analyticsHelper24, _this$analyticsHelper25, _this$metadata$title2, _measure2;
+      var _this$analyticsHelper26, currentState, measure, _this$analyticsHelper27, _this$analyticsHelper28, _measure2;
       return _regeneratorRuntime.wrap(function _callee6$(_context6) {
         while (1) {
           switch (_context6.prev = _context6.next) {
             case 0:
-              // Moved these out of the try catch to maintain the current logic for throwing / not throwing errors
+              _context6.prev = 0;
               startMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              _context6.next = 3;
+              _context6.next = 4;
               return _this.commitUnconfirmedSteps();
-            case 3:
-              _context6.prev = 3;
+            case 4:
               _context6.next = 6;
               return _this.getCurrentState();
             case 6:
               currentState = _context6.sent;
               measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
+              (_this$analyticsHelper26 = _this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
                 latency: measure === null || measure === void 0 ? void 0 : measure.duration
               });
               return _context6.abrupt("return", currentState);
             case 12:
               _context6.prev = 12;
-              _context6.t0 = _context6["catch"](3);
-              _measure2 = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-              (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
+              _context6.t0 = _context6["catch"](0);
+              _measure2 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+              (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
                 latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
               });
-              (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendErrorEvent(_context6.t0, 'Error while returning ADF version of the final draft document');
-              // TODO: We should likely throw here after we stop using this for draft sync, there is no way of knowing what happened otherwise, but this is what it was doing before
-              return _context6.abrupt("return", {
-                content: undefined,
-                title: (_this$metadata$title2 = _this.metadata.title) === null || _this$metadata$title2 === void 0 ? void 0 : _this$metadata$title2.toString(),
-                stepVersion: getVersion(_this.getState())
-              });
+              (_this$analyticsHelper28 = _this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendErrorEvent(_context6.t0, 'Error while returning ADF version of the final draft document');
+              throw _context6.t0;
             case 18:
             case "end":
               return _context6.stop();
           }
         }
-      }, _callee6, null, [[3, 12]]);
+      }, _callee6, null, [[0, 12]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "onNamespaceStatusChanged", /*#__PURE__*/function () {
       var _ref17 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(data) {
@@ -780,8 +792,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           this.isChannelInitialized = true;
         }
       } catch (initError) {
-        var _this$analyticsHelper26;
-        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendErrorEvent(initError, 'Error while initialising the provider');
+        var _this$analyticsHelper29;
+        (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendErrorEvent(initError, 'Error while initialising the provider');
         // Throw error so consumers are aware the initialisation failed when initialising themselves
         throw initError;
       }
@@ -904,9 +916,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper27;
+          var _this$analyticsHelper30;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper30 = this.analyticsHelper) === null || _this$analyticsHelper30 === void 0 ? void 0 : _this$analyticsHelper30.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }
@@ -929,9 +941,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           var callback = telepointerCallback(this.config.documentAri);
           this.channel.broadcast('participant:telepointer', payload, callback);
         } catch (error) {
-          var _this$analyticsHelper28;
+          var _this$analyticsHelper31;
           // We don't want to throw errors for Presence features as they tend to self-restore
-          (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendErrorEvent(error, 'Error while sending message - telepointer');
+          (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 ? void 0 : _this$analyticsHelper31.sendErrorEvent(error, 'Error while sending message - telepointer');
         }
       }
     }
@@ -947,11 +959,13 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           }
         });
       } catch (error) {
-        var _this$analyticsHelper29;
+        var _this$analyticsHelper32;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendErrorEvent(error, 'Error while emitting telepointers from steps');
+        (_this$analyticsHelper32 = this.analyticsHelper) === null || _this$analyticsHelper32 === void 0 ? void 0 : _this$analyticsHelper32.sendErrorEvent(error, 'Error while emitting telepointers from steps');
       }
     }
+
+    // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
   }, {
     key: "destroy",
     value: function destroy() {

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "8.3.0";
+export var version = "8.4.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "8.3.0",
+	"version": "8.4.0",
 	"sideEffects": false
 }

package/dist/types/analytics/performance.d.ts

@@ -3,7 +3,8 @@ export declare enum MEASURE_NAME {
     SOCKET_CONNECT = "socketConnect",
     DOCUMENT_INIT = "documentInit",
     COMMIT_UNCONFIRMED_STEPS = "commitUnconfirmedSteps",
-    PUBLISH_PAGE = "publishPage"
+    PUBLISH_PAGE = "publishPage",
+    GET_CURRENT_STATE = "getCurrentState"
 }
 export declare function startMeasure(measureName: MEASURE_NAME, analyticsHelper: AnalyticsHelper | undefined): void;
 export declare function stopMeasure(measureName: MEASURE_NAME, analyticsHelper: AnalyticsHelper | undefined, onMeasureComplete?: (duration: number, startTime: number) => void): {

package/dist/types/channel.d.ts

@@ -10,15 +10,20 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private initialized;
     private analyticsHelper?;
     private initExperience?;
+    private token?;
     private network;
     constructor(config: Config, analyticsHelper: AnalyticsHelper);
     getInitialized: () => boolean;
     getConnected: () => boolean;
     getSocket: () => Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap> | null;
+    getToken: () => string | undefined;
+    private setToken;
+    private unsetToken;
     /**
      * Connect to collab service using websockets
      */
     connect(): void;
+    private handlePermissionInvalidateToken;
     private onConnectError;
     private onReconnectError;
     private onConnect;

package/dist/types/{error-code-mapper.d.ts → errors/error-code-mapper.d.ts}

@@ -1,4 +1,4 @@
-import type { CollabErrorPayload, ErrorPayload } from './types';
+import type { CollabErrorPayload, ErrorPayload } from '../types';
 export declare const ErrorCodeMapper: {
     noPermissionError: {
         code: string;

package/dist/types/errors/error-types.d.ts

@@ -0,0 +1,8 @@
+export declare class NotConnectedError extends Error {
+    name: string;
+    constructor(message: string);
+}
+export declare class NotInitializedError extends Error {
+    name: string;
+    constructor(message: string);
+}

package/dist/types/helpers/const.d.ts

@@ -1,18 +1,16 @@
 import type { CollabErrorPayload } from '../types';
 export declare enum EVENT_ACTION {
     CONNECTION = "connection",
-    RECONNECTION = "reconnection",
     CATCHUP = "catchup",
     DOCUMENT_INIT = "documentInit",
     ADD_STEPS = "addSteps",
     UPDATE_PARTICIPANTS = "updateParticipants",
     COMMIT_UNCONFIRMED_STEPS = "commitUnconfirmedSteps",
     REINITIALISE_DOCUMENT = "reinitialiseDocument",
-    INIT_PROVIDER = "initProvider",
     ERROR = "error",
-    MEASURE_PERFORMANCE = "measurePerformance",
-    INIT_UFO_EXPERIENCE = "initUFOExperience",
-    PUBLISH_PAGE = "publishPage"
+    PUBLISH_PAGE = "publishPage",
+    GET_CURRENT_STATE = "getCurrentState",
+    INVALIDATE_TOKEN = "invalidateToken"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -27,6 +25,7 @@ export declare type ErrorAnalyticsEvent = {
     eventAction: EVENT_ACTION.ERROR;
     attributes: {
         errorMessage: string;
+        errorName?: string;
         documentAri?: string;
         mappedError?: CollabErrorPayload;
     };
@@ -34,6 +33,14 @@ export declare type ErrorAnalyticsEvent = {
         error: unknown;
     };
 };
+declare type InvalidateTokenAnalyticsEvent = {
+    eventAction: EVENT_ACTION.INVALIDATE_TOKEN;
+    attributes: {
+        eventStatus: EVENT_STATUS.SUCCESS;
+        reason?: string;
+        usedCachedToken?: boolean;
+    };
+};
 declare type AddStepsSuccessAnalyticsEvent = {
     eventAction: EVENT_ACTION.ADD_STEPS;
     attributes: {
@@ -155,7 +162,23 @@ declare type PublishPageFailureAnalyticsEvent = {
         latency?: number;
     };
 };
-export declare type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent;
+declare type GetCurrentStateSuccessAnalyticsEvent = {
+    eventAction: EVENT_ACTION.GET_CURRENT_STATE;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+        latency?: number;
+    };
+};
+declare type GetCurrentStateFailureAnalyticsEvent = {
+    eventAction: EVENT_ACTION.GET_CURRENT_STATE;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.FAILURE;
+        latency?: number;
+    };
+};
+export declare type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent;
 export declare const ACK_MAX_TRY = 30;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types/provider/index.d.ts

@@ -1,9 +1,23 @@
+/// <reference types="lodash" />
 import type { EditorState, Transaction } from 'prosemirror-state';
+import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import { Emitter } from '../emitter';
+import { Channel } from '../channel';
 import type { CollabEditProvider, CollabParticipant, ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { CollabEvents, Config, Metadata } from '../types';
+import type { CollabEvents, Config, ErrorPayload, Metadata, StepsPayload } from '../types';
+import AnalyticsHelper from '../analytics';
 import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
+export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ channel, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+    channel: Channel;
+    steps: readonly ProseMirrorStep<any>[];
+    version: number;
+    userId: string;
+    clientId: string | number;
+    onStepsAdded: (data: StepsPayload) => void;
+    onErrorHandled: (error: ErrorPayload) => void;
+    analyticsHelper?: AnalyticsHelper | undefined;
+}) => void>;
 declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare type ParticipantsMap = Map<string, CollabParticipant & {
     userId: string;

package/dist/types/socket-io-provider.d.ts

@@ -1,5 +1,5 @@
 import { Provider } from './provider';
 import { Socket } from 'socket.io-client';
-import { Config, ProductInformation } from './types';
-export declare function createSocketIOSocket(url: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation): Socket;
+import { Config, ProductInformation, InitAndAuthData, AuthCallback } from './types';
+export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation): Socket;
 export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

package/dist/types/types.d.ts

@@ -15,7 +15,7 @@ export interface Config {
     lifecycle?: Lifecycle;
     storage?: Storage;
     need404?: boolean;
-    createSocket: (path: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation) => Socket;
+    createSocket: (path: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation) => Socket;
     analyticsClient?: AnalyticsWebClient;
     featureFlags?: {
         [key: string]: boolean;
@@ -23,9 +23,24 @@ export interface Config {
     getUser?(userId: string): Promise<Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
         userId: string;
     }>;
+    /**
+     * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
+     */
     permissionTokenRefresh?: () => Promise<string | null>;
+    cacheToken?: boolean;
     productInfo?: ProductInformation;
+    /**
+     * Throws errors when trying to send data to collab but the client is not offline.
+     * This can lead to potential dataloss and retrying should be considered. Without this flag the provider silently drops the requests.
+     */
+    throwOnNotConnected?: boolean;
 }
+export interface InitAndAuthData {
+    initialized: boolean;
+    need404?: boolean;
+    token?: string;
+}
+export declare type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
 interface SimpleEventEmitter {
     on(event: string, fn: Function): SimpleEventEmitter;
 }
@@ -127,14 +142,14 @@ declare type SliceJson = {
     openEnd: number;
 };
 export declare type StepJson = {
+    stepType?: string;
     from?: number;
     to?: number;
-    stepType?: string;
+    slice?: SliceJson;
     clientId: number | string;
     userId: string;
     createdAt?: number;
     structure?: boolean;
-    slice?: SliceJson;
 };
 export declare enum AcknowledgementResponseTypes {
     SUCCESS = "SUCCESS",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -23,7 +23,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.0.10",
     "@atlaskit/analytics-listeners": "^8.5.0",
-    "@atlaskit/editor-common": "^72.5.0",
+    "@atlaskit/editor-common": "^72.6.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
     "@atlaskit/prosemirror-collab": "^0.1.0",
     "@atlaskit/ufo": "^0.1.4",
@@ -51,7 +51,7 @@
   "devDependencies": {
     "@atlaskit/adf-schema": "^25.3.0",
     "@atlaskit/analytics-listeners": "^8.5.0",
-    "@atlaskit/editor-test-helpers": "^18.0.0",
+    "@atlaskit/editor-test-helpers": "^18.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",