@atlaskit/collab-provider 9.0.1 → 9.2.0

package/dist/esm/document/document-service.js

@@ -30,16 +30,19 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param analyticsHelper - Helper for analytics events
    * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
    * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-   * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
    * @param broadcast - Callback for broadcasting events to other clients
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
+   * @param metadataService
+   * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
+    var failedStepsBeforeCatchupOnPublish = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : MAX_STEP_REJECTED_ERROR;
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
+    _defineProperty(this, "aggressiveCatchup", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -274,34 +277,37 @@ export var DocumentService = /*#__PURE__*/function () {
       return _regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) switch (_context3.prev = _context3.next) {
           case 0:
-            _context3.prev = 0;
+            _this.aggressiveCatchup = true;
+            _context3.prev = 1;
             startMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            _context3.next = 4;
+            _context3.next = 5;
             return _this.commitUnconfirmedSteps();
-          case 4:
-            _context3.next = 6;
+          case 5:
+            _context3.next = 7;
             return _this.getCurrentState();
-          case 6:
+          case 7:
             currentState = _context3.sent;
             measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration
             });
+            _this.aggressiveCatchup = false;
             return _context3.abrupt("return", currentState);
-          case 12:
-            _context3.prev = 12;
-            _context3.t0 = _context3["catch"](0);
+          case 14:
+            _context3.prev = 14;
+            _context3.t0 = _context3["catch"](1);
+            _this.aggressiveCatchup = false;
             _measure2 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
               latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
             });
             (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
             throw _context3.t0;
-          case 18:
+          case 21:
           case "end":
             return _context3.stop();
         }
-      }, _callee3, null, [[0, 12]]);
+      }, _callee3, null, [[1, 14]]);
     })));
     _defineProperty(this, "updateDocument", function (_ref6) {
       var doc = _ref6.doc,
@@ -402,10 +408,17 @@ export var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 23]]);
     })));
     _defineProperty(this, "onStepRejectedError", function () {
+      var _this$analyticsHelper20;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      if (_this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+      (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+        count: _this.stepRejectCounter
+      });
+      var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
+      if (_this.stepRejectCounter >= maxRetries) {
+        var _this$analyticsHelper21;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
+        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -425,6 +438,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.stepQueue = new StepQueueState();
   }
   _createClass(DocumentService, [{
@@ -476,9 +490,9 @@ export var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper20;
+          var _this$analyticsHelper22;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }
@@ -543,7 +557,8 @@ export var DocumentService = /*#__PURE__*/function () {
         version: version,
         onStepsAdded: this.onStepsAdded,
         onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper
+        analyticsHelper: this.analyticsHelper,
+        emit: this.providerEmitCallback
       });
     }
   }]);

package/dist/esm/helpers/const.js

@@ -10,12 +10,15 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PUBLISH_PAGE"] = "publishPage";
   EVENT_ACTION["GET_CURRENT_STATE"] = "getCurrentState";
   EVENT_ACTION["INVALIDATE_TOKEN"] = "invalidateToken";
+  EVENT_ACTION["SEND_STEPS_RETRY"] = "sendStepsRetry";
+  EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
   return EVENT_ACTION;
 }({});
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
+  EVENT_STATUS["INFO"] = "INFO";
   return EVENT_STATUS;
 }({});
 export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {

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

@@ -16,7 +16,8 @@ export var commitStep = function commitStep(_ref) {
     clientId = _ref.clientId,
     onStepsAdded = _ref.onStepsAdded,
     onErrorHandled = _ref.onErrorHandled,
-    analyticsHelper = _ref.analyticsHelper;
+    analyticsHelper = _ref.analyticsHelper,
+    emit = _ref.emit;
   var stepsWithClientAndUserId = steps.map(function (step) {
     return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
       clientId: clientId,
@@ -24,6 +25,10 @@ export var commitStep = function commitStep(_ref) {
     });
   });
   var start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version: version
+  });
   try {
     broadcast('steps:commit', {
       steps: stepsWithClientAndUserId,
@@ -43,6 +48,10 @@ export var commitStep = function commitStep(_ref) {
             return stepWithClientAndUserId.stepType;
           })
         });
+        emit('commit-status', {
+          status: 'success',
+          version: response.version
+        });
       } else if (response.type === AcknowledgementResponseTypes.ERROR) {
         onErrorHandled(response.error);
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.FAILURE, {
@@ -53,14 +62,26 @@ export var commitStep = function commitStep(_ref) {
           latency: latency
         });
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+        emit('commit-status', {
+          status: 'failure',
+          version: version
+        });
       } else {
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
         // @ts-expect-error We didn't type the invalid type case
         new Error("Response type: ".concat((response === null || response === void 0 ? void 0 : response.type) || 'No response type')), 'Error while adding steps - Invalid Acknowledgement');
+        emit('commit-status', {
+          status: 'failure',
+          version: version
+        });
       }
     });
   } catch (error) {
     analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
+    emit('commit-status', {
+      status: 'failure',
+      version: version
+    });
   }
 };
 export var throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {

package/dist/esm/provider/index.js

@@ -23,6 +23,7 @@ import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
+var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 export var MAX_STEP_REJECTED_ERROR = 15;
 export var Provider = /*#__PURE__*/function (_Emitter) {
@@ -67,20 +68,27 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           sid: sid,
           initial: !initialized
         });
-        // If initial draft is already present and the channel is initialized,
-        // fire the provider's init event with initial draft document and version
+
+        // Early initialization with initial draft passed via provider
         if (_this.initialDraft && initialized && !_this.isProviderInitialized) {
-          var _this$initialDraft = _this.initialDraft,
-            document = _this$initialDraft.document,
-            version = _this$initialDraft.version,
-            metadata = _this$initialDraft.metadata;
-          // Initial document, version, metadata from initial draft
-          _this.documentService.updateDocument({
-            doc: document,
-            version: version,
-            metadata: metadata
-          });
-          _this.metadataService.updateMetadata(metadata);
+          // Call catchup if the draft has become stale since being passed to provider
+          if (_this.isDraftTimestampStale()) {
+            _this.documentService.throttledCatchup();
+          }
+          // If the initial draft is already up to date, update the document with that of the initial draft
+          else {
+            var _this$initialDraft = _this.initialDraft,
+              document = _this$initialDraft.document,
+              version = _this$initialDraft.version,
+              metadata = _this$initialDraft.metadata;
+            // Initial document, version, metadata from initial draft
+            _this.documentService.updateDocument({
+              doc: document,
+              version: version,
+              metadata: metadata
+            });
+            _this.metadataService.updateMetadata(metadata);
+          }
           _this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
@@ -221,7 +229,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish);
     _this.getStatePromise = new Promise(function (resolve) {
       _this.getStatePromiseResolve = resolve;
     });
@@ -308,6 +316,21 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+  }, {
+    key: "isDraftTimestampStale",
+    value: function isDraftTimestampStale() {
+      var _this$initialDraft2;
+      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+        return false;
+      }
+      return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
+    }
+
     /**
      * 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

package/dist/esm/version-wrapper.js

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

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

@@ -16,10 +16,12 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private failedStepsBeforeCatchupOnPublish;
     private getState;
     private onSyncUpError?;
     private stepQueue;
     private stepRejectCounter;
+    private aggressiveCatchup;
     private clientId?;
     /**
      *
@@ -28,12 +30,13 @@ export declare class DocumentService {
      * @param analyticsHelper - Helper for analytics events
      * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-     * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
      * @param broadcast - Callback for broadcasting events to other clients
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
+     * @param metadataService
+     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, 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);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, 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, failedStepsBeforeCatchupOnPublish?: number);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -11,11 +11,14 @@ export declare enum EVENT_ACTION {
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
     INVALIDATE_TOKEN = "invalidateToken",
+    SEND_STEPS_RETRY = "sendStepsRetry",
+    CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
     DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
-    FAILURE = "FAILURE"
+    FAILURE = "FAILURE",
+    INFO = "INFO"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -185,7 +188,22 @@ type GetCurrentStateFailureAnalyticsEvent = {
         latency?: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | CatchUpDroppedStepsEvent;
+type SendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+        count: number;
+    };
+};
+type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types/provider/commit-step.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import { ChannelEvent, CollabCommitStatusEventPayload, CollabEvents, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
-export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -12,8 +12,9 @@ export declare const commitStep: ({ broadcast, steps, version, userId, clientId,
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void;
-export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -22,4 +23,5 @@ export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broa
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void>;

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

@@ -59,6 +59,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+    private isDraftTimestampStale;
     /**
      * 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

package/dist/types/types.d.ts

@@ -61,6 +61,7 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
+    timestamp?: number;
 }
 export interface Config {
     url: string;
@@ -90,6 +91,11 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    /**
+     * When a page is being published this number can control the number of failed steps until a catchup is triggered.
+     * The default value is MAX_STEP_REJECTED_ERROR (15).
+     */
+    failedStepLimitBeforeCatchupOnPublish?: number;
 }
 export interface InitAndAuthData {
     initialized: boolean;
@@ -135,6 +141,10 @@ export type CollabMetadataPayload = Metadata;
 export type CollabLocalStepsPayload = {
     steps: readonly Step[];
 };
+export type CollabCommitStatusEventPayload = {
+    status: 'attempt' | 'success' | 'failure';
+    version: number;
+};
 export interface CollabEvents {
     'metadata:changed': CollabMetadataPayload;
     init: CollabInitPayload;
@@ -147,6 +157,7 @@ export interface CollabEvents {
     error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
+    'commit-status': CollabCommitStatusEventPayload;
 }
 export interface Metadata {
     [key: string]: string | number | boolean;

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

@@ -16,10 +16,12 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private failedStepsBeforeCatchupOnPublish;
     private getState;
     private onSyncUpError?;
     private stepQueue;
     private stepRejectCounter;
+    private aggressiveCatchup;
     private clientId?;
     /**
      *
@@ -28,12 +30,13 @@ export declare class DocumentService {
      * @param analyticsHelper - Helper for analytics events
      * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-     * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
      * @param broadcast - Callback for broadcasting events to other clients
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
+     * @param metadataService
+     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, 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);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, 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, failedStepsBeforeCatchupOnPublish?: number);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -11,11 +11,14 @@ export declare enum EVENT_ACTION {
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
     INVALIDATE_TOKEN = "invalidateToken",
+    SEND_STEPS_RETRY = "sendStepsRetry",
+    CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
     DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
-    FAILURE = "FAILURE"
+    FAILURE = "FAILURE",
+    INFO = "INFO"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -185,7 +188,22 @@ type GetCurrentStateFailureAnalyticsEvent = {
         latency?: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | CatchUpDroppedStepsEvent;
+type SendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+        count: number;
+    };
+};
+type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types-ts4.5/provider/commit-step.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import { ChannelEvent, CollabCommitStatusEventPayload, CollabEvents, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
-export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -12,8 +12,9 @@ export declare const commitStep: ({ broadcast, steps, version, userId, clientId,
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void;
-export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -22,4 +23,5 @@ export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broa
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void>;

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

@@ -59,6 +59,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+    private isDraftTimestampStale;
     /**
      * 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

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

@@ -61,6 +61,7 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
+    timestamp?: number;
 }
 export interface Config {
     url: string;
@@ -90,6 +91,11 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    /**
+     * When a page is being published this number can control the number of failed steps until a catchup is triggered.
+     * The default value is MAX_STEP_REJECTED_ERROR (15).
+     */
+    failedStepLimitBeforeCatchupOnPublish?: number;
 }
 export interface InitAndAuthData {
     initialized: boolean;
@@ -135,6 +141,10 @@ export type CollabMetadataPayload = Metadata;
 export type CollabLocalStepsPayload = {
     steps: readonly Step[];
 };
+export type CollabCommitStatusEventPayload = {
+    status: 'attempt' | 'success' | 'failure';
+    version: number;
+};
 export interface CollabEvents {
     'metadata:changed': CollabMetadataPayload;
     init: CollabInitPayload;
@@ -147,6 +157,7 @@ export interface CollabEvents {
     error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
+    'commit-status': CollabCommitStatusEventPayload;
 }
 export interface Metadata {
     [key: string]: string | number | boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.0.1",
+  "version": "9.2.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
   "atlassian": {
     "team": "Editor Services",
     "inPublicMirror": true,
-    "releaseModel": "scheduled"
+    "releaseModel": "continuous"
   },
   "af:exports": {
     ".": "./src/index.ts",
@@ -61,7 +61,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^25.7.0",
+    "@atlaskit/adf-schema": "^25.8.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
     "@atlaskit/editor-test-helpers": "^18.5.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",