@atlaskit/editor-common 119.4.0 → 119.5.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-common
 
+## 119.5.0
+
+### Minor Changes
+
+- [`b5b6cb8261481`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b5b6cb8261481) -
+  [CCI-18813] Fix the Post Stream Review modal anchoring far from the real edit (e.g. at an
+  unrelated panel) during backend AI streaming, when the only change to that node was a layout
+  `breakout` mark (e.g. a width change). The collab-edit segment producer recorded it as a
+  reviewable segment while the AI-plugin filter dropped it, leaving the modal anchored to a node
+  with no visible diff.
+
+  The layout-mark-aware slice comparison is now shared from `@atlaskit/editor-common` (new
+  `./collab-agent-review-slice-compare` entry point exporting `slicesEqualIgnoringLocalId`) and used
+  by both sides, so a `localId`-only or `breakout`-only difference is consistently treated as no
+  change. Real content and formatting edits are still recorded.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 119.4.0
 
 ### Minor Changes

package/collab-agent-review-slice-compare/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/collab-agent-review-slice-compare",
+  "main": "../dist/cjs/collab/agent-review-slice-compare.js",
+  "module": "../dist/esm/collab/agent-review-slice-compare.js",
+  "module:es2019": "../dist/es2019/collab/agent-review-slice-compare.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/collab/agent-review-slice-compare.d.ts"
+}

package/dist/cjs/collab/agent-review-slice-compare.js

@@ -0,0 +1,99 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.slicesEqualIgnoringLocalId = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+/**
+ * ADF mark types ignored when deciding whether agent-edited content changed:
+ *
+ *   - `breakout` — a layout-width mark (`mode: wide | full-width`) that a
+ *     whole-node/whole-doc replace (e.g. `replaceDoc`) can drop, re-add or
+ *     re-value without the reviewable *content* changing.
+ *
+ * Module-private (not exported) so this file has a single public runtime export
+ * (Volt strict-mode rule), and so callers cannot diverge from the one comparison
+ * definition below.
+ */
+var IGNORED_MARK_TYPES = new Set(['breakout']);
+
+/**
+ * Deep-normalise ADF JSON for change comparison so two structures that differ
+ * ONLY by ignorable metadata compare equal. Specifically it:
+ *
+ *   - strips every `localId` (at any nesting): an ephemeral, per-node identity
+ *     stamp that lives both as a node attribute (`attrs.localId`) and as a
+ *     `fragment` mark attribute. A whole-node/whole-doc replace (e.g.
+ *     `replaceDoc`) re-emits content with FRESH localIds, so content that is
+ *     otherwise identical legitimately carries different localIds.
+ *   - drops ignorable marks (`IGNORED_MARK_TYPES`, e.g. `breakout`) from every
+ *     `marks` array, and removes a `marks` key that becomes empty so `marks: []`
+ *     and an absent `marks` compare equal.
+ *
+ * Removing these regardless of nesting handles all carriers without needing to
+ * know the schema.
+ */
+var _normaliseForChangeCompare = function normaliseForChangeCompare(value) {
+  if (Array.isArray(value)) {
+    return value.map(_normaliseForChangeCompare);
+  }
+  if (value && (0, _typeof2.default)(value) === 'object') {
+    var result = {};
+    for (var _i = 0, _Object$entries = Object.entries(value); _i < _Object$entries.length; _i++) {
+      var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
+        key = _Object$entries$_i[0],
+        child = _Object$entries$_i[1];
+      if (key === 'localId') {
+        continue;
+      }
+      if (key === 'marks' && Array.isArray(child)) {
+        var kept = child.filter(function (mark) {
+          return !(mark && (0, _typeof2.default)(mark) === 'object' && IGNORED_MARK_TYPES.has(mark.type));
+        });
+        // Drop an empty `marks` array so `marks: []` == absent `marks`.
+        if (kept.length > 0) {
+          result[key] = kept.map(_normaliseForChangeCompare);
+        }
+        continue;
+      }
+      result[key] = _normaliseForChangeCompare(child);
+    }
+    return result;
+  }
+  return value;
+};
+
+/**
+ * We cannot use `Slice.eq` here: it delegates to `Node.eq` → `Node.sameMarkup`,
+ * which `compareDeep`s ALL attributes and marks — so two paragraphs with
+ * identical text but different `localId`s (or a dropped/re-valued `breakout`) are
+ * reported as different. That would leak unchanged segments into the review
+ * whenever the AI re-stamps localIds or re-flows layout (the `replaceDoc` case).
+ * We instead compare the normalised JSON, plus the open depths (`openStart` /
+ * `openEnd`) that `Slice.eq` also considers.
+ *
+ * Shared here in `@atlaskit/editor-common` so the two sides of the Review
+ * pipeline agree on what counts as a change: the collab-edit COARSE segment
+ * producer (`getAgentEditSegments`) and the AI-plugin FINE filter
+ * (`entryHasNoChange`). If they disagreed, an edit whose only delta is a
+ * `breakout` change could be recorded as a segment (anchoring the modal) yet
+ * dropped by the filter (no diff). A breakout-only difference is not reviewable;
+ * both sides consume this to honour that consistently.
+ */
+var slicesEqualIgnoringLocalId = exports.slicesEqualIgnoringLocalId = function slicesEqualIgnoringLocalId(a, b) {
+  var _a$content$toJSON, _b$content$toJSON;
+  if (a === b) {
+    return true;
+  }
+  if (a.openStart !== b.openStart || a.openEnd !== b.openEnd) {
+    return false;
+  }
+  // `Fragment.toJSON()` returns `null` for empty content; normalise so two
+  // empty slices (whatever their provenance) still compare equal.
+  var aContent = _normaliseForChangeCompare((_a$content$toJSON = a.content.toJSON()) !== null && _a$content$toJSON !== void 0 ? _a$content$toJSON : null);
+  var bContent = _normaliseForChangeCompare((_b$content$toJSON = b.content.toJSON()) !== null && _b$content$toJSON !== void 0 ? _b$content$toJSON : null);
+  return JSON.stringify(aContent) === JSON.stringify(bContent);
+};

package/dist/cjs/monitoring/error.js

@@ -28,7 +28,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "119.3.0";
+var packageVersion = "119.4.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "119.3.0";
+var packageVersion = "119.4.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/collab/agent-review-slice-compare.js

@@ -0,0 +1,85 @@
+/**
+ * ADF mark types ignored when deciding whether agent-edited content changed:
+ *
+ *   - `breakout` — a layout-width mark (`mode: wide | full-width`) that a
+ *     whole-node/whole-doc replace (e.g. `replaceDoc`) can drop, re-add or
+ *     re-value without the reviewable *content* changing.
+ *
+ * Module-private (not exported) so this file has a single public runtime export
+ * (Volt strict-mode rule), and so callers cannot diverge from the one comparison
+ * definition below.
+ */
+const IGNORED_MARK_TYPES = new Set(['breakout']);
+
+/**
+ * Deep-normalise ADF JSON for change comparison so two structures that differ
+ * ONLY by ignorable metadata compare equal. Specifically it:
+ *
+ *   - strips every `localId` (at any nesting): an ephemeral, per-node identity
+ *     stamp that lives both as a node attribute (`attrs.localId`) and as a
+ *     `fragment` mark attribute. A whole-node/whole-doc replace (e.g.
+ *     `replaceDoc`) re-emits content with FRESH localIds, so content that is
+ *     otherwise identical legitimately carries different localIds.
+ *   - drops ignorable marks (`IGNORED_MARK_TYPES`, e.g. `breakout`) from every
+ *     `marks` array, and removes a `marks` key that becomes empty so `marks: []`
+ *     and an absent `marks` compare equal.
+ *
+ * Removing these regardless of nesting handles all carriers without needing to
+ * know the schema.
+ */
+const normaliseForChangeCompare = value => {
+  if (Array.isArray(value)) {
+    return value.map(normaliseForChangeCompare);
+  }
+  if (value && typeof value === 'object') {
+    const result = {};
+    for (const [key, child] of Object.entries(value)) {
+      if (key === 'localId') {
+        continue;
+      }
+      if (key === 'marks' && Array.isArray(child)) {
+        const kept = child.filter(mark => !(mark && typeof mark === 'object' && IGNORED_MARK_TYPES.has(mark.type)));
+        // Drop an empty `marks` array so `marks: []` == absent `marks`.
+        if (kept.length > 0) {
+          result[key] = kept.map(normaliseForChangeCompare);
+        }
+        continue;
+      }
+      result[key] = normaliseForChangeCompare(child);
+    }
+    return result;
+  }
+  return value;
+};
+
+/**
+ * We cannot use `Slice.eq` here: it delegates to `Node.eq` → `Node.sameMarkup`,
+ * which `compareDeep`s ALL attributes and marks — so two paragraphs with
+ * identical text but different `localId`s (or a dropped/re-valued `breakout`) are
+ * reported as different. That would leak unchanged segments into the review
+ * whenever the AI re-stamps localIds or re-flows layout (the `replaceDoc` case).
+ * We instead compare the normalised JSON, plus the open depths (`openStart` /
+ * `openEnd`) that `Slice.eq` also considers.
+ *
+ * Shared here in `@atlaskit/editor-common` so the two sides of the Review
+ * pipeline agree on what counts as a change: the collab-edit COARSE segment
+ * producer (`getAgentEditSegments`) and the AI-plugin FINE filter
+ * (`entryHasNoChange`). If they disagreed, an edit whose only delta is a
+ * `breakout` change could be recorded as a segment (anchoring the modal) yet
+ * dropped by the filter (no diff). A breakout-only difference is not reviewable;
+ * both sides consume this to honour that consistently.
+ */
+export const slicesEqualIgnoringLocalId = (a, b) => {
+  var _a$content$toJSON, _b$content$toJSON;
+  if (a === b) {
+    return true;
+  }
+  if (a.openStart !== b.openStart || a.openEnd !== b.openEnd) {
+    return false;
+  }
+  // `Fragment.toJSON()` returns `null` for empty content; normalise so two
+  // empty slices (whatever their provenance) still compare equal.
+  const aContent = normaliseForChangeCompare((_a$content$toJSON = a.content.toJSON()) !== null && _a$content$toJSON !== void 0 ? _a$content$toJSON : null);
+  const bContent = normaliseForChangeCompare((_b$content$toJSON = b.content.toJSON()) !== null && _b$content$toJSON !== void 0 ? _b$content$toJSON : null);
+  return JSON.stringify(aContent) === JSON.stringify(bContent);
+};

package/dist/es2019/monitoring/error.js

@@ -14,7 +14,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "119.3.0";
+const packageVersion = "119.4.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "119.3.0";
+const packageVersion = "119.4.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/collab/agent-review-slice-compare.js

@@ -0,0 +1,92 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _typeof from "@babel/runtime/helpers/typeof";
+/**
+ * ADF mark types ignored when deciding whether agent-edited content changed:
+ *
+ *   - `breakout` — a layout-width mark (`mode: wide | full-width`) that a
+ *     whole-node/whole-doc replace (e.g. `replaceDoc`) can drop, re-add or
+ *     re-value without the reviewable *content* changing.
+ *
+ * Module-private (not exported) so this file has a single public runtime export
+ * (Volt strict-mode rule), and so callers cannot diverge from the one comparison
+ * definition below.
+ */
+var IGNORED_MARK_TYPES = new Set(['breakout']);
+
+/**
+ * Deep-normalise ADF JSON for change comparison so two structures that differ
+ * ONLY by ignorable metadata compare equal. Specifically it:
+ *
+ *   - strips every `localId` (at any nesting): an ephemeral, per-node identity
+ *     stamp that lives both as a node attribute (`attrs.localId`) and as a
+ *     `fragment` mark attribute. A whole-node/whole-doc replace (e.g.
+ *     `replaceDoc`) re-emits content with FRESH localIds, so content that is
+ *     otherwise identical legitimately carries different localIds.
+ *   - drops ignorable marks (`IGNORED_MARK_TYPES`, e.g. `breakout`) from every
+ *     `marks` array, and removes a `marks` key that becomes empty so `marks: []`
+ *     and an absent `marks` compare equal.
+ *
+ * Removing these regardless of nesting handles all carriers without needing to
+ * know the schema.
+ */
+var _normaliseForChangeCompare = function normaliseForChangeCompare(value) {
+  if (Array.isArray(value)) {
+    return value.map(_normaliseForChangeCompare);
+  }
+  if (value && _typeof(value) === 'object') {
+    var result = {};
+    for (var _i = 0, _Object$entries = Object.entries(value); _i < _Object$entries.length; _i++) {
+      var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+        key = _Object$entries$_i[0],
+        child = _Object$entries$_i[1];
+      if (key === 'localId') {
+        continue;
+      }
+      if (key === 'marks' && Array.isArray(child)) {
+        var kept = child.filter(function (mark) {
+          return !(mark && _typeof(mark) === 'object' && IGNORED_MARK_TYPES.has(mark.type));
+        });
+        // Drop an empty `marks` array so `marks: []` == absent `marks`.
+        if (kept.length > 0) {
+          result[key] = kept.map(_normaliseForChangeCompare);
+        }
+        continue;
+      }
+      result[key] = _normaliseForChangeCompare(child);
+    }
+    return result;
+  }
+  return value;
+};
+
+/**
+ * We cannot use `Slice.eq` here: it delegates to `Node.eq` → `Node.sameMarkup`,
+ * which `compareDeep`s ALL attributes and marks — so two paragraphs with
+ * identical text but different `localId`s (or a dropped/re-valued `breakout`) are
+ * reported as different. That would leak unchanged segments into the review
+ * whenever the AI re-stamps localIds or re-flows layout (the `replaceDoc` case).
+ * We instead compare the normalised JSON, plus the open depths (`openStart` /
+ * `openEnd`) that `Slice.eq` also considers.
+ *
+ * Shared here in `@atlaskit/editor-common` so the two sides of the Review
+ * pipeline agree on what counts as a change: the collab-edit COARSE segment
+ * producer (`getAgentEditSegments`) and the AI-plugin FINE filter
+ * (`entryHasNoChange`). If they disagreed, an edit whose only delta is a
+ * `breakout` change could be recorded as a segment (anchoring the modal) yet
+ * dropped by the filter (no diff). A breakout-only difference is not reviewable;
+ * both sides consume this to honour that consistently.
+ */
+export var slicesEqualIgnoringLocalId = function slicesEqualIgnoringLocalId(a, b) {
+  var _a$content$toJSON, _b$content$toJSON;
+  if (a === b) {
+    return true;
+  }
+  if (a.openStart !== b.openStart || a.openEnd !== b.openEnd) {
+    return false;
+  }
+  // `Fragment.toJSON()` returns `null` for empty content; normalise so two
+  // empty slices (whatever their provenance) still compare equal.
+  var aContent = _normaliseForChangeCompare((_a$content$toJSON = a.content.toJSON()) !== null && _a$content$toJSON !== void 0 ? _a$content$toJSON : null);
+  var bContent = _normaliseForChangeCompare((_b$content$toJSON = b.content.toJSON()) !== null && _b$content$toJSON !== void 0 ? _b$content$toJSON : null);
+  return JSON.stringify(aContent) === JSON.stringify(bContent);
+};

package/dist/esm/monitoring/error.js

@@ -20,7 +20,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "119.3.0";
+var packageVersion = "119.4.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "119.3.0";
+var packageVersion = "119.4.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/collab/agent-review-slice-compare.d.ts

@@ -0,0 +1,19 @@
+import type { Slice } from '@atlaskit/editor-prosemirror/model';
+/**
+ * We cannot use `Slice.eq` here: it delegates to `Node.eq` → `Node.sameMarkup`,
+ * which `compareDeep`s ALL attributes and marks — so two paragraphs with
+ * identical text but different `localId`s (or a dropped/re-valued `breakout`) are
+ * reported as different. That would leak unchanged segments into the review
+ * whenever the AI re-stamps localIds or re-flows layout (the `replaceDoc` case).
+ * We instead compare the normalised JSON, plus the open depths (`openStart` /
+ * `openEnd`) that `Slice.eq` also considers.
+ *
+ * Shared here in `@atlaskit/editor-common` so the two sides of the Review
+ * pipeline agree on what counts as a change: the collab-edit COARSE segment
+ * producer (`getAgentEditSegments`) and the AI-plugin FINE filter
+ * (`entryHasNoChange`). If they disagreed, an edit whose only delta is a
+ * `breakout` change could be recorded as a segment (anchoring the modal) yet
+ * dropped by the filter (no diff). A breakout-only difference is not reviewable;
+ * both sides consume this to honour that consistently.
+ */
+export declare const slicesEqualIgnoringLocalId: (a: Slice, b: Slice) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "119.4.0",
+	"version": "119.5.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -49,7 +49,7 @@
 		"@atlaskit/editor-tables": "^3.0.0",
 		"@atlaskit/editor-toolbar": "^2.4.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
-		"@atlaskit/editor-ui-control-model": "^2.6.0",
+		"@atlaskit/editor-ui-control-model": "^2.7.0",
 		"@atlaskit/emoji": "^71.17.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/icon": "^37.3.0",
@@ -84,7 +84,7 @@
 		"@atlaskit/task-decision": "^21.8.0",
 		"@atlaskit/teams-app-config": "^2.2.0",
 		"@atlaskit/textfield": "^10.0.0",
-		"@atlaskit/tmp-editor-statsig": "^147.1.0",
+		"@atlaskit/tmp-editor-statsig": "^148.0.0",
 		"@atlaskit/tokens": "^16.7.0",
 		"@atlaskit/tooltip": "^24.0.0",
 		"@atlaskit/width-detector": "^7.0.0",