@atlaskit/editor-plugin-annotation 6.2.13 → 6.3.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-annotation
 
+## 6.3.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.3.0
+
+### Minor Changes
+
+- [`2bab449c372a5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2bab449c372a5) -
+  sync annotations state when delete and undo
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.2.13
 
 ### Patch Changes

package/dist/cjs/pm-plugins/plugin-factory.js

@@ -9,6 +9,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _reducer = _interopRequireDefault(require("./reducer"));
 var _utils2 = require("./utils");
 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; }
@@ -22,6 +23,60 @@ var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
   });
 };
 
+/**
+ * Creates a handleDocChanged function with its own deleted annotations cache.
+ * This ensures each editor instance has its own cache, avoiding cross-contamination.
+ */
+var createHandleDocChanged = function createHandleDocChanged() {
+  // Cache for preserving deleted annotation resolved states through delete/undo cycles
+  // This lives in closure scope per editor instance to avoid serialization and reduce state size
+  var deletedAnnotationsCache = {};
+  return function (tr, prevPluginState) {
+    if (tr.getMeta('replaceDocument')) {
+      return _objectSpread(_objectSpread({}, prevPluginState), {}, {
+        dirtyAnnotations: true
+      });
+    }
+    var updatedState = getSelectionChangedHandler(false)(tr, prevPluginState);
+
+    // Collect annotation IDs currently in the document
+    var annotationIdsInDocument = new Set();
+    tr.doc.descendants(function (node) {
+      node.marks.forEach(function (mark) {
+        if (mark.type.name === 'annotation') {
+          annotationIdsInDocument.add(mark.attrs.id);
+        }
+      });
+    });
+    var annotationIdsInState = Object.keys(prevPluginState.annotations);
+
+    // Early return if annotations haven't changed
+    var annotationsHaveChanged = annotationIdsInDocument.size !== annotationIdsInState.length || annotationIdsInState.some(function (id) {
+      return !annotationIdsInDocument.has(id);
+    });
+    if (!annotationsHaveChanged) {
+      return updatedState;
+    }
+
+    // Cache deleted annotations to be able to restore their resolved states on undo
+    var updatedAnnotations = {};
+    annotationIdsInState.forEach(function (id) {
+      if (!annotationIdsInDocument.has(id)) {
+        deletedAnnotationsCache[id] = prevPluginState.annotations[id];
+      }
+    });
+
+    // Update annotations to match document state, preserving resolved states through delete/undo
+    annotationIdsInDocument.forEach(function (id) {
+      var _ref, _prevPluginState$anno;
+      updatedAnnotations[id] = (_ref = (_prevPluginState$anno = prevPluginState.annotations[id]) !== null && _prevPluginState$anno !== void 0 ? _prevPluginState$anno : deletedAnnotationsCache[id]) !== null && _ref !== void 0 ? _ref : false;
+    });
+    return _objectSpread(_objectSpread({}, updatedState), {}, {
+      annotations: updatedAnnotations
+    });
+  };
+};
+
 /**
  * We clear bookmark on the following conditions:
  * 1. if current selection is an empty selection, or
@@ -145,9 +200,19 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
     getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
   };
 };
+
+// Create the handler with cache once at module level
+var handleDocChangedWithSync = createHandleDocChanged();
+var getDocChangedHandler = function getDocChangedHandler(tr, prevPluginState) {
+  // Check feature flag at runtime to support test variants
+  if ((0, _expValEquals.expValEquals)('platform_editor_annotations_sync_on_docchange', 'isEnabled', true)) {
+    return handleDocChangedWithSync(tr, prevPluginState);
+  }
+  return handleDocChanged(tr, prevPluginState);
+};
 var _pluginFactory = (0, _utils.pluginFactory)(_utils2.inlineCommentPluginKey, _reducer.default, {
     onSelectionChanged: getSelectionChangedHandler(true),
-    onDocChanged: handleDocChanged,
+    onDocChanged: getDocChangedHandler,
     mapping: function mapping(tr, pluginState, editorState) {
       var draftDecorationSet = pluginState.draftDecorationSet,
         bookmark = pluginState.bookmark;

package/dist/es2019/pm-plugins/plugin-factory.js

@@ -1,6 +1,7 @@
 import { pluginFactory } from '@atlaskit/editor-common/utils';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import reducer from './reducer';
 import { decorationKey, findAnnotationsInSelection, inlineCommentPluginKey, isBlockNodeAnnotationsSelected, isSelectedAnnotationsChanged } from './utils';
 const handleDocChanged = (tr, prevPluginState) => {
@@ -13,6 +14,60 @@ const handleDocChanged = (tr, prevPluginState) => {
   };
 };
 
+/**
+ * Creates a handleDocChanged function with its own deleted annotations cache.
+ * This ensures each editor instance has its own cache, avoiding cross-contamination.
+ */
+const createHandleDocChanged = () => {
+  // Cache for preserving deleted annotation resolved states through delete/undo cycles
+  // This lives in closure scope per editor instance to avoid serialization and reduce state size
+  const deletedAnnotationsCache = {};
+  return (tr, prevPluginState) => {
+    if (tr.getMeta('replaceDocument')) {
+      return {
+        ...prevPluginState,
+        dirtyAnnotations: true
+      };
+    }
+    const updatedState = getSelectionChangedHandler(false)(tr, prevPluginState);
+
+    // Collect annotation IDs currently in the document
+    const annotationIdsInDocument = new Set();
+    tr.doc.descendants(node => {
+      node.marks.forEach(mark => {
+        if (mark.type.name === 'annotation') {
+          annotationIdsInDocument.add(mark.attrs.id);
+        }
+      });
+    });
+    const annotationIdsInState = Object.keys(prevPluginState.annotations);
+
+    // Early return if annotations haven't changed
+    const annotationsHaveChanged = annotationIdsInDocument.size !== annotationIdsInState.length || annotationIdsInState.some(id => !annotationIdsInDocument.has(id));
+    if (!annotationsHaveChanged) {
+      return updatedState;
+    }
+
+    // Cache deleted annotations to be able to restore their resolved states on undo
+    const updatedAnnotations = {};
+    annotationIdsInState.forEach(id => {
+      if (!annotationIdsInDocument.has(id)) {
+        deletedAnnotationsCache[id] = prevPluginState.annotations[id];
+      }
+    });
+
+    // Update annotations to match document state, preserving resolved states through delete/undo
+    annotationIdsInDocument.forEach(id => {
+      var _ref, _prevPluginState$anno;
+      updatedAnnotations[id] = (_ref = (_prevPluginState$anno = prevPluginState.annotations[id]) !== null && _prevPluginState$anno !== void 0 ? _prevPluginState$anno : deletedAnnotationsCache[id]) !== null && _ref !== void 0 ? _ref : false;
+    });
+    return {
+      ...updatedState,
+      annotations: updatedAnnotations
+    };
+  };
+};
+
 /**
  * We clear bookmark on the following conditions:
  * 1. if current selection is an empty selection, or
@@ -144,12 +199,22 @@ const getSelectionChangedHandler = reopenCommentView => (tr, pluginState) => plu
 getSelectionChangeHandlerNew(reopenCommentView)(tr, pluginState) :
 // else if platform_editor_comments_api_manager == false
 getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
+
+// Create the handler with cache once at module level
+const handleDocChangedWithSync = createHandleDocChanged();
+const getDocChangedHandler = (tr, prevPluginState) => {
+  // Check feature flag at runtime to support test variants
+  if (expValEquals('platform_editor_annotations_sync_on_docchange', 'isEnabled', true)) {
+    return handleDocChangedWithSync(tr, prevPluginState);
+  }
+  return handleDocChanged(tr, prevPluginState);
+};
 export const {
   createPluginState,
   createCommand
 } = pluginFactory(inlineCommentPluginKey, reducer, {
   onSelectionChanged: getSelectionChangedHandler(true),
-  onDocChanged: handleDocChanged,
+  onDocChanged: getDocChangedHandler,
   mapping: (tr, pluginState, editorState) => {
     const {
       draftDecorationSet,

package/dist/esm/pm-plugins/plugin-factory.js

@@ -4,6 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { pluginFactory } from '@atlaskit/editor-common/utils';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import reducer from './reducer';
 import { decorationKey, findAnnotationsInSelection, inlineCommentPluginKey, isBlockNodeAnnotationsSelected, isSelectedAnnotationsChanged } from './utils';
 var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
@@ -15,6 +16,60 @@ var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
   });
 };
 
+/**
+ * Creates a handleDocChanged function with its own deleted annotations cache.
+ * This ensures each editor instance has its own cache, avoiding cross-contamination.
+ */
+var createHandleDocChanged = function createHandleDocChanged() {
+  // Cache for preserving deleted annotation resolved states through delete/undo cycles
+  // This lives in closure scope per editor instance to avoid serialization and reduce state size
+  var deletedAnnotationsCache = {};
+  return function (tr, prevPluginState) {
+    if (tr.getMeta('replaceDocument')) {
+      return _objectSpread(_objectSpread({}, prevPluginState), {}, {
+        dirtyAnnotations: true
+      });
+    }
+    var updatedState = getSelectionChangedHandler(false)(tr, prevPluginState);
+
+    // Collect annotation IDs currently in the document
+    var annotationIdsInDocument = new Set();
+    tr.doc.descendants(function (node) {
+      node.marks.forEach(function (mark) {
+        if (mark.type.name === 'annotation') {
+          annotationIdsInDocument.add(mark.attrs.id);
+        }
+      });
+    });
+    var annotationIdsInState = Object.keys(prevPluginState.annotations);
+
+    // Early return if annotations haven't changed
+    var annotationsHaveChanged = annotationIdsInDocument.size !== annotationIdsInState.length || annotationIdsInState.some(function (id) {
+      return !annotationIdsInDocument.has(id);
+    });
+    if (!annotationsHaveChanged) {
+      return updatedState;
+    }
+
+    // Cache deleted annotations to be able to restore their resolved states on undo
+    var updatedAnnotations = {};
+    annotationIdsInState.forEach(function (id) {
+      if (!annotationIdsInDocument.has(id)) {
+        deletedAnnotationsCache[id] = prevPluginState.annotations[id];
+      }
+    });
+
+    // Update annotations to match document state, preserving resolved states through delete/undo
+    annotationIdsInDocument.forEach(function (id) {
+      var _ref, _prevPluginState$anno;
+      updatedAnnotations[id] = (_ref = (_prevPluginState$anno = prevPluginState.annotations[id]) !== null && _prevPluginState$anno !== void 0 ? _prevPluginState$anno : deletedAnnotationsCache[id]) !== null && _ref !== void 0 ? _ref : false;
+    });
+    return _objectSpread(_objectSpread({}, updatedState), {}, {
+      annotations: updatedAnnotations
+    });
+  };
+};
+
 /**
  * We clear bookmark on the following conditions:
  * 1. if current selection is an empty selection, or
@@ -138,9 +193,19 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
     getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
   };
 };
+
+// Create the handler with cache once at module level
+var handleDocChangedWithSync = createHandleDocChanged();
+var getDocChangedHandler = function getDocChangedHandler(tr, prevPluginState) {
+  // Check feature flag at runtime to support test variants
+  if (expValEquals('platform_editor_annotations_sync_on_docchange', 'isEnabled', true)) {
+    return handleDocChangedWithSync(tr, prevPluginState);
+  }
+  return handleDocChanged(tr, prevPluginState);
+};
 var _pluginFactory = pluginFactory(inlineCommentPluginKey, reducer, {
     onSelectionChanged: getSelectionChangedHandler(true),
-    onDocChanged: handleDocChanged,
+    onDocChanged: getDocChangedHandler,
     mapping: function mapping(tr, pluginState, editorState) {
       var draftDecorationSet = pluginState.draftDecorationSet,
         bookmark = pluginState.bookmark;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "6.2.13",
+	"version": "6.3.1",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,12 +39,12 @@
 		"@atlaskit/editor-toolbar-model": "^0.2.0",
 		"@atlaskit/icon": "^29.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^14.5.0",
+		"@atlaskit/tmp-editor-statsig": "^15.0.0",
 		"@babel/runtime": "^7.0.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.38.0",
+		"@atlaskit/editor-common": "^110.40.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},