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

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

@@ -8,13 +8,33 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform-override';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { calculateDiffDecorations } from './calculateDiff/calculateDiffDecorations';
+import { isDiffDecoration, isDiffDecorationSpec } from './decorations/decorationKeys';
 import { enforceCustomStepRegisters } from './enforceCustomStepRegisters';
 import { getScrollableDecorations } from './getScrollableDecorations';
 import { getDefaultDiffType, isExtendedEnabled } from './isExtendedEnabled';
 import { NodeViewSerializer } from './NodeViewSerializer';
 import { scrollToDecoration } from './scrollToDiff';
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
-export var createPlugin = function createPlugin(config, getIntl, api, onEditorView) {
+/**
+ * Tags whose diff decoration survived the transaction. A document change can map a decoration away
+ * without any `showDiff`/`hideDiff` following it, and a tag left behind has no host to render into.
+ * Returns the given array when every tag is still live.
+ */
+var dropOrphanedContributorTags = function dropOrphanedContributorTags(contributorTags, decorations) {
+  if (!(contributorTags !== null && contributorTags !== void 0 && contributorTags.length)) {
+    return contributorTags;
+  }
+  var liveDiffIds = new Set(decorations.find(undefined, undefined, isDiffDecorationSpec).filter(isDiffDecoration).map(function (_ref) {
+    var spec = _ref.spec;
+    return spec.diffId;
+  }));
+  var liveTags = contributorTags.filter(function (_ref2) {
+    var diffId = _ref2.diffId;
+    return liveDiffIds.has(diffId);
+  });
+  return liveTags.length === contributorTags.length ? contributorTags : liveTags;
+};
+export var createPlugin = function createPlugin(config, getIntl, api, portalProviderAPI, onEditorView) {
   enforceCustomStepRegisters();
   var nodeViewSerializer = new NodeViewSerializer({});
   var setNodeViewSerializer = function setNodeViewSerializer(editorView) {
@@ -22,6 +42,23 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
       editorView: editorView
     });
   };
+
+  /**
+   * This editor's own content root. The contributor tags scope every DOM lookup to it, so they take
+   * it from the view the plugin was mounted on rather than resolving `.ProseMirror` by class name
+   * from a decoration — a class this package does not own, and one whose nearest match is the wrong
+   * editor whenever editors are nested. A getter because the view arrives with the ProseMirror view
+   * lifecycle, which decorations are calculated independently of.
+   */
+  var currentEditorView;
+  var tagMountContext = portalProviderAPI ? {
+    api: api,
+    getEditorRoot: function getEditorRoot() {
+      var _currentEditorView$do, _currentEditorView;
+      return (_currentEditorView$do = (_currentEditorView = currentEditorView) === null || _currentEditorView === void 0 ? void 0 : _currentEditorView.dom) !== null && _currentEditorView$do !== void 0 ? _currentEditorView$do : null;
+    },
+    portalProviderAPI: portalProviderAPI
+  } : undefined;
   return new SafePlugin({
     key: showDiffPluginKey,
     state: {
@@ -62,7 +99,8 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
                 colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
                 intl: getIntl(),
                 activeIndexPos: newPluginState.activeIndexPos,
-                api: api
+                api: api,
+                tagMountContext: tagMountContext
               }, isExtendedEnabled((_newPluginState = newPluginState) === null || _newPluginState === void 0 ? void 0 : _newPluginState.diffType) ? {
                 isInverted: (_newPluginState2 = newPluginState) === null || _newPluginState2 === void 0 ? void 0 : _newPluginState2.isInverted,
                 diffType: (_newPluginState3 = newPluginState) === null || _newPluginState3 === void 0 ? void 0 : _newPluginState3.diffType,
@@ -73,10 +111,12 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
                 deletedDiffPlacement: (_newPluginState8 = newPluginState) === null || _newPluginState8 === void 0 ? void 0 : _newPluginState8.deletedDiffPlacement,
                 inlineDeletedDiffPlacement: (_newPluginState9 = newPluginState) === null || _newPluginState9 === void 0 ? void 0 : _newPluginState9.inlineDeletedDiffPlacement
               } : {})),
+              contributorTags = _calculateDiffDecorat.contributorTags,
               decorations = _calculateDiffDecorat.decorations,
               diffDescriptors = _calculateDiffDecorat.diffDescriptors;
             // Update the decorations and their ids
             newPluginState.decorations = decorations;
+            newPluginState.contributorTags = contributorTags;
             if (isExtendedEnabled((_newPluginState0 = newPluginState) === null || _newPluginState0 === void 0 ? void 0 : _newPluginState0.diffType)) {
               newPluginState.diffDescriptors = diffDescriptors;
             }
@@ -84,7 +124,8 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
               decorations: DecorationSet.empty,
               isDisplayingChanges: false,
-              activeIndex: undefined
+              activeIndex: undefined,
+              contributorTags: []
             }, isExtendedEnabled(currentPluginState.diffType) ? {
               isInverted: false,
               diffType: getDefaultDiffType(),
@@ -128,7 +169,8 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
                   colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
                   intl: getIntl(),
                   activeIndexPos: newPluginState.activeIndexPos,
-                  api: api
+                  api: api,
+                  tagMountContext: tagMountContext
                 }, isExtendedEnabled(newPluginState.diffType) ? {
                   isInverted: newPluginState.isInverted,
                   diffType: newPluginState.diffType,
@@ -139,9 +181,11 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
                   deletedDiffPlacement: newPluginState.deletedDiffPlacement,
                   inlineDeletedDiffPlacement: newPluginState.inlineDeletedDiffPlacement
                 } : {})),
+                updatedContributorTags = _calculateDiffDecorat2.contributorTags,
                 updatedDecorations = _calculateDiffDecorat2.decorations,
                 updatedDiffDescriptors = _calculateDiffDecorat2.diffDescriptors;
               newPluginState.decorations = updatedDecorations;
+              newPluginState.contributorTags = updatedContributorTags;
               if (isExtendedEnabled(newPluginState.diffType)) {
                 newPluginState.diffDescriptors = updatedDiffDescriptors;
               }
@@ -150,13 +194,19 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
             newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);
           }
         }
-        return _objectSpread(_objectSpread({}, newPluginState), {}, {
-          decorations: newPluginState.decorations.map(tr.mapping, tr.doc)
+        var mappedDecorations = newPluginState.decorations.map(tr.mapping, tr.doc);
+        var nextState = _objectSpread(_objectSpread({}, newPluginState), {}, {
+          decorations: mappedDecorations
         });
+        if (tr.docChanged) {
+          nextState.contributorTags = dropOrphanedContributorTags(newPluginState.contributorTags, mappedDecorations);
+        }
+        return nextState;
       }
     },
     view: function view(editorView) {
       setNodeViewSerializer(editorView);
+      currentEditorView = editorView;
       onEditorView === null || onEditorView === void 0 || onEditorView(editorView);
       var isFirst = true;
       var previousActiveIndex;
@@ -210,6 +260,7 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
           var _cancelPendingScrollT3;
           (_cancelPendingScrollT3 = cancelPendingScrollToDecoration) === null || _cancelPendingScrollT3 === void 0 || _cancelPendingScrollT3();
           cancelPendingScrollToDecoration = null;
+          currentEditorView = undefined;
           onEditorView === null || onEditorView === void 0 || onEditorView(undefined);
         }
       };

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

@@ -0,0 +1,137 @@
+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; }
+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; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { getAttributionKey } from './decorations/colorSchemes/attributions';
+
+/** A brand name, so a literal rather than a translated message. */
+var ROVO_AGENT_NAME = 'Rovo';
+
+/** `agentType` values that render as "Rovo" rather than as a generic external agent. */
+var ROVO_AGENT_TYPES = new Set(['convo-ai', 'rovo_chat']);
+var hasAgentIdentity = function hasAgentIdentity(attribution) {
+  var _attribution$agentId, _attribution$agentTyp;
+  return Boolean(((_attribution$agentId = attribution.agentId) === null || _attribution$agentId === void 0 ? void 0 : _attribution$agentId.trim()) || ((_attribution$agentTyp = attribution.agentType) === null || _attribution$agentTyp === void 0 ? void 0 : _attribution$agentTyp.trim()));
+};
+var toProfilesByAccountId = function toProfilesByAccountId(profiles) {
+  var profilesByAccountId = new Map();
+  profiles === null || profiles === void 0 || profiles.forEach(function (profile) {
+    // Trimmed to match how attribution ids are keyed, so the two sides compare like for like.
+    var accountId = profile.accountId.trim();
+    if (accountId && !profilesByAccountId.has(accountId)) {
+      profilesByAccountId.set(accountId, profile);
+    }
+  });
+  return profilesByAccountId;
+};
+var resolveUser = function resolveUser(userId, profilesByAccountId) {
+  var profile = profilesByAccountId.get(userId);
+  return profile ? {
+    avatarUrl: profile.avatarUrl,
+    kind: 'user',
+    name: profile.name
+  } : undefined;
+};
+
+/** An agent always resolves: its profile, else "Rovo" for a first-party type, else external. */
+var resolveAgent = function resolveAgent(attribution, profilesByAccountId) {
+  var _attribution$agentId2, _attribution$agentTyp2;
+  var agentId = (_attribution$agentId2 = attribution.agentId) === null || _attribution$agentId2 === void 0 ? void 0 : _attribution$agentId2.trim();
+  var agentProfile = agentId ? profilesByAccountId.get(agentId) : undefined;
+  if (agentProfile) {
+    return {
+      agentKind: 'identified',
+      avatarUrl: agentProfile.avatarUrl,
+      kind: 'agent',
+      name: agentProfile.name
+    };
+  }
+  var agentType = (_attribution$agentTyp2 = attribution.agentType) === null || _attribution$agentTyp2 === void 0 ? void 0 : _attribution$agentTyp2.trim().toLowerCase();
+
+  // An empty name lets the tag fall back to its own localised "External agent" label.
+  return agentType && ROVO_AGENT_TYPES.has(agentType) ? {
+    agentKind: 'rovo',
+    kind: 'agent',
+    name: ROVO_AGENT_NAME
+  } : {
+    agentKind: 'external',
+    kind: 'agent',
+    name: ''
+  };
+};
+
+/**
+ * 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 var resolveDiffContributors = function resolveDiffContributors(stepsWithAttribution, profiles) {
+  var profilesByAccountId = toProfilesByAccountId(profiles);
+  var contributors = [];
+  /** Keyed as the plugin keys changes, so no two entries can collapse onto one another. */
+  var creditedActors = new Set();
+  var _iterator = _createForOfIteratorHelper(stepsWithAttribution),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var _stepAttribution$user;
+      var stepAttribution = _step.value.stepAttribution;
+      // An attribution naming nobody (e.g. one carrying only `wasOffline`) has nobody to credit.
+      var actor = stepAttribution ? getAttributionKey(stepAttribution) : undefined;
+      if (!stepAttribution || !actor || creditedActors.has(actor)) {
+        continue;
+      }
+      var userId = (_stepAttribution$user = stepAttribution.userId) === null || _stepAttribution$user === void 0 ? void 0 : _stepAttribution$user.trim();
+      if (hasAgentIdentity(stepAttribution)) {
+        var agent = resolveAgent(stepAttribution, profilesByAccountId);
+        if (!userId) {
+          // Agent mode: the agent acted on its own, so it is credited on its own.
+          contributors.push(_objectSpread(_objectSpread({}, agent), {}, {
+            attribution: stepAttribution
+          }));
+          creditedActors.add(actor);
+          continue;
+        }
+
+        // User-invoked agent: credit both actors and link the agent back to the invoking user.
+        var invokingUser = {
+          userId: userId
+        };
+        var _user = resolveUser(userId, profilesByAccountId);
+        if (!_user) {
+          return undefined;
+        }
+
+        // Skipped if the invoking user's own step already credited them.
+        var invokingUserActor = getAttributionKey(invokingUser);
+        if (invokingUserActor && !creditedActors.has(invokingUserActor)) {
+          contributors.push(_objectSpread(_objectSpread({}, _user), {}, {
+            attribution: invokingUser
+          }));
+          creditedActors.add(invokingUserActor);
+        }
+        contributors.push(_objectSpread(_objectSpread({}, agent), {}, {
+          attribution: stepAttribution,
+          connectedTo: invokingUser
+        }));
+        creditedActors.add(actor);
+        continue;
+      }
+      var user = userId ? resolveUser(userId, profilesByAccountId) : undefined;
+      if (!user) {
+        return undefined;
+      }
+      contributors.push(_objectSpread(_objectSpread({}, user), {}, {
+        attribution: stepAttribution
+      }));
+      creditedActors.add(actor);
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return contributors.length > 0 ? contributors : undefined;
+};

package/dist/esm/showDiffPlugin.js

@@ -1,23 +1,31 @@
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-var _excluded = ["stepsWithAttribution"];
+var _excluded = ["stepsWithAttribution", "contributorProfiles"];
 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 React from 'react';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { areAttributionColorGatesEnabled, resolveContributors } from './pm-plugins/decorations/colorSchemes/attributions';
 import { getDeletedWidgets as _getDeletedWidgets } from './pm-plugins/getDeletedWidgets';
 import { getScrollableDecorations } from './pm-plugins/getScrollableDecorations';
 import { createPlugin, showDiffPluginKey } from './pm-plugins/main';
+import { resolveDiffContributors } from './pm-plugins/resolveDiffContributors';
 import { IndicatorBarContentComponent } from './ui/IndicatorBar/IndicatorBarContentComponent';
 var normalizeShowDiffParams = function normalizeShowDiffParams(params) {
   if (!params || !('stepsWithAttribution' in params)) {
+    // Cleared so a previous attributed diff's contributors cannot leak onto an unattributed one.
     return params ? _objectSpread(_objectSpread({}, params), {}, {
-      stepAttributions: []
+      stepAttributions: [],
+      contributors: undefined
     }) : params;
   }
   var stepsWithAttribution = params.stepsWithAttribution,
+    contributorProfiles = params.contributorProfiles,
     rest = _objectWithoutProperties(params, _excluded);
   return _objectSpread(_objectSpread({}, rest), {}, {
+    // Resolved and keyed at the public boundary so both the contributor model and the attribution-key
+    // format stay internal.
+    contributors: areAttributionColorGatesEnabled() ? resolveContributors(resolveDiffContributors(stepsWithAttribution, contributorProfiles)) : undefined,
     steps: stepsWithAttribution.map(function (_ref) {
       var step = _ref.step;
       return step;
@@ -70,6 +78,7 @@ export var showDiffPlugin = function showDiffPlugin(_ref3) {
         return tr.setMeta(showDiffPluginKey, {
           steps: [],
           stepAttributions: [],
+          contributors: undefined,
           action: 'HIDE_DIFF'
         });
       },
@@ -89,9 +98,12 @@ export var showDiffPlugin = function showDiffPlugin(_ref3) {
     pmPlugins: function pmPlugins() {
       return [{
         name: 'showDiffPlugin',
+        // Contributor tags mount into their own decoration widgets through the portal
+        // provider, the way the rest of the editor renders React into decorations.
         plugin: function plugin(_ref8) {
-          var getIntl = _ref8.getIntl;
-          return createPlugin(config, getIntl, api, setEditorView);
+          var getIntl = _ref8.getIntl,
+            nodeViewPortalProviderAPI = _ref8.nodeViewPortalProviderAPI;
+          return createPlugin(config, getIntl, api, nodeViewPortalProviderAPI, setEditorView);
         }
       }];
     },
@@ -99,9 +111,11 @@ export var showDiffPlugin = function showDiffPlugin(_ref3) {
       if (!expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
         return null;
       }
-      return /*#__PURE__*/React.createElement(IndicatorBarContentComponent, {
+      // Rendered here so it shares the DOM context of the decoration anchor spans. Contributor
+      // tags are not: each one mounts into the host element its own decoration draws.
+      return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(IndicatorBarContentComponent, {
         api: api
-      });
+      }));
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {
@@ -119,6 +133,7 @@ export var showDiffPlugin = function showDiffPlugin(_ref3) {
         activeIndex: pluginState === null || pluginState === void 0 ? void 0 : pluginState.activeIndex,
         numberOfChanges: decorationCount.length
       }, expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
+        contributorTags: pluginState === null || pluginState === void 0 ? void 0 : pluginState.contributorTags,
         diffDescriptors: pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffDescriptors,
         showIndicators: pluginState === null || pluginState === void 0 ? void 0 : pluginState.showIndicators
       } : {});

package/dist/esm/ui/ContributorTag/ContributorTag.compiled.css

@@ -0,0 +1,29 @@
+._11c8wadc{font:var(--ds-font-body-small,normal 400 9pt/1pc "Atlassian Sans",ui-sans-serif,-apple-system,BlinkMacSystemFont,"Segoe UI",Ubuntu,"Helvetica Neue",sans-serif)}
+._2rko12b0{border-radius:var(--ds-radius-small,4px)}
+._zulp1b66{gap:var(--ds-space-050,4px)}
+._18zr1b66{padding-inline:var(--ds-space-050,4px)}
+._1rjcv77o{padding-block:var(--ds-space-025,2px)}
+._12l2r5cr{margin-inline-end:var(--ds-space-negative-050,-4px)}
+._16qs130s{box-shadow:var(--ds-shadow-overlay,0 8px 9pt #1e1f2126,0 0 1px #1e1f214f)}
+._18m915vq{overflow-y:hidden}
+._1bto1l2s{text-overflow:ellipsis}
+._1doc1dm9{border-bottom-width:var(--ds-border-width-selected,2px)}
+._1e02idpf{inset-inline-start:0}
+._1e0c116y{display:inline-flex}
+._1e0c1ule{display:block}
+._1il9nqa1{border-bottom-style:solid}
+._1o9zidpf{flex-shrink:0}
+._1pbykb7n{z-index:1}
+._1reo15vq{overflow-x:hidden}
+._1ul9idpf{min-width:0}
+._4cvr1h6o{align-items:center}
+._94n51osq{bottom:100%}
+._kqswstnw{position:absolute}
+._lcxv1wug{pointer-events:auto}
+._lcxvglyw{pointer-events:none}
+._o5721q9c{white-space:nowrap}
+._p12f1osq{max-width:100%}
+._tzy4idpf{opacity:0}
+._tzy4kb7n{opacity:1}
+._uiztglyw{-webkit-user-select:none;-ms-user-select:none;user-select:none}
+._vchhusvi{box-sizing:border-box}