@atlaskit/editor-plugin-show-diff 15.0.0 → 15.1.1

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

@@ -2,6 +2,7 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { DiffType } from '../../showDiffPluginType';
 import type { ColorScheme } from './colorSchemes/types';
+import { type ContributorTagMountContext } from './createContributorTagWidget';
 /**
  * Node decoration used for block-level insertions. When isActive, uses emphasised (pressed) styling.
  *
@@ -10,7 +11,8 @@ import type { ColorScheme } from './colorSchemes/types';
  * @param isActive Whether this node is part of the currently active/focused change
  * @returns Prosemirror node decoration or undefined
  */
-export declare const createBlockChangedDecoration: ({ change, colorScheme, isInserted, isActive, shouldHideDeleted, showIndicators, doc, diffType, }: {
+export declare const createBlockChangedDecoration: ({ attributionKey, change, colorScheme, isInserted, isActive, shouldHideDeleted, showContributorTags, showIndicators, doc, diffType, tagMountContext, }: {
+    attributionKey?: string;
     change: {
         from: number;
         name: string;
@@ -22,5 +24,7 @@ export declare const createBlockChangedDecoration: ({ change, colorScheme, isIns
     isActive?: boolean;
     isInserted?: boolean;
     shouldHideDeleted?: boolean;
+    showContributorTags?: boolean;
     showIndicators?: boolean;
+    tagMountContext?: ContributorTagMountContext;
 }) => Decoration[];

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

@@ -42,13 +42,19 @@ export declare const createContributorTagHost: (diffId: string, mountContext?: C
     mount: ContributorTagMount | undefined;
 } | undefined;
 /**
- * A widget hosting the contributor tag of one inline diff range, placed on the first character the
- * range highlights.
+ * A widget hosting the contributor tag of one diff range, placed on the first character the range
+ * highlights — or, with `anchorAtRangeStart`, at `from` itself. Either way a host that would land
+ * inside a code block is hoisted out in front of it; see `resolveCodeBlockStart`.
  *
  * The tag is mounted in `toDOM` and taken down in `destroy`, so it lives exactly as long as the host
  * element ProseMirror drew it into — see `mountContributorTag`.
  */
-export declare const createContributorTagWidget: ({ doc, from, to, diffId, mountContext, }: {
+export declare const createContributorTagWidget: ({ anchorAtRangeStart, doc, from, to, diffId, mountContext, }: {
+    /**
+     * Anchor the host at `from` instead of the range's first inline content, so a block range hosts
+     * its tag outside the node rather than inside its content DOM.
+     */
+    anchorAtRangeStart?: boolean;
     diffId: string;
     doc: PMNode;
     from: number;

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

@@ -1,6 +1,6 @@
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
-import type { DiffType } from '../../showDiffPluginType';
+import type { DiffType, RevealOptions } from '../../showDiffPluginType';
 import type { ColorScheme } from './colorSchemes/types';
 import { type ContributorTagMountContext } from './createContributorTagWidget';
 import type { InlineAttrChangeNodeName } from './utils/getAttrChangeRanges';
@@ -14,7 +14,7 @@ export declare const getAtomicInlineChangedAttrs: (inlineNodeName: InlineAttrCha
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: ({ attributionKey, change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showContributorTags, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, isDeletedWidgetBelow, tagMountContext, }: {
+export declare const createInlineChangedDecoration: ({ attributionKey, change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showContributorTags, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, isDeletedWidgetBelow, reveal, tagMountContext, }: {
     attributionKey?: string;
     change: {
         fromB: number;
@@ -30,6 +30,7 @@ export declare const createInlineChangedDecoration: ({ attributionKey, change, c
     isAtomicInlineNode?: boolean;
     isDeletedWidgetBelow?: boolean;
     isInserted?: boolean;
+    reveal?: RevealOptions;
     shouldHideDeleted?: boolean;
     showContributorTags?: boolean;
     showIndicators?: boolean;

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

@@ -2,7 +2,7 @@ import type { Change } from 'prosemirror-changeset';
 import type { IntlShape } from 'react-intl';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
-import type { DiffType } from '../../showDiffPluginType';
+import type { DiffType, RevealOptions } from '../../showDiffPluginType';
 import type { NodeViewSerializer } from '../NodeViewSerializer';
 import { type ContributorTagMountContext } from './createContributorTagWidget';
 import type { ColorScheme } from './colorSchemes/types';
@@ -10,7 +10,7 @@ import type { ColorScheme } from './colorSchemes/types';
  * This function is used to create a decoration widget to show content
  * that is not in the current document.
  */
-export declare const createNodeChangedDecorationWidget: ({ attributionKey, change, doc, nodeViewSerializer, colorScheme, newDoc, intl, activeIndexPos, isInserted, showContributorTags, showIndicators, placeBelow, diffType, hideAddedDiffsUnderline, tagMountContext, }: {
+export declare const createNodeChangedDecorationWidget: ({ attributionKey, change, doc, nodeViewSerializer, colorScheme, newDoc, intl, activeIndexPos, isInserted, showContributorTags, showIndicators, placeBelow, diffType, hideAddedDiffsUnderline, reveal, tagMountContext, }: {
     activeIndexPos?: {
         from: number;
         to: number;
@@ -26,6 +26,7 @@ export declare const createNodeChangedDecorationWidget: ({ attributionKey, chang
     newDoc: PMNode;
     nodeViewSerializer: NodeViewSerializer;
     placeBelow?: boolean;
+    reveal?: RevealOptions;
     showContributorTags?: boolean;
     showIndicators?: boolean;
     tagMountContext?: ContributorTagMountContext;

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

@@ -0,0 +1,49 @@
+import type { RevealOptions } from '../../showDiffPluginType';
+import type { ColorScheme } from './colorSchemes/types';
+/**
+ * Painting strategy for reveal highlights. Highlights are `linear-gradient`s with animated
+ * `background-size` for the wipe effect. Colours live on elements as custom properties so the
+ * attribution palette works per-contributor.
+ */
+/** Marks an element as taking part in the reveal, and says which side it represents. */
+export declare const REVEAL_ATTR = "data-show-diff-reveal";
+export type RevealRole = 'added' | 'deleted';
+/** Wipe colour, read by the animation as the gradient's colour stop. */
+export declare const REVEAL_BG_VAR = "--show-diff-reveal-bg";
+/** Underline colour, brought in on the same schedule as the highlight. */
+export declare const REVEAL_BORDER_VAR = "--show-diff-reveal-border";
+/** Convert a flat background colour into a wipeable gradient (zero width initially). */
+export declare const buildWipeableBackground: (color: string) => string;
+/**
+ * Resolve reveal attribute and style for a decoration. Returned style REPLACES the decoration's
+ * highlight (not an addition) so the animation has something to wipe. Gate resolved in showDiff
+ * command for single shared answer between decorations and animation.
+ */
+export declare const resolveRevealStyle: ({ colorScheme, hideAddedDiffsUnderline, includeDeletedTextStyle, isActive, isInserted, reveal, }: {
+    colorScheme: ColorScheme | undefined;
+    /**
+     * Mirrors the `showDiff` parameter of the same name. Must be threaded through: it decides
+     * whether the resting appearance has an underline, and so whether the reveal should bring one in.
+     */
+    hideAddedDiffsUnderline?: boolean;
+    /**
+     * Whether to supply deleted content's grey text and strikethrough. False for the deleted-content
+     * widget, which already applies its own.
+     */
+    includeDeletedTextStyle?: boolean;
+    isActive: boolean;
+    isInserted: boolean;
+    reveal: RevealOptions | undefined;
+}) => {
+    role: RevealRole;
+    style: string;
+} | undefined;
+/** Reveal style for imperatively-built elements (deleted-content widget wrappers). */
+export declare const applyRevealToElement: ({ colorScheme, element, hideAddedDiffsUnderline, isActive, isInserted, reveal, }: {
+    colorScheme: ColorScheme | undefined;
+    element: HTMLElement;
+    hideAddedDiffsUnderline?: boolean;
+    isActive: boolean;
+    isInserted: boolean;
+    reveal: RevealOptions | undefined;
+}) => string;

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

@@ -1,6 +1,6 @@
 import type { IntlShape } from 'react-intl';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { DiffType } from '../../../showDiffPluginType';
+import type { DiffType, RevealOptions } from '../../../showDiffPluginType';
 import type { ColorScheme } from '../colorSchemes/types';
 /**
  * Handles all block node rendering with appropriate deleted styling.
@@ -24,14 +24,15 @@ export declare const wrapBlockNodeView: ({ dom, nodeView, targetNode, colorSchem
  * CSS backgrounds don't work when applied to a wrapper around a paragraph, so
  * the wrapper needs to be injected inside the node around the child content.
  */
-export declare const injectInnerWrapper: ({ node, colorScheme, isActive, isInserted, diffType, }: {
+export declare const injectInnerWrapper: ({ node, colorScheme, isActive, isInserted, diffType, reveal, }: {
     colorScheme?: ColorScheme;
     diffType?: DiffType;
     isActive?: boolean;
     isInserted?: boolean;
     node: HTMLElement;
+    reveal?: RevealOptions;
 }) => HTMLElement;
 /**
  * Creates a styled span wrapper for inline content within a change decoration.
  */
-export declare const createContentWrapper: (colorScheme?: ColorScheme, isActive?: boolean, isInserted?: boolean, diffType?: DiffType) => HTMLElement;
+export declare const createContentWrapper: (colorScheme?: ColorScheme, isActive?: boolean, isInserted?: boolean, diffType?: DiffType, reveal?: RevealOptions) => HTMLElement;

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

@@ -15,7 +15,7 @@ export declare const getDeletedContentStyleUnbounded: (colorScheme?: ColorScheme
 /** Inline style for inserted content. */
 export declare const getInsertedContentStyle: (colorScheme?: ColorScheme, isActive?: boolean, hideAddedDiffsUnderline?: boolean) => string;
 /** Inline style for deleted content. */
-export declare const getDeletedContentStyle: (colorScheme?: ColorScheme, isActive?: boolean, diffType?: DiffType) => string;
+export declare const getDeletedContentStyle: (colorScheme?: ColorScheme, isActive?: boolean, diffType?: DiffType, omitHighlight?: boolean) => string;
 /**
  * Overlay style for one added or deleted table cell. Invariant across the cells of a table, so the
  * `querySelectorAll('td, th')` loop in `wrapBlockNodeView.ts` resolves it once.

package/dist/types/pm-plugins/decorations/utils/wrapBlockNodeViewStyles.legacy.d.ts

@@ -8,7 +8,7 @@ export declare const getDeletedContentStyleUnboundedLegacy: (colorScheme?: Color
 /** Pre-refactor inline style for inserted content. */
 export declare const getInsertedContentStyleLegacy: (colorScheme?: ColorScheme, isActive?: boolean, hideAddedDiffsUnderline?: boolean) => string;
 /** Pre-refactor inline style for deleted content. */
-export declare const getDeletedContentStyleLegacy: (colorScheme?: ColorScheme, isActive?: boolean, diffType?: DiffType) => string;
+export declare const getDeletedContentStyleLegacy: (colorScheme?: ColorScheme, isActive?: boolean, diffType?: DiffType, omitHighlight?: boolean) => string;
 /**
  * Pre-refactor table-cell overlay style, as chosen inside the `querySelectorAll('td, th')` loop of
  * `applyCellOverlayStyles`. The choice does not vary per cell, so hoisting it out of the loop is

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

@@ -6,7 +6,7 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform-override';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { ContributorTagModel, DeletedDiffPlacement, DiffDescriptor, DiffParams, DiffStepAttribution, DiffType, InlineDeletedDiffPlacement, ShowDiffPlugin, SmartDiffThresholds } from '../showDiffPluginType';
+import type { ContributorTagModel, DeletedDiffPlacement, DiffDescriptor, DiffParams, DiffStepAttribution, DiffType, InlineDeletedDiffPlacement, RevealOptions, ShowDiffPlugin, SmartDiffThresholds } from '../showDiffPluginType';
 import type { ResolvedDiffContributors } from './decorations/colorSchemes/attributions';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 export type ShowDiffPluginState = {
@@ -42,6 +42,11 @@ export type ShowDiffPluginState = {
     isDisplayingChanges: boolean;
     isInverted?: boolean;
     originalDoc: PMNode | undefined;
+    /**
+     * Reveal choreography for the CURRENT paint only. Set from SHOW_DIFF meta and deliberately not
+     * inherited: a scroll-to-next or an unrelated repaint must not replay the animation.
+     */
+    reveal?: RevealOptions;
     /**
      * When true, the view update handler should scroll to the first decoration
      * and then reset this flag.

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

@@ -0,0 +1,33 @@
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { RevealOptions } from '../showDiffPluginType';
+/**
+ * Reveal animation timing. Phase A (0–0.6D): outgoing state fades in, agent highlight wipes out.
+ * Phase B (0.6D–D): all highlights wipe in. Uses Web Animations API for element reusability and
+ * per-reveal cancellation.
+ */
+/** Total choreography length when the caller does not specify one. */
+export declare const REVEAL_DEFAULT_DURATION_MS = 950;
+/**
+ * Stop any running reveal and drop it from plugin state.
+ *
+ * Clearing the state is what restores the resting appearance: revealing decorations paint their
+ * highlight at zero width, so the repaint that follows is what renders them normally again. Doing
+ * it in state rather than by writing styles onto the current elements means decorations rendered
+ * later are correct too — an imperative fix only reaches the elements that exist at that instant.
+ */
+export declare const cancelReveal: (editorView: EditorView) => void;
+/**
+ * Re-binds the reveal to the current decorations. Called on every repaint while a reveal is in
+ * flight, because a repaint silently destroys any animation attached to re-rendered DOM.
+ */
+export declare const rebindReveal: (editorView: EditorView, content: HTMLElement) => void;
+/**
+ * Start the reveal. Must be called BEFORE transaction dispatch (last moment outgoing DOM exists
+ * for capture). Incoming half animates a frame later, post-decoration-render.
+ */
+export declare const beginReveal: ({ editorView, onComplete, reveal, }: {
+    editorView: EditorView;
+    /** Drops the reveal from plugin state, so the next paint renders the resting style. */
+    onComplete: () => void;
+    reveal: RevealOptions;
+}) => void;

package/dist/types/showDiffPluginType.d.ts

@@ -105,6 +105,26 @@ export type DiffDescriptor = {
     id: string;
     type: 'inline' | 'block' | 'widget';
 };
+/**
+ * How the diff is revealed when it is painted.
+ *
+ * - `phased` — the two-phase choreography used when opening the diff from a clean "new state":
+ *   the outgoing state cross-fades to the incoming one while the agent highlight wipes out to the
+ *   right, then every highlight wipes back in from the left.
+ *
+ * Deliberately separate from {@link DiffType}: that describes how changes are computed and grouped,
+ * this describes how the result is presented over time. Folding one into the other would make every
+ * `DiffType` consumer — version history, track-changes, publish diff — care about presentation.
+ */
+export type RevealMode = 'phased';
+export type RevealOptions = {
+    /**
+     * Total length of the choreography. Defaults to `REVEAL_DEFAULT_DURATION_MS`. Exposed because
+     * this is a design-tunable value; it should not be buried in a stylesheet.
+     */
+    durationMs?: number;
+    mode: RevealMode;
+};
 export type DiffParams = {
     /**
      * Color scheme to use for displaying diffs.
@@ -142,6 +162,13 @@ export type PMDiffParams = {
     inlineDeletedDiffPlacement?: InlineDeletedDiffPlacement;
     isInverted?: boolean;
     originalDoc: Node;
+    /**
+     * How this diff is revealed when painted. Omitted means paint immediately.
+     *
+     * Applies to THIS paint only — it is not inherited by later recalculations, so stepping
+     * through changes or a repaint cannot replay the choreography.
+     */
+    reveal?: RevealOptions;
     /**
      * When true, the editor will scroll to bring the first diff decoration into view
      * after the diff is shown.
@@ -167,7 +194,8 @@ export type PMDiffParams = {
  */
 type PMDiffParamsWithAttribution = Omit<PMDiffParams, 'steps'> & {
     /**
-     * Identities for the accounts named by the attributed steps. When supplied, and the contributor-tag
+     * Identities for the accounts named by the attributed steps. Omitted profiles disable
+     * contributor tags without disabling attribution colours. An explicit empty array permits agent fallback tags. When supplied, and the contributor-tag
      * gate is on, every attributed change the plugin can credit to one of them renders a tag.
      * Complete entries only: a caller looking identities up (e.g. against a user directory) filters
      * out the ones it could not resolve rather than passing partial entries through. Omitting an

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "15.0.0",
+	"version": "15.1.1",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,7 +31,7 @@
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/primitives": "^22.5.0",
-		"@atlaskit/tmp-editor-statsig": "^179.0.0",
+		"@atlaskit/tmp-editor-statsig": "^182.0.0",
 		"@atlaskit/tokens": "^16.11.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
@@ -56,19 +56,25 @@
 		"@atlassian/confluence-presets": "workspace:^",
 		"@atlassian/content-reconciliation": "^0.1.3506",
 		"@atlassian/editor-ai-injected-editors": "^31.0.0",
-		"@atlassian/editor-plugin-ai": "^71.0.0",
+		"@atlassian/editor-plugin-ai": "^71.1.0",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"react": "^19.2.0",
 		"react-dom": "^19.2.0",
 		"react-intl": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^121.0.0",
+		"@atlaskit/editor-common": "^121.1.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
 	"platform-feature-flags": {
+		"platform_editor_diff_reveal_animation": {
+			"type": "boolean"
+		},
+		"platform_editor_diff_hide_pure_deletions": {
+			"type": "boolean"
+		},
 		"platform_editor_ai_show_diff_patch_1": {
 			"type": "boolean"
 		},