@atlaskit/collab-provider 9.41.0 → 9.41.1

package/dist/esm/document/catchup.js

@@ -1,174 +0,0 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
-import { createLogger } from '../helpers/utils';
-import { StepMap, Mapping } from '@atlaskit/editor-prosemirror/transform';
-var logger = createLogger('Catchup', 'red');
-
-/**
- * Rebase the steps based on the mapping pipeline.
- * Some steps could be lost, if they are no longer
- * invalid after rebased.
- */
-export function rebaseSteps(steps, mapping) {
-  var newSteps = [];
-  var _iterator = _createForOfIteratorHelper(steps),
-    _step;
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var step = _step.value;
-      var newStep = step.map(mapping);
-      // newStep could be null(means invalid after rebase) when can't rebase.
-      if (newStep) {
-        newSteps.push(newStep);
-      }
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
-  }
-  return newSteps;
-}
-
-/**
- * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
- * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
- */
-export function removeConfirmedSteps() {
-  var unconfirmedSteps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  var serverStepMaps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  var clientId = arguments.length > 2 ? arguments[2] : undefined;
-  var newUnconfirmedSteps = Array.from(unconfirmedSteps);
-  for (var i = 0; i < serverStepMaps.length; i++) {
-    if (serverStepMaps[i].clientId === clientId) {
-      newUnconfirmedSteps.shift();
-    }
-  }
-  return newUnconfirmedSteps;
-}
-export var catchup = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(opt) {
-    var doc, serverStepMaps, serverVersion, metadata, _yield$opt$fetchCatch, _opt$analyticsHelper, currentPmVersion, unconfirmedSteps, _unconfirmedSteps2, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper2, _opt$analyticsHelper3;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
-        case 0:
-          _context.prev = 0;
-          _context.next = 3;
-          return opt.fetchCatchup(opt.getCurrentPmVersion(), opt.clientId);
-        case 3:
-          _yield$opt$fetchCatch = _context.sent;
-          doc = _yield$opt$fetchCatch.doc;
-          serverStepMaps = _yield$opt$fetchCatch.stepMaps;
-          serverVersion = _yield$opt$fetchCatch.version;
-          metadata = _yield$opt$fetchCatch.metadata;
-          _context.next = 15;
-          break;
-        case 10:
-          _context.prev = 10;
-          _context.t0 = _context["catch"](0);
-          (_opt$analyticsHelper = opt.analyticsHelper) === null || _opt$analyticsHelper === void 0 || _opt$analyticsHelper.sendErrorEvent(_context.t0, 'Error while fetching catchup from server');
-          logger("Fetch catchup from server failed:", _context.t0.message);
-          throw _context.t0;
-        case 15:
-          _context.prev = 15;
-          if (doc) {
-            currentPmVersion = opt.getCurrentPmVersion();
-            if (typeof serverVersion === 'undefined') {
-              logger("Could not determine server version");
-            } else if (serverVersion <= currentPmVersion) {
-              // there are no step maps in this case after page recovery
-              unconfirmedSteps = opt.getUnconfirmedSteps(); // replace the entire document
-              logger("Replacing document: ".concat(doc));
-              logger("getting metadata: ".concat(metadata));
-              // Replace local document and version number
-              opt.updateDocument({
-                doc: JSON.parse(doc),
-                version: serverVersion,
-                metadata: metadata,
-                reserveCursor: true
-              });
-              opt.updateMetadata(metadata);
-              if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-                opt.applyLocalSteps(unconfirmedSteps);
-              }
-            } else {
-              // Please, do not use those steps inside of async
-              // method. That will lead to outdated steps
-              _unconfirmedSteps = opt.getUnconfirmedSteps();
-              logger("Too far behind[current: v".concat(currentPmVersion, ", server: v").concat(serverVersion, ". ").concat(serverStepMaps.length, " steps need to catchup]"));
-              /**
-               * Remove steps from queue where the version is older than
-               * the version we received from service. Keep steps that might be
-               * newer.
-               */
-              opt.filterQueue(function (data) {
-                return data.version > serverVersion;
-              });
-
-              // We are too far behind - replace the entire document
-              logger("Replacing document: ".concat(doc));
-              logger("getting metadata: ".concat(metadata));
-
-              // Replace local document and version number
-              opt.updateDocument({
-                doc: JSON.parse(doc),
-                version: serverVersion,
-                metadata: metadata,
-                reserveCursor: true
-              });
-              opt.updateMetadata(metadata);
-
-              // After replacing the whole document in the editor, we need to reapply the unconfirmed
-              // steps back into the editor, so we don't lose any data. But before that, we need to rebase
-              // those steps since their position could be changed after replacing.
-              // https://prosemirror.net/docs/guide/#transform.rebasing
-              if ((_unconfirmedSteps2 = _unconfirmedSteps) !== null && _unconfirmedSteps2 !== void 0 && _unconfirmedSteps2.length) {
-                // Create StepMap from StepMap JSON
-                // eslint-disable-next-line no-unused-vars
-                _unconfirmedSteps = removeConfirmedSteps(_unconfirmedSteps, serverStepMaps, opt.clientId);
-                stepMaps = serverStepMaps.map(function (_ref2) {
-                  var ranges = _ref2.ranges,
-                    inverted = _ref2.inverted;
-                  // Due to @types/prosemirror-transform mismatch with the actual
-                  // constructor, hack to set the `inverted`.
-                  var stepMap = new StepMap(ranges);
-                  stepMap.inverted = inverted;
-                  return stepMap;
-                }); // create Mapping used for Step.map
-                mapping = new Mapping(stepMaps);
-                logger("".concat(_unconfirmedSteps.length, " unconfirmed steps before rebased: ").concat(JSON.stringify(_unconfirmedSteps)));
-                newUnconfirmedSteps = rebaseSteps(_unconfirmedSteps, mapping);
-                if ((newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length) < _unconfirmedSteps.length) {
-                  // Log the dropped steps after rebase
-                  (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendActionEvent(EVENT_ACTION.DROPPED_STEPS, EVENT_STATUS.SUCCESS, {
-                    numOfDroppedSteps: _unconfirmedSteps.length - (newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length)
-                  });
-                }
-                logger("Re-aply ".concat(newUnconfirmedSteps.length, " mapped unconfirmed steps: ").concat(JSON.stringify(newUnconfirmedSteps)));
-                // Re-apply local steps
-                opt.applyLocalSteps(newUnconfirmedSteps);
-              }
-            }
-          }
-          _context.next = 24;
-          break;
-        case 19:
-          _context.prev = 19;
-          _context.t1 = _context["catch"](15);
-          (_opt$analyticsHelper3 = opt.analyticsHelper) === null || _opt$analyticsHelper3 === void 0 || _opt$analyticsHelper3.sendErrorEvent(_context.t1, 'Failed to apply catchup result in the editor');
-          logger("Apply catchup steps failed:", _context.t1.message);
-          throw _context.t1;
-        case 24:
-        case "end":
-          return _context.stop();
-      }
-    }, _callee, null, [[0, 10], [15, 19]]);
-  }));
-  return function catchup(_x) {
-    return _ref.apply(this, arguments);
-  };
-}();

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

@@ -1,15 +0,0 @@
-import type { CatchupOptions } from '../types';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import { Mapping } from '@atlaskit/editor-prosemirror/transform';
-/**
- * Rebase the steps based on the mapping pipeline.
- * Some steps could be lost, if they are no longer
- * invalid after rebased.
- */
-export declare function rebaseSteps(steps: readonly Step[], mapping: Mapping): Step[];
-/**
- * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
- * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
- */
-export declare function removeConfirmedSteps(unconfirmedSteps: readonly Step[] | undefined, serverStepMaps: any[] | undefined, clientId: string | number | undefined): Step[];
-export declare const catchup: (opt: CatchupOptions) => Promise<void>;

package/dist/types-ts4.5/document/catchup.d.ts

@@ -1,15 +0,0 @@
-import type { CatchupOptions } from '../types';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import { Mapping } from '@atlaskit/editor-prosemirror/transform';
-/**
- * Rebase the steps based on the mapping pipeline.
- * Some steps could be lost, if they are no longer
- * invalid after rebased.
- */
-export declare function rebaseSteps(steps: readonly Step[], mapping: Mapping): Step[];
-/**
- * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
- * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
- */
-export declare function removeConfirmedSteps(unconfirmedSteps: readonly Step[] | undefined, serverStepMaps: any[] | undefined, clientId: string | number | undefined): Step[];
-export declare const catchup: (opt: CatchupOptions) => Promise<void>;