@atlaskit/prosemirror-collab 0.16.3 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/prosemirror-collab
 
+## 0.17.0
+
+### Minor Changes
+
+- [#154562](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/154562)
+  [`9a3495cb72638`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9a3495cb72638) -
+  Support AnalyticsStep filtering for collab
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.16.4
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.16.3
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -74,14 +74,6 @@ unconfirmed) {
 function unconfirmedFrom(transform) {
   var result = [];
   for (var i = 0; i < transform.steps.length; i++) {
-    // Filter out the analytics steps, they don't need to be sent to the collab service
-    // Commented out because it broke undo behaviour
-
-    // TODO: ED-26957 - Figure out how it broke undo
-    // if (transform.steps[i] instanceof AnalyticsStep) {
-    //   continue;
-    // }
-
     result.push(new Rebaseable(transform.steps[i], transform.steps[i].invert(transform.docs[i]), transform));
   }
   return result;

package/dist/cjs/movedContent.js

@@ -3,24 +3,36 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.mapStep = void 0;
+exports.mapStep = exports.isMoveSequence = exports.createMoveMapStep = void 0;
+var _steps = require("@atlaskit/adf-schema/steps");
 var _model = require("@atlaskit/editor-prosemirror/model");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
+// Iterate from the specified starting index down to 0
+var findPreviousStepInverseIndex = function findPreviousStepInverseIndex(steps) {
+  var startIndex = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : steps.length - 1;
+  for (var i = startIndex; i >= 0; i--) {
+    if (!(steps[i] instanceof _steps.AnalyticsStep)) {
+      return i;
+    }
+  }
+};
 var mapStep = exports.mapStep = function mapStep(steps, transform, index, mapped) {
   if (index < 1) {
     return undefined;
   }
-  var previousRebaseableStep = steps[index - 1];
-  if (
+  var previousRebaseableStepIndex = findPreviousStepInverseIndex(steps.map(function (s) {
+    return s.step;
+  }), index - 1);
+
   // This checks the local steps are a "move" sequence
-  isMoveSequence(previousRebaseableStep.step, steps[index].step,
-  // Used to get the document prior to step changes
-  previousRebaseableStep)) {
-    var previousStep = transform.steps[transform.steps.length - 1];
+  if (previousRebaseableStepIndex !== undefined && isMoveSequence(steps[previousRebaseableStepIndex], steps[index].step)) {
+    var previousStepInverseIndex = findPreviousStepInverseIndex(transform.steps);
+
     // Creates a new step based on the "current" steps (partially through the rebase)
-    return createMoveMapStep(mapped, previousStep, transform);
+    if (previousStepInverseIndex !== undefined) {
+      return createMoveMapStep(mapped, transform.steps[previousStepInverseIndex], transform, previousStepInverseIndex);
+    }
   }
-  return undefined;
 };
 
 // Only consider ReplaceStep (ReplaceAroundStep do not occur for moves)
@@ -37,20 +49,20 @@ var isReplaceTypeStep = function isReplaceTypeStep(step) {
  * @param currentStep
  * @param previousRebaseable
  */
-var isMoveSequence = function isMoveSequence(previousStep, currentStep, previousRebaseable) {
+var isMoveSequence = exports.isMoveSequence = function isMoveSequence(previousRebaseableStep, currentStep) {
   if (
   // The both steps are replace
-  isReplaceTypeStep(previousStep) && isReplaceTypeStep(currentStep) &&
+  isReplaceTypeStep(previousRebaseableStep.step) && isReplaceTypeStep(currentStep) &&
   // The current step is a deletion
-  previousStep.slice.size === 0 &&
+  previousRebaseableStep.step.slice.size === 0 &&
   // The following step is an insertion with the same length that was deleted by the current step
-  Math.abs(previousStep.to - previousStep.from) === currentStep.slice.size) {
+  Math.abs(previousRebaseableStep.step.to - previousRebaseableStep.step.from) === currentStep.slice.size) {
     // Ensure we're getting the doc before our step changes so we can compare node contents
-    var originStepIndex = previousRebaseable.origin.steps.findIndex(function (s) {
-      return s === previousStep;
+    var originStepIndex = previousRebaseableStep.origin.steps.findIndex(function (s) {
+      return s === previousRebaseableStep.step;
     });
-    var originalDoc = previousRebaseable.origin.docs[originStepIndex];
-    var currentSlice = originalDoc.slice(previousStep.from, previousStep.to);
+    var originalDoc = previousRebaseableStep.origin.docs[originStepIndex];
+    var currentSlice = originalDoc.slice(previousRebaseableStep.step.from, previousRebaseableStep.step.to);
     // The content from the deleted + inserted slice is exactly the same (cut + paste or drag + drop)
     if (currentSlice.eq(currentStep.slice)) {
       return true;
@@ -68,11 +80,11 @@ var isMoveSequence = function isMoveSequence(previousStep, currentStep, previous
  * @param transform
  * @returns Step to apply missing changes
  */
-var createMoveMapStep = function createMoveMapStep(mapped, previousStep, transform) {
+var createMoveMapStep = exports.createMoveMapStep = function createMoveMapStep(mapped, previousStep, transform, previousStepIndex) {
   if (!isReplaceTypeStep(previousStep) || mapped && !isReplaceTypeStep(mapped) || !mapped) {
     return undefined;
   }
-  var newSlice = transform.docs[transform.docs.length - 1].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
+  var newSlice = transform.docs[previousStepIndex].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
   var diff = getDiffRange(mapped.slice.content, newSlice.content);
   if (diff === undefined) {
     return undefined;
@@ -87,7 +99,7 @@ var createMoveMapStep = function createMoveMapStep(mapped, previousStep, transfo
   }
 
   // Replace the diff range with the latest content in the document (at the old position)
-  return new _transform.ReplaceStep(start, start + offset, transform.docs[transform.docs.length - 1].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
+  return new _transform.ReplaceStep(start, start + offset, transform.docs[previousStepIndex].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
 };
 
 /**

package/dist/es2019/index.js

@@ -60,14 +60,6 @@ class CollabState {
 function unconfirmedFrom(transform) {
   const result = [];
   for (let i = 0; i < transform.steps.length; i++) {
-    // Filter out the analytics steps, they don't need to be sent to the collab service
-    // Commented out because it broke undo behaviour
-
-    // TODO: ED-26957 - Figure out how it broke undo
-    // if (transform.steps[i] instanceof AnalyticsStep) {
-    //   continue;
-    // }
-
     result.push(new Rebaseable(transform.steps[i], transform.steps[i].invert(transform.docs[i]), transform));
   }
   return result;

package/dist/es2019/movedContent.js

@@ -1,20 +1,29 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { Slice } from '@atlaskit/editor-prosemirror/model';
 import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+// Iterate from the specified starting index down to 0
+const findPreviousStepInverseIndex = (steps, startIndex = steps.length - 1) => {
+  for (let i = startIndex; i >= 0; i--) {
+    if (!(steps[i] instanceof AnalyticsStep)) {
+      return i;
+    }
+  }
+};
 export const mapStep = (steps, transform, index, mapped) => {
   if (index < 1) {
     return undefined;
   }
-  const previousRebaseableStep = steps[index - 1];
-  if (
+  const previousRebaseableStepIndex = findPreviousStepInverseIndex(steps.map(s => s.step), index - 1);
+
   // This checks the local steps are a "move" sequence
-  isMoveSequence(previousRebaseableStep.step, steps[index].step,
-  // Used to get the document prior to step changes
-  previousRebaseableStep)) {
-    const previousStep = transform.steps[transform.steps.length - 1];
+  if (previousRebaseableStepIndex !== undefined && isMoveSequence(steps[previousRebaseableStepIndex], steps[index].step)) {
+    const previousStepInverseIndex = findPreviousStepInverseIndex(transform.steps);
+
     // Creates a new step based on the "current" steps (partially through the rebase)
-    return createMoveMapStep(mapped, previousStep, transform);
+    if (previousStepInverseIndex !== undefined) {
+      return createMoveMapStep(mapped, transform.steps[previousStepInverseIndex], transform, previousStepInverseIndex);
+    }
   }
-  return undefined;
 };
 
 // Only consider ReplaceStep (ReplaceAroundStep do not occur for moves)
@@ -29,18 +38,18 @@ const isReplaceTypeStep = step => step instanceof ReplaceStep;
  * @param currentStep
  * @param previousRebaseable
  */
-const isMoveSequence = (previousStep, currentStep, previousRebaseable) => {
+export const isMoveSequence = (previousRebaseableStep, currentStep) => {
   if (
   // The both steps are replace
-  isReplaceTypeStep(previousStep) && isReplaceTypeStep(currentStep) &&
+  isReplaceTypeStep(previousRebaseableStep.step) && isReplaceTypeStep(currentStep) &&
   // The current step is a deletion
-  previousStep.slice.size === 0 &&
+  previousRebaseableStep.step.slice.size === 0 &&
   // The following step is an insertion with the same length that was deleted by the current step
-  Math.abs(previousStep.to - previousStep.from) === currentStep.slice.size) {
+  Math.abs(previousRebaseableStep.step.to - previousRebaseableStep.step.from) === currentStep.slice.size) {
     // Ensure we're getting the doc before our step changes so we can compare node contents
-    const originStepIndex = previousRebaseable.origin.steps.findIndex(s => s === previousStep);
-    const originalDoc = previousRebaseable.origin.docs[originStepIndex];
-    const currentSlice = originalDoc.slice(previousStep.from, previousStep.to);
+    const originStepIndex = previousRebaseableStep.origin.steps.findIndex(s => s === previousRebaseableStep.step);
+    const originalDoc = previousRebaseableStep.origin.docs[originStepIndex];
+    const currentSlice = originalDoc.slice(previousRebaseableStep.step.from, previousRebaseableStep.step.to);
     // The content from the deleted + inserted slice is exactly the same (cut + paste or drag + drop)
     if (currentSlice.eq(currentStep.slice)) {
       return true;
@@ -58,11 +67,11 @@ const isMoveSequence = (previousStep, currentStep, previousRebaseable) => {
  * @param transform
  * @returns Step to apply missing changes
  */
-const createMoveMapStep = (mapped, previousStep, transform) => {
+export const createMoveMapStep = (mapped, previousStep, transform, previousStepIndex) => {
   if (!isReplaceTypeStep(previousStep) || mapped && !isReplaceTypeStep(mapped) || !mapped) {
     return undefined;
   }
-  const newSlice = transform.docs[transform.docs.length - 1].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
+  const newSlice = transform.docs[previousStepIndex].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
   const diff = getDiffRange(mapped.slice.content, newSlice.content);
   if (diff === undefined) {
     return undefined;
@@ -77,7 +86,7 @@ const createMoveMapStep = (mapped, previousStep, transform) => {
   }
 
   // Replace the diff range with the latest content in the document (at the old position)
-  return new ReplaceStep(start, start + offset, transform.docs[transform.docs.length - 1].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
+  return new ReplaceStep(start, start + offset, transform.docs[previousStepIndex].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
 };
 
 /**

package/dist/esm/index.js

@@ -60,14 +60,6 @@ unconfirmed) {
 function unconfirmedFrom(transform) {
   var result = [];
   for (var i = 0; i < transform.steps.length; i++) {
-    // Filter out the analytics steps, they don't need to be sent to the collab service
-    // Commented out because it broke undo behaviour
-
-    // TODO: ED-26957 - Figure out how it broke undo
-    // if (transform.steps[i] instanceof AnalyticsStep) {
-    //   continue;
-    // }
-
     result.push(new Rebaseable(transform.steps[i], transform.steps[i].invert(transform.docs[i]), transform));
   }
   return result;

package/dist/esm/movedContent.js

@@ -1,20 +1,32 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { Slice } from '@atlaskit/editor-prosemirror/model';
 import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+// Iterate from the specified starting index down to 0
+var findPreviousStepInverseIndex = function findPreviousStepInverseIndex(steps) {
+  var startIndex = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : steps.length - 1;
+  for (var i = startIndex; i >= 0; i--) {
+    if (!(steps[i] instanceof AnalyticsStep)) {
+      return i;
+    }
+  }
+};
 export var mapStep = function mapStep(steps, transform, index, mapped) {
   if (index < 1) {
     return undefined;
   }
-  var previousRebaseableStep = steps[index - 1];
-  if (
+  var previousRebaseableStepIndex = findPreviousStepInverseIndex(steps.map(function (s) {
+    return s.step;
+  }), index - 1);
+
   // This checks the local steps are a "move" sequence
-  isMoveSequence(previousRebaseableStep.step, steps[index].step,
-  // Used to get the document prior to step changes
-  previousRebaseableStep)) {
-    var previousStep = transform.steps[transform.steps.length - 1];
+  if (previousRebaseableStepIndex !== undefined && isMoveSequence(steps[previousRebaseableStepIndex], steps[index].step)) {
+    var previousStepInverseIndex = findPreviousStepInverseIndex(transform.steps);
+
     // Creates a new step based on the "current" steps (partially through the rebase)
-    return createMoveMapStep(mapped, previousStep, transform);
+    if (previousStepInverseIndex !== undefined) {
+      return createMoveMapStep(mapped, transform.steps[previousStepInverseIndex], transform, previousStepInverseIndex);
+    }
   }
-  return undefined;
 };
 
 // Only consider ReplaceStep (ReplaceAroundStep do not occur for moves)
@@ -31,20 +43,20 @@ var isReplaceTypeStep = function isReplaceTypeStep(step) {
  * @param currentStep
  * @param previousRebaseable
  */
-var isMoveSequence = function isMoveSequence(previousStep, currentStep, previousRebaseable) {
+export var isMoveSequence = function isMoveSequence(previousRebaseableStep, currentStep) {
   if (
   // The both steps are replace
-  isReplaceTypeStep(previousStep) && isReplaceTypeStep(currentStep) &&
+  isReplaceTypeStep(previousRebaseableStep.step) && isReplaceTypeStep(currentStep) &&
   // The current step is a deletion
-  previousStep.slice.size === 0 &&
+  previousRebaseableStep.step.slice.size === 0 &&
   // The following step is an insertion with the same length that was deleted by the current step
-  Math.abs(previousStep.to - previousStep.from) === currentStep.slice.size) {
+  Math.abs(previousRebaseableStep.step.to - previousRebaseableStep.step.from) === currentStep.slice.size) {
     // Ensure we're getting the doc before our step changes so we can compare node contents
-    var originStepIndex = previousRebaseable.origin.steps.findIndex(function (s) {
-      return s === previousStep;
+    var originStepIndex = previousRebaseableStep.origin.steps.findIndex(function (s) {
+      return s === previousRebaseableStep.step;
     });
-    var originalDoc = previousRebaseable.origin.docs[originStepIndex];
-    var currentSlice = originalDoc.slice(previousStep.from, previousStep.to);
+    var originalDoc = previousRebaseableStep.origin.docs[originStepIndex];
+    var currentSlice = originalDoc.slice(previousRebaseableStep.step.from, previousRebaseableStep.step.to);
     // The content from the deleted + inserted slice is exactly the same (cut + paste or drag + drop)
     if (currentSlice.eq(currentStep.slice)) {
       return true;
@@ -62,11 +74,11 @@ var isMoveSequence = function isMoveSequence(previousStep, currentStep, previous
  * @param transform
  * @returns Step to apply missing changes
  */
-var createMoveMapStep = function createMoveMapStep(mapped, previousStep, transform) {
+export var createMoveMapStep = function createMoveMapStep(mapped, previousStep, transform, previousStepIndex) {
   if (!isReplaceTypeStep(previousStep) || mapped && !isReplaceTypeStep(mapped) || !mapped) {
     return undefined;
   }
-  var newSlice = transform.docs[transform.docs.length - 1].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
+  var newSlice = transform.docs[previousStepIndex].slice(previousStep === null || previousStep === void 0 ? void 0 : previousStep.from, previousStep === null || previousStep === void 0 ? void 0 : previousStep.to);
   var diff = getDiffRange(mapped.slice.content, newSlice.content);
   if (diff === undefined) {
     return undefined;
@@ -81,7 +93,7 @@ var createMoveMapStep = function createMoveMapStep(mapped, previousStep, transfo
   }
 
   // Replace the diff range with the latest content in the document (at the old position)
-  return new ReplaceStep(start, start + offset, transform.docs[transform.docs.length - 1].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
+  return new ReplaceStep(start, start + offset, transform.docs[previousStepIndex].slice((previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.start, (previousStep === null || previousStep === void 0 ? void 0 : previousStep.from) + diff.end));
 };
 
 /**

package/dist/types/movedContent.d.ts

@@ -2,3 +2,23 @@ import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import type { Step as ProseMirrorStep, Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
 import type { Rebaseable } from './index';
 export declare const mapStep: (steps: readonly Rebaseable[], transform: ProseMirrorTransform, index: number, mapped: ProseMirrorStep | null) => ReplaceStep | undefined;
+/**
+ * Determines if a step pairing is a move sequence (ie. drag + drop or cut + paste).
+ *
+ * We determine this if we have a deletion followed by insertion and their content matches
+ *
+ * @param previousStep
+ * @param currentStep
+ * @param previousRebaseable
+ */
+export declare const isMoveSequence: (previousRebaseableStep: Rebaseable, currentStep: ProseMirrorStep) => boolean;
+/**
+ * Update the replace step slice of the insert part of a move
+ * to contain the slice of the current document rather than what was sliced originally.
+ *
+ * @param mapped
+ * @param previousStep
+ * @param transform
+ * @returns Step to apply missing changes
+ */
+export declare const createMoveMapStep: (mapped: ProseMirrorStep | null, previousStep: ProseMirrorStep, transform: ProseMirrorTransform, previousStepIndex: number) => ReplaceStep | undefined;

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

@@ -2,3 +2,23 @@ import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import type { Step as ProseMirrorStep, Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
 import type { Rebaseable } from './index';
 export declare const mapStep: (steps: readonly Rebaseable[], transform: ProseMirrorTransform, index: number, mapped: ProseMirrorStep | null) => ReplaceStep | undefined;
+/**
+ * Determines if a step pairing is a move sequence (ie. drag + drop or cut + paste).
+ *
+ * We determine this if we have a deletion followed by insertion and their content matches
+ *
+ * @param previousStep
+ * @param currentStep
+ * @param previousRebaseable
+ */
+export declare const isMoveSequence: (previousRebaseableStep: Rebaseable, currentStep: ProseMirrorStep) => boolean;
+/**
+ * Update the replace step slice of the insert part of a move
+ * to contain the slice of the current document rather than what was sliced originally.
+ *
+ * @param mapped
+ * @param previousStep
+ * @param transform
+ * @returns Step to apply missing changes
+ */
+export declare const createMoveMapStep: (mapped: ProseMirrorStep | null, previousStep: ProseMirrorStep, transform: ProseMirrorTransform, previousStepIndex: number) => ReplaceStep | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/prosemirror-collab",
-	"version": "0.16.3",
+	"version": "0.17.0",
 	"description": "Collaborative editing for ProseMirror - Atlassian Fork",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -30,14 +30,12 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
+		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/tmp-editor-statsig": "^4.21.0",
+		"@atlaskit/tmp-editor-statsig": "^5.5.0",
 		"@babel/runtime": "^7.0.0",
 		"uuid": "^3.1.0"
 	},
-	"devDependencies": {
-		"@atlaskit/adf-schema": "^47.6.0"
-	},
 	"techstack": {
 		"@atlassian/frontend": {
 			"import-structure": [