@atlaskit/editor-plugin-show-diff 3.1.4 → 3.1.5

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 3.1.5
+
+### Patch Changes
+
+- [`7c8492867be97`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7c8492867be97) -
+  [ux] Add support for media attribute changes in the diff
+
 ## 3.1.4
 
 ### Patch Changes

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

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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");
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+
+// Currently allow attributes that indicats a change in media image
+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) {
+      return allowedAttrs.includes(v);
+    })) {
+      var $pos = doc.resolve(step.pos);
+      if ($pos.parent.type === doc.type.schema.nodes.mediaSingle) {
+        var startPos = $pos.pos + $pos.parentOffset;
+        return {
+          fromB: startPos,
+          toB: startPos + $pos.parent.nodeSize - 1
+        };
+      }
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -15,6 +15,7 @@ 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");
 var _markDecorations = require("./markDecorations");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
@@ -151,6 +152,9 @@ 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) {
+    decorations.push.apply(decorations, (0, _toConsumableArray2.default)(calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme)));
+  });
   return _view.DecorationSet.empty.add(tr.doc, decorations);
 };
 var calculateDiffDecorations = exports.calculateDiffDecorations = (0, _memoizeOne.default)(calculateDiffDecorationsInner,

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

@@ -0,0 +1,21 @@
+import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
+const filterUndefined = x => !!x;
+
+// Currently allow attributes that indicats a change in media image
+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))) {
+      const $pos = doc.resolve(step.pos);
+      if ($pos.parent.type === doc.type.schema.nodes.mediaSingle) {
+        const startPos = $pos.pos + $pos.parentOffset;
+        return {
+          fromB: startPos,
+          toB: startPos + $pos.parent.nodeSize - 1
+        };
+      }
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -6,6 +6,7 @@ import { AnalyticsStep, SetAttrsStep } 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 { createInlineChangedDecoration, createDeletedContentDecoration, createBlockChangedDecoration } from './decorations';
 import { getMarkChangeRanges } from './markDecorations';
 const calculateNodesForBlockDecoration = (doc, from, to, colourScheme) => {
@@ -135,6 +136,9 @@ const calculateDiffDecorationsInner = ({
   getMarkChangeRanges(steps).forEach(change => {
     decorations.push(createInlineChangedDecoration(change, colourScheme));
   });
+  getAttrChangeRanges(tr.doc, rawSteps).forEach(change => {
+    decorations.push(...calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme));
+  });
   return DecorationSet.empty.add(tr.doc, decorations);
 };
 export const calculateDiffDecorations = memoizeOne(calculateDiffDecorationsInner,

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

@@ -0,0 +1,26 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+
+// Currently allow attributes that indicats a change in media image
+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) {
+      return allowedAttrs.includes(v);
+    })) {
+      var $pos = doc.resolve(step.pos);
+      if ($pos.parent.type === doc.type.schema.nodes.mediaSingle) {
+        var startPos = $pos.pos + $pos.parentOffset;
+        return {
+          fromB: startPos,
+          toB: startPos + $pos.parent.nodeSize - 1
+        };
+      }
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -14,6 +14,7 @@ import { AnalyticsStep, SetAttrsStep } 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 { createInlineChangedDecoration, createDeletedContentDecoration, createBlockChangedDecoration } from './decorations';
 import { getMarkChangeRanges } from './markDecorations';
 var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration(doc, from, to, colourScheme) {
@@ -145,6 +146,9 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   getMarkChangeRanges(steps).forEach(function (change) {
     decorations.push(createInlineChangedDecoration(change, colourScheme));
   });
+  getAttrChangeRanges(tr.doc, rawSteps).forEach(function (change) {
+    decorations.push.apply(decorations, _toConsumableArray(calculateNodesForBlockDecoration(tr.doc, change.fromB, change.toB, colourScheme)));
+  });
   return DecorationSet.empty.add(tr.doc, decorations);
 };
 export var calculateDiffDecorations = memoizeOne(calculateDiffDecorationsInner,

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

@@ -0,0 +1,8 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { type Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+type StepRange = {
+    fromB: number;
+    toB: number;
+};
+export declare const getAttrChangeRanges: (doc: PMNode, steps: ProseMirrorStep[]) => StepRange[];
+export {};

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

@@ -0,0 +1,8 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { type Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+type StepRange = {
+    fromB: number;
+    toB: number;
+};
+export declare const getAttrChangeRanges: (doc: PMNode, steps: ProseMirrorStep[]) => StepRange[];
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "3.1.4",
+	"version": "3.1.5",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/afm-dev-agents/tsconfig.json

@@ -1,27 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__editor-plugin-show-diff/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/tokens/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-dev-agents/tsconfig.json"
-		}
-	]
-}

package/afm-passionfruit/tsconfig.json

@@ -1,27 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__editor-plugin-show-diff/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/tokens/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-passionfruit/tsconfig.json"
-		}
-	]
-}

package/afm-rovo-extension/tsconfig.json

@@ -1,27 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.rovo-extension.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../rovo-extension/tsDist/@atlaskit__editor-plugin-show-diff/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/tokens/afm-rovo-extension/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-rovo-extension/tsconfig.json"
-		}
-	]
-}

package/afm-volt/tsconfig.json

@@ -1,27 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.volt.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../volt/tsDist/@atlaskit__editor-plugin-show-diff/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/tokens/afm-volt/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-volt/tsconfig.json"
-		}
-	]
-}