@atlaskit/editor-plugin-show-diff 3.2.1 → 3.2.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 3.2.3
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.2.2
+
+### Patch Changes
+
+- [`1c0d87f570c52`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1c0d87f570c52) -
+  [ux] Update attributes to ignore attr steps that do not affect the document
+
 ## 3.2.1
 
 ### Patch Changes

package/afm-jira/tsconfig.json

@@ -17,6 +17,9 @@
 		"../src/**/examples.*"
 	],
 	"references": [
+		{
+			"path": "../../editor-tables/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../../platform/feature-flags/afm-jira/tsconfig.json"
 		},

package/afm-products/tsconfig.json

@@ -17,6 +17,9 @@
 		"../src/**/examples.*"
 	],
 	"references": [
+		{
+			"path": "../../editor-tables/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../../platform/feature-flags/afm-products/tsconfig.json"
 		},

package/dist/cjs/pm-plugins/attributeDecorations.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getAttrChangeRanges = void 0;
+exports.stepIsValidAttrChange = exports.getAttrChangeRanges = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _steps = require("@atlaskit/adf-schema/steps");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
@@ -16,7 +16,7 @@ var filterUndefined = function filterUndefined(x) {
 var allowedAttrs = ['id', 'collection', 'url'];
 var getAttrChangeRanges = exports.getAttrChangeRanges = function getAttrChangeRanges(doc, steps) {
   return steps.map(function (step) {
-    if (step instanceof _transform.AttrStep && allowedAttrs.includes(step.attr) || step instanceof _steps.SetAttrsStep && (0, _toConsumableArray2.default)(Object.keys(step.attrs)).some(function (v) {
+    if (step instanceof _transform.AttrStep && allowedAttrs.includes(step.attr) || step instanceof _steps.SetAttrsStep && step.attrs && (0, _toConsumableArray2.default)(Object.keys(step.attrs)).some(function (v) {
       return allowedAttrs.includes(v);
     })) {
       var $pos = doc.resolve(step.pos);
@@ -30,4 +30,28 @@ var getAttrChangeRanges = exports.getAttrChangeRanges = function getAttrChangeRa
     }
     return undefined;
   }).filter(filterUndefined);
+};
+
+/**
+ * Check if the step was a valid attr change and affected the doc
+ *
+ * @param step Attr step to test
+ * @param beforeDoc Doc before the step
+ * @param afterDoc Doc after the step
+ * @returns Boolean if the change should show a decoration
+ */
+var stepIsValidAttrChange = exports.stepIsValidAttrChange = function stepIsValidAttrChange(step, beforeDoc, afterDoc) {
+  try {
+    if (step instanceof _transform.AttrStep || step instanceof _steps.SetAttrsStep) {
+      var attrStepAfter = afterDoc.nodeAt(step.pos);
+      var attrStepBefore = beforeDoc.nodeAt(step.pos);
+      // The change affected the document
+      if (attrStepAfter && attrStepBefore && !attrStepAfter.eq(attrStepBefore)) {
+        return true;
+      }
+    }
+    return false;
+  } catch (e) {
+    return false;
+  }
 };

package/dist/cjs/pm-plugins/calculateDiffDecorations.js

@@ -13,7 +13,6 @@ var _memoizeOne = _interopRequireDefault(require("memoize-one"));
 var _prosemirrorChangeset = require("prosemirror-changeset");
 var _steps = require("@atlaskit/adf-schema/steps");
 var _document = require("@atlaskit/editor-common/utils/document");
-var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _view = require("@atlaskit/editor-prosemirror/view");
 var _attributeDecorations = require("./attributeDecorations");
 var _decorations = require("./decorations");
@@ -76,7 +75,7 @@ function simplifySteps(steps) {
   return steps
   // Remove steps that don't affect document structure or content
   .filter(function (step) {
-    return !(step instanceof _steps.AnalyticsStep || step instanceof _transform.AttrStep || step instanceof _steps.SetAttrsStep);
+    return !(step instanceof _steps.AnalyticsStep);
   })
   // Merge consecutive steps where possible
   .reduce(function (acc, step) {
@@ -105,7 +104,7 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   }
   var tr = state.tr;
   var steppedDoc = originalDoc;
-  var stepMaps = [];
+  var attrSteps = [];
   var changeset = _prosemirrorChangeset.ChangeSet.create(originalDoc);
   var _iterator = _createForOfIteratorHelper(steps),
     _step;
@@ -114,8 +113,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
       var step = _step.value;
       var result = step.apply(steppedDoc);
       if (result.failed === null && result.doc) {
+        if ((0, _attributeDecorations.stepIsValidAttrChange)(step, steppedDoc, result.doc)) {
+          attrSteps.push(step);
+        }
         steppedDoc = result.doc;
-        stepMaps.push(step.getMap());
         changeset = changeset.addSteps(steppedDoc, [step.getMap()], step);
       }
     }
@@ -155,7 +156,7 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   (0, _markDecorations.getMarkChangeRanges)(steps).forEach(function (change) {
     decorations.push((0, _decorations.createInlineChangedDecoration)(change, colourScheme));
   });
-  (0, _attributeDecorations.getAttrChangeRanges)(tr.doc, rawSteps).forEach(function (change) {
+  (0, _attributeDecorations.getAttrChangeRanges)(tr.doc, attrSteps).forEach(function (change) {
     decorations.push.apply(decorations, (0, _toConsumableArray2.default)(calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme)));
   });
   return _view.DecorationSet.empty.add(tr.doc, decorations);

package/dist/es2019/pm-plugins/attributeDecorations.js

@@ -6,7 +6,7 @@ const filterUndefined = x => !!x;
 const allowedAttrs = ['id', 'collection', 'url'];
 export const getAttrChangeRanges = (doc, steps) => {
   return steps.map(step => {
-    if (step instanceof AttrStep && allowedAttrs.includes(step.attr) || step instanceof SetAttrsStep && [...Object.keys(step.attrs)].some(v => allowedAttrs.includes(v))) {
+    if (step instanceof AttrStep && allowedAttrs.includes(step.attr) || step instanceof SetAttrsStep && step.attrs && [...Object.keys(step.attrs)].some(v => allowedAttrs.includes(v))) {
       const $pos = doc.resolve(step.pos);
       if ($pos.parent.type === doc.type.schema.nodes.mediaSingle) {
         const startPos = $pos.pos + $pos.parentOffset;
@@ -18,4 +18,28 @@ export const getAttrChangeRanges = (doc, steps) => {
     }
     return undefined;
   }).filter(filterUndefined);
+};
+
+/**
+ * Check if the step was a valid attr change and affected the doc
+ *
+ * @param step Attr step to test
+ * @param beforeDoc Doc before the step
+ * @param afterDoc Doc after the step
+ * @returns Boolean if the change should show a decoration
+ */
+export const stepIsValidAttrChange = (step, beforeDoc, afterDoc) => {
+  try {
+    if (step instanceof AttrStep || step instanceof SetAttrsStep) {
+      const attrStepAfter = afterDoc.nodeAt(step.pos);
+      const attrStepBefore = beforeDoc.nodeAt(step.pos);
+      // The change affected the document
+      if (attrStepAfter && attrStepBefore && !attrStepAfter.eq(attrStepBefore)) {
+        return true;
+      }
+    }
+    return false;
+  } catch (e) {
+    return false;
+  }
 };

package/dist/es2019/pm-plugins/calculateDiffDecorations.js

@@ -2,11 +2,10 @@
 import isEqual from 'lodash/isEqual';
 import memoizeOne from 'memoize-one';
 import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
-import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { areNodesEqualIgnoreAttrs } from '@atlaskit/editor-common/utils/document';
-import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { getAttrChangeRanges } from './attributeDecorations';
+import { getAttrChangeRanges, stepIsValidAttrChange } from './attributeDecorations';
 import { createInlineChangedDecoration, createDeletedContentDecoration, createBlockChangedDecoration } from './decorations';
 import { getMarkChangeRanges } from './markDecorations';
 const calculateNodesForBlockDecoration = (doc, from, to, colourScheme) => {
@@ -65,7 +64,7 @@ function optimizeChanges(changes) {
 function simplifySteps(steps) {
   return steps
   // Remove steps that don't affect document structure or content
-  .filter(step => !(step instanceof AnalyticsStep || step instanceof AttrStep || step instanceof SetAttrsStep))
+  .filter(step => !(step instanceof AnalyticsStep))
   // Merge consecutive steps where possible
   .reduce((acc, step) => {
     var _lastStep$merge;
@@ -98,13 +97,15 @@ const calculateDiffDecorationsInner = ({
     tr
   } = state;
   let steppedDoc = originalDoc;
-  const stepMaps = [];
+  const attrSteps = [];
   let changeset = ChangeSet.create(originalDoc);
   for (const step of steps) {
     const result = step.apply(steppedDoc);
     if (result.failed === null && result.doc) {
+      if (stepIsValidAttrChange(step, steppedDoc, result.doc)) {
+        attrSteps.push(step);
+      }
       steppedDoc = result.doc;
-      stepMaps.push(step.getMap());
       changeset = changeset.addSteps(steppedDoc, [step.getMap()], step);
     }
   }
@@ -139,7 +140,7 @@ const calculateDiffDecorationsInner = ({
   getMarkChangeRanges(steps).forEach(change => {
     decorations.push(createInlineChangedDecoration(change, colourScheme));
   });
-  getAttrChangeRanges(tr.doc, rawSteps).forEach(change => {
+  getAttrChangeRanges(tr.doc, attrSteps).forEach(change => {
     decorations.push(...calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme));
   });
   return DecorationSet.empty.add(tr.doc, decorations);

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

@@ -9,7 +9,7 @@ var filterUndefined = function filterUndefined(x) {
 var allowedAttrs = ['id', 'collection', 'url'];
 export var getAttrChangeRanges = function getAttrChangeRanges(doc, steps) {
   return steps.map(function (step) {
-    if (step instanceof AttrStep && allowedAttrs.includes(step.attr) || step instanceof SetAttrsStep && _toConsumableArray(Object.keys(step.attrs)).some(function (v) {
+    if (step instanceof AttrStep && allowedAttrs.includes(step.attr) || step instanceof SetAttrsStep && step.attrs && _toConsumableArray(Object.keys(step.attrs)).some(function (v) {
       return allowedAttrs.includes(v);
     })) {
       var $pos = doc.resolve(step.pos);
@@ -23,4 +23,28 @@ export var getAttrChangeRanges = function getAttrChangeRanges(doc, steps) {
     }
     return undefined;
   }).filter(filterUndefined);
+};
+
+/**
+ * Check if the step was a valid attr change and affected the doc
+ *
+ * @param step Attr step to test
+ * @param beforeDoc Doc before the step
+ * @param afterDoc Doc after the step
+ * @returns Boolean if the change should show a decoration
+ */
+export var stepIsValidAttrChange = function stepIsValidAttrChange(step, beforeDoc, afterDoc) {
+  try {
+    if (step instanceof AttrStep || step instanceof SetAttrsStep) {
+      var attrStepAfter = afterDoc.nodeAt(step.pos);
+      var attrStepBefore = beforeDoc.nodeAt(step.pos);
+      // The change affected the document
+      if (attrStepAfter && attrStepBefore && !attrStepAfter.eq(attrStepBefore)) {
+        return true;
+      }
+    }
+    return false;
+  } catch (e) {
+    return false;
+  }
 };

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

@@ -10,11 +10,10 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import isEqual from 'lodash/isEqual';
 import memoizeOne from 'memoize-one';
 import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
-import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { areNodesEqualIgnoreAttrs } from '@atlaskit/editor-common/utils/document';
-import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { getAttrChangeRanges } from './attributeDecorations';
+import { getAttrChangeRanges, stepIsValidAttrChange } from './attributeDecorations';
 import { createInlineChangedDecoration, createDeletedContentDecoration, createBlockChangedDecoration } from './decorations';
 import { getMarkChangeRanges } from './markDecorations';
 var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration(doc, from, to, colourScheme) {
@@ -70,7 +69,7 @@ function simplifySteps(steps) {
   return steps
   // Remove steps that don't affect document structure or content
   .filter(function (step) {
-    return !(step instanceof AnalyticsStep || step instanceof AttrStep || step instanceof SetAttrsStep);
+    return !(step instanceof AnalyticsStep);
   })
   // Merge consecutive steps where possible
   .reduce(function (acc, step) {
@@ -99,7 +98,7 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   }
   var tr = state.tr;
   var steppedDoc = originalDoc;
-  var stepMaps = [];
+  var attrSteps = [];
   var changeset = ChangeSet.create(originalDoc);
   var _iterator = _createForOfIteratorHelper(steps),
     _step;
@@ -108,8 +107,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
       var step = _step.value;
       var result = step.apply(steppedDoc);
       if (result.failed === null && result.doc) {
+        if (stepIsValidAttrChange(step, steppedDoc, result.doc)) {
+          attrSteps.push(step);
+        }
         steppedDoc = result.doc;
-        stepMaps.push(step.getMap());
         changeset = changeset.addSteps(steppedDoc, [step.getMap()], step);
       }
     }
@@ -149,7 +150,7 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   getMarkChangeRanges(steps).forEach(function (change) {
     decorations.push(createInlineChangedDecoration(change, colourScheme));
   });
-  getAttrChangeRanges(tr.doc, rawSteps).forEach(function (change) {
+  getAttrChangeRanges(tr.doc, attrSteps).forEach(function (change) {
     decorations.push.apply(decorations, _toConsumableArray(calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme)));
   });
   return DecorationSet.empty.add(tr.doc, decorations);

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

@@ -5,4 +5,13 @@ type StepRange = {
     toB: number;
 };
 export declare const getAttrChangeRanges: (doc: PMNode, steps: ProseMirrorStep[]) => StepRange[];
+/**
+ * Check if the step was a valid attr change and affected the doc
+ *
+ * @param step Attr step to test
+ * @param beforeDoc Doc before the step
+ * @param afterDoc Doc after the step
+ * @returns Boolean if the change should show a decoration
+ */
+export declare const stepIsValidAttrChange: (step: ProseMirrorStep, beforeDoc: PMNode, afterDoc: PMNode) => boolean;
 export {};

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

@@ -5,4 +5,13 @@ type StepRange = {
     toB: number;
 };
 export declare const getAttrChangeRanges: (doc: PMNode, steps: ProseMirrorStep[]) => StepRange[];
+/**
+ * Check if the step was a valid attr change and affected the doc
+ *
+ * @param step Attr step to test
+ * @param beforeDoc Doc before the step
+ * @param afterDoc Doc after the step
+ * @returns Boolean if the change should show a decoration
+ */
+export declare const stepIsValidAttrChange: (step: ProseMirrorStep, beforeDoc: PMNode, afterDoc: PMNode) => boolean;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "3.2.1",
+	"version": "3.2.3",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,14 +32,14 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tokens": "^7.1.0",
+		"@atlaskit/tokens": "^8.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21",
 		"memoize-one": "^6.0.0",
 		"prosemirror-changeset": "^2.2.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.21.0",
+		"@atlaskit/editor-common": "^110.24.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {