@atlaskit/collab-provider 10.6.2 → 10.7.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 10.7.0
+
+### Minor Changes
+
+- [#115482](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/115482)
+  [`5c3199f49f3c7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5c3199f49f3c7) -
+  Added analytics tracking for rebased steps
+
+### Patch Changes
+
+- [#115191](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/115191)
+  [`83e0a3ca379fa`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/83e0a3ca379fa) -
+  CEPS-362: pass a forcePublish flag to NCS backend when committing steps via publish - this is so
+  that we can remoev ackDelays for publish
+- Updated dependencies
+
 ## 10.6.2
 
 ### Patch Changes

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

@@ -320,10 +320,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         obfuscatedSteps = 'Failed to obfuscate steps';
       }
       var obfuscatedDoc;
-      try {
-        obfuscatedDoc = (0, _utils.getDocAdfWithObfuscation)(currentState.content);
-      } catch (error) {
-        obfuscatedDoc = 'Failed to obfuscate doc';
+      if (currentState) {
+        try {
+          obfuscatedDoc = (0, _utils.getDocAdfWithObfuscation)(currentState.content);
+        } catch (error) {
+          obfuscatedDoc = 'Failed to obfuscate doc';
+        }
       }
       return {
         obfuscatedSteps: obfuscatedSteps,
@@ -629,7 +631,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               _context5.next = 22;
               break;
             }
-            _this.sendStepsFromCurrentState();
+            // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
+            _this.sendStepsFromCurrentState(undefined, true);
             _context5.next = 13;
             return (0, _utils.sleep)(500);
           case 13:
@@ -866,7 +869,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      */
   }, {
     key: "sendStepsFromCurrentState",
-    value: function sendStepsFromCurrentState(sendAnalyticsEvent) {
+    value: function sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
       var _this$getState8;
       var state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
       if (!state) {
@@ -874,7 +877,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
         return;
       }
-      this.send(null, null, state, sendAnalyticsEvent);
+      this.send(null, null, state, sendAnalyticsEvent, forcePublish);
     }
   }, {
     key: "send",
@@ -883,7 +886,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    function send(_tr, _oldState, newState, sendAnalyticsEvent) {
+    function send(tr, _oldState, newState, sendAnalyticsEvent, forcePublish) {
       var unconfirmedStepsData = (0, _prosemirrorCollab.sendableSteps)(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -910,6 +913,23 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
         return;
       }
+      var rebased = tr === null || tr === void 0 ? void 0 : tr.getMeta('rebasedData');
+      if (rebased) {
+        var _this$analyticsHelper35;
+        var obfuscatedUnconfirmedSteps = this.obfuscateStepsAndState(rebased.unconfirmedSteps).obfuscatedSteps;
+        var obfuscatedRemoteSteps = this.obfuscateStepsAndState(rebased.remoteSteps);
+        var obfuscatedRebasedSteps = this.obfuscateStepsAndState(unconfirmedSteps).obfuscatedSteps;
+        // send analtyics on unconfirmed steps
+        (_this$analyticsHelper35 = this.analyticsHelper) === null || _this$analyticsHelper35 === void 0 || _this$analyticsHelper35.sendActionEvent(_const.EVENT_ACTION.STEPS_REBASED, _const.EVENT_STATUS.INFO, {
+          obfuscatedUnconfirmedSteps: obfuscatedUnconfirmedSteps,
+          obfuscatedRemoteSteps: obfuscatedRemoteSteps,
+          obfuscatedRebasedSteps: obfuscatedRebasedSteps,
+          clientID: this.clientId,
+          userId: this.getUserId(),
+          versionBefore: rebased.versionBefore,
+          versionAfter: version
+        });
+      }
 
       // If we are going to commit unconfirmed steps
       // we need to lock them to ensure they don't get
@@ -942,7 +962,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         emit: this.providerEmitCallback,
         __livePage: this.options.__livePage,
         hasRecovered: this.hasRecovered,
-        collabMode: this.participantsService.getCollabMode()
+        collabMode: this.participantsService.getCollabMode(),
+        forcePublish: forcePublish
       });
     }
   }]);

package/dist/cjs/helpers/const.js

@@ -26,6 +26,7 @@ var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
   EVENT_ACTION["OUT_OF_SYNC"] = "outOfSync";
+  EVENT_ACTION["STEPS_REBASED"] = "stepsRebased";
   return EVENT_ACTION;
 }({});
 var EVENT_STATUS = exports.EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {

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

@@ -29,7 +29,8 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
     emit = _ref.emit,
     __livePage = _ref.__livePage,
     hasRecovered = _ref.hasRecovered,
-    collabMode = _ref.collabMode;
+    collabMode = _ref.collabMode,
+    forcePublish = _ref.forcePublish;
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
     return;
@@ -91,7 +92,8 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
       collabMode: collabMode,
       steps: stepsWithClientAndUserId,
       version: version,
-      userId: userId
+      userId: userId,
+      forcePublish: forcePublish
     }, function (response) {
       var latency = new Date().getTime() - start;
       if (timer) {

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "10.6.2";
+var version = exports.version = "10.7.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -287,10 +287,12 @@ export class DocumentService {
         obfuscatedSteps = 'Failed to obfuscate steps';
       }
       let obfuscatedDoc;
-      try {
-        obfuscatedDoc = getDocAdfWithObfuscation(currentState.content);
-      } catch (error) {
-        obfuscatedDoc = 'Failed to obfuscate doc';
+      if (currentState) {
+        try {
+          obfuscatedDoc = getDocAdfWithObfuscation(currentState.content);
+        } catch (error) {
+          obfuscatedDoc = 'Failed to obfuscate doc';
+        }
       }
       return {
         obfuscatedSteps,
@@ -538,7 +540,8 @@ export class DocumentService {
             (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
           }
           while (!isLastTrConfirmed) {
-            this.sendStepsFromCurrentState();
+            // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
+            this.sendStepsFromCurrentState(undefined, true);
             await sleep(500);
             const nextUnconfirmedSteps = this.getUnconfirmedSteps();
             if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
@@ -740,7 +743,7 @@ export class DocumentService {
    * The getState function will return the current EditorState
    * from the EditorView.
    */
-  sendStepsFromCurrentState(sendAnalyticsEvent) {
+  sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
     var _this$getState8;
     const state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
     if (!state) {
@@ -748,13 +751,13 @@ export class DocumentService {
       (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 ? void 0 : _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
       return;
     }
-    this.send(null, null, state, sendAnalyticsEvent);
+    this.send(null, null, state, sendAnalyticsEvent, forcePublish);
   }
   /**
    * Send steps from transaction to other participants
    * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
    */
-  send(_tr, _oldState, newState, sendAnalyticsEvent) {
+  send(tr, _oldState, newState, sendAnalyticsEvent, forcePublish) {
     const unconfirmedStepsData = sendableSteps(newState);
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -781,6 +784,23 @@ export class DocumentService {
     if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
       return;
     }
+    const rebased = tr === null || tr === void 0 ? void 0 : tr.getMeta('rebasedData');
+    if (rebased) {
+      var _this$analyticsHelper35;
+      const obfuscatedUnconfirmedSteps = this.obfuscateStepsAndState(rebased.unconfirmedSteps).obfuscatedSteps;
+      const obfuscatedRemoteSteps = this.obfuscateStepsAndState(rebased.remoteSteps);
+      const obfuscatedRebasedSteps = this.obfuscateStepsAndState(unconfirmedSteps).obfuscatedSteps;
+      // send analtyics on unconfirmed steps
+      (_this$analyticsHelper35 = this.analyticsHelper) === null || _this$analyticsHelper35 === void 0 ? void 0 : _this$analyticsHelper35.sendActionEvent(EVENT_ACTION.STEPS_REBASED, EVENT_STATUS.INFO, {
+        obfuscatedUnconfirmedSteps,
+        obfuscatedRemoteSteps,
+        obfuscatedRebasedSteps,
+        clientID: this.clientId,
+        userId: this.getUserId(),
+        versionBefore: rebased.versionBefore,
+        versionAfter: version
+      });
+    }
 
     // If we are going to commit unconfirmed steps
     // we need to lock them to ensure they don't get
@@ -813,7 +833,8 @@ export class DocumentService {
       emit: this.providerEmitCallback,
       __livePage: this.options.__livePage,
       hasRecovered: this.hasRecovered,
-      collabMode: this.participantsService.getCollabMode()
+      collabMode: this.participantsService.getCollabMode(),
+      forcePublish
     });
   }
 }

package/dist/es2019/helpers/const.js

@@ -20,6 +20,7 @@ export let EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
   EVENT_ACTION["OUT_OF_SYNC"] = "outOfSync";
+  EVENT_ACTION["STEPS_REBASED"] = "stepsRebased";
   return EVENT_ACTION;
 }({});
 export let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {

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

@@ -19,7 +19,8 @@ export const commitStepQueue = ({
   emit,
   __livePage,
   hasRecovered,
-  collabMode
+  collabMode,
+  forcePublish
 }) => {
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
@@ -83,7 +84,8 @@ export const commitStepQueue = ({
       collabMode,
       steps: stepsWithClientAndUserId,
       version,
-      userId
+      userId,
+      forcePublish
     }, response => {
       const latency = new Date().getTime() - start;
       if (timer) {

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "10.6.2";
+export const version = "10.7.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -313,10 +313,12 @@ export var DocumentService = /*#__PURE__*/function () {
         obfuscatedSteps = 'Failed to obfuscate steps';
       }
       var obfuscatedDoc;
-      try {
-        obfuscatedDoc = getDocAdfWithObfuscation(currentState.content);
-      } catch (error) {
-        obfuscatedDoc = 'Failed to obfuscate doc';
+      if (currentState) {
+        try {
+          obfuscatedDoc = getDocAdfWithObfuscation(currentState.content);
+        } catch (error) {
+          obfuscatedDoc = 'Failed to obfuscate doc';
+        }
       }
       return {
         obfuscatedSteps: obfuscatedSteps,
@@ -622,7 +624,8 @@ export var DocumentService = /*#__PURE__*/function () {
               _context5.next = 22;
               break;
             }
-            _this.sendStepsFromCurrentState();
+            // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
+            _this.sendStepsFromCurrentState(undefined, true);
             _context5.next = 13;
             return sleep(500);
           case 13:
@@ -859,7 +862,7 @@ export var DocumentService = /*#__PURE__*/function () {
      */
   }, {
     key: "sendStepsFromCurrentState",
-    value: function sendStepsFromCurrentState(sendAnalyticsEvent) {
+    value: function sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
       var _this$getState8;
       var state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
       if (!state) {
@@ -867,7 +870,7 @@ export var DocumentService = /*#__PURE__*/function () {
         (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
         return;
       }
-      this.send(null, null, state, sendAnalyticsEvent);
+      this.send(null, null, state, sendAnalyticsEvent, forcePublish);
     }
   }, {
     key: "send",
@@ -876,7 +879,7 @@ export var DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    function send(_tr, _oldState, newState, sendAnalyticsEvent) {
+    function send(tr, _oldState, newState, sendAnalyticsEvent, forcePublish) {
       var unconfirmedStepsData = sendableSteps(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -903,6 +906,23 @@ export var DocumentService = /*#__PURE__*/function () {
       if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
         return;
       }
+      var rebased = tr === null || tr === void 0 ? void 0 : tr.getMeta('rebasedData');
+      if (rebased) {
+        var _this$analyticsHelper35;
+        var obfuscatedUnconfirmedSteps = this.obfuscateStepsAndState(rebased.unconfirmedSteps).obfuscatedSteps;
+        var obfuscatedRemoteSteps = this.obfuscateStepsAndState(rebased.remoteSteps);
+        var obfuscatedRebasedSteps = this.obfuscateStepsAndState(unconfirmedSteps).obfuscatedSteps;
+        // send analtyics on unconfirmed steps
+        (_this$analyticsHelper35 = this.analyticsHelper) === null || _this$analyticsHelper35 === void 0 || _this$analyticsHelper35.sendActionEvent(EVENT_ACTION.STEPS_REBASED, EVENT_STATUS.INFO, {
+          obfuscatedUnconfirmedSteps: obfuscatedUnconfirmedSteps,
+          obfuscatedRemoteSteps: obfuscatedRemoteSteps,
+          obfuscatedRebasedSteps: obfuscatedRebasedSteps,
+          clientID: this.clientId,
+          userId: this.getUserId(),
+          versionBefore: rebased.versionBefore,
+          versionAfter: version
+        });
+      }
 
       // If we are going to commit unconfirmed steps
       // we need to lock them to ensure they don't get
@@ -935,7 +955,8 @@ export var DocumentService = /*#__PURE__*/function () {
         emit: this.providerEmitCallback,
         __livePage: this.options.__livePage,
         hasRecovered: this.hasRecovered,
-        collabMode: this.participantsService.getCollabMode()
+        collabMode: this.participantsService.getCollabMode(),
+        forcePublish: forcePublish
       });
     }
   }]);

package/dist/esm/helpers/const.js

@@ -20,6 +20,7 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
   EVENT_ACTION["OUT_OF_SYNC"] = "outOfSync";
+  EVENT_ACTION["STEPS_REBASED"] = "stepsRebased";
   return EVENT_ACTION;
 }({});
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {

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

@@ -22,7 +22,8 @@ export var commitStepQueue = function commitStepQueue(_ref) {
     emit = _ref.emit,
     __livePage = _ref.__livePage,
     hasRecovered = _ref.hasRecovered,
-    collabMode = _ref.collabMode;
+    collabMode = _ref.collabMode,
+    forcePublish = _ref.forcePublish;
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
     return;
@@ -84,7 +85,8 @@ export var commitStepQueue = function commitStepQueue(_ref) {
       collabMode: collabMode,
       steps: stepsWithClientAndUserId,
       version: version,
-      userId: userId
+      userId: userId,
+      forcePublish: forcePublish
     }, function (response) {
       var latency = new Date().getTime() - start;
       if (timer) {

package/dist/esm/version-wrapper.js

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

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

@@ -80,7 +80,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * Called when we receive steps from the service
      */
     onStepsAdded: (data: StepsPayload) => void;
-    obfuscateStepsAndState: (unconfirmedSteps: readonly ProseMirrorStep[] | undefined, currentState: ResolvedEditorState) => {
+    obfuscateStepsAndState: (unconfirmedSteps: readonly ProseMirrorStep[] | undefined, currentState?: ResolvedEditorState) => {
         obfuscatedSteps: string | {
             stepType: {
                 type: string;
@@ -106,7 +106,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 unconfirmedStepAfterRecovery?: boolean | undefined;
             } | undefined;
         }[];
-        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null;
+        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
@@ -131,11 +131,11 @@ export declare class DocumentService implements DocumentServiceInterface {
      * The getState function will return the current EditorState
      * from the EditorView.
      */
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
     onStepRejectedError: () => void;
     /**
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
 }

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

@@ -25,7 +25,7 @@ export interface DocumentServiceInterface {
     }): void;
     onStepRejectedError(): void;
     send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
     getFinalAcknowledgedState(): Promise<ResolvedEditorState>;

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

@@ -20,7 +20,8 @@ export declare enum EVENT_ACTION {
     RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
     PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
     HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
-    OUT_OF_SYNC = "outOfSync"
+    OUT_OF_SYNC = "outOfSync",// https://data-portal.internal.atlassian.com/analytics/registry/74993
+    STEPS_REBASED = "stepsRebased"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -275,7 +276,26 @@ type OutOfSyncAnalyticsEvent = {
         catchupReason: CatchupEventReason | undefined;
     } & BaseActionAnalyticsEventAttributes;
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent;
+type StepsRebasedAnalyticsEvent = {
+    eventAction: EVENT_ACTION.STEPS_REBASED;
+    attributes: {
+        eventStatus: EVENT_STATUS.INFO;
+        obfuscatedUnconfirmedSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedRemoteSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedRebasedSteps: {
+            [key: string]: number;
+        }[];
+        clientID: 'string';
+        userId: 'string';
+        versionBefore: 'string';
+        versionAfter: 'string';
+    } & BaseActionAnalyticsEventAttributes;
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent | StepsRebasedAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 /** Enumerable for attaching a reason to catchup (v2) call(s) */

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

@@ -5,7 +5,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 export declare let readyToCommit: boolean;
 export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, }: {
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, forcePublish, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -18,4 +18,5 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     __livePage: boolean;
     hasRecovered: boolean;
     collabMode: string;
+    forcePublish?: boolean | undefined;
 }) => void;

package/dist/types/types.d.ts

@@ -189,6 +189,7 @@ export type ChannelEvent = {
     'steps:commit': StepsPayload & {
         userId: string;
         collabMode: string;
+        forcePublish?: boolean;
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;

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

@@ -80,7 +80,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * Called when we receive steps from the service
      */
     onStepsAdded: (data: StepsPayload) => void;
-    obfuscateStepsAndState: (unconfirmedSteps: readonly ProseMirrorStep[] | undefined, currentState: ResolvedEditorState) => {
+    obfuscateStepsAndState: (unconfirmedSteps: readonly ProseMirrorStep[] | undefined, currentState?: ResolvedEditorState) => {
         obfuscatedSteps: string | {
             stepType: {
                 type: string;
@@ -106,7 +106,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 unconfirmedStepAfterRecovery?: boolean | undefined;
             } | undefined;
         }[];
-        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null;
+        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
@@ -131,11 +131,11 @@ export declare class DocumentService implements DocumentServiceInterface {
      * The getState function will return the current EditorState
      * from the EditorView.
      */
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
     onStepRejectedError: () => void;
     /**
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
 }

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

@@ -25,7 +25,7 @@ export interface DocumentServiceInterface {
     }): void;
     onStepRejectedError(): void;
     send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
     getFinalAcknowledgedState(): Promise<ResolvedEditorState>;

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

@@ -20,7 +20,8 @@ export declare enum EVENT_ACTION {
     RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
     PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
     HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
-    OUT_OF_SYNC = "outOfSync"
+    OUT_OF_SYNC = "outOfSync",// https://data-portal.internal.atlassian.com/analytics/registry/74993
+    STEPS_REBASED = "stepsRebased"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -275,7 +276,26 @@ type OutOfSyncAnalyticsEvent = {
         catchupReason: CatchupEventReason | undefined;
     } & BaseActionAnalyticsEventAttributes;
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent;
+type StepsRebasedAnalyticsEvent = {
+    eventAction: EVENT_ACTION.STEPS_REBASED;
+    attributes: {
+        eventStatus: EVENT_STATUS.INFO;
+        obfuscatedUnconfirmedSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedRemoteSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedRebasedSteps: {
+            [key: string]: number;
+        }[];
+        clientID: 'string';
+        userId: 'string';
+        versionBefore: 'string';
+        versionAfter: 'string';
+    } & BaseActionAnalyticsEventAttributes;
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent | StepsRebasedAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 /** Enumerable for attaching a reason to catchup (v2) call(s) */

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

@@ -5,7 +5,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 export declare let readyToCommit: boolean;
 export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, }: {
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, forcePublish, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -18,4 +18,5 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     __livePage: boolean;
     hasRecovered: boolean;
     collabMode: string;
+    forcePublish?: boolean | undefined;
 }) => void;

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

@@ -189,6 +189,7 @@ export type ChannelEvent = {
     'steps:commit': StepsPayload & {
         userId: string;
         collabMode: string;
+        forcePublish?: boolean;
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.6.2",
+	"version": "10.7.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -40,8 +40,8 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/feature-gate-js-client": "^4.25.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/prosemirror-collab": "^0.13.0",
-		"@atlaskit/react-ufo": "^2.15.0",
+		"@atlaskit/prosemirror-collab": "^0.14.0",
+		"@atlaskit/react-ufo": "^2.16.0",
 		"@atlaskit/ufo": "^0.3.0",
 		"@atlaskit/util-service-support": "^6.2.0",
 		"@babel/runtime": "^7.0.0",