@atlaskit/editor-plugin-local-id 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-local-id
 
+## 4.2.0
+
+### Minor Changes
+
+- [`5167552fe1a93`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5167552fe1a93) -
+  [EDITOR-2339] Bump @atlaskit/adf-schema to 51.3.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.1.0
 
 ### Minor Changes

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

@@ -1,10 +1,13 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.localIdPluginKey = exports.createPlugin = exports.addLocalIdToNode = void 0;
+exports.localIdPluginKey = exports.createPlugin = exports.batchAddLocalIdToNodes = exports.addLocalIdToNode = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _adfSchema = require("@atlaskit/adf-schema");
+var _steps = require("@atlaskit/adf-schema/steps");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -35,6 +38,8 @@ var createPlugin = exports.createPlugin = function createPlugin() {
       requestIdleCallbackWithFallback(function () {
         var tr = editorView.state.tr;
         var localIdWasAdded = false;
+        var nodesToUpdate = new Map(); // position -> localId
+
         var _editorView$state$sch = editorView.state.schema.nodes,
           text = _editorView$state$sch.text,
           hardBreak = _editorView$state$sch.hardBreak,
@@ -45,14 +50,21 @@ var createPlugin = exports.createPlugin = function createPlugin() {
         editorView.state.doc.descendants(function (node, pos) {
           var _node$type$spec$attrs;
           if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
-            localIdWasAdded = true;
-            addLocalIdToNode(pos, tr);
+            if ((0, _platformFeatureFlags.fg)('platform_editor_localid_improvements')) {
+              nodesToUpdate.set(pos, _adfSchema.uuid.generate());
+            } else {
+              localIdWasAdded = true;
+              addLocalIdToNode(pos, tr);
+            }
           }
           return true; // Continue traversing
         });
-
-        // Only dispatch the transaction if we actually added local IDs
-        if (localIdWasAdded) {
+        if ((0, _platformFeatureFlags.fg)('platform_editor_localid_improvements')) {
+          if (nodesToUpdate.size > 0) {
+            batchAddLocalIdToNodes(nodesToUpdate, tr);
+            editorView.dispatch(tr);
+          }
+        } else if (localIdWasAdded) {
           tr.setMeta('addToHistory', false);
           editorView.dispatch(tr);
         }
@@ -78,6 +90,7 @@ var createPlugin = exports.createPlugin = function createPlugin() {
       var addedNodes = new Set();
       var addedNodePos = new Map();
       var localIds = new Set();
+      var nodesToUpdate = new Map(); // position -> localId
 
       // Process only the nodes added in the transactions
       transactions.forEach(function (transaction) {
@@ -114,7 +127,12 @@ var createPlugin = exports.createPlugin = function createPlugin() {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(pos, tr);
+                  if ((0, _platformFeatureFlags.fg)('platform_editor_localid_improvements')) {
+                    nodesToUpdate.set(pos, _adfSchema.uuid.generate());
+                  } else {
+                    // Legacy behavior - individual steps
+                    addLocalIdToNode(pos, tr);
+                  }
                 }
               }
               return true;
@@ -138,7 +156,11 @@ var createPlugin = exports.createPlugin = function createPlugin() {
             if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
               var pos = addedNodePos.get(node);
               if (pos !== undefined) {
-                addLocalIdToNode(pos, tr);
+                if ((0, _platformFeatureFlags.fg)('platform_editor_localid_improvements')) {
+                  nodesToUpdate.set(pos, _adfSchema.uuid.generate());
+                } else {
+                  addLocalIdToNode(pos, tr);
+                }
                 modified = true;
               }
             }
@@ -149,6 +171,13 @@ var createPlugin = exports.createPlugin = function createPlugin() {
           _iterator.f();
         }
       }
+
+      // Apply local ID updates based on the improvements feature flag:
+      // - When enabled: Batch all updates into a single BatchAttrsStep
+      // - When disabled: Individual steps were already applied above during node processing
+      if (modified && nodesToUpdate.size > 0 && (0, _platformFeatureFlags.fg)('platform_editor_localid_improvements')) {
+        batchAddLocalIdToNodes(nodesToUpdate, tr);
+      }
       return modified ? tr : undefined;
     }
   });
@@ -164,4 +193,30 @@ var createPlugin = exports.createPlugin = function createPlugin() {
 var addLocalIdToNode = exports.addLocalIdToNode = function addLocalIdToNode(pos, tr) {
   tr.setNodeAttribute(pos, 'localId', _adfSchema.uuid.generate());
   tr.setMeta('addToHistory', false);
+};
+
+/**
+ * Batch adds local IDs to nodes using a BatchAttrsStep
+ * @param nodesToUpdate Map of position -> localId for nodes that need updates
+ * @param tr
+ */
+var batchAddLocalIdToNodes = exports.batchAddLocalIdToNodes = function batchAddLocalIdToNodes(nodesToUpdate, tr) {
+  var batchData = Array.from(nodesToUpdate.entries()).map(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      pos = _ref2[0],
+      localId = _ref2[1];
+    var node = tr.doc.nodeAt(pos);
+    if (!node) {
+      throw new Error("Node does not exist at position ".concat(pos));
+    }
+    return {
+      position: pos,
+      attrs: {
+        localId: localId
+      },
+      nodeType: node.type.name
+    };
+  });
+  tr.step(new _steps.BatchAttrsStep(batchData));
+  tr.setMeta('addToHistory', false);
 };

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

@@ -1,4 +1,5 @@
 import { uuid } from '@atlaskit/adf-schema';
+import { BatchAttrsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -26,6 +27,8 @@ export const createPlugin = () => {
       requestIdleCallbackWithFallback(() => {
         const tr = editorView.state.tr;
         let localIdWasAdded = false;
+        const nodesToUpdate = new Map(); // position -> localId
+
         const {
           text,
           hardBreak,
@@ -37,14 +40,21 @@ export const createPlugin = () => {
         editorView.state.doc.descendants((node, pos) => {
           var _node$type$spec$attrs;
           if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
-            localIdWasAdded = true;
-            addLocalIdToNode(pos, tr);
+            if (fg('platform_editor_localid_improvements')) {
+              nodesToUpdate.set(pos, uuid.generate());
+            } else {
+              localIdWasAdded = true;
+              addLocalIdToNode(pos, tr);
+            }
           }
           return true; // Continue traversing
         });
-
-        // Only dispatch the transaction if we actually added local IDs
-        if (localIdWasAdded) {
+        if (fg('platform_editor_localid_improvements')) {
+          if (nodesToUpdate.size > 0) {
+            batchAddLocalIdToNodes(nodesToUpdate, tr);
+            editorView.dispatch(tr);
+          }
+        } else if (localIdWasAdded) {
           tr.setMeta('addToHistory', false);
           editorView.dispatch(tr);
         }
@@ -71,6 +81,7 @@ export const createPlugin = () => {
       const addedNodes = new Set();
       const addedNodePos = new Map();
       const localIds = new Set();
+      const nodesToUpdate = new Map(); // position -> localId
 
       // Process only the nodes added in the transactions
       transactions.forEach(transaction => {
@@ -107,7 +118,12 @@ export const createPlugin = () => {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(pos, tr);
+                  if (fg('platform_editor_localid_improvements')) {
+                    nodesToUpdate.set(pos, uuid.generate());
+                  } else {
+                    // Legacy behavior - individual steps
+                    addLocalIdToNode(pos, tr);
+                  }
                 }
               }
               return true;
@@ -127,12 +143,23 @@ export const createPlugin = () => {
           if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
             const pos = addedNodePos.get(node);
             if (pos !== undefined) {
-              addLocalIdToNode(pos, tr);
+              if (fg('platform_editor_localid_improvements')) {
+                nodesToUpdate.set(pos, uuid.generate());
+              } else {
+                addLocalIdToNode(pos, tr);
+              }
               modified = true;
             }
           }
         }
       }
+
+      // Apply local ID updates based on the improvements feature flag:
+      // - When enabled: Batch all updates into a single BatchAttrsStep
+      // - When disabled: Individual steps were already applied above during node processing
+      if (modified && nodesToUpdate.size > 0 && fg('platform_editor_localid_improvements')) {
+        batchAddLocalIdToNodes(nodesToUpdate, tr);
+      }
       return modified ? tr : undefined;
     }
   });
@@ -148,4 +175,27 @@ export const createPlugin = () => {
 export const addLocalIdToNode = (pos, tr) => {
   tr.setNodeAttribute(pos, 'localId', uuid.generate());
   tr.setMeta('addToHistory', false);
+};
+
+/**
+ * Batch adds local IDs to nodes using a BatchAttrsStep
+ * @param nodesToUpdate Map of position -> localId for nodes that need updates
+ * @param tr
+ */
+export const batchAddLocalIdToNodes = (nodesToUpdate, tr) => {
+  const batchData = Array.from(nodesToUpdate.entries()).map(([pos, localId]) => {
+    const node = tr.doc.nodeAt(pos);
+    if (!node) {
+      throw new Error(`Node does not exist at position ${pos}`);
+    }
+    return {
+      position: pos,
+      attrs: {
+        localId
+      },
+      nodeType: node.type.name
+    };
+  });
+  tr.step(new BatchAttrsStep(batchData));
+  tr.setMeta('addToHistory', false);
 };

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

@@ -1,7 +1,9 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 import { uuid } from '@atlaskit/adf-schema';
+import { BatchAttrsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -29,6 +31,8 @@ export var createPlugin = function createPlugin() {
       requestIdleCallbackWithFallback(function () {
         var tr = editorView.state.tr;
         var localIdWasAdded = false;
+        var nodesToUpdate = new Map(); // position -> localId
+
         var _editorView$state$sch = editorView.state.schema.nodes,
           text = _editorView$state$sch.text,
           hardBreak = _editorView$state$sch.hardBreak,
@@ -39,14 +43,21 @@ export var createPlugin = function createPlugin() {
         editorView.state.doc.descendants(function (node, pos) {
           var _node$type$spec$attrs;
           if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
-            localIdWasAdded = true;
-            addLocalIdToNode(pos, tr);
+            if (fg('platform_editor_localid_improvements')) {
+              nodesToUpdate.set(pos, uuid.generate());
+            } else {
+              localIdWasAdded = true;
+              addLocalIdToNode(pos, tr);
+            }
           }
           return true; // Continue traversing
         });
-
-        // Only dispatch the transaction if we actually added local IDs
-        if (localIdWasAdded) {
+        if (fg('platform_editor_localid_improvements')) {
+          if (nodesToUpdate.size > 0) {
+            batchAddLocalIdToNodes(nodesToUpdate, tr);
+            editorView.dispatch(tr);
+          }
+        } else if (localIdWasAdded) {
           tr.setMeta('addToHistory', false);
           editorView.dispatch(tr);
         }
@@ -72,6 +83,7 @@ export var createPlugin = function createPlugin() {
       var addedNodes = new Set();
       var addedNodePos = new Map();
       var localIds = new Set();
+      var nodesToUpdate = new Map(); // position -> localId
 
       // Process only the nodes added in the transactions
       transactions.forEach(function (transaction) {
@@ -108,7 +120,12 @@ export var createPlugin = function createPlugin() {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(pos, tr);
+                  if (fg('platform_editor_localid_improvements')) {
+                    nodesToUpdate.set(pos, uuid.generate());
+                  } else {
+                    // Legacy behavior - individual steps
+                    addLocalIdToNode(pos, tr);
+                  }
                 }
               }
               return true;
@@ -132,7 +149,11 @@ export var createPlugin = function createPlugin() {
             if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
               var pos = addedNodePos.get(node);
               if (pos !== undefined) {
-                addLocalIdToNode(pos, tr);
+                if (fg('platform_editor_localid_improvements')) {
+                  nodesToUpdate.set(pos, uuid.generate());
+                } else {
+                  addLocalIdToNode(pos, tr);
+                }
                 modified = true;
               }
             }
@@ -143,6 +164,13 @@ export var createPlugin = function createPlugin() {
           _iterator.f();
         }
       }
+
+      // Apply local ID updates based on the improvements feature flag:
+      // - When enabled: Batch all updates into a single BatchAttrsStep
+      // - When disabled: Individual steps were already applied above during node processing
+      if (modified && nodesToUpdate.size > 0 && fg('platform_editor_localid_improvements')) {
+        batchAddLocalIdToNodes(nodesToUpdate, tr);
+      }
       return modified ? tr : undefined;
     }
   });
@@ -158,4 +186,30 @@ export var createPlugin = function createPlugin() {
 export var addLocalIdToNode = function addLocalIdToNode(pos, tr) {
   tr.setNodeAttribute(pos, 'localId', uuid.generate());
   tr.setMeta('addToHistory', false);
+};
+
+/**
+ * Batch adds local IDs to nodes using a BatchAttrsStep
+ * @param nodesToUpdate Map of position -> localId for nodes that need updates
+ * @param tr
+ */
+export var batchAddLocalIdToNodes = function batchAddLocalIdToNodes(nodesToUpdate, tr) {
+  var batchData = Array.from(nodesToUpdate.entries()).map(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+      pos = _ref2[0],
+      localId = _ref2[1];
+    var node = tr.doc.nodeAt(pos);
+    if (!node) {
+      throw new Error("Node does not exist at position ".concat(pos));
+    }
+    return {
+      position: pos,
+      attrs: {
+        localId: localId
+      },
+      nodeType: node.type.name
+    };
+  });
+  tr.step(new BatchAttrsStep(batchData));
+  tr.setMeta('addToHistory', false);
 };

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

@@ -11,3 +11,9 @@ export declare const createPlugin: () => SafePlugin<any>;
  * @param tr - The transaction to apply the change to
  */
 export declare const addLocalIdToNode: (pos: number, tr: Transaction) => void;
+/**
+ * Batch adds local IDs to nodes using a BatchAttrsStep
+ * @param nodesToUpdate Map of position -> localId for nodes that need updates
+ * @param tr
+ */
+export declare const batchAddLocalIdToNodes: (nodesToUpdate: Map<number, string>, tr: Transaction) => void;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -11,3 +11,9 @@ export declare const createPlugin: () => SafePlugin<any>;
  * @param tr - The transaction to apply the change to
  */
 export declare const addLocalIdToNode: (pos: number, tr: Transaction) => void;
+/**
+ * Batch adds local IDs to nodes using a BatchAttrsStep
+ * @param nodesToUpdate Map of position -> localId for nodes that need updates
+ * @param tr
+ */
+export declare const batchAddLocalIdToNodes: (nodesToUpdate: Map<number, string>, tr: Transaction) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-local-id",
-	"version": "4.1.0",
+	"version": "4.2.0",
 	"description": "LocalId plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,14 +28,14 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.2.0",
+		"@atlaskit/adf-schema": "^51.3.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"raf-schd": "^4.0.3"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.4.0",
+		"@atlaskit/editor-common": "^110.14.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -80,6 +80,9 @@
 	"platform-feature-flags": {
 		"platform_editor_use_localid_dedupe": {
 			"type": "boolean"
+		},
+		"platform_editor_localid_improvements": {
+			"type": "boolean"
 		}
 	}
 }