@atlaskit/collab-provider 10.9.2 → 10.9.4

package/dist/esm/provider/index.js

@@ -270,27 +270,32 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    _defineProperty(_this, "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-      var _this$analyticsHelper5;
-      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-        while (1) switch (_context3.prev = _context3.next) {
-          case 0:
-            _context3.prev = 0;
-            _context3.next = 3;
-            return _this.documentService.getFinalAcknowledgedState();
-          case 3:
-            return _context3.abrupt("return", _context3.sent);
-          case 6:
-            _context3.prev = 6;
-            _context3.t0 = _context3["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
-            throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
-          case 10:
-          case "end":
-            return _context3.stop();
-        }
-      }, _callee3, null, [[0, 6]]);
-    })));
+    _defineProperty(_this, "getFinalAcknowledgedState", /*#__PURE__*/function () {
+      var _ref7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(reason) {
+        var _this$analyticsHelper5;
+        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              _context3.next = 3;
+              return _this.documentService.getFinalAcknowledgedState(reason);
+            case 3:
+              return _context3.abrupt("return", _context3.sent);
+            case 6:
+              _context3.prev = 6;
+              _context3.t0 = _context3["catch"](0);
+              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
+              throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
+            case 10:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, null, [[0, 6]]);
+      }));
+      return function (_x2) {
+        return _ref7.apply(this, arguments);
+      };
+    }());
     _defineProperty(_this, "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
@@ -347,7 +352,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     }
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');
-      _this.documentService.sendStepsFromCurrentState(true);
+      _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
     return _this;
   }

package/dist/esm/version-wrapper.js

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

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

@@ -10,6 +10,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 import type { ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare class DocumentService implements DocumentServiceInterface {
     private participantsService;
     private analyticsHelper;
@@ -111,7 +112,7 @@ export declare class DocumentService implements DocumentServiceInterface {
         obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
-    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
     private updateDocumentAnalytics;
@@ -120,7 +121,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
-    commitUnconfirmedSteps: () => Promise<void>;
+    commitUnconfirmedSteps: (reason: GetResolvedEditorStateReason) => Promise<void>;
     setup({ getState, onSyncUpError, clientId, }: {
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
@@ -133,11 +134,11 @@ export declare class DocumentService implements DocumentServiceInterface {
      * The getState function will return the current EditorState
      * from the EditorView.
      */
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): 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, forcePublish?: boolean): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
 }

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

@@ -0,0 +1,26 @@
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { ConflictChanges } from '@atlaskit/editor-common/collab';
+interface Options {
+    localSteps: readonly {
+        inverted: ProseMirrorStep;
+        step: ProseMirrorStep;
+    }[];
+    remoteSteps: ProseMirrorStep[];
+    tr: Transaction;
+}
+/**
+ * Gets the conflicts between the local document and the remote document based on steps.
+ * It assumes the steps will be rebased using the `prosemirror-collab` algorithm synchronously after this
+ * Therefore the `tr` property is based on the document before rebasing.
+ *
+ * In the future we could possibly use `prosemirror-recreate-steps` (or similar approach)
+ * and tweak this to work for arbitrary diffs between offline and remote documents.
+ *
+ * @param localSteps Local steps applied between now and the server steps
+ * @param remoteSteps Steps retrieved from the server
+ * @param tr Transaction of the current document (expected to happen with local steps applied, before remote are applied)
+ * @returns All the conflicts (inserted + deleted) which can be applied to the current document
+ */
+export declare function getConflictChanges({ localSteps, remoteSteps, tr }: Options): ConflictChanges;
+export {};

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

@@ -2,6 +2,7 @@ import type { ResolvedEditorState, SyncUpErrorFunction } from '@atlaskit/editor-
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { InternalError } from '../errors/internal-errors';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export interface DocumentServiceInterface {
     setup(params: {
         getState: () => EditorState;
@@ -25,10 +26,10 @@ export interface DocumentServiceInterface {
     }): void;
     onStepRejectedError(): void;
     send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): readonly ProseMirrorStep[] | undefined;
     getCurrentPmVersion(): number;

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

@@ -1,5 +1,6 @@
 import type { ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { DocumentServiceInterface } from './interface-document-service';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare class NullDocumentService implements DocumentServiceInterface {
     setup: () => this;
     updateDocument(): void;
@@ -10,7 +11,7 @@ export declare class NullDocumentService implements DocumentServiceInterface {
     sendStepsFromCurrentState(): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): undefined;
     getCurrentPmVersion(): number;

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

@@ -3,9 +3,10 @@ import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/edi
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare let readyToCommit: boolean;
-export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 20000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, forcePublish, }: {
+export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, reason, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -18,5 +19,5 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     __livePage: boolean;
     hasRecovered: boolean;
     collabMode: string;
-    forcePublish?: boolean | undefined;
+    reason?: GetResolvedEditorStateReason | undefined;
 }) => void;

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

@@ -5,6 +5,7 @@ import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload, PresenceActivity } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
 export declare const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
@@ -156,7 +157,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
     /**
      * Returns the namespace locking status via true/false
      */

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

@@ -10,6 +10,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 import type { ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare class DocumentService implements DocumentServiceInterface {
     private participantsService;
     private analyticsHelper;
@@ -111,7 +112,7 @@ export declare class DocumentService implements DocumentServiceInterface {
         obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
-    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
     private updateDocumentAnalytics;
@@ -120,7 +121,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
-    commitUnconfirmedSteps: () => Promise<void>;
+    commitUnconfirmedSteps: (reason: GetResolvedEditorStateReason) => Promise<void>;
     setup({ getState, onSyncUpError, clientId, }: {
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
@@ -133,11 +134,11 @@ export declare class DocumentService implements DocumentServiceInterface {
      * The getState function will return the current EditorState
      * from the EditorView.
      */
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): 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, forcePublish?: boolean): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
 }

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

@@ -0,0 +1,26 @@
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { ConflictChanges } from '@atlaskit/editor-common/collab';
+interface Options {
+    localSteps: readonly {
+        inverted: ProseMirrorStep;
+        step: ProseMirrorStep;
+    }[];
+    remoteSteps: ProseMirrorStep[];
+    tr: Transaction;
+}
+/**
+ * Gets the conflicts between the local document and the remote document based on steps.
+ * It assumes the steps will be rebased using the `prosemirror-collab` algorithm synchronously after this
+ * Therefore the `tr` property is based on the document before rebasing.
+ *
+ * In the future we could possibly use `prosemirror-recreate-steps` (or similar approach)
+ * and tweak this to work for arbitrary diffs between offline and remote documents.
+ *
+ * @param localSteps Local steps applied between now and the server steps
+ * @param remoteSteps Steps retrieved from the server
+ * @param tr Transaction of the current document (expected to happen with local steps applied, before remote are applied)
+ * @returns All the conflicts (inserted + deleted) which can be applied to the current document
+ */
+export declare function getConflictChanges({ localSteps, remoteSteps, tr }: Options): ConflictChanges;
+export {};

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

@@ -2,6 +2,7 @@ import type { ResolvedEditorState, SyncUpErrorFunction } from '@atlaskit/editor-
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { InternalError } from '../errors/internal-errors';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export interface DocumentServiceInterface {
     setup(params: {
         getState: () => EditorState;
@@ -25,10 +26,10 @@ export interface DocumentServiceInterface {
     }): void;
     onStepRejectedError(): void;
     send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, forcePublish?: boolean): void;
+    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): readonly ProseMirrorStep[] | undefined;
     getCurrentPmVersion(): number;

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

@@ -1,5 +1,6 @@
 import type { ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { DocumentServiceInterface } from './interface-document-service';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare class NullDocumentService implements DocumentServiceInterface {
     setup: () => this;
     updateDocument(): void;
@@ -10,7 +11,7 @@ export declare class NullDocumentService implements DocumentServiceInterface {
     sendStepsFromCurrentState(): void;
     throttledCatchupv2(): void;
     getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): undefined;
     getCurrentPmVersion(): number;

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

@@ -3,9 +3,10 @@ import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/edi
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare let readyToCommit: boolean;
-export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 20000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, forcePublish, }: {
+export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, reason, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -18,5 +19,5 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     __livePage: boolean;
     hasRecovered: boolean;
     collabMode: string;
-    forcePublish?: boolean | undefined;
+    reason?: GetResolvedEditorStateReason | undefined;
 }) => void;

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

@@ -5,6 +5,7 @@ import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload, PresenceActivity } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
+import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
 export declare const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
@@ -156,7 +157,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
     /**
      * Returns the namespace locking status via true/false
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.9.2",
+	"version": "10.9.4",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,18 +35,19 @@
 		"@atlaskit/adf-utils": "^19.19.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^9.0.0",
-		"@atlaskit/editor-common": "^102.0.0",
+		"@atlaskit/editor-common": "^102.5.0",
 		"@atlaskit/editor-json-transformer": "^8.24.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/feature-gate-js-client": "^4.26.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.15.0",
-		"@atlaskit/react-ufo": "^3.3.0",
+		"@atlaskit/react-ufo": "^3.4.0",
 		"@atlaskit/ufo": "^0.4.0",
-		"@atlaskit/util-service-support": "^6.2.0",
+		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
 		"eventemitter2": "^4.1.0",
 		"lodash": "^4.17.21",
+		"prosemirror-changeset": "^2.2.1",
 		"socket.io-client": "^4.7.5",
 		"uuid": "^3.1.0"
 	},