@atlaskit/collab-provider 8.6.0 → 8.7.0

package/dist/esm/provider/index.js

@@ -1,4 +1,3 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
@@ -8,7 +7,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 import { Emitter } from '../emitter';
@@ -30,20 +29,13 @@ export var MAX_STEP_REJECTED_ERROR = 15;
 export var Provider = /*#__PURE__*/function (_Emitter) {
   _inherits(Provider, _Emitter);
   var _super = _createSuper(Provider);
-  // To keep track of the namespace event changes from the server.
-
-  // SessionID is the unique socket-session.
-
-  // ClientID is the unique ID for a prosemirror client. Used for step-rebasing.
-
-  // UserID is the users actual account id.
-
   function Provider(config) {
     var _this;
     _classCallCheck(this, Provider);
     _this = _super.call(this);
     _defineProperty(_assertThisInitialized(_this), "isChannelInitialized", false);
     _defineProperty(_assertThisInitialized(_this), "isProviderInitialized", false);
+    // To keep track of the namespace event changes from the server.
     _defineProperty(_assertThisInitialized(_this), "isNamespaceLocked", false);
     _defineProperty(_assertThisInitialized(_this), "emitCallback", function (evt, data) {
       return _this.emit(evt, data);
@@ -98,6 +90,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _this.metadataService.updateMetadata(metadata);
       }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).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('disconnect', _this.onDisconnected.bind(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.onNamespaceStatusChanged.bind(_assertThisInitialized(_this))).connect(shouldInitialize);
     });
+    /**
+     * @param {InternalError} error The error to handle
+     */
     _defineProperty(_assertThisInitialized(_this), "onErrorHandled", function (error) {
       var _error$data, _error$data2;
       // User tried committing steps but they were rejected because:
@@ -136,6 +131,13 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while sending presence');
       }
     });
+    /**
+     * Called when a participant joins the session.
+     *
+     * We keep track of participants internally in this class, and emit the `presence` event to update
+     * the active avatars in the editor.
+     * This method will be triggered from backend to notify all participants to exchange presence
+     */
     _defineProperty(_assertThisInitialized(_this), "onPresenceJoined", function (_ref3) {
       var sessionId = _ref3.sessionId;
       try {
@@ -161,103 +163,129 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while receiving presence');
       }
     });
+    /**
+     * Called when a participant leaves the session.
+     *
+     * We emit the `presence` event to update the active avatars in the editor.
+     */
     _defineProperty(_assertThisInitialized(_this), "onParticipantLeft", function (data) {
       return _this.participantsService.participantLeft(data, _this.emitCallback);
     });
     _defineProperty(_assertThisInitialized(_this), "startInactiveRemover", function () {
       return _this.participantsService.removeInactiveParticipants(_this.sessionId, _this.emitCallback);
     });
+    /**
+     * Called when we receive an update event from another participant.
+     */
     _defineProperty(_assertThisInitialized(_this), "onParticipantUpdated", function (data) {
       return _this.participantsService.updateParticipant(data, _this.config.getUser, _this.emitCallback);
     });
+    /**
+     * Called when we receive a telepointer update from another
+     * participant.
+     */
     _defineProperty(_assertThisInitialized(_this), "onParticipantTelepointer", function (data) {
       return _this.participantsService.participantTelepointer(data, _this.sessionId, _this.config.getUser, _this.emitCallback);
     });
+    // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
     _defineProperty(_assertThisInitialized(_this), "onDisconnected", function (_ref5) {
       var reason = _ref5.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId, _this.emitCallback);
     });
-    _defineProperty(_assertThisInitialized(_this), "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+    /**
+     * Returns the documents metadata
+     */
+    _defineProperty(_assertThisInitialized(_this), "getMetadata", function () {
+      return _this.metadataService.getMetaData();
+    });
+    /**
+     * Return the ADF version of the current draft document, together with it's title and the current step version.
+     * Used for draft sync, a process running every 5s for the first editor of a document to sync the document to the Confluence back-end.
+     * @throws {GetCurrentStateError} Something went wrong while returning the current state
+     */
+    _defineProperty(_assertThisInitialized(_this), "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
       var _this$analyticsHelper6;
-      return _regeneratorRuntime().wrap(function _callee$(_context) {
-        while (1) {
-          switch (_context.prev = _context.next) {
-            case 0:
-              _context.prev = 0;
-              return _context.abrupt("return", _this.documentService.getCurrentState());
-            case 4:
-              _context.prev = 4;
-              _context.t0 = _context["catch"](0);
-              (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
-              throw new GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
-            case 8:
-            case "end":
-              return _context.stop();
-          }
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            _context.prev = 0;
+            return _context.abrupt("return", _this.documentService.getCurrentState());
+          case 4:
+            _context.prev = 4;
+            _context.t0 = _context["catch"](0);
+            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
+            throw new GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
+          case 8:
+          case "end":
+            return _context.stop();
         }
       }, _callee, null, [[0, 4]]);
     })));
-    _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+    /**
+     * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.
+     * Used when returning the document to Confluence on publish.
+     * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
+     */
+    _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
       var _this$analyticsHelper7;
-      return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-        while (1) {
-          switch (_context2.prev = _context2.next) {
-            case 0:
-              _context2.prev = 0;
-              return _context2.abrupt("return", _this.documentService.getFinalAcknowledgedState());
-            case 4:
-              _context2.prev = 4;
-              _context2.t0 = _context2["catch"](0);
-              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
-              throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
-            case 8:
-            case "end":
-              return _context2.stop();
-          }
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.prev = 0;
+            return _context2.abrupt("return", _this.documentService.getFinalAcknowledgedState());
+          case 4:
+            _context2.prev = 4;
+            _context2.t0 = _context2["catch"](0);
+            (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
+            throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
+          case 8:
+          case "end":
+            return _context2.stop();
         }
       }, _callee2, null, [[0, 4]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
+    /**
+     * ESS-2916 namespace status event- lock/unlock
+     */
     _defineProperty(_assertThisInitialized(_this), "onNamespaceStatusChanged", /*#__PURE__*/function () {
-      var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(data) {
+      var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(data) {
         var isLocked, waitTimeInMs, timestamp, start;
-        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                isLocked = data.isLocked, waitTimeInMs = data.waitTimeInMs, timestamp = data.timestamp;
-                start = Date.now();
-                logger("Received a namespace status changed event ", {
-                  data: data
-                });
-                if (!(isLocked && waitTimeInMs)) {
-                  _context3.next = 8;
-                  break;
-                }
-                _this.isNamespaceLocked = true;
-                logger("Received a namespace status change event ", {
-                  isLocked: isLocked
-                });
+        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              isLocked = data.isLocked, waitTimeInMs = data.waitTimeInMs, timestamp = data.timestamp;
+              start = Date.now();
+              logger("Received a namespace status changed event ", {
+                data: data
+              });
+              if (!(isLocked && waitTimeInMs)) {
+                _context3.next = 8;
+                break;
+              }
+              _this.isNamespaceLocked = true;
+              logger("Received a namespace status change event ", {
+                isLocked: isLocked
+              });
 
-                // To protect the collab editing process from locked out due to BE
-                setTimeout(function () {
-                  logger("The namespace lock has expired", {
-                    waitTime: Date.now() - start,
-                    timestamp: timestamp
-                  });
-                  _this.isNamespaceLocked = false;
-                }, waitTimeInMs);
-                return _context3.abrupt("return");
-              case 8:
+              // To protect the collab editing process from locked out due to BE
+              setTimeout(function () {
+                logger("The namespace lock has expired", {
+                  waitTime: Date.now() - start,
+                  timestamp: timestamp
+                });
                 _this.isNamespaceLocked = false;
-                logger("The page lock has expired");
-              case 10:
-              case "end":
-                return _context3.stop();
-            }
+              }, waitTimeInMs);
+              return _context3.abrupt("return");
+            case 8:
+              _this.isNamespaceLocked = false;
+              logger("The page lock has expired");
+            case 10:
+            case "end":
+              return _context3.stop();
           }
         }, _callee3);
       }));
@@ -265,6 +293,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         return _ref8.apply(this, arguments);
       };
     }());
+    /**
+     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
+     */
     _defineProperty(_assertThisInitialized(_this), "clearTimers", function () {
       clearTimeout(_this.presenceUpdateTimeout);
       _this.participantsService.clearTimers();
@@ -309,6 +340,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     value: function setup(_ref9) {
       var getState = _ref9.getState,
         onSyncUpError = _ref9.onSyncUpError;
+      this.checkForCookies();
       try {
         var collabPlugin = getState().plugins.find(function (p) {
           return p.key === 'collab$';
@@ -334,6 +366,16 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
       return this;
     }
+  }, {
+    key: "checkForCookies",
+    value: function checkForCookies() {
+      if (!global.navigator.cookieEnabled) {
+        var _this$analyticsHelper9;
+        var initError = new ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+        throw new ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
+      }
+    }
 
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
@@ -353,15 +395,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.documentService.send(_tr, _oldState, newState);
       } catch (error) {
-        var _this$analyticsHelper9;
-        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while sending steps for a transaction');
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending steps for a transaction');
         throw new SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
-
-    /**
-     * @param {InternalError} error The error to handle
-     */
   }, {
     key: "sendMessage",
     value:
@@ -386,36 +424,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast('participant:telepointer', payload, callback);
         }
       } catch (error) {
-        var _this$analyticsHelper10;
+        var _this$analyticsHelper11;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
-
-    /**
-     * Called when a participant joins the session.
-     *
-     * We keep track of participants internally in this class, and emit the `presence` event to update
-     * the active avatars in the editor.
-     * This method will be triggered from backend to notify all participants to exchange presence
-     */
-
-    /**
-     * Called when a participant leaves the session.
-     *
-     * We emit the `presence` event to update the active avatars in the editor.
-     */
-
-    /**
-     * Called when we receive an update event from another participant.
-     */
-
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
-
-    // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
   }, {
     key: "destroy",
     value:
@@ -452,8 +465,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _get(_getPrototypeOf(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
       } catch (error) {
-        var _this$analyticsHelper11;
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while shutting down the collab provider');
+        var _this$analyticsHelper12;
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while shutting down the collab provider');
         throw new DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -462,6 +475,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
 
     /**
      * Update the title of the document in the collab provider and optionally broadcast it to other participants and NCS
+     * @deprecated use setMetadata instead, it does the same thing
      * @param {string} title Title you want to set on the document
      * @param {boolean} broadcast (Optional) Flag indicating whether you want to broadcast the title change to the other participants, always true for now (otherwise we would lose title changes)
      * @throws {SetTitleError} Something went wrong while setting the title
@@ -472,8 +486,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
-        var _this$analyticsHelper12;
-        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting title');
+        var _this$analyticsHelper13;
+        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting title');
         throw new SetTitleError('Error while setting title', error);
       }
     }
@@ -491,8 +505,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setEditorWidth(editorWidth, broadcast);
       } catch (error) {
-        var _this$analyticsHelper13;
-        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting editor width');
+        var _this$analyticsHelper14;
+        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting editor width');
         throw new SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -508,31 +522,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setMetadata(metadata);
       } catch (error) {
-        var _this$analyticsHelper14;
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting metadata');
+        var _this$analyticsHelper15;
+        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting metadata');
         throw new SetMetadataError('Error while setting metadata', error);
       }
     }
-
-    /**
-     * Return the ADF version of the current draft document, together with it's title and the current step version.
-     * Used for draft sync, a process running every 5s for the first editor of a document to sync the document to the Confluence back-end.
-     * @throws {GetCurrentStateError} Something went wrong while returning the current state
-     */
-
-    /**
-     * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.
-     * Used when returning the document to Confluence on publish.
-     * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
-     */
-
-    /**
-     * ESS-2916 namespace status event- lock/unlock
-     */
-
-    /**
-     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
-     */
   }]);
   return Provider;
 }(Emitter);

package/dist/esm/types.js

@@ -6,9 +6,19 @@
 
 // Channel
 
-export var AcknowledgementResponseTypes;
-(function (AcknowledgementResponseTypes) {
+/**
+ * @description Incoming payload type from the `broadcast` route in NCS
+ * @param {number} timestamp added in NCS
+ * @param {string} sessionId socket.id from NCS
+ * @param data event specific data from NCS
+ */
+
+export var AcknowledgementResponseTypes = /*#__PURE__*/function (AcknowledgementResponseTypes) {
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";
-})(AcknowledgementResponseTypes || (AcknowledgementResponseTypes = {})); // ESS-2916 Type def for namespace status - lock/unlock
+  return AcknowledgementResponseTypes;
+}({});
+
+// ESS-2916 Type def for namespace status - lock/unlock
+
 // Catchup

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "8.6.0";
+export var version = "8.7.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.6.0",
+	"version": "8.7.0",
 	"sideEffects": false
 }

package/dist/types/channel.d.ts

@@ -36,7 +36,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      */
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function | undefined) => void;
     /**
-     * Send metadata to to the back-end service over the channel
+     * Send metadata to the back-end service over the channel
      * @throws {NotInitializedError} Channel not initialized
      * @throws {NotConnectedError} Channel not connected
      */

package/dist/types/metadata/metadata-service.d.ts

@@ -16,7 +16,7 @@ export declare class MetadataService {
      * Updates the local metadata and broadcasts the metadata to other clients/backend.
      * @param metadata
      */
-    setMetadata(metadata: Metadata): void;
+    setMetadata: (metadata: Metadata) => void;
     /**
      * Emits a change in document's metadata
      * @param metadata

package/dist/types/participants/participants-helper.d.ts

@@ -8,8 +8,7 @@ export declare type ProviderParticipant = CollabParticipant & {
 export declare type ParticipantsMap = Map<string, ProviderParticipant>;
 export declare type PresenceEmit = (evt: 'presence', data: CollabEventPresenceData) => void;
 export declare type TelepointerEmit = (evt: 'telepointer', data: CollabEventTelepointerData) => void;
+export declare type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: PresencePayload & {
     userId: string;
-}, getUser: ((userId: string) => Promise<Pick<CollabParticipant, "avatar" | "email" | "name"> & {
-    userId: string;
-}>) | undefined) => Promise<ProviderParticipant>;
+}, getUser: GetUserType) => Promise<ProviderParticipant>;

package/dist/types/participants/participants-service.d.ts

@@ -1,7 +1,7 @@
-import type { CollabEventPresenceData, CollabParticipant, CollabEventDisconnectedData } from '@atlaskit/editor-common/collab';
+import type { CollabEventPresenceData, CollabEventDisconnectedData } from '@atlaskit/editor-common/collab';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { CollabEventTelepointerData, PresencePayload, StepJson, TelepointerPayload } from '../types';
-import { TelepointerEmit } from './participants-helper';
+import { GetUserType, TelepointerEmit } from './participants-helper';
 import type { PresenceEmit } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 export declare class ParticipantsService {
@@ -16,9 +16,7 @@ export declare class ParticipantsService {
      * @param emit Function to execute emit from provider socket
      * @returns Awaitable Promise, due to getUser
      */
-    updateParticipant: (payload: PresencePayload, getUser: ((userId: string) => Promise<Pick<CollabParticipant, "avatar" | "email" | "name"> & {
-        userId: string;
-    }>) | undefined, emit: PresenceEmit) => Promise<void>;
+    updateParticipant: (payload: PresencePayload, getUser: GetUserType, emit: PresenceEmit) => Promise<void>;
     /**
      * Called when a participant leaves the session.
      *
@@ -41,9 +39,7 @@ export declare class ParticipantsService {
      * Called when we receive a telepointer update from another
      * participant.
      */
-    participantTelepointer: (payload: TelepointerPayload, thisSessionId: string | undefined, getUser: ((userId: string) => Promise<Pick<CollabParticipant, "avatar" | "email" | "name"> & {
-        userId: string;
-    }>) | undefined, emit: (evt: 'telepointer' | 'presence', data: CollabEventTelepointerData | CollabEventPresenceData) => void) => void;
+    participantTelepointer: (payload: TelepointerPayload, thisSessionId: string | undefined, getUser: GetUserType, emit: (evt: 'telepointer' | 'presence', data: CollabEventTelepointerData | CollabEventPresenceData) => void) => void;
     /**
      * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
      * Needs to be kicked off in the Provider.

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

@@ -43,6 +43,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
+    private checkForCookies;
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider
@@ -112,6 +113,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     unsubscribeAll(): this;
     /**
      * Update the title of the document in the collab provider and optionally broadcast it to other participants and NCS
+     * @deprecated use setMetadata instead, it does the same thing
      * @param {string} title Title you want to set on the document
      * @param {boolean} broadcast (Optional) Flag indicating whether you want to broadcast the title change to the other participants, always true for now (otherwise we would lose title changes)
      * @throws {SetTitleError} Something went wrong while setting the title
@@ -131,6 +133,10 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * @throws {ExampleError} Something went wrong while setting the metadata
      */
     setMetadata(metadata: Metadata): void;
+    /**
+     * Returns the documents metadata
+     */
+    getMetadata: () => Metadata;
     /**
      * Return the ADF version of the current draft document, together with it's title and the current step version.
      * Used for draft sync, a process running every 5s for the first editor of a document to sync the document to the Confluence back-end.

package/dist/types/types.d.ts

@@ -1,6 +1,6 @@
 import type { Step } from 'prosemirror-transform';
 import type { EditorState, Transaction } from 'prosemirror-state';
-import type { CollabParticipant, CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, ResolvedEditorState } from '@atlaskit/editor-common/collab';
+import type { CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, ResolvedEditorState } 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';
@@ -8,6 +8,7 @@ import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-types';
 import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import { ProviderParticipant } from './participants/participants-helper';
 export interface Storage {
     get(key: string): Promise<string>;
     set(key: string, value: string): Promise<void>;
@@ -33,9 +34,7 @@ export interface Config {
     featureFlags?: {
         [key: string]: boolean;
     };
-    getUser?(userId: string): Promise<Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
-        userId: string;
-    }>;
+    getUser?(userId: string): Promise<Pick<ProviderParticipant, 'avatar' | 'name' | 'userId'>>;
     /**
      * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
      */
@@ -119,6 +118,17 @@ export declare type InitPayload = {
     userId?: string;
     metadata?: Metadata;
 };
+/**
+ * @description Incoming payload type from the `broadcast` route in NCS
+ * @param {number} timestamp added in NCS
+ * @param {string} sessionId socket.id from NCS
+ * @param data event specific data from NCS
+ */
+export declare type BroadcastIncomingPayload = {
+    sessionId?: string;
+    timestamp?: number;
+    data: PresencePayload | TelepointerPayload | StepsPayload | any;
+};
 export declare type PresencePayload = {
     sessionId: string;
     userId: string | undefined;
@@ -126,11 +136,7 @@ export declare type PresencePayload = {
     timestamp: number;
 };
 export declare type TelepointerPayload = PresencePayload & {
-    selection: {
-        type: 'textSelection' | 'nodeSelection';
-        anchor?: number | string;
-        head?: number | string;
-    };
+    selection: CollabSendableSelection;
 };
 declare type MarkJson = {
     type: string;