@atlaskit/editor-plugin-collab-edit 31.0.6 → 32.0.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 32.0.0
+
+### Major Changes
+
+- [`88f6eda39f497`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/88f6eda39f497) -
+  Resolve agent telepointer colours from supplied display names and stable named IDs instead of
+  machine types. Under `confluence_ncs_step_diffing_version_history`, collab-provider carries
+  `agentId`, `agentName` and `agentNamedId` from received steps into local agent presence, retaining
+  known metadata when later steps omit it. This path uses no profile lookups. Missing presentation
+  metadata uses the generic agent palette; human participants keep their existing colours.
+
+  Telepointers identify agent participants from these explicit identity fields rather than
+  `agentType` or a human participant's display name.
+
+  `getParticipantColor(id, agentName?, agentNamedId?)` and
+  `collabEdit.actions.getAvatarColor(id, agentName?, agentNamedId?)` now accept a resolved display
+  name in the second argument. Callers previously passing a machine type should supply the agent's
+  name instead, and pass stable named IDs in the third argument. With
+  `confluence_ncs_step_diffing_version_history` enabled, named brand metadata takes precedence over
+  the display name. With the gate off, brand lookup is disabled. Human callers should continue to
+  omit agent metadata.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 31.0.6
 
 ### Patch Changes

package/dist/cjs/pm-plugins/main/plugin-state.js

@@ -29,6 +29,13 @@ var getValidPos = exports.getValidPos = function getValidPos(tr, pos) {
   }
   return endOfDocPos;
 };
+var getAgentName = function getAgentName(participant) {
+  var _participant$agentNam;
+  return (
+    // Explicit agent identity selects the agent palette without classifying human display names.
+    participant !== null && participant !== void 0 && participant.agentName || participant !== null && participant !== void 0 && participant.agentNamedId || participant !== null && participant !== void 0 && participant.agentId ? ((_participant$agentNam = participant.agentName) === null || _participant$agentNam === void 0 ? void 0 : _participant$agentNam.trim()) || participant.name.trim() || 'Agent' : undefined
+  );
+};
 var PluginState = exports.PluginState = /*#__PURE__*/function () {
   function PluginState(decorations, participants, sessionId) {
     var collabInitalised = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
@@ -152,7 +159,7 @@ var PluginState = exports.PluginState = /*#__PURE__*/function () {
           } catch (err) {
             this.onError(err);
           }
-          add = add.concat((0, _utils.createTelepointers)(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), (0, _utils.hasExistingNudge)(sessionId, this.nudgeAnimations), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentType));
+          add = add.concat((0, _utils.createTelepointers)(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), (0, _utils.hasExistingNudge)(sessionId, this.nudgeAnimations), getAgentName(participants.get(sessionId)), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentNamedId));
         }
       }
       if (tr.docChanged) {
@@ -172,7 +179,7 @@ var PluginState = exports.PluginState = /*#__PURE__*/function () {
                     size = _ref.slice.content.size,
                     _from = _ref.from;
                   var pos = getValidPos(tr, size ? Math.min(_from + size, tr.doc.nodeSize - 3) : Math.max(_from, 1));
-                  add = add.concat((0, _utils.createTelepointers)(pos, pos, _sessionId, false, _this.getInitial(_sessionId), presenceId, _this.getFullName(_sessionId), (0, _utils.hasExistingNudge)(_sessionId, _this.nudgeAnimations), (_participants$get2 = participants.get(_sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentType));
+                  add = add.concat((0, _utils.createTelepointers)(pos, pos, _sessionId, false, _this.getInitial(_sessionId), presenceId, _this.getFullName(_sessionId), (0, _utils.hasExistingNudge)(_sessionId, _this.nudgeAnimations), getAgentName(participants.get(_sessionId)), (_participants$get2 = participants.get(_sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentNamedId));
                 }
               }
             }

package/dist/cjs/pm-plugins/utils.js

@@ -35,17 +35,17 @@ function style(options) {
   var borderWidth = "var(--ds-border-width-focused, 2px)";
   return "border-right: ".concat(borderWidth, " solid ").concat(color, "; margin-right: calc(-1 * ").concat(borderWidth, "); z-index: 1");
 }
-function getAvatarColor(str, agentType) {
-  var participantColor = (0, _utils.getParticipantColor)(str, (0, _fg.fg)('confluence_ncs_step_diffing_version_history') ? agentType : undefined);
+function getAvatarColor(str, agentName, agentNamedId) {
+  var participantColor = (0, _utils.getParticipantColor)(str, (0, _fg.fg)('confluence_ncs_step_diffing_version_history') ? agentName : undefined, (0, _fg.fg)('confluence_ncs_step_diffing_version_history') ? agentNamedId : undefined);
   return {
     index: participantColor.index,
     backgroundColor: participantColor.color.backgroundColor,
     textColor: participantColor.color.textColor
   };
 }
-var createTelepointers = exports.createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentType) {
+var createTelepointers = exports.createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentName, agentNamedId) {
   var decorations = [];
-  var avatarColor = getAvatarColor(presenceId, agentType);
+  var avatarColor = getAvatarColor(presenceId, agentName, agentNamedId);
   var color = avatarColor.index.toString();
   if (isSelection) {
     var className = "telepointer color-".concat(color, " telepointer-selection");

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

@@ -21,6 +21,13 @@ export const getValidPos = (tr, pos) => {
   }
   return endOfDocPos;
 };
+const getAgentName = participant => {
+  var _participant$agentNam;
+  return (
+    // Explicit agent identity selects the agent palette without classifying human display names.
+    participant !== null && participant !== void 0 && participant.agentName || participant !== null && participant !== void 0 && participant.agentNamedId || participant !== null && participant !== void 0 && participant.agentId ? ((_participant$agentNam = participant.agentName) === null || _participant$agentNam === void 0 ? void 0 : _participant$agentNam.trim()) || participant.name.trim() || 'Agent' : undefined
+  );
+};
 export class PluginState {
   get decorations() {
     return this.decorationSet;
@@ -126,7 +133,7 @@ export class PluginState {
         } catch (err) {
           this.onError(err);
         }
-        add = add.concat(createTelepointers(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentType));
+        add = add.concat(createTelepointers(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), getAgentName(participants.get(sessionId)), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentNamedId));
       }
     }
     if (tr.docChanged) {
@@ -154,7 +161,7 @@ export class PluginState {
                   // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 } = step;
                 const pos = getValidPos(tr, size ? Math.min(from + size, tr.doc.nodeSize - 3) : Math.max(from, 1));
-                add = add.concat(createTelepointers(pos, pos, sessionId, false, this.getInitial(sessionId), presenceId, this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), (_participants$get2 = participants.get(sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentType));
+                add = add.concat(createTelepointers(pos, pos, sessionId, false, this.getInitial(sessionId), presenceId, this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), getAgentName(participants.get(sessionId)), (_participants$get2 = participants.get(sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentNamedId));
               }
             }
           }

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

@@ -23,17 +23,17 @@ function style(options) {
   const borderWidth = "var(--ds-border-width-focused, 2px)";
   return `border-right: ${borderWidth} solid ${color}; margin-right: calc(-1 * ${borderWidth}); z-index: 1`;
 }
-export function getAvatarColor(str, agentType) {
-  const participantColor = getParticipantColor(str, fg('confluence_ncs_step_diffing_version_history') ? agentType : undefined);
+export function getAvatarColor(str, agentName, agentNamedId) {
+  const participantColor = getParticipantColor(str, fg('confluence_ncs_step_diffing_version_history') ? agentName : undefined, fg('confluence_ncs_step_diffing_version_history') ? agentNamedId : undefined);
   return {
     index: participantColor.index,
     backgroundColor: participantColor.color.backgroundColor,
     textColor: participantColor.color.textColor
   };
 }
-export const createTelepointers = (from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentType) => {
+export const createTelepointers = (from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentName, agentNamedId) => {
   const decorations = [];
-  const avatarColor = getAvatarColor(presenceId, agentType);
+  const avatarColor = getAvatarColor(presenceId, agentName, agentNamedId);
   const color = avatarColor.index.toString();
   if (isSelection) {
     const className = `telepointer color-${color} telepointer-selection`;

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

@@ -23,6 +23,13 @@ export var getValidPos = function getValidPos(tr, pos) {
   }
   return endOfDocPos;
 };
+var getAgentName = function getAgentName(participant) {
+  var _participant$agentNam;
+  return (
+    // Explicit agent identity selects the agent palette without classifying human display names.
+    participant !== null && participant !== void 0 && participant.agentName || participant !== null && participant !== void 0 && participant.agentNamedId || participant !== null && participant !== void 0 && participant.agentId ? ((_participant$agentNam = participant.agentName) === null || _participant$agentNam === void 0 ? void 0 : _participant$agentNam.trim()) || participant.name.trim() || 'Agent' : undefined
+  );
+};
 export var PluginState = /*#__PURE__*/function () {
   function PluginState(decorations, participants, sessionId) {
     var collabInitalised = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
@@ -146,7 +153,7 @@ export var PluginState = /*#__PURE__*/function () {
           } catch (err) {
             this.onError(err);
           }
-          add = add.concat(createTelepointers(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentType));
+          add = add.concat(createTelepointers(from, to, sessionId, isSelection, this.getInitial(sessionId), this.getPresenceId(sessionId), this.getFullName(sessionId), hasExistingNudge(sessionId, this.nudgeAnimations), getAgentName(participants.get(sessionId)), (_participants$get = participants.get(sessionId)) === null || _participants$get === void 0 ? void 0 : _participants$get.agentNamedId));
         }
       }
       if (tr.docChanged) {
@@ -166,7 +173,7 @@ export var PluginState = /*#__PURE__*/function () {
                     size = _ref.slice.content.size,
                     _from = _ref.from;
                   var pos = getValidPos(tr, size ? Math.min(_from + size, tr.doc.nodeSize - 3) : Math.max(_from, 1));
-                  add = add.concat(createTelepointers(pos, pos, _sessionId, false, _this.getInitial(_sessionId), presenceId, _this.getFullName(_sessionId), hasExistingNudge(_sessionId, _this.nudgeAnimations), (_participants$get2 = participants.get(_sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentType));
+                  add = add.concat(createTelepointers(pos, pos, _sessionId, false, _this.getInitial(_sessionId), presenceId, _this.getFullName(_sessionId), hasExistingNudge(_sessionId, _this.nudgeAnimations), getAgentName(participants.get(_sessionId)), (_participants$get2 = participants.get(_sessionId)) === null || _participants$get2 === void 0 ? void 0 : _participants$get2.agentNamedId));
                 }
               }
             }

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

@@ -26,17 +26,17 @@ function style(options) {
   var borderWidth = "var(--ds-border-width-focused, 2px)";
   return "border-right: ".concat(borderWidth, " solid ").concat(color, "; margin-right: calc(-1 * ").concat(borderWidth, "); z-index: 1");
 }
-export function getAvatarColor(str, agentType) {
-  var participantColor = getParticipantColor(str, fg('confluence_ncs_step_diffing_version_history') ? agentType : undefined);
+export function getAvatarColor(str, agentName, agentNamedId) {
+  var participantColor = getParticipantColor(str, fg('confluence_ncs_step_diffing_version_history') ? agentName : undefined, fg('confluence_ncs_step_diffing_version_history') ? agentNamedId : undefined);
   return {
     index: participantColor.index,
     backgroundColor: participantColor.color.backgroundColor,
     textColor: participantColor.color.textColor
   };
 }
-export var createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentType) {
+export var createTelepointers = function createTelepointers(from, to, sessionId, isSelection, initial, presenceId, fullName, isNudged, agentName, agentNamedId) {
   var decorations = [];
-  var avatarColor = getAvatarColor(presenceId, agentType);
+  var avatarColor = getAvatarColor(presenceId, agentName, agentNamedId);
   var color = avatarColor.index.toString();
   if (isSelection) {
     var className = "telepointer color-".concat(color, " telepointer-selection");

package/dist/types/collabEditPluginType.d.ts

@@ -26,7 +26,7 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
             mark: Mark;
             pos: number;
         }) => boolean;
-        getAvatarColor: (str: string, agentType?: string) => {
+        getAvatarColor: (str: string, agentName?: string, agentNamedId?: string) => {
             backgroundColor: string;
             index: number;
             textColor: string;

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

@@ -7,12 +7,12 @@ import type { Step } from '@atlaskit/editor-prosemirror/transform-override';
 import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 export declare const findPointers: (id: string, decorations: DecorationSet) => Decoration[];
-export declare function getAvatarColor(str: string, agentType?: string): {
+export declare function getAvatarColor(str: string, agentName?: string, agentNamedId?: string): {
     backgroundColor: string;
     index: number;
     textColor: string;
 };
-export declare const createTelepointers: (from: number, to: number, sessionId: string, isSelection: boolean, initial: string, presenceId: string, fullName: string, isNudged: boolean, agentType?: string) => Decoration[];
+export declare const createTelepointers: (from: number, to: number, sessionId: string, isSelection: boolean, initial: string, presenceId: string, fullName: string, isNudged: boolean, agentName?: string, agentNamedId?: string) => Decoration[];
 export declare const replaceDocument: (doc: any, state: EditorState, version?: number, options?: CollabEditOptions, reserveCursor?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI) => Transaction;
 export declare const scrollToCollabCursor: (editorView: EditorView, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
 export declare const getPositionOfTelepointer: (sessionId: string, decorationSet: DecorationSet) => undefined | number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "31.0.6",
+	"version": "32.0.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 		"@atlaskit/editor-plugin-editor-viewmode": "^32.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^29.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
-		"@atlaskit/editor-shared-styles": "^4.6.0",
+		"@atlaskit/editor-shared-styles": "^5.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/prosemirror-collab": "^1.1.0",
@@ -37,7 +37,7 @@
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^134.3.0",
+		"@atlaskit/editor-common": "^134.4.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0"
 	},