@atlaskit/collab-provider 11.2.4 → 11.3.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/collab-provider
 
+## 11.3.1
+
+### Patch Changes
+
+- [`e860af1658f2d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e860af1658f2d) -
+  Ensure we are always sending the latest state while step merging
+- Updated dependencies
+
+## 11.3.0
+
+### Minor Changes
+
+- [`72f94befc61f2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/72f94befc61f2) -
+  replace method-style signatures with function-style signatures
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 11.2.4
 
 ### Patch Changes

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

@@ -1013,11 +1013,18 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * @param reason
      * @example
      */
-    function send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+    function send(tr, _oldState, _newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
     ) {
-      var _this3 = this;
+      var _this$getState1,
+        _this$getState10,
+        _this3 = this;
       var offlineEditingEnabled = (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true);
       var onlineStepMergingEnabled = (0, _expValEquals.expValEquals)('platform_editor_enable_single_player_step_merging', 'isEnabled', true);
+      // We don't trust `_newState` not to be stale
+      // ED-29051 - the `onEditorViewStateUpdated` can have a stale state in edge cases. We need
+      // to always ensure we're sending the latest state and unconfirmed steps so we use the state
+      // from editorView directly (via getState).
+      var newState = onlineStepMergingEnabled ? (_this$getState1 = (_this$getState10 = this.getState) === null || _this$getState10 === void 0 ? void 0 : _this$getState10.call(this)) !== null && _this$getState1 !== void 0 ? _this$getState1 : _newState : _newState;
 
       // Don't send any steps before we're ready.
       if (offlineEditingEnabled || onlineStepMergingEnabled) {

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 = "11.2.3";
+var version = exports.version = "11.3.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -880,10 +880,16 @@ export class DocumentService {
    * @param reason
    * @example
    */
-  send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+  send(tr, _oldState, _newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
   ) {
+    var _this$getState1, _this$getState10;
     const offlineEditingEnabled = editorExperiment('platform_editor_offline_editing_web', true);
     const onlineStepMergingEnabled = expValEquals('platform_editor_enable_single_player_step_merging', 'isEnabled', true);
+    // We don't trust `_newState` not to be stale
+    // ED-29051 - the `onEditorViewStateUpdated` can have a stale state in edge cases. We need
+    // to always ensure we're sending the latest state and unconfirmed steps so we use the state
+    // from editorView directly (via getState).
+    const newState = onlineStepMergingEnabled ? (_this$getState1 = (_this$getState10 = this.getState) === null || _this$getState10 === void 0 ? void 0 : _this$getState10.call(this)) !== null && _this$getState1 !== void 0 ? _this$getState1 : _newState : _newState;
 
     // Don't send any steps before we're ready.
     if (offlineEditingEnabled || onlineStepMergingEnabled) {

package/dist/es2019/version-wrapper.js

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

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

@@ -1006,11 +1006,18 @@ export var DocumentService = /*#__PURE__*/function () {
      * @param reason
      * @example
      */
-    function send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+    function send(tr, _oldState, _newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
     ) {
-      var _this3 = this;
+      var _this$getState1,
+        _this$getState10,
+        _this3 = this;
       var offlineEditingEnabled = editorExperiment('platform_editor_offline_editing_web', true);
       var onlineStepMergingEnabled = expValEquals('platform_editor_enable_single_player_step_merging', 'isEnabled', true);
+      // We don't trust `_newState` not to be stale
+      // ED-29051 - the `onEditorViewStateUpdated` can have a stale state in edge cases. We need
+      // to always ensure we're sending the latest state and unconfirmed steps so we use the state
+      // from editorView directly (via getState).
+      var newState = onlineStepMergingEnabled ? (_this$getState1 = (_this$getState10 = this.getState) === null || _this$getState10 === void 0 ? void 0 : _this$getState10.call(this)) !== null && _this$getState1 !== void 0 ? _this$getState1 : _newState : _newState;
 
       // Don't send any steps before we're ready.
       if (offlineEditingEnabled || onlineStepMergingEnabled) {

package/dist/esm/version-wrapper.js

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

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

@@ -188,5 +188,5 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param reason
      * @example
      */
-    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, _newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
 }

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

@@ -4,34 +4,34 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { InternalError } from '../errors/internal-errors';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export interface DocumentServiceInterface {
-    setup(params: {
+    setup: (params: {
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
         clientId: number | string | undefined;
-    }): this;
-    updateDocument(params: {
+    }) => this;
+    updateDocument: (params: {
         doc: any;
         version: number;
         metadata: any;
         reserveCursor?: boolean;
-    }): void;
-    onRestore(params: {
+    }) => void;
+    onRestore: (params: {
         doc: any;
         version: number;
         metadata: any;
-    }): void;
-    onStepsAdded(data: {
+    }) => void;
+    onStepsAdded: (data: {
         version: number;
         steps: any[];
-    }): void;
-    onStepRejectedError(): void;
-    send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
-    throttledCatchupv2(): void;
-    getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
-    getIsNamespaceLocked(): boolean;
-    getUnconfirmedSteps(): readonly ProseMirrorStep[] | undefined;
-    getCurrentPmVersion(): number;
+    }) => void;
+    onStepRejectedError: () => void;
+    send: (tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean) => void;
+    sendStepsFromCurrentState: (sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason) => void;
+    throttledCatchupv2: () => void;
+    getCurrentState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
+    getIsNamespaceLocked: () => boolean;
+    getUnconfirmedSteps: () => readonly ProseMirrorStep[] | undefined;
+    getCurrentPmVersion: () => number;
     onErrorHandled: (error: InternalError) => void;
 }

package/dist/types/participants/participants-helper.d.ts

@@ -12,7 +12,7 @@ export type BatchProps = {
     /** how often the debounce should run. Defaults to {@link ./participants-service#DEFAULT_FETCH_USERS_INTERVAL} if none provided **/
     debounceTime?: number;
     getUsers?: GetUsersType;
-    onError?(error: unknown): void;
+    onError?: (error: unknown) => void;
     /** when to stop fetching users. eg. if this = 5, we won't attempt to hydrate more than 5 **/
     participantsLimit?: number;
 };

package/dist/types/types.d.ts

@@ -13,9 +13,9 @@ export interface CollabEventDisconnectedData {
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
 }
 export interface Storage {
-    get(key: string): Promise<string>;
-    set(key: string, value: string): Promise<void>;
-    delete(key: string): Promise<void>;
+    get: (key: string) => Promise<string>;
+    set: (key: string, value: string) => Promise<void>;
+    delete: (key: string) => Promise<void>;
 }
 export interface InitialDraft {
     document: JSONDocNode;

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

@@ -188,5 +188,5 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @param reason
      * @example
      */
-    send(tr: Transaction | null, _oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
+    send(tr: Transaction | null, _oldState: EditorState | null, _newState: EditorState, sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
 }

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

@@ -4,34 +4,34 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { InternalError } from '../errors/internal-errors';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
 export interface DocumentServiceInterface {
-    setup(params: {
+    setup: (params: {
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
         clientId: number | string | undefined;
-    }): this;
-    updateDocument(params: {
+    }) => this;
+    updateDocument: (params: {
         doc: any;
         version: number;
         metadata: any;
         reserveCursor?: boolean;
-    }): void;
-    onRestore(params: {
+    }) => void;
+    onRestore: (params: {
         doc: any;
         version: number;
         metadata: any;
-    }): void;
-    onStepsAdded(data: {
+    }) => void;
+    onStepsAdded: (data: {
         version: number;
         steps: any[];
-    }): void;
-    onStepRejectedError(): void;
-    send(tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean): void;
-    sendStepsFromCurrentState(sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason): void;
-    throttledCatchupv2(): void;
-    getCurrentState(): Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
-    getIsNamespaceLocked(): boolean;
-    getUnconfirmedSteps(): readonly ProseMirrorStep[] | undefined;
-    getCurrentPmVersion(): number;
+    }) => void;
+    onStepRejectedError: () => void;
+    send: (tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean) => void;
+    sendStepsFromCurrentState: (sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason) => void;
+    throttledCatchupv2: () => void;
+    getCurrentState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
+    getIsNamespaceLocked: () => boolean;
+    getUnconfirmedSteps: () => readonly ProseMirrorStep[] | undefined;
+    getCurrentPmVersion: () => number;
     onErrorHandled: (error: InternalError) => void;
 }

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

@@ -12,7 +12,7 @@ export type BatchProps = {
     /** how often the debounce should run. Defaults to {@link ./participants-service#DEFAULT_FETCH_USERS_INTERVAL} if none provided **/
     debounceTime?: number;
     getUsers?: GetUsersType;
-    onError?(error: unknown): void;
+    onError?: (error: unknown) => void;
     /** when to stop fetching users. eg. if this = 5, we won't attempt to hydrate more than 5 **/
     participantsLimit?: number;
 };

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

@@ -13,9 +13,9 @@ export interface CollabEventDisconnectedData {
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
 }
 export interface Storage {
-    get(key: string): Promise<string>;
-    set(key: string, value: string): Promise<void>;
-    delete(key: string): Promise<void>;
+    get: (key: string) => Promise<string>;
+    set: (key: string, value: string) => Promise<void>;
+    delete: (key: string) => Promise<void>;
 }
 export interface InitialDraft {
     document: JSONDocNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "11.2.4",
+	"version": "11.3.1",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -36,13 +36,13 @@
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^9.0.0",
 		"@atlaskit/anonymous-assets": "^0.0.4",
-		"@atlaskit/editor-json-transformer": "^8.25.0",
+		"@atlaskit/editor-json-transformer": "^8.27.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/feature-gate-js-client": "^5.5.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.17.0",
 		"@atlaskit/react-ufo": "^4.4.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -68,7 +68,7 @@
 		}
 	},
 	"devDependencies": {
-		"@atlaskit/adf-schema": "^50.2.0",
+		"@atlaskit/adf-schema": "^50.2.1",
 		"@atlassian/feature-flags-test-utils": "^0.3.0"
 	},
 	"platform-feature-flags": {
@@ -86,6 +86,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.25.0"
+		"@atlaskit/editor-common": "^107.28.0"
 	}
 }