@atlaskit/editor-plugin-show-diff 12.0.3 → 12.1.1

package/dist/esm/pm-plugins/decorations/utils/getAttrChangeRanges.js

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _defineProperty(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; }
 import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { isExperimentEnabled } from '@atlaskit/editor-common/deprecated-platform-feature-experiments';
 import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 var filterUndefined = function filterUndefined(x) {
@@ -63,7 +64,9 @@ export var getAttrChangeRanges = function getAttrChangeRanges(doc, steps, origin
     // date node: timestamp attribute change — highlight the date node itself (inline)
     if (stepAttrs.some(function (v) {
       return dateAttrs.includes(v);
-    }) && (nodeAtPos === null || nodeAtPos === void 0 ? void 0 : nodeAtPos.type.name) === 'date' && !expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true)) {
+    }) && (nodeAtPos === null || nodeAtPos === void 0 ? void 0 : nodeAtPos.type.name) === 'date' && !isExperimentEnabled('platform_editor_improve_inline_diffs', function () {
+      return expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true);
+    })) {
       return {
         fromB: step.pos,
         toB: step.pos + nodeAtPos.nodeSize,
@@ -75,7 +78,9 @@ export var getAttrChangeRanges = function getAttrChangeRanges(doc, steps, origin
     // The following inline node attr changes are gated behind platform_editor_improve_inline_diffs.
     // The changeset path (createDecorationsForChange) handles the deletion widget via
     // prosemirror-changeset; we only need to add the inline insertion highlight here.
-    if (expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true) && nodeAtPos) {
+    if (isExperimentEnabled('platform_editor_improve_inline_diffs', function () {
+      return expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true);
+    }) && nodeAtPos) {
       var nodeName = nodeAtPos.type.name;
       if (isInlineAttrChangeNodeName(nodeName)) {
         var watchedAttrs = inlineNodeAttrMap[nodeName];
@@ -136,7 +141,9 @@ export var getAttrChangeRanges = function getAttrChangeRanges(doc, steps, origin
   // Gated behind the same experiment as the inline node attr changes that introduced
   // the possibility of multiple ranges for the same node position.
   .filter(function (range, i, arr) {
-    return !expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true) || arr.findIndex(function (r) {
+    return !isExperimentEnabled('platform_editor_improve_inline_diffs', function () {
+      return expValEquals('platform_editor_improve_inline_diffs', 'isEnabled', true);
+    }) || arr.findIndex(function (r) {
       return r.fromB === range.fromB;
     }) === i;
   });

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

@@ -0,0 +1,43 @@
+import { isDiffDecorationSpec } from './decorations/decorationKeys';
+import { showDiffPluginKey } from './main';
+
+// prosemirror-view does not type `Decoration.type`; a widget's `type.toDOM` is the node passed to
+// `Decoration.widget()` (an element or a factory — the `WidgetConstructor` union).
+
+// The element a deleted-content widget renders, or undefined if it renders via a factory.
+var getWidgetElement = function getWidgetElement(decoration) {
+  var _type;
+  var _ref = (_type = decoration.type) !== null && _type !== void 0 ? _type : {},
+    toDOM = _ref.toDOM;
+  return toDOM instanceof HTMLElement ? toDOM : undefined;
+};
+
+/**
+ * The rendered deleted-content widgets in `editorState`, optionally restricted to `[from, to]`,
+ * ordered by position. Deleted content is rendered as widget decorations rather than document
+ * nodes, so this is how the element and the position it is anchored at are recovered.
+ *
+ * Kept internal and surfaced only through the `getDeletedWidgets` plugin action, so consumers never
+ * receive the plugin key or the decoration set (which would let them mutate plugin behaviour).
+ */
+export var getDeletedWidgets = function getDeletedWidgets(editorState, range) {
+  var _showDiffPluginKey$ge;
+  var decorations = (_showDiffPluginKey$ge = showDiffPluginKey.getState(editorState)) === null || _showDiffPluginKey$ge === void 0 ? void 0 : _showDiffPluginKey$ge.decorations;
+  if (!decorations) {
+    return [];
+  }
+  return decorations.find(range === null || range === void 0 ? void 0 : range.from, range === null || range === void 0 ? void 0 : range.to, function (spec) {
+    return isDiffDecorationSpec(spec) && spec.decorationType === 'widget';
+  }).reduce(function (widgets, decoration) {
+    var element = getWidgetElement(decoration);
+    if (element) {
+      widgets.push({
+        element: element,
+        position: decoration.from
+      });
+    }
+    return widgets;
+  }, []).sort(function (a, b) {
+    return a.position - b.position;
+  });
+};

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

@@ -14,7 +14,7 @@ import { isExtendedEnabled } from './isExtendedEnabled';
 import { NodeViewSerializer } from './NodeViewSerializer';
 import { scrollToActiveDecoration, scrollToFirstDecoration } from './scrollToDiff';
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
-export var createPlugin = function createPlugin(config, getIntl, api) {
+export var createPlugin = function createPlugin(config, getIntl, api, onEditorView) {
   enforceCustomStepRegisters();
   var nodeViewSerializer = new NodeViewSerializer({});
   var setNodeViewSerializer = function setNodeViewSerializer(editorView) {
@@ -155,6 +155,7 @@ export var createPlugin = function createPlugin(config, getIntl, api) {
     },
     view: function view(editorView) {
       setNodeViewSerializer(editorView);
+      onEditorView === null || onEditorView === void 0 || onEditorView(editorView);
       var isFirst = true;
       var previousActiveIndex;
       var cancelPendingScrollToDecoration = null;
@@ -207,6 +208,7 @@ export var createPlugin = function createPlugin(config, getIntl, api) {
           var _cancelPendingScrollT3;
           (_cancelPendingScrollT3 = cancelPendingScrollToDecoration) === null || _cancelPendingScrollT3 === void 0 || _cancelPendingScrollT3();
           cancelPendingScrollToDecoration = null;
+          onEditorView === null || onEditorView === void 0 || onEditorView(undefined);
         }
       };
     },

package/dist/esm/showDiffPlugin.js

@@ -3,14 +3,26 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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) { _defineProperty(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; }
 import React from 'react';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { getDeletedWidgets as _getDeletedWidgets } from './pm-plugins/getDeletedWidgets';
 import { getScrollableDecorations } from './pm-plugins/getScrollableDecorations';
 import { createPlugin, showDiffPluginKey } from './pm-plugins/main';
 import { IndicatorBarContentComponent } from './ui/IndicatorBar/IndicatorBarContentComponent';
 export var showDiffPlugin = function showDiffPlugin(_ref) {
   var api = _ref.api,
     config = _ref.config;
+  // Captured from the plugin's view lifecycle (see `createPlugin`) so read-only actions can access
+  // the current state without exposing the plugin key to consumers.
+  var editorView;
+  var setEditorView = function setEditorView(view) {
+    editorView = view;
+  };
   return {
     name: 'showDiff',
+    actions: {
+      getDeletedWidgets: function getDeletedWidgets(range) {
+        return editorView ? _getDeletedWidgets(editorView.state, range) : [];
+      }
+    },
     commands: {
       showDiff: function showDiff(params) {
         return function (_ref2) {
@@ -57,7 +69,7 @@ export var showDiffPlugin = function showDiffPlugin(_ref) {
         name: 'showDiffPlugin',
         plugin: function plugin(_ref6) {
           var getIntl = _ref6.getIntl;
-          return createPlugin(config, getIntl, api);
+          return createPlugin(config, getIntl, api, setEditorView);
         }
       }];
     },

package/dist/types/entry-points/show-diff-plugin-type.d.ts

@@ -1 +1 @@
-export type { DeletedDiffPlacement, DiffParams, DiffType, PMDiffParams, ShowDiffPlugin, SmartDiffThresholds, } from '../showDiffPluginType';
+export type { DeletedDiffPlacement, DeletedDiffWidget, DiffParams, DiffType, PMDiffParams, ShowDiffPlugin, SmartDiffThresholds, } from '../showDiffPluginType';

package/dist/types/pm-plugins/calculateDiff/calculateDiffDecorations.d.ts

@@ -1,4 +1,5 @@
 import { type MemoizedFn } from 'memoize-one';
+import { type Change } from 'prosemirror-changeset';
 import type { IntlShape } from 'react-intl';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
@@ -10,6 +11,22 @@ type CalculatedDiffs = {
     decorations: DecorationSet;
     diffDescriptors: DiffDescriptor[];
 };
+/**
+ * Whether deleted content for `change` renders after the new content instead of before it.
+ *
+ * show-diff splits this across two options by change granularity, so the level decides which one
+ * applies:
+ * - node/paragraph-level: `deletedDiffPlacement` (default `'top'`). Pure deletions are promoted to
+ *   node level, so they are governed here too.
+ * - inline/sentence-level: `inlineDeletedDiffPlacement` (default `'before'`).
+ *
+ * Callers are responsible for the `smart` diffType and gate checks.
+ */
+export declare const isDeletedContentPlacedBelow: ({ change, deletedDiffPlacement, inlineDeletedDiffPlacement, }: {
+    change: Change;
+    deletedDiffPlacement?: DeletedDiffPlacement;
+    inlineDeletedDiffPlacement?: InlineDeletedDiffPlacement;
+}) => boolean;
 export declare const calculateDiffDecorations: MemoizedFn<({ state, pluginState, nodeViewSerializer, colorScheme, intl, activeIndexPos, api, hideDeletedDiffs, hideAddedDiffsUnderline, showIndicators, }: {
     activeIndexPos?: {
         from: number;

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

@@ -8,7 +8,7 @@ import type { InlineAttrChangeNodeName } from './utils/getAttrChangeRanges';
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: ({ change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, }: {
+export declare const createInlineChangedDecoration: ({ change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, isDeletedWidgetBelow, }: {
     change: {
         fromB: number;
         toB: number;
@@ -21,6 +21,7 @@ export declare const createInlineChangedDecoration: ({ change, colorScheme, isAc
     inlineNodeName?: InlineAttrChangeNodeName;
     isActive?: boolean;
     isAtomicInlineNode?: boolean;
+    isDeletedWidgetBelow?: boolean;
     isInserted?: boolean;
     shouldHideDeleted?: boolean;
     showIndicators?: boolean;

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

@@ -0,0 +1,14 @@
+import type { EditorState } from 'prosemirror-state';
+import type { DeletedDiffWidget } from '../showDiffPluginType';
+/**
+ * The rendered deleted-content widgets in `editorState`, optionally restricted to `[from, to]`,
+ * ordered by position. Deleted content is rendered as widget decorations rather than document
+ * nodes, so this is how the element and the position it is anchored at are recovered.
+ *
+ * Kept internal and surfaced only through the `getDeletedWidgets` plugin action, so consumers never
+ * receive the plugin key or the decoration set (which would let them mutate plugin behaviour).
+ */
+export declare const getDeletedWidgets: (editorState: EditorState, range?: {
+    from: number;
+    to: number;
+}) => DeletedDiffWidget[];

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

@@ -4,6 +4,7 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { DeletedDiffPlacement, DiffDescriptor, DiffParams, DiffType, InlineDeletedDiffPlacement, ShowDiffPlugin, SmartDiffThresholds } from '../showDiffPluginType';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
@@ -49,4 +50,4 @@ export type ShowDiffPluginState = {
     smartThresholds?: Partial<SmartDiffThresholds>;
     steps: ProseMirrorStep[];
 };
-export declare const createPlugin: (config: DiffParams | undefined, getIntl: () => IntlShape, api: ExtractInjectionAPI<ShowDiffPlugin> | undefined) => SafePlugin<ShowDiffPluginState>;
+export declare const createPlugin: (config: DiffParams | undefined, getIntl: () => IntlShape, api: ExtractInjectionAPI<ShowDiffPlugin> | undefined, onEditorView?: (editorView: EditorView | undefined) => void) => SafePlugin<ShowDiffPluginState>;

package/dist/types/showDiffPluginType.d.ts

@@ -23,6 +23,17 @@ export type DeletedDiffPlacement = 'top' | 'bottom';
  * - `'after'`: the deleted content is anchored after the new content.
  */
 export type InlineDeletedDiffPlacement = 'before' | 'after';
+/**
+ * A rendered deleted-content widget: the DOM element show-diff renders for a piece of deleted
+ * content, together with the document position it is anchored at. Deleted content is rendered as
+ * widget decorations rather than document nodes, so this is how consumers recover the element and
+ * its position — via the `getDeletedWidgets` action — without reaching into the plugin's internal
+ * state.
+ */
+export type DeletedDiffWidget = {
+    element: HTMLElement;
+    position: number;
+};
 export type SmartDiffThresholds = SmartDiffThresholdsInternal;
 export type DiffDescriptor = {
     id: string;
@@ -86,6 +97,18 @@ export type PMDiffParams = {
 };
 export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF' | 'SCROLL_TO_NEXT' | 'SCROLL_TO_PREVIOUS';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
+    actions: {
+        /**
+         * The rendered deleted-content widgets currently displayed, optionally restricted to a
+         * document range, ordered by position. This is the safe, read-only way to recover deleted
+         * content's element and position (e.g. to position UI relative to it) without access to the
+         * plugin's internal decoration set. Returns an empty array when no diff is displayed.
+         */
+        getDeletedWidgets: (range?: {
+            from: number;
+            to: number;
+        }) => DeletedDiffWidget[];
+    };
     commands: {
         hideDiff: EditorCommand;
         scrollToNext: EditorCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "12.0.3",
+	"version": "12.1.1",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,15 +20,15 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^56.6.0",
+		"@atlaskit/adf-schema": "^56.7.0",
 		"@atlaskit/custom-steps": "^1.0.0",
 		"@atlaskit/editor-plugin-analytics": "^14.0.0",
 		"@atlaskit/editor-plugin-user-intent": "^12.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-tables": "^3.0.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
-		"@atlaskit/tmp-editor-statsig": "^145.0.0",
-		"@atlaskit/tokens": "^16.5.0",
+		"@atlaskit/tmp-editor-statsig": "^146.0.0",
+		"@atlaskit/tokens": "^16.6.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.0",
 		"lodash": "^4.17.21",
@@ -42,10 +42,10 @@
 		"@atlaskit/dropdown-menu": "^18.0.0",
 		"@atlaskit/editor-core": "^223.0.0",
 		"@atlaskit/editor-json-transformer": "^9.2.0",
-		"@atlaskit/form": "^16.1.0",
+		"@atlaskit/form": "^17.0.0",
 		"@atlaskit/primitives": "^22.2.0",
 		"@atlaskit/section-message": "^10.0.0",
-		"@atlaskit/textarea": "^9.1.0",
+		"@atlaskit/textarea": "^10.0.0",
 		"@atlassian/confluence-presets": "workspace:^",
 		"@atlassian/content-reconciliation": "^0.1.3506",
 		"@atlassian/structured-docs-types": "workspace:^",
@@ -53,7 +53,7 @@
 		"react-intl": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^118.2.0",
+		"@atlaskit/editor-common": "^118.5.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"techstack": {