@atlaskit/editor-plugin-collab-edit 2.0.0 → 2.0.2

package/dist/esm/pm-plugins/utils.js

@@ -3,14 +3,16 @@ import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { processRawValueWithoutValidation } from '@atlaskit/editor-common/process-raw-value';
 import { ZERO_WIDTH_JOINER } from '@atlaskit/editor-common/whitespace';
-import { Transaction } from '@atlaskit/editor-prosemirror/state';
-import { Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { Transaction, Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { avatarColors } from '@atlaskit/editor-shared-styles/consts';
 import { fg } from '@atlaskit/platform-feature-flags';
 export var findPointers = function findPointers(id, decorations) {
-  return decorations.find().reduce(function (arr, deco) {
+  return decorations.find()
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  .reduce(function (arr, deco) {
     return deco.spec.pointer.sessionId === id ? arr.concat(deco) : arr;
   }, []);
 };
@@ -32,13 +34,19 @@ export function getAvatarColor(str) {
     color: avatarColors[index]
   };
 }
-export var createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial) {
+export var createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/max-params
+) {
   var decorations = [];
   var avatarColor = getAvatarColor(sessionId);
   var color = avatarColor.index.toString();
   if (isSelection) {
     var className = "telepointer color-".concat(color, " telepointer-selection");
-    decorations.push(Decoration.inline(from, to, {
+    decorations.push(
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    Decoration.inline(from, to, {
       class: className,
       'data-initial': initial
     }, {
@@ -58,24 +66,36 @@ export var createTelepointers = function createTelepointers(from, to, sessionId,
     color: avatarColor.color
   }), ";");
   cursor.setAttribute('data-initial', initial);
-  return decorations.concat(Decoration.widget(to, spaceJoinerAfter, {
+  return decorations.concat(
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Decoration.widget(to, spaceJoinerAfter, {
     pointer: {
       sessionId: sessionId
     },
     key: "telepointer-".concat(sessionId, "-zero")
-  })).concat(Decoration.widget(to, cursor, {
+  })).concat(
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Decoration.widget(to, cursor, {
     pointer: {
       sessionId: sessionId
     },
     key: "telepointer-".concat(sessionId)
-  })).concat(Decoration.widget(to, spaceJoinerBefore, {
+  })).concat(
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Decoration.widget(to, spaceJoinerBefore, {
     pointer: {
       sessionId: sessionId
     },
     key: "telepointer-".concat(sessionId, "-zero")
   }));
 };
-export var replaceDocument = function replaceDocument(doc, state, version, options, reserveCursor, editorAnalyticsAPI) {
+export var replaceDocument = function replaceDocument(doc, state, version, options, reserveCursor, editorAnalyticsAPI
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/max-params
+) {
   var schema = state.schema,
     tr = state.tr;
   var hasContent;
@@ -85,6 +105,8 @@ export var replaceDocument = function replaceDocument(doc, state, version, optio
     hasContent = !!(parsedDoc !== null && parsedDoc !== void 0 && parsedDoc.childCount);
     content = parsedDoc === null || parsedDoc === void 0 ? void 0 : parsedDoc.content;
   } else {
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     content = (doc.content || []).map(function (child) {
       return schema.nodeFromJSON(child);
     });
@@ -92,6 +114,8 @@ export var replaceDocument = function replaceDocument(doc, state, version, optio
   }
   if (hasContent) {
     tr.setMeta('addToHistory', false);
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     tr.replaceWith(0, state.doc.nodeSize - 2, content);
     var selection = state.selection;
     if (reserveCursor) {
@@ -117,7 +141,10 @@ export var replaceDocument = function replaceDocument(doc, state, version, optio
   }
   return tr;
 };
-export var scrollToCollabCursor = function scrollToCollabCursor(editorView, participants, sessionId, index, editorAnalyticsAPI) {
+export var scrollToCollabCursor = function scrollToCollabCursor(editorView, participants, sessionId, index, editorAnalyticsAPI
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/max-params
+) {
   var selectedUser = participants[index];
   if (selectedUser && selectedUser.cursorPos !== undefined && selectedUser.sessionId !== sessionId) {
     var state = editorView.state;
@@ -138,6 +165,8 @@ export var scrollToCollabCursor = function scrollToCollabCursor(editorView, part
 };
 export var getPositionOfTelepointer = function getPositionOfTelepointer(sessionId, decorationSet) {
   var scrollPosition;
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   decorationSet.find().forEach(function (deco) {
     if (deco.type.spec.pointer.sessionId === sessionId) {
       scrollPosition = deco.from;

package/dist/types/pm-plugins/mergeUnconfirmed.d.ts

@@ -0,0 +1,24 @@
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
+declare class LockableRebaseable {
+    readonly step: LockableProseMirrorStep;
+    readonly inverted: ProseMirrorStep;
+    readonly origin: ProseMirrorTransform;
+    constructor(step: LockableProseMirrorStep, inverted: ProseMirrorStep, origin: ProseMirrorTransform);
+}
+declare abstract class LockableProseMirrorStep extends ProseMirrorStep {
+    lockStep?: () => void;
+    isLocked?: () => boolean;
+}
+/**
+ * Merge a set of steps together to reduce the total number of steps stored in memory.
+ *
+ * All steps passing through here should be "lockable" (ie. can be locked by the document service)
+ * so that it can be indicated they have already been sent (or are about to be sent) to the backend
+ * and cannot be merged.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ */
+export declare function mergeUnconfirmedSteps(steps: LockableRebaseable[]): LockableRebaseable[];
+export {};

package/dist/types-ts4.5/pm-plugins/mergeUnconfirmed.d.ts

@@ -0,0 +1,24 @@
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
+declare class LockableRebaseable {
+    readonly step: LockableProseMirrorStep;
+    readonly inverted: ProseMirrorStep;
+    readonly origin: ProseMirrorTransform;
+    constructor(step: LockableProseMirrorStep, inverted: ProseMirrorStep, origin: ProseMirrorTransform);
+}
+declare abstract class LockableProseMirrorStep extends ProseMirrorStep {
+    lockStep?: () => void;
+    isLocked?: () => boolean;
+}
+/**
+ * Merge a set of steps together to reduce the total number of steps stored in memory.
+ *
+ * All steps passing through here should be "lockable" (ie. can be locked by the document service)
+ * so that it can be indicated they have already been sent (or are about to be sent) to the backend
+ * and cannot be merged.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ */
+export declare function mergeUnconfirmedSteps(steps: LockableRebaseable[]): LockableRebaseable[];
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "2.0.0",
+	"version": "2.0.2",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,15 +33,15 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^46.1.0",
 		"@atlaskit/custom-steps": "^0.9.0",
-		"@atlaskit/editor-common": "^96.5.0",
+		"@atlaskit/editor-common": "^97.2.0",
 		"@atlaskit/editor-json-transformer": "^8.21.0",
-		"@atlaskit/editor-plugin-analytics": "1.10.8",
+		"@atlaskit/editor-plugin-analytics": "1.10.9",
 		"@atlaskit/editor-plugin-editor-viewmode": "^2.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/editor-shared-styles": "^3.2.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/prosemirror-collab": "^0.10.0",
+		"@atlaskit/prosemirror-collab": "^0.11.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
@@ -104,6 +104,9 @@
 	"platform-feature-flags": {
 		"platform_editor_use_nested_table_pm_nodes": {
 			"type": "boolean"
+		},
+		"platform_editor_merge_unconfirmed_steps": {
+			"type": "boolean"
 		}
 	}
 }