@atlaskit/collab-provider 9.41.0 → 9.41.1

package/dist/esm/provider/index.js

@@ -291,7 +291,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       _this.documentService = new NullDocumentService();
       _this.api = new NullApi();
     } else {
-      _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
+      _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
         return _this.userId;
       }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, {
         __livePage: _this.config.__livePage || false

package/dist/esm/types.js

@@ -21,6 +21,4 @@ export var AcknowledgementResponseTypes = /*#__PURE__*/function (Acknowledgement
 
 // ESS-2916 Type def for namespace status - lock/unlock
 
-// Catchup
-
 // CatchupV2

package/dist/esm/version-wrapper.js

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

package/dist/types/channel.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from './emitter';
-import type { Config, ChannelEvent, CatchupResponse, Catchupv2Response, ReconcileResponse } from './types';
+import type { Config, ChannelEvent, Catchupv2Response, ReconcileResponse } from './types';
 import { type CatchupEventReason } from './helpers/const';
 import type { Socket } from 'socket.io-client';
 import type AnalyticsHelper from './analytics/analytics-helper';
@@ -40,7 +40,6 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onReconnectError;
     private onConnect;
     private onReceiveData;
-    fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
     fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**

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

@@ -3,7 +3,7 @@ import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/trans
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import { CatchupEventReason } from '../helpers/const';
 import type { MetadataService } from '../metadata/metadata-service';
-import type { CatchupResponse, Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
+import type { Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { InternalError } from '../errors/internal-errors';
@@ -12,7 +12,6 @@ import { type DocumentServiceInterface } from './interface-document-service';
 export declare class DocumentService implements DocumentServiceInterface {
     private participantsService;
     private analyticsHelper;
-    private fetchCatchup;
     private fetchCatchupv2;
     private fetchReconcile;
     private providerEmitCallback;
@@ -35,7 +34,6 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param participantsService - The participants service, used when users are detected active when making changes to the document
      * and to emit their telepointers from steps they add
      * @param analyticsHelper - Helper for analytics events
-     * @param fetchCatchup - StepMap based - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param fetchCatchupv2 - Step based - Function to fetch "catchupv2" data, data required to rebase current steps to the latest version.
      * @param fetchReconcile - Function to call "reconcile" from NCS backend
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
@@ -45,19 +43,9 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, options?: {
         __livePage: boolean;
     });
-    /**
-     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
-     */
-    throttledCatchup: import("lodash").DebouncedFunc<() => Promise<void>>;
-    /**
-     * Called when:
-     *   * session established(offline -> online)
-     *   * try to accept steps but version is behind.
-     */
-    private catchup;
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.

package/dist/types/types.d.ts

@@ -5,7 +5,7 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
+import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
 import { type CatchupEventReason } from './helpers/const';
 export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
@@ -190,12 +190,6 @@ export type ChannelEvent = {
     };
     status: NamespaceStatus;
 };
-export interface CatchupResponse {
-    doc?: string;
-    version?: number;
-    stepMaps?: any[];
-    metadata?: Metadata;
-}
 export interface Catchupv2Response {
     steps?: Step[];
     metadata?: Metadata;
@@ -206,17 +200,6 @@ export interface ReconcileResponse {
     ari?: string;
     metadata?: Metadata;
 }
-export interface CatchupOptions {
-    getCurrentPmVersion: () => number;
-    fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    filterQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
-    getUnconfirmedSteps: () => readonly Step[] | undefined;
-    applyLocalSteps: (steps: Step[]) => void;
-    updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
-    updateMetadata: (metadata: Metadata | undefined) => void;
-    analyticsHelper: AnalyticsHelper | undefined;
-    clientId: number | string | undefined;
-}
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
     fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean, reason?: CatchupEventReason) => Promise<Catchupv2Response>;

package/dist/types-ts4.5/channel.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from './emitter';
-import type { Config, ChannelEvent, CatchupResponse, Catchupv2Response, ReconcileResponse } from './types';
+import type { Config, ChannelEvent, Catchupv2Response, ReconcileResponse } from './types';
 import { type CatchupEventReason } from './helpers/const';
 import type { Socket } from 'socket.io-client';
 import type AnalyticsHelper from './analytics/analytics-helper';
@@ -40,7 +40,6 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onReconnectError;
     private onConnect;
     private onReceiveData;
-    fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
     fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**

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

@@ -3,7 +3,7 @@ import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/trans
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import { CatchupEventReason } from '../helpers/const';
 import type { MetadataService } from '../metadata/metadata-service';
-import type { CatchupResponse, Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
+import type { Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { InternalError } from '../errors/internal-errors';
@@ -12,7 +12,6 @@ import { type DocumentServiceInterface } from './interface-document-service';
 export declare class DocumentService implements DocumentServiceInterface {
     private participantsService;
     private analyticsHelper;
-    private fetchCatchup;
     private fetchCatchupv2;
     private fetchReconcile;
     private providerEmitCallback;
@@ -35,7 +34,6 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param participantsService - The participants service, used when users are detected active when making changes to the document
      * and to emit their telepointers from steps they add
      * @param analyticsHelper - Helper for analytics events
-     * @param fetchCatchup - StepMap based - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param fetchCatchupv2 - Step based - Function to fetch "catchupv2" data, data required to rebase current steps to the latest version.
      * @param fetchReconcile - Function to call "reconcile" from NCS backend
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
@@ -45,19 +43,9 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, options?: {
         __livePage: boolean;
     });
-    /**
-     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
-     */
-    throttledCatchup: import("lodash").DebouncedFunc<() => Promise<void>>;
-    /**
-     * Called when:
-     *   * session established(offline -> online)
-     *   * try to accept steps but version is behind.
-     */
-    private catchup;
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.

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

@@ -5,7 +5,7 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
+import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
 import { type CatchupEventReason } from './helpers/const';
 export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
@@ -190,12 +190,6 @@ export type ChannelEvent = {
     };
     status: NamespaceStatus;
 };
-export interface CatchupResponse {
-    doc?: string;
-    version?: number;
-    stepMaps?: any[];
-    metadata?: Metadata;
-}
 export interface Catchupv2Response {
     steps?: Step[];
     metadata?: Metadata;
@@ -206,17 +200,6 @@ export interface ReconcileResponse {
     ari?: string;
     metadata?: Metadata;
 }
-export interface CatchupOptions {
-    getCurrentPmVersion: () => number;
-    fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    filterQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
-    getUnconfirmedSteps: () => readonly Step[] | undefined;
-    applyLocalSteps: (steps: Step[]) => void;
-    updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
-    updateMetadata: (metadata: Metadata | undefined) => void;
-    analyticsHelper: AnalyticsHelper | undefined;
-    clientId: number | string | undefined;
-}
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
     fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean, reason?: CatchupEventReason) => Promise<Catchupv2Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.41.0",
+	"version": "9.41.1",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"

package/dist/cjs/document/catchup.js

@@ -1,183 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.catchup = void 0;
-exports.rebaseSteps = rebaseSteps;
-exports.removeConfirmedSteps = removeConfirmedSteps;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _const = require("../helpers/const");
-var _utils = require("../helpers/utils");
-var _transform = require("@atlaskit/editor-prosemirror/transform");
-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; }
-var logger = (0, _utils.createLogger)('Catchup', 'red');
-
-/**
- * Rebase the steps based on the mapping pipeline.
- * Some steps could be lost, if they are no longer
- * invalid after rebased.
- */
-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
- */
-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;
-}
-var catchup = exports.catchup = /*#__PURE__*/function () {
-  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.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 _regenerator.default.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 _transform.StepMap(ranges);
-                  stepMap.inverted = inverted;
-                  return stepMap;
-                }); // create Mapping used for Step.map
-                mapping = new _transform.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(_const.EVENT_ACTION.DROPPED_STEPS, _const.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/es2019/document/catchup.js

@@ -1,141 +0,0 @@
-import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
-import { createLogger } from '../helpers/utils';
-import { StepMap, Mapping } from '@atlaskit/editor-prosemirror/transform';
-const 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) {
-  const newSteps = [];
-  for (const step of steps) {
-    const newStep = step.map(mapping);
-    // newStep could be null(means invalid after rebase) when can't rebase.
-    if (newStep) {
-      newSteps.push(newStep);
-    }
-  }
-  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(unconfirmedSteps = [], serverStepMaps = [], clientId) {
-  let newUnconfirmedSteps = Array.from(unconfirmedSteps);
-  for (let i = 0; i < serverStepMaps.length; i++) {
-    if (serverStepMaps[i].clientId === clientId) {
-      newUnconfirmedSteps.shift();
-    }
-  }
-  return newUnconfirmedSteps;
-}
-export const catchup = async opt => {
-  let doc, serverStepMaps, serverVersion, metadata;
-  try {
-    ({
-      doc,
-      stepMaps: serverStepMaps,
-      version: serverVersion,
-      metadata
-    } = await opt.fetchCatchup(opt.getCurrentPmVersion(), opt.clientId));
-  } catch (error) {
-    var _opt$analyticsHelper;
-    (_opt$analyticsHelper = opt.analyticsHelper) === null || _opt$analyticsHelper === void 0 ? void 0 : _opt$analyticsHelper.sendErrorEvent(error, 'Error while fetching catchup from server');
-    logger(`Fetch catchup from server failed:`, error.message);
-    throw error;
-  }
-  try {
-    if (doc) {
-      const 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
-        const unconfirmedSteps = opt.getUnconfirmedSteps();
-
-        // replace the entire document
-        logger(`Replacing document: ${doc}`);
-        logger(`getting metadata: ${metadata}`);
-        // Replace local document and version number
-        opt.updateDocument({
-          doc: JSON.parse(doc),
-          version: serverVersion,
-          metadata,
-          reserveCursor: true
-        });
-        opt.updateMetadata(metadata);
-        if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          opt.applyLocalSteps(unconfirmedSteps);
-        }
-      } else {
-        var _unconfirmedSteps;
-        // Please, do not use those steps inside of async
-        // method. That will lead to outdated steps
-        let unconfirmedSteps = opt.getUnconfirmedSteps();
-        logger(`Too far behind[current: v${currentPmVersion}, server: v${serverVersion}. ${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(data => data.version > serverVersion);
-
-        // We are too far behind - replace the entire document
-        logger(`Replacing document: ${doc}`);
-        logger(`getting metadata: ${metadata}`);
-
-        // Replace local document and version number
-        opt.updateDocument({
-          doc: JSON.parse(doc),
-          version: serverVersion,
-          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 ((_unconfirmedSteps = unconfirmedSteps) !== null && _unconfirmedSteps !== void 0 && _unconfirmedSteps.length) {
-          // Create StepMap from StepMap JSON
-          // eslint-disable-next-line no-unused-vars
-          unconfirmedSteps = removeConfirmedSteps(unconfirmedSteps, serverStepMaps, opt.clientId);
-          const stepMaps = serverStepMaps.map(({
-            ranges,
-            inverted
-          }) => {
-            // Due to @types/prosemirror-transform mismatch with the actual
-            // constructor, hack to set the `inverted`.
-            const stepMap = new StepMap(ranges);
-            stepMap.inverted = inverted;
-            return stepMap;
-          });
-          // create Mapping used for Step.map
-          const mapping = new Mapping(stepMaps);
-          logger(`${unconfirmedSteps.length} unconfirmed steps before rebased: ${JSON.stringify(unconfirmedSteps)}`);
-          const newUnconfirmedSteps = rebaseSteps(unconfirmedSteps, mapping);
-          if ((newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length) < unconfirmedSteps.length) {
-            var _opt$analyticsHelper2;
-            // Log the dropped steps after rebase
-            (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 ? 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 ${newUnconfirmedSteps.length} mapped unconfirmed steps: ${JSON.stringify(newUnconfirmedSteps)}`);
-          // Re-apply local steps
-          opt.applyLocalSteps(newUnconfirmedSteps);
-        }
-      }
-    }
-  } catch (error) {
-    var _opt$analyticsHelper3;
-    (_opt$analyticsHelper3 = opt.analyticsHelper) === null || _opt$analyticsHelper3 === void 0 ? void 0 : _opt$analyticsHelper3.sendErrorEvent(error, 'Failed to apply catchup result in the editor');
-    logger(`Apply catchup steps failed:`, error.message);
-    throw error;
-  }
-};