@atlaskit/editor-plugin-collab-edit 16.0.3 → 16.0.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 16.0.4
+
+### Patch Changes
+
+- [`e2d9151b3bd46`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e2d9151b3bd46) -
+  Fix the agent edit shimmer/telepointer appearing on a panel (or other block) the agent did not
+  meaningfully change during backend streaming. The collab apply can stamp a same-size re-write on
+  an unrelated node (e.g. a `localId`/`breakout` re-stamp on a panel) whose StepMap still reports
+  new content, so the shimmer highlighted the whole block despite no visible change. The shimmer now
+  skips same-size steps whose before/after content is equal ignoring identity-only metadata
+  (`localId`) and layout-only marks (`breakout`), reusing the shared `slicesEqualIgnoringLocalId`
+  helper — matching the Review-moment segment producer's guard.
+- Updated dependencies
+
 ## 16.0.3
 
 ### Patch Changes

package/dist/cjs/pm-plugins/main/agent-shimmer-ranges.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isPositionNeutralStep = exports.getAgentShimmerRanges = void 0;
+var _collabAgentReviewSliceCompare = require("@atlaskit/editor-common/collab-agent-review-slice-compare");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 // When an agent step lands we cover the top-level block(s) it wrote with a skeleton-loader shimmer
@@ -120,6 +121,7 @@ var getAgentShimmerRanges = exports.getAgentShimmerRanges = function getAgentShi
 
     var infos = [];
     json.forEach(function (rawStep, index) {
+      var _tr$docs$index;
       if (typeof (rawStep === null || rawStep === void 0 ? void 0 : rawStep.agentType) !== 'string') {
         return;
       }
@@ -128,13 +130,33 @@ var getAgentShimmerRanges = exports.getAgentShimmerRanges = function getAgentShi
       if (typeof (pmStep === null || pmStep === void 0 ? void 0 : pmStep.getMap) !== 'function') {
         return;
       }
-      pmStep.getMap().forEach(function (_oldStart, _oldEnd, newStart, newEnd) {
+      // The doc this step was applied to (its `old` coords resolve here). `tr.docs[index]` is the
+      // document state before step `index`; fall back to the batch's before-doc for the first step.
+      var beforeDoc = (_tr$docs$index = tr.docs[index]) !== null && _tr$docs$index !== void 0 ? _tr$docs$index : tr.before;
+      pmStep.getMap().forEach(function (oldStart, oldEnd, newStart, newEnd) {
         if (newEnd <= newStart) {
           return; // pure deletion / attribute-only — no new content to highlight
         }
+        var from = mapToFinalDoc(newStart, index, -1);
+        var to = mapToFinalDoc(newEnd, index, 1);
+        // Skip phantom same-size re-writes (e.g. a `localId`/breakout re-stamp on an untouched
+        // panel): their StepMap reports new content but nothing visibly changed. Drop only when
+        // before/after are equal ignoring `localId` and layout marks, so real same-size edits
+        // still shimmer. Mirrors the Review-moment segment producer's guard.
+        if (oldEnd - oldStart === newEnd - newStart) {
+          try {
+            var before = beforeDoc.slice(oldStart, oldEnd);
+            var after = tr.doc.slice(from, to);
+            if ((0, _collabAgentReviewSliceCompare.slicesEqualIgnoringLocalId)(before, after)) {
+              return;
+            }
+          } catch (_unused) {
+            // Comparison unsafe: keep the range; whole-block expansion still renders it.
+          }
+        }
         infos.push({
-          from: mapToFinalDoc(newStart, index, -1),
-          to: mapToFinalDoc(newEnd, index, 1)
+          from: from,
+          to: to
         });
       });
     });

package/dist/es2019/pm-plugins/main/agent-shimmer-ranges.js

@@ -1,3 +1,4 @@
+import { slicesEqualIgnoringLocalId } from '@atlaskit/editor-common/collab-agent-review-slice-compare';
 import { getCollabState } from '@atlaskit/prosemirror-collab';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 // When an agent step lands we cover the top-level block(s) it wrote with a skeleton-loader shimmer
@@ -106,6 +107,7 @@ export const getAgentShimmerRanges = (json, steps, tr, view, shimmerDurationMs,
 
     const infos = [];
     json.forEach((rawStep, index) => {
+      var _tr$docs$index;
       if (typeof (rawStep === null || rawStep === void 0 ? void 0 : rawStep.agentType) !== 'string') {
         return;
       }
@@ -114,13 +116,33 @@ export const getAgentShimmerRanges = (json, steps, tr, view, shimmerDurationMs,
       if (typeof (pmStep === null || pmStep === void 0 ? void 0 : pmStep.getMap) !== 'function') {
         return;
       }
-      pmStep.getMap().forEach((_oldStart, _oldEnd, newStart, newEnd) => {
+      // The doc this step was applied to (its `old` coords resolve here). `tr.docs[index]` is the
+      // document state before step `index`; fall back to the batch's before-doc for the first step.
+      const beforeDoc = (_tr$docs$index = tr.docs[index]) !== null && _tr$docs$index !== void 0 ? _tr$docs$index : tr.before;
+      pmStep.getMap().forEach((oldStart, oldEnd, newStart, newEnd) => {
         if (newEnd <= newStart) {
           return; // pure deletion / attribute-only — no new content to highlight
         }
+        const from = mapToFinalDoc(newStart, index, -1);
+        const to = mapToFinalDoc(newEnd, index, 1);
+        // Skip phantom same-size re-writes (e.g. a `localId`/breakout re-stamp on an untouched
+        // panel): their StepMap reports new content but nothing visibly changed. Drop only when
+        // before/after are equal ignoring `localId` and layout marks, so real same-size edits
+        // still shimmer. Mirrors the Review-moment segment producer's guard.
+        if (oldEnd - oldStart === newEnd - newStart) {
+          try {
+            const before = beforeDoc.slice(oldStart, oldEnd);
+            const after = tr.doc.slice(from, to);
+            if (slicesEqualIgnoringLocalId(before, after)) {
+              return;
+            }
+          } catch {
+            // Comparison unsafe: keep the range; whole-block expansion still renders it.
+          }
+        }
         infos.push({
-          from: mapToFinalDoc(newStart, index, -1),
-          to: mapToFinalDoc(newEnd, index, 1)
+          from,
+          to
         });
       });
     });

package/dist/esm/pm-plugins/main/agent-shimmer-ranges.js

@@ -1,3 +1,4 @@
+import { slicesEqualIgnoringLocalId } from '@atlaskit/editor-common/collab-agent-review-slice-compare';
 import { getCollabState } from '@atlaskit/prosemirror-collab';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 // When an agent step lands we cover the top-level block(s) it wrote with a skeleton-loader shimmer
@@ -114,6 +115,7 @@ export var getAgentShimmerRanges = function getAgentShimmerRanges(json, steps, t
 
     var infos = [];
     json.forEach(function (rawStep, index) {
+      var _tr$docs$index;
       if (typeof (rawStep === null || rawStep === void 0 ? void 0 : rawStep.agentType) !== 'string') {
         return;
       }
@@ -122,13 +124,33 @@ export var getAgentShimmerRanges = function getAgentShimmerRanges(json, steps, t
       if (typeof (pmStep === null || pmStep === void 0 ? void 0 : pmStep.getMap) !== 'function') {
         return;
       }
-      pmStep.getMap().forEach(function (_oldStart, _oldEnd, newStart, newEnd) {
+      // The doc this step was applied to (its `old` coords resolve here). `tr.docs[index]` is the
+      // document state before step `index`; fall back to the batch's before-doc for the first step.
+      var beforeDoc = (_tr$docs$index = tr.docs[index]) !== null && _tr$docs$index !== void 0 ? _tr$docs$index : tr.before;
+      pmStep.getMap().forEach(function (oldStart, oldEnd, newStart, newEnd) {
         if (newEnd <= newStart) {
           return; // pure deletion / attribute-only — no new content to highlight
         }
+        var from = mapToFinalDoc(newStart, index, -1);
+        var to = mapToFinalDoc(newEnd, index, 1);
+        // Skip phantom same-size re-writes (e.g. a `localId`/breakout re-stamp on an untouched
+        // panel): their StepMap reports new content but nothing visibly changed. Drop only when
+        // before/after are equal ignoring `localId` and layout marks, so real same-size edits
+        // still shimmer. Mirrors the Review-moment segment producer's guard.
+        if (oldEnd - oldStart === newEnd - newStart) {
+          try {
+            var before = beforeDoc.slice(oldStart, oldEnd);
+            var after = tr.doc.slice(from, to);
+            if (slicesEqualIgnoringLocalId(before, after)) {
+              return;
+            }
+          } catch (_unused) {
+            // Comparison unsafe: keep the range; whole-block expansion still renders it.
+          }
+        }
         infos.push({
-          from: mapToFinalDoc(newStart, index, -1),
-          to: mapToFinalDoc(newEnd, index, 1)
+          from: from,
+          to: to
         });
       });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "16.0.3",
+	"version": "16.0.4",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,7 +38,7 @@
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.7.0",
+		"@atlaskit/editor-common": "^119.8.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0"
 	},