@atlaskit/collab-provider 7.1.4 → 7.1.7

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/collab-provider
 
+## 7.1.7
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.1.6
+
+### Patch Changes
+
+- [`5d5d6468ba9`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5d5d6468ba9) - Remove url-parse from collab-provider
+
+  Url-parse can be replaced with the built-in URL constructor
+
+## 7.1.5
+
+### Patch Changes
+
+- [`f82fb6c48f7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f82fb6c48f7) - [ED-13911] Fix cycle dependencies
+- [`97412280671`](https://bitbucket.org/atlassian/atlassian-frontend/commits/97412280671) - [ED-13939] Add analytics event to track "can't syncup with collab service" error
+- [`88ada10af2c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/88ada10af2c) - [ED-14097] Moved getFinalAcknowledgedState control to editor and made the API public
+- [`85648c038a4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/85648c038a4) - ED-13939 Rename newCollabSyncUpError analytics event to newCollabSyncUpErrorNoSteps
+- [`e292f108d4b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e292f108d4b) - Ensure metadata is persisted when it is updated by another participant during an editing session
+- Updated dependencies
+
 ## 7.1.4
 
 ### Patch Changes

package/dist/cjs/provider/index.js

@@ -77,6 +77,8 @@ var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 exports.CATCHUP_THROTTLE = CATCHUP_THROTTLE;
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
+var noop = function noop() {};
+
 var MAX_STEP_REJECTED_ERROR = 15;
 exports.MAX_STEP_REJECTED_ERROR = MAX_STEP_REJECTED_ERROR;
 
@@ -146,7 +148,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           version: version,
           metadata: metadata
         });
-      }).on('steps:added', _this.onStepsAdded).on('participant:telepointer', _this.onParticipantTelepointer).on('presence:joined', _this.onPresenceJoined).on('presence', _this.onPresence).on('participant:left', _this.onParticipantLeft).on('participant:updated', _this.onParticipantUpdated).on('metadata:changed', _this.onMetadataChanged).on('disconnect', _this.onDisconnected).on('error', _this.onErrorHandled).connect();
+      }).on('steps:added', _this.onStepsAdded.bind((0, _assertThisInitialized2.default)(_this))).on('participant:telepointer', _this.onParticipantTelepointer.bind((0, _assertThisInitialized2.default)(_this))).on('presence:joined', _this.onPresenceJoined.bind((0, _assertThisInitialized2.default)(_this))).on('presence', _this.onPresence.bind((0, _assertThisInitialized2.default)(_this))).on('participant:left', _this.onParticipantLeft.bind((0, _assertThisInitialized2.default)(_this))).on('participant:updated', _this.onParticipantUpdated.bind((0, _assertThisInitialized2.default)(_this))).on('metadata:changed', _this.onMetadataChanged.bind((0, _assertThisInitialized2.default)(_this))).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled.bind((0, _assertThisInitialized2.default)(_this))).connect();
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onStepsAdded", function (data) {
       logger("Received steps", {
@@ -332,6 +334,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onMetadataChanged", function (metadata) {
       if (metadata !== undefined && !(0, _isEqual.default)(_this.metadata, metadata)) {
+        _this.metadata = metadata;
+
         _this.emit('metadata:changed', metadata);
       }
     });
@@ -531,6 +535,71 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         });
       }
     });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+      var _this$getUnconfirmedS, _this$metadata$title;
+
+      var maxAttemptsToSync, count, unconfirmedSteps, _this$getUnconfirmedS2, _unconfirmedSteps, _state, state;
+
+      return _regenerator.default.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              maxAttemptsToSync = _const.ACK_MAX_TRY;
+              count = 0;
+              unconfirmedSteps = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
+
+            case 3:
+              if (!(unconfirmedSteps && unconfirmedSteps.length)) {
+                _context3.next = 13;
+                break;
+              }
+
+              _this.sendStepsFromCurrentState();
+
+              _context3.next = 7;
+              return (0, _utils.sleep)(500);
+
+            case 7:
+              unconfirmedSteps = (_this$getUnconfirmedS2 = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+
+              if (!(count++ >= maxAttemptsToSync)) {
+                _context3.next = 11;
+                break;
+              }
+
+              if (_this.onSyncUpError) {
+                _state = _this.getState();
+
+                _this.onSyncUpError({
+                  lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
+                  tries: count,
+                  maxRetries: maxAttemptsToSync,
+                  clientId: _this.clientId,
+                  version: (0, _prosemirrorCollab.getVersion)(_state)
+                });
+              }
+
+              throw new Error("Can't syncup with Collab Service");
+
+            case 11:
+              _context3.next = 3;
+              break;
+
+            case 13:
+              state = _this.getState();
+              return _context3.abrupt("return", {
+                content: state.doc.toJSON(),
+                title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
+                stepVersion: (0, _prosemirrorCollab.getVersion)(state)
+              });
+
+            case 15:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    })));
     _this.config = config;
     _this.channel = new _channel.Channel(config);
     _this.isChannelInitialized = false;
@@ -544,13 +613,26 @@ var Provider = /*#__PURE__*/function (_Emitter) {
 
   (0, _createClass2.default)(Provider, [{
     key: "initialize",
-    value: function initialize(optionsOrGetState) {
-      // move this
-      this.getState = typeof optionsOrGetState === 'function' ? optionsOrGetState : optionsOrGetState.getState;
-      this.clientId = typeof optionsOrGetState === 'function' ? // Quick-hack to get clientID from native collab-plugin.
-      this.getState().plugins.find(function (p) {
+    value:
+    /**
+     * Called by collab plugin in editor when it's ready to
+     * initialize a collab session.
+     */
+    function initialize(getState) {
+      return this.setup({
+        getState: getState
+      });
+    }
+  }, {
+    key: "setup",
+    value: function setup(_ref16) {
+      var getState = _ref16.getState,
+          onSyncUpError = _ref16.onSyncUpError;
+      this.getState = getState;
+      this.onSyncUpError = onSyncUpError || noop;
+      this.clientId = getState().plugins.find(function (p) {
         return p.key === 'collab$';
-      }).spec.config.clientID : optionsOrGetState.clientId;
+      }).spec.config.clientID;
 
       if (!this.isChannelInitialized) {
         this.initializeChannel();
@@ -655,8 +737,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       logger("Processing data. Version \"".concat(version, "\"."));
 
       if (steps && steps.length) {
-        var clientIds = steps.map(function (_ref15) {
-          var clientId = _ref15.clientId;
+        var clientIds = steps.map(function (_ref17) {
+          var clientId = _ref17.clientId;
           return clientId;
         });
         this.emit('data', {
@@ -718,14 +800,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             participant = _Array$from$filter2[0];
 
         if (participant) {
-          var _ref16 = step,
-              stepType = _ref16.stepType,
-              to = _ref16.to,
-              from = _ref16.from,
-              _ref16$slice = _ref16.slice,
-              slice = _ref16$slice === void 0 ? {
+          var _ref18 = step,
+              stepType = _ref18.stepType,
+              to = _ref18.to,
+              from = _ref18.from,
+              _ref18$slice = _ref18.slice,
+              slice = _ref18$slice === void 0 ? {
             content: []
-          } : _ref16$slice;
+          } : _ref18$slice;
 
           var _slice$content = (0, _slicedToArray2.default)(slice.content, 1),
               node = _slice$content[0];
@@ -786,80 +868,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       this.channel.sendMetadata(metadata);
       Object.assign(this.metadata, metadata);
     }
-    /**
-     * Get latest state.
-     *
-     * NOTE: Should this actually convert to ADF instead?
-     */
-
   }, {
-    key: "getFinalAcknowledgedState",
-    value: function () {
-      var _getFinalAcknowledgedState = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-        var _this$getUnconfirmedS;
-
-        var state, count, unconfirmedSteps, _this$getUnconfirmedS2;
-
-        return _regenerator.default.wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                state = this.getState();
-                count = 0;
-                unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps);
-
-              case 3:
-                if (!(unconfirmedSteps && unconfirmedSteps.length)) {
-                  _context3.next = 12;
-                  break;
-                }
-
-                this.sendStepsFromCurrentState();
-                _context3.next = 7;
-                return (0, _utils.sleep)(500);
-
-              case 7:
-                unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps);
-
-                if (!(count++ >= _const.ACK_MAX_TRY)) {
-                  _context3.next = 10;
-                  break;
-                }
-
-                throw new Error("Can't syncup with Collab Service");
-
-              case 10:
-                _context3.next = 3;
-                break;
-
-              case 12:
-                return _context3.abrupt("return", {
-                  content: state.doc.toJSON(),
-                  title: this.metadata.title,
-                  stepVersion: (0, _prosemirrorCollab.getVersion)(state)
-                });
-
-              case 13:
-              case "end":
-                return _context3.stop();
-            }
-          }
-        }, _callee3, this);
-      }));
-
-      function getFinalAcknowledgedState() {
-        return _getFinalAcknowledgedState.apply(this, arguments);
-      }
-
-      return getFinalAcknowledgedState;
-    }()
+    key: "unsubscribeAll",
+    value:
     /**
      * Unsubscribe from all events emitted by this provider.
      */
-
-  }, {
-    key: "unsubscribeAll",
-    value: function unsubscribeAll() {
+    function unsubscribeAll() {
       (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
       this.channel.disconnect();
       return this;

package/dist/cjs/socket-io-provider.js

@@ -14,15 +14,13 @@ var _provider = require("./provider");
 
 var _socket = require("socket.io-client");
 
-var _urlParse2 = _interopRequireDefault(require("url-parse"));
-
 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; }
 
 function createSocketIOSocket(url, auth) {
-  var _urlParse = (0, _urlParse2.default)(url),
-      pathname = _urlParse.pathname;
+  var _URL = new URL(url),
+      pathname = _URL.pathname;
 
   return (0, _socket.io)(url, {
     withCredentials: true,

package/dist/cjs/version.json

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

package/dist/es2019/provider/index.js

@@ -21,6 +21,8 @@ export const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
+const noop = () => {};
+
 export const MAX_STEP_REJECTED_ERROR = 15;
 
 const commitStep = ({
@@ -84,7 +86,7 @@ export class Provider extends Emitter {
           version,
           metadata
         });
-      }).on('steps:added', this.onStepsAdded).on('participant:telepointer', this.onParticipantTelepointer).on('presence:joined', this.onPresenceJoined).on('presence', this.onPresence).on('participant:left', this.onParticipantLeft).on('participant:updated', this.onParticipantUpdated).on('metadata:changed', this.onMetadataChanged).on('disconnect', this.onDisconnected).on('error', this.onErrorHandled).connect();
+      }).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).connect();
     });
 
     _defineProperty(this, "onStepsAdded", data => {
@@ -248,6 +250,7 @@ export class Provider extends Emitter {
 
     _defineProperty(this, "onMetadataChanged", metadata => {
       if (metadata !== undefined && !isequal(this.metadata, metadata)) {
+        this.metadata = metadata;
         this.emit('metadata:changed', metadata);
       }
     });
@@ -420,6 +423,46 @@ export class Provider extends Emitter {
       }
     });
 
+    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+      var _this$getUnconfirmedS, _this$metadata$title;
+
+      const maxAttemptsToSync = ACK_MAX_TRY;
+      let count = 0;
+      let unconfirmedSteps = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
+
+      while (unconfirmedSteps && unconfirmedSteps.length) {
+        var _this$getUnconfirmedS2;
+
+        this.sendStepsFromCurrentState();
+        await sleep(500);
+        unconfirmedSteps = (_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+
+        if (count++ >= maxAttemptsToSync) {
+          if (this.onSyncUpError) {
+            var _unconfirmedSteps;
+
+            const state = this.getState();
+            this.onSyncUpError({
+              lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
+              tries: count,
+              maxRetries: maxAttemptsToSync,
+              clientId: this.clientId,
+              version: getVersion(state)
+            });
+          }
+
+          throw new Error("Can't syncup with Collab Service");
+        }
+      }
+
+      const state = this.getState();
+      return {
+        content: state.doc.toJSON(),
+        title: (_this$metadata$title = this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
+        stepVersion: getVersion(state)
+      };
+    });
+
     this.config = config;
     this.channel = new Channel(config);
     this.isChannelInitialized = false;
@@ -429,11 +472,23 @@ export class Provider extends Emitter {
     }
   }
 
-  initialize(optionsOrGetState) {
-    // move this
-    this.getState = typeof optionsOrGetState === 'function' ? optionsOrGetState : optionsOrGetState.getState;
-    this.clientId = typeof optionsOrGetState === 'function' ? // Quick-hack to get clientID from native collab-plugin.
-    this.getState().plugins.find(p => p.key === 'collab$').spec.config.clientID : optionsOrGetState.clientId;
+  /**
+   * Called by collab plugin in editor when it's ready to
+   * initialize a collab session.
+   */
+  initialize(getState) {
+    return this.setup({
+      getState
+    });
+  }
+
+  setup({
+    getState,
+    onSyncUpError
+  }) {
+    this.getState = getState;
+    this.onSyncUpError = onSyncUpError || noop;
+    this.clientId = getState().plugins.find(p => p.key === 'collab$').spec.config.clientID;
 
     if (!this.isChannelInitialized) {
       this.initializeChannel();
@@ -652,43 +707,10 @@ export class Provider extends Emitter {
     this.channel.sendMetadata(metadata);
     Object.assign(this.metadata, metadata);
   }
-  /**
-   * Get latest state.
-   *
-   * NOTE: Should this actually convert to ADF instead?
-   */
-
-
-  async getFinalAcknowledgedState() {
-    var _this$getUnconfirmedS;
-
-    const state = this.getState();
-    let count = 0;
-    let unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps);
 
-    while (unconfirmedSteps && unconfirmedSteps.length) {
-      var _this$getUnconfirmedS2;
-
-      this.sendStepsFromCurrentState();
-      await sleep(500);
-      unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps);
-
-      if (count++ >= ACK_MAX_TRY) {
-        throw new Error("Can't syncup with Collab Service");
-      }
-    }
-
-    return {
-      content: state.doc.toJSON(),
-      title: this.metadata.title,
-      stepVersion: getVersion(state)
-    };
-  }
   /**
    * Unsubscribe from all events emitted by this provider.
    */
-
-
   unsubscribeAll() {
     super.unsubscribeAll();
     this.channel.disconnect();

package/dist/es2019/socket-io-provider.js

@@ -1,10 +1,9 @@
 import { Provider } from './provider';
 import { io } from 'socket.io-client';
-import urlParse from 'url-parse';
 export function createSocketIOSocket(url, auth) {
   const {
     pathname
-  } = urlParse(url);
+  } = new URL(url);
   return io(url, {
     withCredentials: true,
     transports: ['polling', 'websocket'],

package/dist/es2019/version.json

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

package/dist/esm/provider/index.js

@@ -43,6 +43,8 @@ export 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 commitStep = function commitStep(_ref) {
@@ -116,7 +118,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           version: version,
           metadata: metadata
         });
-      }).on('steps:added', _this.onStepsAdded).on('participant:telepointer', _this.onParticipantTelepointer).on('presence:joined', _this.onPresenceJoined).on('presence', _this.onPresence).on('participant:left', _this.onParticipantLeft).on('participant:updated', _this.onParticipantUpdated).on('metadata:changed', _this.onMetadataChanged).on('disconnect', _this.onDisconnected).on('error', _this.onErrorHandled).connect();
+      }).on('steps:added', _this.onStepsAdded.bind(_assertThisInitialized(_this))).on('participant:telepointer', _this.onParticipantTelepointer.bind(_assertThisInitialized(_this))).on('presence:joined', _this.onPresenceJoined.bind(_assertThisInitialized(_this))).on('presence', _this.onPresence.bind(_assertThisInitialized(_this))).on('participant:left', _this.onParticipantLeft.bind(_assertThisInitialized(_this))).on('participant:updated', _this.onParticipantUpdated.bind(_assertThisInitialized(_this))).on('metadata:changed', _this.onMetadataChanged.bind(_assertThisInitialized(_this))).on('disconnect', _this.onDisconnected.bind(_assertThisInitialized(_this))).on('error', _this.onErrorHandled.bind(_assertThisInitialized(_this))).connect();
     });
 
     _defineProperty(_assertThisInitialized(_this), "onStepsAdded", function (data) {
@@ -316,6 +318,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
 
     _defineProperty(_assertThisInitialized(_this), "onMetadataChanged", function (metadata) {
       if (metadata !== undefined && !isequal(_this.metadata, metadata)) {
+        _this.metadata = metadata;
+
         _this.emit('metadata:changed', metadata);
       }
     });
@@ -523,6 +527,72 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     });
 
+    _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+      var _this$getUnconfirmedS, _this$metadata$title;
+
+      var maxAttemptsToSync, count, unconfirmedSteps, _this$getUnconfirmedS2, _unconfirmedSteps, _state, state;
+
+      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              maxAttemptsToSync = ACK_MAX_TRY;
+              count = 0;
+              unconfirmedSteps = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
+
+            case 3:
+              if (!(unconfirmedSteps && unconfirmedSteps.length)) {
+                _context3.next = 13;
+                break;
+              }
+
+              _this.sendStepsFromCurrentState();
+
+              _context3.next = 7;
+              return sleep(500);
+
+            case 7:
+              unconfirmedSteps = (_this$getUnconfirmedS2 = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+
+              if (!(count++ >= maxAttemptsToSync)) {
+                _context3.next = 11;
+                break;
+              }
+
+              if (_this.onSyncUpError) {
+                _state = _this.getState();
+
+                _this.onSyncUpError({
+                  lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
+                  tries: count,
+                  maxRetries: maxAttemptsToSync,
+                  clientId: _this.clientId,
+                  version: getVersion(_state)
+                });
+              }
+
+              throw new Error("Can't syncup with Collab Service");
+
+            case 11:
+              _context3.next = 3;
+              break;
+
+            case 13:
+              state = _this.getState();
+              return _context3.abrupt("return", {
+                content: state.doc.toJSON(),
+                title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
+                stepVersion: getVersion(state)
+              });
+
+            case 15:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    })));
+
     _this.config = config;
     _this.channel = new Channel(config);
     _this.isChannelInitialized = false;
@@ -536,13 +606,26 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
 
   _createClass(Provider, [{
     key: "initialize",
-    value: function initialize(optionsOrGetState) {
-      // move this
-      this.getState = typeof optionsOrGetState === 'function' ? optionsOrGetState : optionsOrGetState.getState;
-      this.clientId = typeof optionsOrGetState === 'function' ? // Quick-hack to get clientID from native collab-plugin.
-      this.getState().plugins.find(function (p) {
+    value:
+    /**
+     * Called by collab plugin in editor when it's ready to
+     * initialize a collab session.
+     */
+    function initialize(getState) {
+      return this.setup({
+        getState: getState
+      });
+    }
+  }, {
+    key: "setup",
+    value: function setup(_ref16) {
+      var getState = _ref16.getState,
+          onSyncUpError = _ref16.onSyncUpError;
+      this.getState = getState;
+      this.onSyncUpError = onSyncUpError || noop;
+      this.clientId = getState().plugins.find(function (p) {
         return p.key === 'collab$';
-      }).spec.config.clientID : optionsOrGetState.clientId;
+      }).spec.config.clientID;
 
       if (!this.isChannelInitialized) {
         this.initializeChannel();
@@ -647,8 +730,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       logger("Processing data. Version \"".concat(version, "\"."));
 
       if (steps && steps.length) {
-        var clientIds = steps.map(function (_ref15) {
-          var clientId = _ref15.clientId;
+        var clientIds = steps.map(function (_ref17) {
+          var clientId = _ref17.clientId;
           return clientId;
         });
         this.emit('data', {
@@ -711,14 +794,14 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
             participant = _Array$from$filter2[0];
 
         if (participant) {
-          var _ref16 = step,
-              stepType = _ref16.stepType,
-              to = _ref16.to,
-              from = _ref16.from,
-              _ref16$slice = _ref16.slice,
-              slice = _ref16$slice === void 0 ? {
+          var _ref18 = step,
+              stepType = _ref18.stepType,
+              to = _ref18.to,
+              from = _ref18.from,
+              _ref18$slice = _ref18.slice,
+              slice = _ref18$slice === void 0 ? {
             content: []
-          } : _ref16$slice;
+          } : _ref18$slice;
 
           var _slice$content = _slicedToArray(slice.content, 1),
               node = _slice$content[0];
@@ -779,80 +862,13 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       this.channel.sendMetadata(metadata);
       Object.assign(this.metadata, metadata);
     }
-    /**
-     * Get latest state.
-     *
-     * NOTE: Should this actually convert to ADF instead?
-     */
-
   }, {
-    key: "getFinalAcknowledgedState",
-    value: function () {
-      var _getFinalAcknowledgedState = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-        var _this$getUnconfirmedS;
-
-        var state, count, unconfirmedSteps, _this$getUnconfirmedS2;
-
-        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                state = this.getState();
-                count = 0;
-                unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps);
-
-              case 3:
-                if (!(unconfirmedSteps && unconfirmedSteps.length)) {
-                  _context3.next = 12;
-                  break;
-                }
-
-                this.sendStepsFromCurrentState();
-                _context3.next = 7;
-                return sleep(500);
-
-              case 7:
-                unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps);
-
-                if (!(count++ >= ACK_MAX_TRY)) {
-                  _context3.next = 10;
-                  break;
-                }
-
-                throw new Error("Can't syncup with Collab Service");
-
-              case 10:
-                _context3.next = 3;
-                break;
-
-              case 12:
-                return _context3.abrupt("return", {
-                  content: state.doc.toJSON(),
-                  title: this.metadata.title,
-                  stepVersion: getVersion(state)
-                });
-
-              case 13:
-              case "end":
-                return _context3.stop();
-            }
-          }
-        }, _callee3, this);
-      }));
-
-      function getFinalAcknowledgedState() {
-        return _getFinalAcknowledgedState.apply(this, arguments);
-      }
-
-      return getFinalAcknowledgedState;
-    }()
+    key: "unsubscribeAll",
+    value:
     /**
      * Unsubscribe from all events emitted by this provider.
      */
-
-  }, {
-    key: "unsubscribeAll",
-    value: function unsubscribeAll() {
+    function unsubscribeAll() {
       _get(_getPrototypeOf(Provider.prototype), "unsubscribeAll", this).call(this);
 
       this.channel.disconnect();

package/dist/esm/socket-io-provider.js

@@ -6,10 +6,9 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 import { Provider } from './provider';
 import { io } from 'socket.io-client';
-import urlParse from 'url-parse';
 export function createSocketIOSocket(url, auth) {
-  var _urlParse = urlParse(url),
-      pathname = _urlParse.pathname;
+  var _URL = new URL(url),
+      pathname = _URL.pathname;
 
   return io(url, {
     withCredentials: true,

package/dist/esm/version.json

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

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

@@ -1,6 +1,6 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import { GasPurePayload } from '@atlaskit/analytics-gas-types';
-import { ErrorPayload } from '../channel';
+import { ErrorPayload } from '../types';
 export declare const buildAnalyticsPayload: (subject: string, payload?: any) => GasPurePayload;
 export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, analyticsEvent?: GasPurePayload | undefined) => void;
 export declare const triggerAnalyticsForStepsAddedSuccessfully: (analyticsClient?: AnalyticsWebClient | undefined) => void;

package/dist/types/channel.d.ts

@@ -1,74 +1,5 @@
 import { Emitter } from './emitter';
-import { Config, Socket } from './types';
-export interface Metadata {
-    [key: string]: string | number | boolean;
-}
-export declare type InitPayload = {
-    doc: any;
-    version: number;
-    userId?: string;
-    metadata?: Metadata;
-};
-export declare type PresencePayload = {
-    sessionId: string;
-    userId: string;
-    clientId: string;
-    timestamp: number;
-};
-export declare type TelepointerPayload = PresencePayload & {
-    selection: {
-        type: 'textSelection' | 'nodeSelection';
-        anchor: number;
-        head: number;
-    };
-};
-export declare type StepJson = {
-    from?: number;
-    to?: number;
-    stepType?: string;
-    clientId: string;
-    userId: string;
-};
-export declare type StepsPayload = {
-    version: number;
-    steps: StepJson[];
-};
-export declare type ErrorPayload = {
-    message: string;
-    data?: {
-        status: number;
-        code?: string;
-        meta?: string;
-    };
-};
-export declare type ChannelEvent = {
-    connected: {
-        sid: string;
-        initialized: boolean;
-    };
-    init: InitPayload;
-    reconnected: null;
-    'presence:joined': PresencePayload;
-    presence: PresencePayload;
-    'participant:left': PresencePayload;
-    'participant:telepointer': TelepointerPayload;
-    'participant:updated': PresencePayload;
-    'steps:commit': StepsPayload & {
-        userId: string;
-    };
-    'steps:added': StepsPayload;
-    'metadata:changed': Metadata;
-    error: ErrorPayload;
-    disconnect: {
-        reason: string;
-    };
-};
-export interface CatchupResponse {
-    doc?: string;
-    version?: number;
-    stepMaps?: any[];
-    metadata?: Metadata;
-}
+import type { Config, Socket, ChannelEvent, CatchupResponse, Metadata } from './types';
 export declare class Channel extends Emitter<ChannelEvent> {
     private connected;
     private config;

package/dist/types/error-code-mapper.d.ts

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

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
 export { Provider } from './provider';
-export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, } from './provider';
-export type { Socket } from './types';
+export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, Socket, } from './types';

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

@@ -1,20 +1,5 @@
-import { StepsPayload, CatchupResponse } from '../channel';
-import { CollabInitPayload } from '.';
+import type { CatchupOptions } from '../types';
 import { Mapping, Step } from 'prosemirror-transform';
-import { Transaction } from 'prosemirror-state';
-export interface CatchupOptions {
-    getCurrentPmVersion: () => number;
-    fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;
-    fitlerQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
-    getUnconfirmedSteps: () => {
-        version: number;
-        steps: Step<any>[];
-        clientID: string | number;
-        origins: Transaction<any>[];
-    } | null | undefined;
-    updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
-    applyLocalsteps: (steps: Step[]) => void;
-}
 /**
  * Rebase the steps based on the mapping pipeline.
  * Some steps could be lost, if they are no longer

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

@@ -1,57 +1,11 @@
 import { EditorState, Transaction } from 'prosemirror-state';
-import { Step } from 'prosemirror-transform';
 import { Emitter } from '../emitter';
-import { Metadata, StepJson } from '../channel';
-import { CollabEditProvider, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } from '@atlaskit/editor-common/collab';
-import { Config } from '../types';
-import { DisconnectReason } from '../disconnected-reason-mapper';
+import { CollabEditProvider, ResolvedEditorState } from '@atlaskit/editor-common/collab';
+import type { Config, Metadata, CollabEvents } from '../types';
+import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 export declare const CATCHUP_THROTTLE: number;
 export declare const MAX_STEP_REJECTED_ERROR = 15;
-export declare type CollabConnectedPayload = EditorCollabConnetedData;
-export interface CollabDisconnectedPayload {
-    reason: DisconnectReason;
-    sid: string;
-}
-export interface CollabErrorPayload {
-    status: number;
-    code: string;
-    message: string;
-}
-export interface CollabInitPayload extends EditorCollabInitData {
-    doc: any;
-    version: number;
-    userId?: string;
-    metadata?: Metadata;
-}
-export interface CollabDataPayload extends EditorCollabData {
-    version: number;
-    json: StepJson[];
-    userIds: string[];
-}
-export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
-export declare type CollabPresencePayload = EditorCollabPresenceData;
-export declare type CollabMetadataPayload = Metadata;
-export declare type CollabLocalStepsPayload = {
-    steps: Step[];
-};
-export interface CollabEvents {
-    'metadata:changed': CollabMetadataPayload;
-    init: CollabInitPayload;
-    connected: CollabConnectedPayload;
-    disconnected: CollabDisconnectedPayload;
-    data: CollabDataPayload;
-    telepointer: CollabTelepointerPayload;
-    presence: CollabPresencePayload;
-    'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
-    entity: any;
-}
-declare type EditorStateGetter = () => EditorState;
-declare type InitializeOptions = {
-    getState: EditorStateGetter;
-    clientId: string;
-};
-declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'initialize' | 'send' | 'sendMessage'>;
+declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
     private participants;
     private channel;
@@ -61,6 +15,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private stepRejectCounter;
     private analyticsClient?;
     private isChannelInitialized;
+    private onSyncUpError?;
     private sessionId?;
     private clientId?;
     private userId?;
@@ -73,8 +28,11 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * Called by collab plugin in editor when it's ready to
      * initialize a collab session.
      */
-    initialize(getState: EditorStateGetter): this;
-    initialize(options: InitializeOptions): this;
+    initialize(getState: () => EditorState): this;
+    setup({ getState, onSyncUpError, }: {
+        getState: () => EditorState;
+        onSyncUpError?: SyncUpErrorFunction;
+    }): this;
     /**
      * We can use this function to throttle/delay
      * Any send steps operation
@@ -157,18 +115,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     setTitle(title: string, broadcast?: boolean): void;
     setEditorWidth(editorWidth: string, broadcast?: boolean): void;
     setMetadata(metadata: Metadata): void;
-    /**
-     * Get latest state.
-     *
-     * NOTE: Should this actually convert to ADF instead?
-     */
-    getFinalAcknowledgedState(): Promise<{
-        content: {
-            [key: string]: any;
-        };
-        title: string | number | boolean;
-        stepVersion: number;
-    }>;
+    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
     /**
      * Unsubscribe from all events emitted by this provider.
      */

package/dist/types/types.d.ts

@@ -1,6 +1,9 @@
-import { CollabParticipant } from '@atlaskit/editor-common/collab';
-import { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-import { Manager } from 'socket.io-client';
+import type { Transaction } from 'prosemirror-state';
+import type { Step } from 'prosemirror-transform';
+import type { CollabParticipant, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } from '@atlaskit/editor-common/collab';
+import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { Manager } from 'socket.io-client';
+import type { DisconnectReason } from './disconnected-reason-mapper';
 export interface Storage {
     get(key: string): Promise<string>;
     set(key: string, value: string): Promise<void>;
@@ -33,4 +36,125 @@ export declare type EventHandler = () => void;
 export interface Lifecycle {
     on(event: LifecycleEvents, handler: EventHandler): void;
 }
+export declare type CollabConnectedPayload = EditorCollabConnetedData;
+export interface CollabDisconnectedPayload {
+    reason: DisconnectReason;
+    sid: string;
+}
+export interface CollabErrorPayload {
+    status: number;
+    code: string;
+    message: string;
+}
+export interface CollabInitPayload extends EditorCollabInitData {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+}
+export interface CollabDataPayload extends EditorCollabData {
+    version: number;
+    json: StepJson[];
+    userIds: string[];
+}
+export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
+export declare type CollabPresencePayload = EditorCollabPresenceData;
+export declare type CollabMetadataPayload = Metadata;
+export declare type CollabLocalStepsPayload = {
+    steps: Step[];
+};
+export interface CollabEvents {
+    'metadata:changed': CollabMetadataPayload;
+    init: CollabInitPayload;
+    connected: CollabConnectedPayload;
+    disconnected: CollabDisconnectedPayload;
+    data: CollabDataPayload;
+    telepointer: CollabTelepointerPayload;
+    presence: CollabPresencePayload;
+    'local-steps': CollabLocalStepsPayload;
+    error: CollabErrorPayload;
+    entity: any;
+}
+export interface Metadata {
+    [key: string]: string | number | boolean;
+}
+export declare type InitPayload = {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+};
+export declare type PresencePayload = {
+    sessionId: string;
+    userId: string;
+    clientId: string;
+    timestamp: number;
+};
+export declare type TelepointerPayload = PresencePayload & {
+    selection: {
+        type: 'textSelection' | 'nodeSelection';
+        anchor: number;
+        head: number;
+    };
+};
+export declare type StepJson = {
+    from?: number;
+    to?: number;
+    stepType?: string;
+    clientId: string;
+    userId: string;
+};
+export declare type StepsPayload = {
+    version: number;
+    steps: StepJson[];
+};
+export declare type ErrorPayload = {
+    message: string;
+    data?: {
+        status: number;
+        code?: string;
+        meta?: string;
+    };
+};
+export declare type ChannelEvent = {
+    connected: {
+        sid: string;
+        initialized: boolean;
+    };
+    init: InitPayload;
+    reconnected: null;
+    'presence:joined': PresencePayload;
+    presence: PresencePayload;
+    'participant:left': PresencePayload;
+    'participant:telepointer': TelepointerPayload;
+    'participant:updated': PresencePayload;
+    'steps:commit': StepsPayload & {
+        userId: string;
+    };
+    'steps:added': StepsPayload;
+    'metadata:changed': Metadata;
+    error: ErrorPayload;
+    disconnect: {
+        reason: string;
+    };
+};
+export interface CatchupResponse {
+    doc?: string;
+    version?: number;
+    stepMaps?: any[];
+    metadata?: Metadata;
+}
+export interface CatchupOptions {
+    getCurrentPmVersion: () => number;
+    fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;
+    fitlerQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
+    getUnconfirmedSteps: () => {
+        version: number;
+        steps: Step<any>[];
+        clientID: string | number;
+        origins: Transaction<any>[];
+    } | null | undefined;
+    updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
+    applyLocalsteps: (steps: Step[]) => void;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.1.4",
+  "version": "7.1.7",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -22,8 +22,9 @@
   },
   "dependencies": {
     "@atlaskit/analytics-gas-types": "5.0.5",
-    "@atlaskit/analytics-listeners": "^8.0.0",
-    "@atlaskit/editor-common": "^63.0.0",
+    "@atlaskit/analytics-listeners": "^8.2.0",
+    "@atlaskit/editor-common": "^65.0.0",
+    "@atlaskit/editor-json-transformer": "^8.7.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
     "eventemitter2": "^4.1.0",
@@ -31,8 +32,7 @@
     "prosemirror-collab": "^1.2.2",
     "prosemirror-state": "1.3.4",
     "prosemirror-transform": "1.3.2",
-    "socket.io-client": "^4.0.0",
-    "url-parse": "^1.4.5"
+    "socket.io-client": "^4.0.0"
   },
   "techstack": {
     "@atlassian/frontend": {
@@ -43,7 +43,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^16.0.0",
+    "@atlaskit/editor-test-helpers": "^16.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-collab": "^1.1.1",
     "@types/prosemirror-model": "^1.11.0",