@atlaskit/collab-provider 11.3.0 → 11.3.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 11.3.2
+
+### Patch Changes
+
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
+## 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

package/afm-cc/tsconfig.json

@@ -3,9 +3,9 @@
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
-		"composite": true,
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__collab-provider",
-		"rootDir": "../"
+		"rootDir": "../",
+		"composite": true
 	},
 	"include": [
 		"../src/**/*.ts",

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.4";
+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.4";
+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.4";
+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

@@ -117,13 +117,13 @@ export declare class DocumentService implements DocumentServiceInterface {
                 to?: number | undefined;
             };
             stepMetadata: {
-                source?: string;
-                stepId?: string;
                 prevStepId?: string;
                 rebased?: boolean;
-                traceId?: string;
                 reqId?: string;
                 schemaVersion?: string;
+                source?: string;
+                stepId?: string;
+                traceId?: string;
                 unconfirmedStepAfterRecovery?: boolean;
             } | undefined;
         }[];
@@ -155,9 +155,9 @@ export declare class DocumentService implements DocumentServiceInterface {
      * @example
      */
     setup({ getState, onSyncUpError, clientId, }: {
+        clientId: number | string | undefined;
         getState: () => EditorState;
         onSyncUpError?: SyncUpErrorFunction;
-        clientId: number | string | undefined;
     }): this;
     /**
      * We can use this function to throttle/delay
@@ -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: {
-        getState: () => EditorState;
-        onSyncUpError?: SyncUpErrorFunction;
-        clientId: number | string | undefined;
-    }) => this;
-    updateDocument: (params: {
-        doc: any;
-        version: number;
-        metadata: any;
-        reserveCursor?: boolean;
-    }) => void;
+    getCurrentPmVersion: () => number;
+    getCurrentState: () => Promise<ResolvedEditorState>;
+    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
+    getIsNamespaceLocked: () => boolean;
+    getUnconfirmedSteps: () => readonly ProseMirrorStep[] | undefined;
+    onErrorHandled: (error: InternalError) => void;
     onRestore: (params: {
         doc: any;
-        version: number;
         metadata: any;
+        version: number;
     }) => void;
+    onStepRejectedError: () => void;
     onStepsAdded: (data: {
-        version: number;
         steps: any[];
+        version: number;
     }) => void;
-    onStepRejectedError: () => void;
     send: (tr: Transaction | null, oldState: EditorState | null, newState: EditorState, sendAnalyticsEvent?: boolean) => void;
     sendStepsFromCurrentState: (sendAnalyticsEvent?: boolean, reason?: GetResolvedEditorStateReason) => void;
+    setup: (params: {
+        clientId: number | string | undefined;
+        getState: () => EditorState;
+        onSyncUpError?: SyncUpErrorFunction;
+    }) => this;
     throttledCatchupv2: () => void;
-    getCurrentState: () => Promise<ResolvedEditorState>;
-    getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;
-    getIsNamespaceLocked: () => boolean;
-    getUnconfirmedSteps: () => readonly ProseMirrorStep[] | undefined;
-    getCurrentPmVersion: () => number;
-    onErrorHandled: (error: InternalError) => void;
+    updateDocument: (params: {
+        doc: any;
+        metadata: any;
+        reserveCursor?: boolean;
+        version: number;
+    }) => void;
 }

package/dist/types/errors/internal-errors.d.ts

@@ -13,95 +13,95 @@ export declare enum INTERNAL_ERROR_CODE {
     OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT = "OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT"
 }
 type DocumentRecoveryError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
         status: number;
     };
+    message: string;
 };
 type AddStepsError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.ADD_STEPS_ERROR;
         status: number;
     };
+    message: string;
 };
 type OutOfSyncClientDatalossEvent = {
-    message: string;
     data: {
+        code: INTERNAL_ERROR_CODE.OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT;
         meta: {
             reason?: string;
         };
-        code: INTERNAL_ERROR_CODE.OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT;
     };
+    message: string;
 };
 export type CatchUpFailedError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.CATCHUP_FAILED;
         status: number;
     };
+    message: string;
 };
 export type TokenPermissionError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR;
-        status: number;
         meta: {
             originalError?: unknown;
             reason?: string;
         };
+        status: number;
     };
+    message: string;
 };
 export type ReconnectionError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.RECONNECTION_ERROR;
         status: number;
     };
+    message: string;
 };
 export type ConnectionError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.CONNECTION_ERROR;
     };
+    message: string;
 };
 export type ReconnectionNetworkError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE;
     };
+    message: string;
 };
 export type DocumentNotFoundError = {
-    message: string;
     data: {
         code: INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND;
         status: number;
     };
+    message: string;
 };
 /**
  * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
  * changes can be saved to NCS.
  */
 export type InternalDocumentUpdateFailure = {
-    message: 'The provider failed to apply changes to the editor';
     data: {
         code: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
         meta: {
-            newVersion?: number;
             editorVersion?: number;
+            newVersion?: number;
         };
         status: 500;
     };
+    message: 'The provider failed to apply changes to the editor';
 };
 /**
  * When in view only mode, we should not generate any steps whatsoever.
  */
 export type ViewOnlyStepsError = {
-    message: 'Attempted to send steps in view only mode';
     data: {
         code: INTERNAL_ERROR_CODE.VIEW_ONLY_STEPS_ERROR;
     };
+    message: 'Attempted to send steps in view only mode';
 };
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.

package/dist/types/errors/ncs-errors.d.ts

@@ -19,7 +19,6 @@ export declare enum NCS_ERROR_CODE {
     PROSEMIRROR_SCHEMA_VALIDATION_ERROR = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR"
 }
 type HeadVersionUpdateFailedError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED;
         meta: {
@@ -28,17 +27,17 @@ type HeadVersionUpdateFailedError = {
         };
         status: number;
     };
+    message: string;
 };
 type VersionAlreadyPresentInDynamoError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type InsufficientEditingPermissionError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION;
         meta: {
@@ -47,65 +46,65 @@ type InsufficientEditingPermissionError = {
         };
         status: number;
     };
+    message: string;
 };
 type ForbiddenUserTokenError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type NCSDocumentNotFoundError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.DOCUMENT_NOT_FOUND;
         status: number;
     };
+    message: string;
 };
 type FailedToLoadInitDataError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED;
         status: number;
     };
+    message: string;
 };
 /**
  * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
  * This might be because invalid ADF has been written to a document, as it was not validated correctly.
  */
 type ProsemirrorSchemaValidationError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR;
         status: number;
     };
+    message: string;
 };
 type ErrorMappingError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.ERROR_MAPPING_ERROR;
         status: number;
     };
+    message: string;
 };
 type InvalidNamespaceDefinedError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.NAMESPACE_INVALID;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type SocketNamespaceNotFoundError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.NAMESPACE_NOT_FOUND;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type TenantInstanceMaintenanceError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE;
         meta: {
@@ -114,71 +113,72 @@ type TenantInstanceMaintenanceError = {
         };
         status: number;
     };
+    message: string;
 };
 type NamespaceLockedError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.LOCKED_DOCUMENT;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type EmptyBroadcastError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.EMPTY_BROADCAST;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type DynamoError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.DYNAMO_ERROR;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type InvalidActivationIdError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.INVALID_ACTIVATION_ID;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type InvalidDocumentAriError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.INVALID_DOCUMENT_ARI;
         meta: string;
         status: number;
     };
+    message: string;
 };
 type InvalidCloudIdError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.INVALID_CLOUD_ID;
         meta: string;
         status: number;
     };
+    message: string;
 };
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
  * operating condition and should only ever indicate a frontend bug.
  */
 export type RateLimitError = {
-    message: string;
     data: {
         code: NCS_ERROR_CODE.RATE_LIMIT_ERROR;
         meta: {
-            rateLimitType: number;
             maxStepSize: number;
-            stepSizeCounter: number;
+            rateLimitType: number;
             stepCounter: number;
+            stepSizeCounter: number;
         };
         status: 500;
     };
+    message: string;
 };
 export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
 export {};