@atlaskit/editor-shared-styles 4.3.12 → 4.3.13

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-shared-styles
 
+## 4.3.13
+
+### Patch Changes
+
+- [`5ea393c04c702`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5ea393c04c702) -
+  [ux] Reserve red for deleted content: telepointers and collab avatars now skip the red participant
+  palette slots. Behind `confluence_ncs_step_diffing_version_history`.
+- Updated dependencies
+
 ## 4.3.12
 
 ### Patch Changes

package/dist/cjs/utils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getHashCode = getHashCode;
 exports.getParticipantColor = getParticipantColor;
 var _getAgentColor = require("@atlaskit/agent-color/get-agent-color");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _consts = require("./consts");
 /**
  * Agent types with a fixed participant colour instead of an identity-derived colour.
@@ -26,6 +27,20 @@ var AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX = {
   blue: 1
 };
 
+/** The two red palette slots. Red reads as "deleted", so it never identifies a participant. */
+var RESERVED_PARTICIPANT_COLOR_INDEXES = new Set([0, 11]);
+
+/** Advances past a reserved slot, wrapping around the palette. */
+var getAssignableIndex = function getAssignableIndex(index) {
+  for (var offset = 0; offset < _consts.participantColors.length; offset++) {
+    var candidate = (index + offset) % _consts.participantColors.length;
+    if (!RESERVED_PARTICIPANT_COLOR_INDEXES.has(candidate)) {
+      return candidate;
+    }
+  }
+  return index;
+};
+
 /**
  * Generates a hash code for a given string.
  *
@@ -49,6 +64,9 @@ function getHashCode(str) {
 /**
  * Returns a fixed agent brand colour, an Agent Studio palette preference, or a hashed identity.
  *
+ * Under `confluence_ncs_step_diffing_version_history` the red slots are skipped. Fixed brand
+ * slots are exempt because none of them is red.
+ *
  * @param str - The input string used to determine the participant color.
  * @param agentType - Optional agent type supplied by agent-aware callers.
  * @returns The palette colour and index; `isFixed` prevents callers from reallocating brand colours.
@@ -66,7 +84,8 @@ function getParticipantColor(str, agentType) {
   var agentColor = agentType ? (0, _getAgentColor.getAgentColor)({
     agentId: str
   }) : undefined;
-  var index = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % _consts.participantColors.length;
+  var preferredIndex = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % _consts.participantColors.length;
+  var index = (0, _fg.fg)('confluence_ncs_step_diffing_version_history') ? getAssignableIndex(preferredIndex) : preferredIndex;
   return {
     index: index,
     color: _consts.participantColors[index]

package/dist/es2019/utils.js

@@ -1,4 +1,5 @@
 import { getAgentColor } from '@atlaskit/agent-color/get-agent-color';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { participantColors } from './consts';
 
 /**
@@ -20,6 +21,20 @@ const AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX = {
   blue: 1
 };
 
+/** The two red palette slots. Red reads as "deleted", so it never identifies a participant. */
+const RESERVED_PARTICIPANT_COLOR_INDEXES = new Set([0, 11]);
+
+/** Advances past a reserved slot, wrapping around the palette. */
+const getAssignableIndex = index => {
+  for (let offset = 0; offset < participantColors.length; offset++) {
+    const candidate = (index + offset) % participantColors.length;
+    if (!RESERVED_PARTICIPANT_COLOR_INDEXES.has(candidate)) {
+      return candidate;
+    }
+  }
+  return index;
+};
+
 /**
  * Generates a hash code for a given string.
  *
@@ -43,6 +58,9 @@ export function getHashCode(str) {
 /**
  * Returns a fixed agent brand colour, an Agent Studio palette preference, or a hashed identity.
  *
+ * Under `confluence_ncs_step_diffing_version_history` the red slots are skipped. Fixed brand
+ * slots are exempt because none of them is red.
+ *
  * @param str - The input string used to determine the participant color.
  * @param agentType - Optional agent type supplied by agent-aware callers.
  * @returns The palette colour and index; `isFixed` prevents callers from reallocating brand colours.
@@ -60,7 +78,8 @@ export function getParticipantColor(str, agentType) {
   const agentColor = agentType ? getAgentColor({
     agentId: str
   }) : undefined;
-  const index = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % participantColors.length;
+  const preferredIndex = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % participantColors.length;
+  const index = fg('confluence_ncs_step_diffing_version_history') ? getAssignableIndex(preferredIndex) : preferredIndex;
   return {
     index,
     color: participantColors[index]

package/dist/esm/utils.js

@@ -1,4 +1,5 @@
 import { getAgentColor } from '@atlaskit/agent-color/get-agent-color';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { participantColors } from './consts';
 
 /**
@@ -20,6 +21,20 @@ var AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX = {
   blue: 1
 };
 
+/** The two red palette slots. Red reads as "deleted", so it never identifies a participant. */
+var RESERVED_PARTICIPANT_COLOR_INDEXES = new Set([0, 11]);
+
+/** Advances past a reserved slot, wrapping around the palette. */
+var getAssignableIndex = function getAssignableIndex(index) {
+  for (var offset = 0; offset < participantColors.length; offset++) {
+    var candidate = (index + offset) % participantColors.length;
+    if (!RESERVED_PARTICIPANT_COLOR_INDEXES.has(candidate)) {
+      return candidate;
+    }
+  }
+  return index;
+};
+
 /**
  * Generates a hash code for a given string.
  *
@@ -43,6 +58,9 @@ export function getHashCode(str) {
 /**
  * Returns a fixed agent brand colour, an Agent Studio palette preference, or a hashed identity.
  *
+ * Under `confluence_ncs_step_diffing_version_history` the red slots are skipped. Fixed brand
+ * slots are exempt because none of them is red.
+ *
  * @param str - The input string used to determine the participant color.
  * @param agentType - Optional agent type supplied by agent-aware callers.
  * @returns The palette colour and index; `isFixed` prevents callers from reallocating brand colours.
@@ -60,7 +78,8 @@ export function getParticipantColor(str, agentType) {
   var agentColor = agentType ? getAgentColor({
     agentId: str
   }) : undefined;
-  var index = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % participantColors.length;
+  var preferredIndex = agentColor ? AGENT_COLOR_TO_PARTICIPANT_COLOR_INDEX[agentColor] : getHashCode(str) % participantColors.length;
+  var index = fg('confluence_ncs_step_diffing_version_history') ? getAssignableIndex(preferredIndex) : preferredIndex;
   return {
     index: index,
     color: participantColors[index]

package/dist/types/utils.d.ts

@@ -12,6 +12,9 @@ export declare function getHashCode(str: string): number;
 /**
  * Returns a fixed agent brand colour, an Agent Studio palette preference, or a hashed identity.
  *
+ * Under `confluence_ncs_step_diffing_version_history` the red slots are skipped. Fixed brand
+ * slots are exempt because none of them is red.
+ *
  * @param str - The input string used to determine the participant color.
  * @param agentType - Optional agent type supplied by agent-aware callers.
  * @returns The palette colour and index; `isFixed` prevents callers from reallocating brand colours.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-shared-styles",
-	"version": "4.3.12",
+	"version": "4.3.13",
 	"description": "Style values used in the editor/renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -20,16 +20,23 @@
 		"team": "Editor: Lego"
 	},
 	"platform-feature-flags": {
+		"confluence_ncs_step_diffing_version_history": {
+			"type": "boolean",
+			"referenceOnly": true
+		},
 		"platform_editor_ai_aifc_streaming": {
 			"type": "boolean"
 		}
 	},
 	"dependencies": {
-		"@atlaskit/agent-color": "^0.1.0",
+		"@atlaskit/agent-color": "^0.2.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/tmp-editor-statsig": "^199.0.0",
-		"@atlaskit/tokens": "^18.0.0",
+		"@atlaskit/tokens": "^18.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
+	},
+	"devDependencies": {
+		"@atlassian/feature-flags-test-utils": "^1.3.0"
 	}
 }