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

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

@@ -1,5 +1,7 @@
 import { convertToInlineCss } from '@atlaskit/editor-common/lazy-node-view';
+import { trackChangesMessages } from '@atlaskit/editor-common/messages';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { findSafeInsertPos } from './findSafeInsertPos';
 const editingStyle = convertToInlineCss({
   background: "var(--ds-background-accent-purple-subtlest, #F3F0FF)",
@@ -68,6 +70,59 @@ const getEditorStyleNode = (nodeName, colourScheme) => {
       return colourScheme === 'traditional' ? traditionalStyleNode : editingStyleNode;
   }
 };
+const getDeletedStyleNode = nodeName => {
+  switch (nodeName) {
+    case 'blockquote':
+      return deletedStyleQuoteNode;
+    case 'expand':
+    case 'decisionList':
+      return deletedBlockOutline;
+    case 'panel':
+    case 'codeBlock':
+      return deletedBlockOutlineRounded;
+    default:
+      return undefined;
+  }
+};
+const shouldShowRemovedLozenge = nodeName => {
+  switch (nodeName) {
+    case 'expand':
+    case 'codeBlock':
+    case 'mediaSingle':
+    case 'panel':
+    case 'decisionList':
+      return true;
+    default:
+      return false;
+  }
+};
+const shouldFitContentWidth = nodeName => {
+  switch (nodeName) {
+    case 'mediaSingle':
+    case 'embedCard':
+    case 'blockCard':
+      return true;
+    default:
+      return false;
+  }
+};
+const shouldAddShowDiffDeletedNodeClass = nodeName => {
+  switch (nodeName) {
+    case 'mediaSingle':
+    case 'embedCard':
+      return true;
+    default:
+      return false;
+  }
+};
+
+/**
+ * Checks if a node should apply deleted styles directly without wrapper
+ * to preserve natural block-level margins
+ */
+const shouldApplyDeletedStylesDirectly = nodeName => {
+  return nodeName === 'blockquote' || nodeName === 'heading';
+};
 const editingStyleQuoteNode = convertToInlineCss({
   borderLeft: `2px solid ${"var(--ds-border-accent-purple, #8270DB)"}`
 });
@@ -96,6 +151,18 @@ const traditionalStyleCardBlockNode = convertToInlineCss({
   boxShadow: `0 0 0 1px ${"var(--ds-border-accent-green, #22A06B)"}`,
   borderRadius: "var(--ds-radius-medium, 6px)"
 });
+const deletedStyleQuoteNode = convertToInlineCss({
+  borderLeft: `2px solid ${"var(--ds-border-accent-gray, #758195)"}`
+});
+const deletedBlockOutline = convertToInlineCss({
+  boxShadow: `0 0 0 1px ${"var(--ds-border-accent-gray, #758195)"}`,
+  borderRadius: "var(--ds-radius-small, 4px)"
+});
+const deletedBlockOutlineRounded = convertToInlineCss({
+  boxShadow: `0 0 0 1px ${"var(--ds-border-accent-gray, #758195)"}`,
+  borderRadius: `calc(${"var(--ds-radius-xsmall, 2px)"} + 1px)`
+});
+
 /**
  * Inline decoration used for insertions as the content already exists in the document
  *
@@ -136,14 +203,145 @@ const deletedTraditionalContentStyleUnbounded = convertToInlineCss({
   pointerEvents: 'none',
   zIndex: 1
 });
+const lozengeStyle = convertToInlineCss({
+  display: 'inline-flex',
+  boxSizing: 'border-box',
+  position: 'static',
+  blockSize: 'min-content',
+  borderRadius: "var(--ds-radius-small, 4px)",
+  overflow: 'hidden',
+  paddingInlineStart: "var(--ds-space-050, 4px)",
+  paddingInlineEnd: "var(--ds-space-050, 4px)",
+  backgroundColor: "var(--ds-background-accent-gray-subtler, #DCDFE4)",
+  font: "var(--ds-font-body-small, normal 400 11px/16px ui-sans-serif, -apple-system, BlinkMacSystemFont, \"Segoe UI\", Ubuntu, \"Helvetica Neue\", sans-serif)",
+  fontWeight: "var(--ds-font-weight-bold, 700)",
+  textOverflow: 'ellipsis',
+  whiteSpace: 'nowrap',
+  color: "var(--ds-text-warning-inverse, #172B4D)"
+});
 const getDeletedContentStyleUnbounded = colourScheme => colourScheme === 'traditional' ? deletedTraditionalContentStyleUnbounded : deletedContentStyleUnbounded;
 const getDeletedContentStyle = colourScheme => colourScheme === 'traditional' ? deletedTraditionalContentStyle : deletedContentStyle;
+
+/**
+ * Creates a "Removed" lozenge to be displayed at the top right corner of deleted block nodes
+ */
+const createRemovedLozenge = (intl, nodeName) => {
+  const container = document.createElement('span');
+  let borderTopRightRadius;
+  let borderTopLeftRadius;
+  if (['expand', 'decisionList'].includes(nodeName || '')) {
+    borderTopRightRadius = "var(--ds-radius-small, 4px)";
+  } else if (['panel', 'codeBlock'].includes(nodeName || '')) {
+    borderTopRightRadius = `calc(${"var(--ds-radius-xsmall, 2px)"} + 1px)`;
+  } else if (nodeName === 'mediaSingle') {
+    borderTopLeftRadius = "var(--ds-radius-small, 4px)";
+  }
+  const containerStyle = convertToInlineCss({
+    position: 'absolute',
+    top: nodeName === 'mediaSingle' ? "var(--ds-space-300, 24px)" : "var(--ds-space-0, 0px)",
+    right: nodeName === 'mediaSingle' ? undefined : "var(--ds-space-0, 0px)",
+    left: nodeName === 'mediaSingle' ? "var(--ds-space-0, 0px)" : undefined,
+    zIndex: 2,
+    pointerEvents: 'none',
+    display: 'flex',
+    overflow: 'hidden',
+    borderTopRightRadius,
+    borderTopLeftRadius
+  });
+  container.setAttribute('style', containerStyle);
+  container.setAttribute('data-testid', 'show-diff-removed-lozenge');
+
+  // Create vanilla HTML lozenge element with Atlaskit Lozenge styling (visual refresh)
+  const lozengeElement = document.createElement('span');
+  lozengeElement.setAttribute('style', lozengeStyle);
+  lozengeElement.textContent = intl.formatMessage(trackChangesMessages.removed).toUpperCase();
+  container.appendChild(lozengeElement);
+  return container;
+};
+
+/**
+ * Wraps a block node in a container with relative positioning to support absolute positioned lozenge
+ */
+const createBlockNodeWrapper = nodeName => {
+  const wrapper = document.createElement('div');
+  const fitContent = shouldFitContentWidth(nodeName);
+  const baseStyle = convertToInlineCss({
+    position: 'relative',
+    display: fitContent ? 'inline-block' : 'block',
+    width: fitContent ? 'fit-content' : undefined,
+    height: fitContent ? 'fit-content' : undefined,
+    opacity: 1
+  });
+  wrapper.setAttribute('style', baseStyle);
+  return wrapper;
+};
+
+/**
+ * Wraps content with deleted styling without opacity (for use when content is a direct child of dom)
+ */
+const createDeletedStyleWrapperWithoutOpacity = colourScheme => {
+  const wrapper = document.createElement('span');
+  wrapper.setAttribute('style', getDeletedContentStyle(colourScheme));
+  return wrapper;
+};
+
+/**
+ * Applies deleted styles directly to an HTML element by merging with existing styles
+ */
+const applyDeletedStylesToElement = (element, targetNode, colourScheme) => {
+  const currentStyle = element.getAttribute('style') || '';
+  const deletedContentStyle = getDeletedContentStyle(colourScheme);
+  const nodeSpecificStyle = getDeletedStyleNode(targetNode.type.name) || '';
+  element.setAttribute('style', `${currentStyle}${deletedContentStyle}${nodeSpecificStyle}`);
+};
+
+/**
+ * Appends a block node with wrapper, lozenge, and appropriate styling
+ */
+const appendBlockNodeWithWrapper = (dom, nodeView, targetNode, colourScheme, intl) => {
+  const blockWrapper = createBlockNodeWrapper(targetNode.type.name);
+  if (shouldShowRemovedLozenge(targetNode.type.name)) {
+    const lozenge = createRemovedLozenge(intl, targetNode.type.name);
+    blockWrapper.append(lozenge);
+  }
+
+  // Wrap the nodeView in a content wrapper that has the opacity style AND the box-shadow
+  // This keeps the lozenge at full opacity while the content AND border are faded
+  const contentWrapper = document.createElement('div');
+  const nodeStyle = getDeletedStyleNode(targetNode.type.name);
+  contentWrapper.setAttribute('style', `${getDeletedContentStyle(colourScheme)}${nodeStyle || ''}`);
+  contentWrapper.append(nodeView);
+  blockWrapper.append(contentWrapper);
+  if (nodeView instanceof HTMLElement) {
+    if (shouldAddShowDiffDeletedNodeClass(targetNode.type.name)) {
+      nodeView.classList.add('show-diff-deleted-node');
+    }
+  }
+  dom.append(blockWrapper);
+};
+
+/**
+ * Handles all block node rendering with appropriate deleted styling.
+ * For blockquote and heading nodes, applies styles directly to preserve natural margins.
+ * For other block nodes, uses wrapper approach with optional lozenge.
+ */
+const handleBlockNodeView = (dom, nodeView, targetNode, colourScheme, intl) => {
+  if (shouldApplyDeletedStylesDirectly(targetNode.type.name) && nodeView instanceof HTMLElement) {
+    // Apply deleted styles directly to preserve natural block-level margins
+    applyDeletedStylesToElement(nodeView, targetNode, colourScheme);
+    dom.append(nodeView);
+  } else {
+    // Use wrapper approach for other block nodes
+    appendBlockNodeWithWrapper(dom, nodeView, targetNode, colourScheme, intl);
+  }
+};
 export const createDeletedContentDecoration = ({
   change,
   doc,
   nodeViewSerializer,
   colourScheme,
-  newDoc
+  newDoc,
+  intl
 }) => {
   const slice = doc.slice(change.fromA, change.toA);
   if (slice.content.content.length === 0) {
@@ -157,7 +355,9 @@ export const createDeletedContentDecoration = ({
 
   // For non-table content, use the existing span wrapper approach
   const dom = document.createElement('span');
-  dom.setAttribute('style', getDeletedContentStyle(colourScheme));
+  if (!fg('platform_editor_ai_aifc_patch_beta_2')) {
+    dom.setAttribute('style', getDeletedContentStyle(colourScheme));
+  }
 
   /*
    * The thinking is we separate out the fragment we got from doc.slice
@@ -169,8 +369,11 @@ export const createDeletedContentDecoration = ({
     // Create a wrapper for each node with strikethrough
     const createWrapperWithStrikethrough = () => {
       const wrapper = document.createElement('span');
-      wrapper.style.position = 'relative';
-      wrapper.style.width = 'fit-content';
+      const baseStyle = convertToInlineCss({
+        position: 'relative',
+        width: 'fit-content'
+      });
+      wrapper.setAttribute('style', `${baseStyle}${getDeletedContentStyle(colourScheme)}`);
       const strikethrough = document.createElement('span');
       strikethrough.setAttribute('style', getDeletedContentStyleUnbounded(colourScheme));
       wrapper.append(strikethrough);
@@ -193,7 +396,13 @@ export const createDeletedContentDecoration = ({
             // Fallback to serializing the individual child node
             const serializedChild = serializer.serializeNode(childNode);
             if (serializedChild) {
-              dom.append(serializedChild);
+              if (fg('platform_editor_ai_aifc_patch_beta_2')) {
+                const wrapper = createWrapperWithStrikethrough();
+                wrapper.append(serializedChild);
+                dom.append(wrapper);
+              } else {
+                dom.append(serializedChild);
+              }
             }
           }
         });
@@ -245,6 +454,9 @@ export const createDeletedContentDecoration = ({
         const wrapper = createWrapperWithStrikethrough();
         wrapper.append(nodeView);
         dom.append(wrapper);
+      } else if (fg('platform_editor_ai_aifc_patch_beta_2')) {
+        // Handle all block nodes with unified function
+        handleBlockNodeView(dom, nodeView, targetNode, colourScheme, intl);
       } else {
         dom.append(nodeView);
       }
@@ -254,7 +466,13 @@ export const createDeletedContentDecoration = ({
     } else {
       const fallbackNode = fallbackSerialization();
       if (fallbackNode) {
-        dom.append(fallbackNode);
+        if (fg('platform_editor_ai_aifc_patch_beta_2')) {
+          const wrapper = createDeletedStyleWrapperWithoutOpacity(colourScheme);
+          wrapper.append(fallbackNode);
+          dom.append(wrapper);
+        } else {
+          dom.append(fallbackNode);
+        }
       }
     }
   });
@@ -263,5 +481,5 @@ export const createDeletedContentDecoration = ({
   // Widget decoration used for deletions as the content is not in the document
   // and we want to display the deleted content with a style.
   const safeInsertPos = findSafeInsertPos(newDoc, change.fromB, slice);
-  return Decoration.widget(safeInsertPos, dom, {});
+  return Decoration.widget(safeInsertPos, dom);
 };

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

@@ -6,7 +6,7 @@ import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { calculateDiffDecorations } from './calculateDiffDecorations';
 import { NodeViewSerializer } from './NodeViewSerializer';
 export const showDiffPluginKey = new PluginKey('showDiffPlugin');
-export const createPlugin = config => {
+export const createPlugin = (config, getIntl) => {
   const nodeViewSerializer = new NodeViewSerializer({});
   const setNodeViewSerializer = editorView => {
     nodeViewSerializer.init({
@@ -16,7 +16,7 @@ export const createPlugin = config => {
   return new SafePlugin({
     key: showDiffPluginKey,
     state: {
-      init(_, state) {
+      init(_, _state) {
         // We do initial setup after we setup the editor view
         return {
           steps: [],
@@ -41,7 +41,8 @@ export const createPlugin = config => {
               state: newState,
               pluginState: newPluginState,
               nodeViewSerializer,
-              colourScheme: config === null || config === void 0 ? void 0 : config.colourScheme
+              colourScheme: config === null || config === void 0 ? void 0 : config.colourScheme,
+              intl: getIntl()
             });
             // Update the decorations
             newPluginState.decorations = decorations;

package/dist/es2019/showDiffPlugin.js

@@ -1,6 +1,6 @@
 import { createPlugin, showDiffPluginKey } from './pm-plugins/main';
 export const showDiffPlugin = ({
-  api,
+  api: _api,
   config
 }) => ({
   name: 'showDiff',
@@ -25,7 +25,9 @@ export const showDiffPlugin = ({
   pmPlugins() {
     return [{
       name: 'showDiffPlugin',
-      plugin: () => createPlugin(config)
+      plugin: ({
+        getIntl
+      }) => createPlugin(config, getIntl)
     }];
   },
   getSharedState: editorState => {

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) {
@@ -88,7 +89,8 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
   var state = _ref.state,
     pluginState = _ref.pluginState,
     nodeViewSerializer = _ref.nodeViewSerializer,
-    colourScheme = _ref.colourScheme;
+    colourScheme = _ref.colourScheme,
+    intl = _ref.intl;
   var originalDoc = pluginState.originalDoc,
     rawSteps = pluginState.steps;
   var steps = simplifySteps(rawSteps);
@@ -135,7 +137,8 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref)
         doc: originalDoc,
         nodeViewSerializer: nodeViewSerializer,
         colourScheme: colourScheme,
-        newDoc: tr.doc
+        newDoc: tr.doc,
+        intl: intl
       });
       if (decoration) {
         decorations.push(decoration);
@@ -145,6 +148,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,
@@ -155,12 +161,14 @@ function (_ref2, _ref3) {
     _ref4$ = _ref4[0],
     pluginState = _ref4$.pluginState,
     state = _ref4$.state,
-    colourScheme = _ref4$.colourScheme;
+    colourScheme = _ref4$.colourScheme,
+    intl = _ref4$.intl;
   var _ref5 = _slicedToArray(_ref3, 1),
     _ref5$ = _ref5[0],
     lastPluginState = _ref5$.pluginState,
     lastState = _ref5$.state,
-    lastColourScheme = _ref5$.colourScheme;
+    lastColourScheme = _ref5$.colourScheme,
+    lastIntl = _ref5$.intl;
   var originalDocIsSame = lastPluginState.originalDoc && pluginState.originalDoc && pluginState.originalDoc.eq(lastPluginState.originalDoc);
-  return (_ref6 = originalDocIsSame && isEqual(pluginState.steps, lastPluginState.steps) && state.doc.eq(lastState.doc) && colourScheme === lastColourScheme) !== null && _ref6 !== void 0 ? _ref6 : false;
+  return (_ref6 = originalDocIsSame && isEqual(pluginState.steps, lastPluginState.steps) && state.doc.eq(lastState.doc) && colourScheme === lastColourScheme && intl.locale === lastIntl.locale) !== null && _ref6 !== void 0 ? _ref6 : false;
 });