@atlaskit/editor-plugin-show-diff 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 0.1.2
+
+### Patch Changes
+
+- [`7fe4c9e51271d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7fe4c9e51271d) -
+  Fix initial show diff after performance fix.
+- [`b2d53a70dbaa5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b2d53a70dbaa5) -
+  Improve show diff performance by storing decorations in state.
+- Updated dependencies
+
+## 0.1.1
+
+### Patch Changes
+
+- [`941fdc429d140`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/941fdc429d140) -
+  Show formatting changes in the diff
+- Updated dependencies
+
 ## 0.1.0
 
 ### Minor Changes

package/afm-passionfruit/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"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-volt/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"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"
+		}
+	]
+}

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

@@ -13,6 +13,7 @@ var _state = require("@atlaskit/editor-prosemirror/state");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _view = require("@atlaskit/editor-prosemirror/view");
 var _decorations = require("./decorations");
+var _markDecorations = require("./markDecorations");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 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; } } }; }
@@ -23,7 +24,7 @@ var calculateDecorations = function calculateDecorations(_ref) {
     pluginState = _ref.pluginState;
   var originalDoc = pluginState.originalDoc,
     steps = pluginState.steps;
-  if (!originalDoc) {
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
     return _view.DecorationSet.empty;
   }
   var tr = state.tr;
@@ -62,6 +63,9 @@ var calculateDecorations = function calculateDecorations(_ref) {
       }));
     }
   });
+  (0, _markDecorations.getMarkChangeRanges)(steps).forEach(function (change) {
+    decorations.push((0, _decorations.createInlineChangedDecoration)(change));
+  });
   return _view.DecorationSet.empty.add(tr.doc, decorations);
 };
 var showDiffPluginKey = exports.showDiffPluginKey = new _state.PluginKey('showDiffPlugin');
@@ -70,20 +74,24 @@ var createPlugin = exports.createPlugin = function createPlugin(config) {
     key: showDiffPluginKey,
     state: {
       init: function init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         var schema = state.schema;
+        var isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
+        var steps = ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(function (step) {
+          return _transform.Step.fromJSON(schema, step);
+        });
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(function (step) {
-            return _transform.Step.fromJSON(schema, step);
-          }),
+          steps: steps,
           originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined,
           decorations: calculateDecorations({
             state: state,
             pluginState: {
-              steps: [],
-              originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined
+              steps: steps,
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges: isDisplayingChanges
             }
-          })
+          }),
+          isDisplayingChanges: isDisplayingChanges
         };
       },
       apply: function apply(tr, currentPluginState, oldState, newState) {
@@ -91,28 +99,30 @@ var createPlugin = exports.createPlugin = function createPlugin(config) {
         var newPluginState = currentPluginState;
         if (meta) {
           if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            // Calculate and store decorations in state
+            var decorations = calculateDecorations({
+              state: newState,
+              pluginState: {
+                steps: meta.steps,
+                originalDoc: meta.originalDoc,
+                isDisplayingChanges: true
+              }
+            });
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              decorations: decorations,
               isDisplayingChanges: true
             });
           } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              decorations: _view.DecorationSet.empty,
               isDisplayingChanges: false
             });
           } else {
             newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);
           }
         }
-
-        // Calculate and store decorations in state
-        var decorations = calculateDecorations({
-          state: newState,
-          pluginState: {
-            steps: newPluginState.steps,
-            originalDoc: newPluginState.originalDoc
-          }
-        });
         return _objectSpread(_objectSpread({}, newPluginState), {}, {
-          decorations: decorations
+          decorations: newPluginState.decorations.map(tr.mapping, tr.doc)
         });
       }
     },

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

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getMarkChangeRanges = void 0;
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+var getMarkChangeRanges = exports.getMarkChangeRanges = function getMarkChangeRanges(steps) {
+  return steps.map(function (step) {
+    if (step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -6,6 +6,7 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
+import { getMarkChangeRanges } from './markDecorations';
 const calculateDecorations = ({
   state,
   pluginState
@@ -14,7 +15,7 @@ const calculateDecorations = ({
     originalDoc,
     steps
   } = pluginState;
-  if (!originalDoc) {
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
     return DecorationSet.empty;
   }
   const {
@@ -46,6 +47,9 @@ const calculateDecorations = ({
       }));
     }
   });
+  getMarkChangeRanges(steps).forEach(change => {
+    decorations.push(createInlineChangedDecoration(change));
+  });
   return DecorationSet.empty.add(tr.doc, decorations);
 };
 export const showDiffPluginKey = new PluginKey('showDiffPlugin');
@@ -54,18 +58,22 @@ export const createPlugin = config => {
     key: showDiffPluginKey,
     state: {
       init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         const schema = state.schema;
+        const isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
+        const steps = ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(step => ProseMirrorStep.fromJSON(schema, step));
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(step => ProseMirrorStep.fromJSON(schema, step)),
+          steps,
           originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
           decorations: calculateDecorations({
             state,
             pluginState: {
-              steps: [],
-              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined
+              steps,
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges
             }
-          })
+          }),
+          isDisplayingChanges
         };
       },
       apply: (tr, currentPluginState, oldState, newState) => {
@@ -73,15 +81,26 @@ export const createPlugin = config => {
         let newPluginState = currentPluginState;
         if (meta) {
           if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            // Calculate and store decorations in state
+            const decorations = calculateDecorations({
+              state: newState,
+              pluginState: {
+                steps: meta.steps,
+                originalDoc: meta.originalDoc,
+                isDisplayingChanges: true
+              }
+            });
             newPluginState = {
               ...currentPluginState,
               ...meta,
+              decorations,
               isDisplayingChanges: true
             };
           } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
             newPluginState = {
               ...currentPluginState,
               ...meta,
+              decorations: DecorationSet.empty,
               isDisplayingChanges: false
             };
           } else {
@@ -91,18 +110,9 @@ export const createPlugin = config => {
             };
           }
         }
-
-        // Calculate and store decorations in state
-        const decorations = calculateDecorations({
-          state: newState,
-          pluginState: {
-            steps: newPluginState.steps,
-            originalDoc: newPluginState.originalDoc
-          }
-        });
         return {
           ...newPluginState,
-          decorations
+          decorations: newPluginState.decorations.map(tr.mapping, tr.doc)
         };
       }
     },

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

@@ -0,0 +1,13 @@
+import { AddMarkStep, RemoveMarkStep } from '@atlaskit/editor-prosemirror/transform';
+const filterUndefined = x => !!x;
+export const getMarkChangeRanges = steps => {
+  return steps.map(step => {
+    if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -12,12 +12,13 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
+import { getMarkChangeRanges } from './markDecorations';
 var calculateDecorations = function calculateDecorations(_ref) {
   var state = _ref.state,
     pluginState = _ref.pluginState;
   var originalDoc = pluginState.originalDoc,
     steps = pluginState.steps;
-  if (!originalDoc) {
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
     return DecorationSet.empty;
   }
   var tr = state.tr;
@@ -56,6 +57,9 @@ var calculateDecorations = function calculateDecorations(_ref) {
       }));
     }
   });
+  getMarkChangeRanges(steps).forEach(function (change) {
+    decorations.push(createInlineChangedDecoration(change));
+  });
   return DecorationSet.empty.add(tr.doc, decorations);
 };
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
@@ -64,20 +68,24 @@ export var createPlugin = function createPlugin(config) {
     key: showDiffPluginKey,
     state: {
       init: function init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         var schema = state.schema;
+        var isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
+        var steps = ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(function (step) {
+          return ProseMirrorStep.fromJSON(schema, step);
+        });
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(function (step) {
-            return ProseMirrorStep.fromJSON(schema, step);
-          }),
+          steps: steps,
           originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
           decorations: calculateDecorations({
             state: state,
             pluginState: {
-              steps: [],
-              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined
+              steps: steps,
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges: isDisplayingChanges
             }
-          })
+          }),
+          isDisplayingChanges: isDisplayingChanges
         };
       },
       apply: function apply(tr, currentPluginState, oldState, newState) {
@@ -85,28 +93,30 @@ export var createPlugin = function createPlugin(config) {
         var newPluginState = currentPluginState;
         if (meta) {
           if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            // Calculate and store decorations in state
+            var decorations = calculateDecorations({
+              state: newState,
+              pluginState: {
+                steps: meta.steps,
+                originalDoc: meta.originalDoc,
+                isDisplayingChanges: true
+              }
+            });
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              decorations: decorations,
               isDisplayingChanges: true
             });
           } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              decorations: DecorationSet.empty,
               isDisplayingChanges: false
             });
           } else {
             newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);
           }
         }
-
-        // Calculate and store decorations in state
-        var decorations = calculateDecorations({
-          state: newState,
-          pluginState: {
-            steps: newPluginState.steps,
-            originalDoc: newPluginState.originalDoc
-          }
-        });
         return _objectSpread(_objectSpread({}, newPluginState), {}, {
-          decorations: decorations
+          decorations: newPluginState.decorations.map(tr.mapping, tr.doc)
         });
       }
     },

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

@@ -0,0 +1,15 @@
+import { AddMarkStep, RemoveMarkStep } from '@atlaskit/editor-prosemirror/transform';
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+export var getMarkChangeRanges = function getMarkChangeRanges(steps) {
+  return steps.map(function (step) {
+    if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

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

@@ -8,7 +8,10 @@ import { Decoration } from '@atlaskit/editor-prosemirror/view';
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: (change: Change) => Decoration;
+export declare const createInlineChangedDecoration: (change: {
+    fromB: number;
+    toB: number;
+}) => Decoration;
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;

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

@@ -9,6 +9,7 @@ type ShowDiffPluginState = {
     steps: ProseMirrorStep[];
     originalDoc: PMNode | undefined;
     decorations: DecorationSet;
+    isDisplayingChanges: boolean;
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

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

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

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

@@ -8,7 +8,10 @@ import { Decoration } from '@atlaskit/editor-prosemirror/view';
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: (change: Change) => Decoration;
+export declare const createInlineChangedDecoration: (change: {
+    fromB: number;
+    toB: number;
+}) => Decoration;
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;

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

@@ -9,6 +9,7 @@ type ShowDiffPluginState = {
     steps: ProseMirrorStep[];
     originalDoc: PMNode | undefined;
     decorations: DecorationSet;
+    isDisplayingChanges: boolean;
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,7 +37,7 @@
 		"prosemirror-changeset": "^2.2.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.20.0",
+		"@atlaskit/editor-common": "^107.23.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {