@atlaskit/editor-plugin-show-diff 14.3.2 → 14.4.0

package/dist/types/pm-plugins/decorations/createInlineChangedDecoration.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';
 import type { InlineAttrChangeNodeName } from './utils/getAttrChangeRanges';
 export declare const getAtomicInlineChangedAttrs: (inlineNodeName: InlineAttrChangeNodeName, colorScheme: ColorScheme | undefined) => {
     className: string;
@@ -13,7 +14,8 @@ 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: ({ change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, isDeletedWidgetBelow, }: {
+export declare const createInlineChangedDecoration: ({ attributionKey, change, colorScheme, isActive, isInserted, isAtomicInlineNode, shouldHideDeleted, showContributorTags, showIndicators, doc, diffType, hideAddedDiffsUnderline, inlineNodeName, hasDeletedWidget, isDeletedWidgetBelow, tagMountContext, }: {
+    attributionKey?: string;
     change: {
         fromB: number;
         toB: number;
@@ -29,5 +31,7 @@ export declare const createInlineChangedDecoration: ({ change, colorScheme, isAc
     isDeletedWidgetBelow?: boolean;
     isInserted?: boolean;
     shouldHideDeleted?: boolean;
+    showContributorTags?: boolean;
     showIndicators?: boolean;
+    tagMountContext?: ContributorTagMountContext;
 }) => Decoration[];

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

@@ -4,16 +4,18 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { DiffType } from '../../showDiffPluginType';
 import type { NodeViewSerializer } from '../NodeViewSerializer';
+import { type ContributorTagMountContext } from './createContributorTagWidget';
 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: ({ change, doc, nodeViewSerializer, colorScheme, newDoc, intl, activeIndexPos, isInserted, showIndicators, placeBelow, diffType, hideAddedDiffsUnderline, }: {
+export declare const createNodeChangedDecorationWidget: ({ attributionKey, change, doc, nodeViewSerializer, colorScheme, newDoc, intl, activeIndexPos, isInserted, showContributorTags, showIndicators, placeBelow, diffType, hideAddedDiffsUnderline, tagMountContext, }: {
     activeIndexPos?: {
         from: number;
         to: number;
     };
+    attributionKey?: string;
     change: Pick<Change, 'fromA' | 'toA' | 'fromB' | 'deleted' | 'toB'>;
     colorScheme?: ColorScheme;
     diffType?: DiffType;
@@ -24,5 +26,7 @@ export declare const createNodeChangedDecorationWidget: ({ change, doc, nodeView
     newDoc: PMNode;
     nodeViewSerializer: NodeViewSerializer;
     placeBelow?: boolean;
+    showContributorTags?: boolean;
     showIndicators?: boolean;
+    tagMountContext?: ContributorTagMountContext;
 }) => Decoration[];

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

@@ -1,5 +1,6 @@
 import type { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { DiffDescriptor, DiffType } from '../../showDiffPluginType';
+import type { ColorScheme } from './colorSchemes/types';
 /**
  * Decoration families produced by the show-diff plugin.
  * Each family owns its own key space and spec shape.
@@ -7,6 +8,7 @@ import type { DiffDescriptor, DiffType } from '../../showDiffPluginType';
 export declare const DecorationFamily: {
     readonly diff: 'diff';
     readonly anchor: 'anchor';
+    readonly contributorTag: 'contributor-tag';
 };
 type DecorationFamilyValue = (typeof DecorationFamily)[keyof typeof DecorationFamily];
 type BaseDecorationSpec<TFamily extends DecorationFamilyValue> = {
@@ -15,8 +17,20 @@ type BaseDecorationSpec<TFamily extends DecorationFamilyValue> = {
     side?: number;
 };
 export type DiffDecorationSpec = BaseDecorationSpec<typeof DecorationFamily.diff> & {
+    attributionKey?: string;
+    colorScheme?: ColorScheme;
     decorationType: DiffDescriptor['type'];
     diffId: string;
+    /**
+     * The change currently stepped to. Needed on the spec because `activeIndex` indexes the filtered,
+     * re-sorted scrollable decorations, not `diffDescriptors`.
+     */
+    isActive?: boolean;
+    /**
+     * Carried rather than derived from `decorationType`, because an inverted diff swaps which side is
+     * the inserted one.
+     */
+    isInserted?: boolean;
     nodeName?: string;
 };
 export declare const AnchorTypeKey: {
@@ -25,14 +39,21 @@ export declare const AnchorTypeKey: {
     readonly left: 'left';
     readonly docMargin: 'doc-margin';
 };
-type InlineAnchorType = Exclude<(typeof AnchorTypeKey)[keyof typeof AnchorTypeKey], typeof AnchorTypeKey.docMargin>;
+export type InlineAnchorType = Exclude<(typeof AnchorTypeKey)[keyof typeof AnchorTypeKey], typeof AnchorTypeKey.docMargin>;
 export type AnchorDecorationSpec = (BaseDecorationSpec<typeof DecorationFamily.anchor> & {
     anchorType: typeof AnchorTypeKey.docMargin;
 }) | (BaseDecorationSpec<typeof DecorationFamily.anchor> & {
     anchorType: InlineAnchorType;
     diffId: string;
 });
-export type ShowDiffDecorationSpec = DiffDecorationSpec | AnchorDecorationSpec;
+/**
+ * The host widget one contributor tag renders into. Its own family, so the tag never reaches the
+ * consumers that read diff decorations — change counting, navigation and `getDeletedWidgets`.
+ */
+export type ContributorTagDecorationSpec = BaseDecorationSpec<typeof DecorationFamily.contributorTag> & {
+    diffId: string;
+};
+export type ShowDiffDecorationSpec = DiffDecorationSpec | AnchorDecorationSpec | ContributorTagDecorationSpec;
 /**
  * The diff-decoration kinds produced by the show-diff plugin. Each value is
  * the leading segment of the generated key, so a diff decoration's kind can be
@@ -59,11 +80,14 @@ export declare const buildDiffDecorationKey: ({ decorationKeyPrefix, isActive, d
     diffType?: DiffType;
     isActive?: boolean;
 }) => string;
-export declare const buildDiffDecorationSpec: ({ decorationType, diffId, isActive, nodeName, side, diffType, }: {
+export declare const buildDiffDecorationSpec: ({ attributionKey, colorScheme, decorationType, diffId, isActive, isInserted, nodeName, side, diffType, }: {
+    attributionKey?: string;
+    colorScheme?: ColorScheme;
     decorationType: DiffDescriptor['type'];
     diffId: string;
     diffType?: DiffType;
     isActive?: boolean;
+    isInserted?: boolean;
     nodeName?: string;
     side?: number;
 }) => DiffDecorationSpec;
@@ -76,6 +100,7 @@ export declare function buildAnchorDecorationSpec(args: {
     diffId: string;
     side?: number;
 }): AnchorDecorationSpec;
+export declare const buildContributorTagDecorationSpec: (diffId: string) => ContributorTagDecorationSpec;
 export declare const isDiffDecorationSpec: (spec: unknown) => spec is DiffDecorationSpec;
 export declare const isAnchorDecorationSpec: (spec: unknown) => spec is AnchorDecorationSpec;
 export declare const isDiffDecoration: (decoration: Decoration) => decoration is Decoration & {

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

@@ -0,0 +1,9 @@
+import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { ContributorTagModel } from '../../showDiffPluginType';
+import type { ResolvedDiffContributors } from './colorSchemes/attributions';
+/**
+ * One model per diff decoration whose attribution resolves to a supplied contributor; anything
+ * unattributed, untaggable or unresolved is skipped. A replacement's two decorations are collapsed
+ * into the single inline tag — see `isSameChange`.
+ */
+export declare const extractContributorTags: (decorations: DecorationSet, contributors: ResolvedDiffContributors | undefined) => ContributorTagModel[];

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

@@ -1,4 +1,5 @@
 import type { IntlShape } from 'react-intl';
+import type { PortalProviderAPI } from '@atlaskit/editor-common/portal';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
@@ -6,7 +7,8 @@ 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 { DeletedDiffPlacement, DiffDescriptor, DiffParams, DiffStepAttribution, DiffType, InlineDeletedDiffPlacement, ShowDiffPlugin, SmartDiffThresholds } from '../showDiffPluginType';
+import type { ContributorTagModel, DeletedDiffPlacement, DiffDescriptor, DiffParams, DiffStepAttribution, DiffType, InlineDeletedDiffPlacement, ShowDiffPlugin, SmartDiffThresholds } from '../showDiffPluginType';
+import type { ResolvedDiffContributors } from './decorations/colorSchemes/attributions';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 export type ShowDiffPluginState = {
     activeIndex?: number;
@@ -14,6 +16,10 @@ export type ShowDiffPluginState = {
         from: number;
         to: number;
     };
+    /** Set via SHOW_DIFF meta, after `normalizeShowDiffParams` has keyed the public list. */
+    contributors?: ResolvedDiffContributors;
+    /** Resolved per calculation, never set via meta. */
+    contributorTags?: ContributorTagModel[];
     decorations: DecorationSet;
     /**
      * For the `smart` diffType, where node/paragraph-level deleted content is rendered relative to
@@ -52,4 +58,4 @@ export type ShowDiffPluginState = {
     stepAttributions?: Array<DiffStepAttribution | undefined>;
     steps: ProseMirrorStep[];
 };
-export declare const createPlugin: (config: DiffParams | undefined, getIntl: () => IntlShape, api: ExtractInjectionAPI<ShowDiffPlugin> | undefined, onEditorView?: (editorView: EditorView | undefined) => void) => SafePlugin<ShowDiffPluginState>;
+export declare const createPlugin: (config: DiffParams | undefined, getIntl: () => IntlShape, api: ExtractInjectionAPI<ShowDiffPlugin> | undefined, portalProviderAPI?: PortalProviderAPI, onEditorView?: (editorView: EditorView | undefined) => void) => SafePlugin<ShowDiffPluginState>;

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

@@ -0,0 +1,7 @@
+import type { DiffContributorProfile, DiffContributors, StepWithAttribution } from '../showDiffPluginType';
+/**
+ * One contributor per distinct actor behind the attributed steps, resolved against the identities
+ * the consumer supplied. Returns `undefined` if any actor cannot be named: a half-credited diff
+ * reads as "nobody touched this", so the whole list is dropped and the plain diff renders instead.
+ */
+export declare const resolveDiffContributors: <TStep>(stepsWithAttribution: Array<StepWithAttribution<TStep>>, profiles: readonly DiffContributorProfile[] | undefined) => DiffContributors | undefined;

package/dist/types/showDiffPluginType.d.ts

@@ -6,7 +6,8 @@ import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { Step } from '@atlaskit/editor-prosemirror/transform-override';
 import type { SmartDiffThresholds as SmartDiffThresholdsInternal } from './pm-plugins/calculateDiff/smart/thresholds';
-export type ColorScheme = 'standard' | 'traditional';
+import type { ColorScheme as ResolvedColorScheme, PublicColorScheme } from './pm-plugins/decorations/colorSchemes/types';
+export type ColorScheme = PublicColorScheme;
 export type DiffType = 'inline' | 'block' | 'step' | 'smart';
 /**
  * Attribution for a ProseMirror step.
@@ -26,6 +27,53 @@ export type StepWithAttribution<TStep> = {
     step: TStep;
     stepAttribution?: DiffStepAttribution;
 };
+/** A complete identity for one of the accounts named by a step attribution. */
+export type DiffContributorProfile = {
+    /** Matched against the `userId` and `agentId` on step attributions. */
+    accountId: string;
+    avatarUrl?: string;
+    name: string;
+};
+type DiffContributorKind = 'user' | 'agent';
+/** Agent presentation: `rovo`/`identified` use the agent's identity, `external` is generic. */
+type DiffAgentKind = 'rovo' | 'identified' | 'external';
+/**
+ * A contributor the plugin has resolved from a step attribution and a supplied profile. Internal:
+ * never re-exported from an entry point and not reachable from any public type. Same for
+ * `DiffContributors`.
+ */
+export type DiffContributor = {
+    /** For `kind: 'agent'`, which presentation to use. Defaults to `'external'`. */
+    agentKind?: DiffAgentKind;
+    attribution: DiffStepAttribution;
+    avatarUrl?: string;
+    /** Attribution of the invoking user, so the pair renders as connected. */
+    connectedTo?: DiffStepAttribution;
+    kind: DiffContributorKind;
+    name: string;
+};
+/** Where two contributors share an identity, the last wins. */
+export type DiffContributors = DiffContributor[];
+/** A contributor stripped of its attributions, as a tag presents it. Internal. */
+export type TagContributor = Omit<DiffContributor, 'attribution' | 'connectedTo'>;
+/**
+ * Everything a contributor tag renders, resolved by the plugin so the tag UI does no lookups.
+ * Declared here rather than beside `extractContributorTags` so the shared state below can name it
+ * without importing back out of this file. Internal, like `TagContributor`.
+ */
+export type ContributorTagModel = {
+    colorScheme?: ResolvedColorScheme;
+    connectedContributor?: TagContributor;
+    contributor: TagContributor;
+    diffId: string;
+    isActive?: boolean;
+    isInserted?: boolean;
+    /**
+     * Other decorations of the same change that this one tag captions, so hovering any of them
+     * reveals it. Set when a replacement's deleted-content widget is folded into its inline tag.
+     */
+    linkedDiffIds?: string[];
+};
 /**
  * Where node/paragraph-level deleted content is rendered relative to the new (replacement)
  * content in the `smart` diffType:
@@ -118,11 +166,19 @@ export type PMDiffParams = {
  * by `userId`, with `agentId` used as a tie-breaker.
  */
 type PMDiffParamsWithAttribution = Omit<PMDiffParams, 'steps'> & {
+    /**
+     * Identities for the accounts named by the attributed steps. 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
+     * account is meaningful — a user the plugin cannot name drops every tag, while an agent falls
+     * back to its own presentation.
+     */
+    contributorProfiles?: readonly DiffContributorProfile[];
     steps?: never;
     stepsWithAttribution: Array<StepWithAttribution<Step>>;
 };
 export type ShowDiffParams = PMDiffParams | PMDiffParamsWithAttribution;
-export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF' | 'SCROLL_TO_NEXT' | 'SCROLL_TO_PREVIOUS';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
     actions: {
         /**
@@ -149,6 +205,13 @@ export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
          * The index of the current diff being viewed.
          */
         activeIndex?: number;
+        /**
+         * The contributor tags to render for the diff currently being displayed. Resolved by the
+         * plugin and consumed by its own contributor-tag UI — `ContributorTagModel` and
+         * `TagContributor` are not exported from any entry point.
+         * Only set when `platform_editor_diff_plugin_extended` is on.
+         */
+        contributorTags?: ContributorTagModel[];
         /**
          * The diff descriptors of the diff decorations currently being displayed.
          * Only set when `platform_editor_diff_plugin_extended` is on.

package/dist/types/ui/ContributorTag/ContributorTag.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import type { ColorScheme } from '../../pm-plugins/decorations/colorSchemes/types';
+import type { TagContributor } from '../../showDiffPluginType';
+type ContributorTagProps = {
+    colorScheme?: ColorScheme;
+    connectedContributor?: TagContributor;
+    contributor: TagContributor;
+    diffId: string;
+    /**
+     * This editor's own content root (`editorView.dom`), read through the plugin's captured view.
+     *
+     * Every DOM lookup the tag makes is scoped to it, rather than resolved by class name from a
+     * highlight element: `.ProseMirror` is not this package's to rename, and with nested editors the
+     * nearest one is not necessarily the editor whose plugin rendered this tag.
+     *
+     * A getter rather than the element itself because the view arrives with the ProseMirror view
+     * lifecycle, which the plugin does not re-render for: reading it inside the effect means it is
+     * always the current one.
+     */
+    getEditorRoot: () => HTMLElement | null;
+    isActive?: boolean;
+    isInserted?: boolean;
+    /**
+     * Other decorations of the same change this one tag captions — the deleted half of a replacement.
+     * Hovering any of them reveals the tag; only `diffId` is measured against.
+     */
+    linkedDiffIds?: string[];
+};
+/**
+ * A small tag naming who made one diff, rendered into the host widget its decoration places on the
+ * change's first character and positioned above it.
+ */
+export declare function ContributorTag({ colorScheme, connectedContributor, contributor, diffId, getEditorRoot, isActive, isInserted, linkedDiffIds, }: ContributorTagProps): JSX.Element;
+export {};

package/dist/types/ui/ContributorTag/ContributorTagWidget.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { ShowDiffPlugin } from '../../showDiffPluginType';
+/**
+ * One contributor tag, mounted by its diff decoration into the host element that decoration draws
+ * (see `mountContributorTag`).
+ *
+ * The model is read from plugin state here rather than passed in, because ProseMirror skips `toDOM`
+ * for a widget it reuses: stepping to the next change republishes the tags without redrawing their
+ * hosts, so anything the tag needs to react to — `isActive` above all — has to arrive through a
+ * subscription of its own. Renders nothing when this diff has no tag, which is the case for the
+ * deleted half of a replacement: that half is folded into the inline tag.
+ */
+export declare const ContributorTagWidget: ({ api, diffId, getEditorRoot, }: {
+    api?: ExtractInjectionAPI<ShowDiffPlugin>;
+    diffId: string;
+    /** This editor's own content root — see `ContributorTagProps.getEditorRoot`. */
+    getEditorRoot: () => HTMLElement | null;
+}) => JSX.Element | null;

package/dist/types/ui/ContributorTag/messages.d.ts

@@ -0,0 +1,6 @@
+import { type MessageDescriptor } from 'react-intl';
+export declare const contributorTagMessages: {
+    changedBy: MessageDescriptor;
+    changedByConnected: MessageDescriptor;
+    externalAgentName: MessageDescriptor;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "14.3.2",
+	"version": "14.4.0",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,33 +20,39 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^57.2.0",
+		"@atlaskit/adf-schema": "^57.3.0",
+		"@atlaskit/avatar": "^28.0.0",
 		"@atlaskit/custom-steps": "^1.1.0",
 		"@atlaskit/editor-plugin-analytics": "^16.1.0",
 		"@atlaskit/editor-plugin-user-intent": "^14.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-shared-styles": "^4.1.0",
 		"@atlaskit/editor-tables": "^3.1.0",
+		"@atlaskit/icon-lab": "^7.8.0",
+		"@atlaskit/logo": "^21.6.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
+		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/tmp-editor-statsig": "^174.0.0",
 		"@atlaskit/tokens": "^16.11.0",
+		"@atlaskit/tooltip": "^24.3.0",
+		"@atlaskit/visually-hidden": "^4.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
+		"bind-event-listener": "^3.0.0",
 		"lodash": "^4.17.21",
 		"memoize-one": "^6.0.0",
 		"prosemirror-changeset": "^2.3.1"
 	},
 	"devDependencies": {
-		"@atlaskit/adf-utils": "^20.8.0",
+		"@atlaskit/adf-utils": "^20.9.0",
 		"@atlaskit/button": "^25.3.0",
 		"@atlaskit/css": "^1.1.0",
 		"@atlaskit/dropdown-menu": "^18.3.0",
-		"@atlaskit/editor-core": "^226.3.0",
+		"@atlaskit/editor-core": "^226.4.0",
 		"@atlaskit/editor-json-transformer": "^9.8.0",
 		"@atlaskit/editor-plugins": "^16.1.0",
 		"@atlaskit/form": "^17.2.0",
-		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/section-message": "^10.2.0",
 		"@atlaskit/textarea": "^10.2.0",
 		"@atlaskit/textfield": "^10.2.0",
@@ -57,11 +63,14 @@
 		"@atlassian/editor-plugin-ai": "^70.2.0",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"react": "^19.2.0",
+		"react-dom": "^19.2.0",
 		"react-intl": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.12.0",
-		"react": "^18.2.0 || ^19.2.0"
+		"@atlaskit/editor-common": "^120.13.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_ai_show_diff_patch_1": {