@atlaskit/editor-plugin-local-id 13.0.3 → 13.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-local-id
 
+## 13.1.0
+
+### Minor Changes
+
+- [`bbd0908b16b23`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bbd0908b16b23) -
+  Under `platform_editor_local_id_reliability`, improve local ID reliability by validating blank IDs
+  and rescanning the document before Rovo reads it.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 13.0.3
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -32,6 +32,9 @@
 		{
 			"path": "../../editor-prosemirror/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../../platform/feature-experiments/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
 		},

package/dist/cjs/editor-commands/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addMissingLocalIds = void 0;
+var _addMissingLocalIds = require("../pm-plugins/add-missing-local-ids");
+/**
+ * Scans the current document and adds missing local IDs.
+ */
+var addMissingLocalIds = exports.addMissingLocalIds = function addMissingLocalIds() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return function (_ref) {
+    var tr = _ref.tr;
+    if (!(0, _addMissingLocalIds.addMissingLocalIdsToDocument)(tr, options)) {
+      return null;
+    }
+    return tr;
+  };
+};

package/dist/cjs/localIdPlugin.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.localIdPlugin = void 0;
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _editorActions = require("./editor-actions");
+var _editorCommands = require("./editor-commands");
 var _main = require("./pm-plugins/main");
 var _watchmen = require("./pm-plugins/watchmen");
 var localIdPlugin = exports.localIdPlugin = function localIdPlugin(_ref) {
@@ -16,6 +17,9 @@ var localIdPlugin = exports.localIdPlugin = function localIdPlugin(_ref) {
       replaceNode: (0, _editorActions.replaceNode)(api),
       getNode: (0, _editorActions.getNode)(api)
     },
+    commands: {
+      addMissingLocalIds: _editorCommands.addMissingLocalIds
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'localIdPlugin',

package/dist/cjs/pm-plugins/add-missing-local-ids.js

@@ -0,0 +1,71 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.localIdNotEmpty = exports.batchAddLocalIdToNodes = exports.addMissingLocalIdsToDocument = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _steps = require("@atlaskit/adf-schema/steps");
+var _collab = require("@atlaskit/editor-common/collab");
+var _generateShortUUID = require("./generateShortUUID");
+var localIdNotEmpty = exports.localIdNotEmpty = function localIdNotEmpty(localId) {
+  return typeof localId === 'string' && localId.trim().length > 0;
+};
+var addMissingLocalIdsToDocument = exports.addMissingLocalIdsToDocument = function addMissingLocalIdsToDocument(tr) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    onRepaired = _ref.onRepaired;
+  var missingLocalIdPositions = [];
+  var _tr$doc$type$schema$n = tr.doc.type.schema.nodes,
+    text = _tr$doc$type$schema$n.text,
+    hardBreak = _tr$doc$type$schema$n.hardBreak,
+    mediaGroup = _tr$doc$type$schema$n.mediaGroup;
+  var ignoredNodeTypes = [text === null || text === void 0 ? void 0 : text.name, hardBreak === null || hardBreak === void 0 ? void 0 : hardBreak.name, mediaGroup === null || mediaGroup === void 0 ? void 0 : mediaGroup.name];
+  tr.doc.descendants(function (node, pos) {
+    var _node$type$spec$attrs;
+    if (localIdNotEmpty(node.attrs.localId)) {
+      _generateShortUUID.generatedShortUUIDs.add(node.attrs.localId);
+    } else if (!ignoredNodeTypes.includes(node.type.name) && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
+      missingLocalIdPositions.push(pos);
+    }
+    return true;
+  });
+  var nodesToUpdate = new Map(missingLocalIdPositions.map(function (pos) {
+    return [pos, (0, _generateShortUUID.generateShortUUID)()];
+  }));
+  if (nodesToUpdate.size === 0) {
+    return false;
+  }
+  batchAddLocalIdToNodes(nodesToUpdate, tr);
+  (0, _collab.tintDirtyTransaction)(tr);
+  onRepaired === null || onRepaired === void 0 || onRepaired({
+    repairedNodeCount: nodesToUpdate.size
+  });
+  return true;
+};
+
+/**
+ * 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 (_ref2) {
+    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+      pos = _ref3[0],
+      localId = _ref3[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/cjs/pm-plugins/main.js

@@ -4,15 +4,17 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.localIdPluginKey = exports.createPlugin = exports.batchAddLocalIdToNodes = void 0;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+exports.localIdPluginKey = exports.createPlugin = void 0;
 var _toArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toArray"));
 var _steps = require("@atlaskit/adf-schema/steps");
 var _collab = require("@atlaskit/editor-common/collab");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+var _editorCommands = require("../editor-commands");
+var _addMissingLocalIds = require("./add-missing-local-ids");
 var _generateShortUUID = require("./generateShortUUID");
 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; } }
@@ -48,6 +50,10 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
         };
       }
       requestIdleCallbackWithFallback(function () {
+        if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_local_id_reliability')) {
+          api === null || api === void 0 || api.core.actions.execute((0, _editorCommands.addMissingLocalIds)());
+          return;
+        }
         var tr = editorView.state.tr;
         var nodesToUpdate = new Map(); // position -> localId
 
@@ -66,7 +72,7 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
           return true; // Continue traversing
         });
         if (nodesToUpdate.size > 0) {
-          batchAddLocalIdToNodes(nodesToUpdate, tr);
+          (0, _addMissingLocalIds.batchAddLocalIdToNodes)(nodesToUpdate, tr);
           (0, _collab.tintDirtyTransaction)(tr);
           editorView.dispatch(tr);
         }
@@ -190,7 +196,7 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
               continue;
             }
             var existingId = node.attrs.localId;
-            var needsNewIds = !existingId || localIds.has(existingId) || seenIds.has(existingId);
+            var needsNewIds = ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_local_id_reliability') ? !(0, _addMissingLocalIds.localIdNotEmpty)(existingId) : !existingId) || localIds.has(existingId) || seenIds.has(existingId);
             if (needsNewIds) {
               // No usable localId: assign a fresh unique one to every position.
               var _iterator2 = _createForOfIteratorHelper(positions),
@@ -245,34 +251,9 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
       // - 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) {
-        batchAddLocalIdToNodes(nodesToUpdate, tr);
+        (0, _addMissingLocalIds.batchAddLocalIdToNodes)(nodesToUpdate, tr);
       }
       return modified ? tr : undefined;
     }
   });
-};
-/**
- * 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/editor-commands/index.js

@@ -0,0 +1,13 @@
+import { addMissingLocalIdsToDocument } from '../pm-plugins/add-missing-local-ids';
+
+/**
+ * Scans the current document and adds missing local IDs.
+ */
+export const addMissingLocalIds = (options = {}) => ({
+  tr
+}) => {
+  if (!addMissingLocalIdsToDocument(tr, options)) {
+    return null;
+  }
+  return tr;
+};

package/dist/es2019/localIdPlugin.js

@@ -1,5 +1,6 @@
 import { fg } from '@atlaskit/platform-feature-flags';
 import { replaceNode, getNode } from './editor-actions';
+import { addMissingLocalIds } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { createWatchmenPlugin, localIdWatchmenPluginKey } from './pm-plugins/watchmen';
 export const localIdPlugin = ({
@@ -10,6 +11,9 @@ export const localIdPlugin = ({
     replaceNode: replaceNode(api),
     getNode: getNode(api)
   },
+  commands: {
+    addMissingLocalIds
+  },
   pmPlugins() {
     return [{
       name: 'localIdPlugin',

package/dist/es2019/pm-plugins/add-missing-local-ids.js

@@ -0,0 +1,57 @@
+import { BatchAttrsStep } from '@atlaskit/adf-schema/steps';
+import { tintDirtyTransaction } from '@atlaskit/editor-common/collab';
+import { generateShortUUID, generatedShortUUIDs } from './generateShortUUID';
+export const localIdNotEmpty = localId => typeof localId === 'string' && localId.trim().length > 0;
+export const addMissingLocalIdsToDocument = (tr, {
+  onRepaired
+} = {}) => {
+  const missingLocalIdPositions = [];
+  const {
+    text,
+    hardBreak,
+    mediaGroup
+  } = tr.doc.type.schema.nodes;
+  const ignoredNodeTypes = [text === null || text === void 0 ? void 0 : text.name, hardBreak === null || hardBreak === void 0 ? void 0 : hardBreak.name, mediaGroup === null || mediaGroup === void 0 ? void 0 : mediaGroup.name];
+  tr.doc.descendants((node, pos) => {
+    var _node$type$spec$attrs;
+    if (localIdNotEmpty(node.attrs.localId)) {
+      generatedShortUUIDs.add(node.attrs.localId);
+    } else if (!ignoredNodeTypes.includes(node.type.name) && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
+      missingLocalIdPositions.push(pos);
+    }
+    return true;
+  });
+  const nodesToUpdate = new Map(missingLocalIdPositions.map(pos => [pos, generateShortUUID()]));
+  if (nodesToUpdate.size === 0) {
+    return false;
+  }
+  batchAddLocalIdToNodes(nodesToUpdate, tr);
+  tintDirtyTransaction(tr);
+  onRepaired === null || onRepaired === void 0 ? void 0 : onRepaired({
+    repairedNodeCount: nodesToUpdate.size
+  });
+  return true;
+};
+
+/**
+ * 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/es2019/pm-plugins/main.js

@@ -1,9 +1,12 @@
-import { BatchAttrsStep, OverrideDocumentStep } from '@atlaskit/adf-schema/steps';
+import { OverrideDocumentStep } from '@atlaskit/adf-schema/steps';
 import { tintDirtyTransaction } from '@atlaskit/editor-common/collab';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { addMissingLocalIds } from '../editor-commands';
+import { batchAddLocalIdToNodes, localIdNotEmpty } from './add-missing-local-ids';
 import { generateShortUUID, generatedShortUUIDs } from './generateShortUUID';
 export const localIdPluginKey = new PluginKey('localIdPlugin');
 const generateUUID = () => {
@@ -36,6 +39,10 @@ export const createPlugin = api => {
         };
       }
       requestIdleCallbackWithFallback(() => {
+        if (isExperimentEnabled('platform_editor_local_id_reliability')) {
+          api === null || api === void 0 ? void 0 : api.core.actions.execute(addMissingLocalIds());
+          return;
+        }
         const tr = editorView.state.tr;
         const nodesToUpdate = new Map(); // position -> localId
 
@@ -174,7 +181,7 @@ export const createPlugin = api => {
             continue;
           }
           const existingId = node.attrs.localId;
-          const needsNewIds = !existingId || localIds.has(existingId) || seenIds.has(existingId);
+          const needsNewIds = (isExperimentEnabled('platform_editor_local_id_reliability') ? !localIdNotEmpty(existingId) : !existingId) || localIds.has(existingId) || seenIds.has(existingId);
           if (needsNewIds) {
             // No usable localId: assign a fresh unique one to every position.
             for (const pos of positions) {
@@ -208,26 +215,4 @@ export const createPlugin = api => {
       return modified ? tr : undefined;
     }
   });
-};
-/**
- * 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/editor-commands/index.js

@@ -0,0 +1,15 @@
+import { addMissingLocalIdsToDocument } from '../pm-plugins/add-missing-local-ids';
+
+/**
+ * Scans the current document and adds missing local IDs.
+ */
+export var addMissingLocalIds = function addMissingLocalIds() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return function (_ref) {
+    var tr = _ref.tr;
+    if (!addMissingLocalIdsToDocument(tr, options)) {
+      return null;
+    }
+    return tr;
+  };
+};

package/dist/esm/localIdPlugin.js

@@ -1,5 +1,6 @@
 import { fg } from '@atlaskit/platform-feature-flags';
 import { replaceNode, getNode } from './editor-actions';
+import { addMissingLocalIds } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { createWatchmenPlugin, localIdWatchmenPluginKey } from './pm-plugins/watchmen';
 export var localIdPlugin = function localIdPlugin(_ref) {
@@ -10,6 +11,9 @@ export var localIdPlugin = function localIdPlugin(_ref) {
       replaceNode: replaceNode(api),
       getNode: getNode(api)
     },
+    commands: {
+      addMissingLocalIds: addMissingLocalIds
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'localIdPlugin',

package/dist/esm/pm-plugins/add-missing-local-ids.js

@@ -0,0 +1,64 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { BatchAttrsStep } from '@atlaskit/adf-schema/steps';
+import { tintDirtyTransaction } from '@atlaskit/editor-common/collab';
+import { generateShortUUID, generatedShortUUIDs } from './generateShortUUID';
+export var localIdNotEmpty = function localIdNotEmpty(localId) {
+  return typeof localId === 'string' && localId.trim().length > 0;
+};
+export var addMissingLocalIdsToDocument = function addMissingLocalIdsToDocument(tr) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    onRepaired = _ref.onRepaired;
+  var missingLocalIdPositions = [];
+  var _tr$doc$type$schema$n = tr.doc.type.schema.nodes,
+    text = _tr$doc$type$schema$n.text,
+    hardBreak = _tr$doc$type$schema$n.hardBreak,
+    mediaGroup = _tr$doc$type$schema$n.mediaGroup;
+  var ignoredNodeTypes = [text === null || text === void 0 ? void 0 : text.name, hardBreak === null || hardBreak === void 0 ? void 0 : hardBreak.name, mediaGroup === null || mediaGroup === void 0 ? void 0 : mediaGroup.name];
+  tr.doc.descendants(function (node, pos) {
+    var _node$type$spec$attrs;
+    if (localIdNotEmpty(node.attrs.localId)) {
+      generatedShortUUIDs.add(node.attrs.localId);
+    } else if (!ignoredNodeTypes.includes(node.type.name) && !!((_node$type$spec$attrs = node.type.spec.attrs) !== null && _node$type$spec$attrs !== void 0 && _node$type$spec$attrs.localId)) {
+      missingLocalIdPositions.push(pos);
+    }
+    return true;
+  });
+  var nodesToUpdate = new Map(missingLocalIdPositions.map(function (pos) {
+    return [pos, generateShortUUID()];
+  }));
+  if (nodesToUpdate.size === 0) {
+    return false;
+  }
+  batchAddLocalIdToNodes(nodesToUpdate, tr);
+  tintDirtyTransaction(tr);
+  onRepaired === null || onRepaired === void 0 || onRepaired({
+    repairedNodeCount: nodesToUpdate.size
+  });
+  return true;
+};
+
+/**
+ * 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 (_ref2) {
+    var _ref3 = _slicedToArray(_ref2, 2),
+      pos = _ref3[0],
+      localId = _ref3[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/esm/pm-plugins/main.js

@@ -1,14 +1,16 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _toArray from "@babel/runtime/helpers/toArray";
 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 { BatchAttrsStep, OverrideDocumentStep } from '@atlaskit/adf-schema/steps';
+import { OverrideDocumentStep } from '@atlaskit/adf-schema/steps';
 import { tintDirtyTransaction } from '@atlaskit/editor-common/collab';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { addMissingLocalIds } from '../editor-commands';
+import { batchAddLocalIdToNodes, localIdNotEmpty } from './add-missing-local-ids';
 import { generateShortUUID, generatedShortUUIDs } from './generateShortUUID';
 export var localIdPluginKey = new PluginKey('localIdPlugin');
 var generateUUID = function generateUUID() {
@@ -41,6 +43,10 @@ export var createPlugin = function createPlugin(api) {
         };
       }
       requestIdleCallbackWithFallback(function () {
+        if (isExperimentEnabled('platform_editor_local_id_reliability')) {
+          api === null || api === void 0 || api.core.actions.execute(addMissingLocalIds());
+          return;
+        }
         var tr = editorView.state.tr;
         var nodesToUpdate = new Map(); // position -> localId
 
@@ -183,7 +189,7 @@ export var createPlugin = function createPlugin(api) {
               continue;
             }
             var existingId = node.attrs.localId;
-            var needsNewIds = !existingId || localIds.has(existingId) || seenIds.has(existingId);
+            var needsNewIds = (isExperimentEnabled('platform_editor_local_id_reliability') ? !localIdNotEmpty(existingId) : !existingId) || localIds.has(existingId) || seenIds.has(existingId);
             if (needsNewIds) {
               // No usable localId: assign a fresh unique one to every position.
               var _iterator2 = _createForOfIteratorHelper(positions),
@@ -243,29 +249,4 @@ export var createPlugin = function createPlugin(api) {
       return modified ? tr : undefined;
     }
   });
-};
-/**
- * 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/editor-commands/index.d.ts

@@ -0,0 +1,6 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { AddMissingLocalIdsOptions } from '../localIdPluginType';
+/**
+ * Scans the current document and adds missing local IDs.
+ */
+export declare const addMissingLocalIds: (options?: AddMissingLocalIdsOptions) => EditorCommand;

package/dist/types/localIdPluginType.d.ts

@@ -1,4 +1,4 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { CollabEditPlugin } from '@atlaskit/editor-plugin-collab-edit';
 import type { CompositionPlugin } from '@atlaskit/editor-plugin-composition';
 import type { LimitedModePlugin } from '@atlaskit/editor-plugin-limited-mode';
@@ -7,6 +7,11 @@ import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
 export type ActionProps = {
     localId: string;
 };
+export type AddMissingLocalIdsOptions = {
+    onRepaired?: (payload: {
+        repairedNodeCount: number;
+    }) => void;
+};
 export type LocalIdStatusCode = 'current' | 'localChangeByAttr' | 'localChangeBySetAttrs' | 'localChangeByBatchAttrs' | 'localChangeByReplace' | 'localChangeByDelete' | 'localChangeByReplaceAround' | 'localChangeByUnknown' | 'remoteChangeByAttr' | 'remoteChangeBySetAttrs' | 'remoteChangeByBatchAttrs' | 'remoteChangeByReplace' | 'remoteChangeByDelete' | 'remoteChangeByReplaceAround' | 'remoteChangeByUnknown' | 'AIChangeByAttr' | 'AIChangeBySetAttrs' | 'AIChangeByBatchAttrs' | 'AIChangeByReplace' | 'AIChangeByDelete' | 'AIChangeByReplaceAround' | 'AIChangeByUnknown' | 'docChangeByAttr' | 'docChangeBySetAttrs' | 'docChangeByBatchAttrs' | 'docChangeByReplace' | 'docChangeByDelete' | 'docChangeByReplaceAround' | 'docChangeByUnknown';
 export interface LocalIdSharedState {
     localIdStatus: Map<string, LocalIdStatusCode> | undefined;
@@ -32,6 +37,12 @@ export type LocalIdPlugin = NextEditorPlugin<'localId', {
             value: Node;
         }) => boolean;
     };
+    commands: {
+        /**
+         * Scans the current document and adds local IDs to eligible nodes that are missing them.
+         */
+        addMissingLocalIds: (options?: AddMissingLocalIdsOptions) => EditorCommand;
+    };
     dependencies: [
         CompositionPlugin,
         OptionalPlugin<CollabEditPlugin>,

package/dist/types/pm-plugins/add-missing-local-ids.d.ts

@@ -0,0 +1,10 @@
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { AddMissingLocalIdsOptions } from '../localIdPluginType';
+export declare const localIdNotEmpty: (localId: unknown) => boolean;
+export declare const addMissingLocalIdsToDocument: (tr: Transaction, { onRepaired }?: AddMissingLocalIdsOptions) => boolean;
+/**
+ * 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/pm-plugins/main.d.ts

@@ -1,12 +1,6 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { PluginKey, type Transaction } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { LocalIdPlugin } from '../localIdPluginType';
 export declare const localIdPluginKey: PluginKey;
 export declare const createPlugin: (api: ExtractInjectionAPI<LocalIdPlugin> | undefined) => SafePlugin;
-/**
- * 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": "13.0.3",
+	"version": "13.1.0",
 	"description": "LocalId plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,13 +25,14 @@
 		"@atlaskit/editor-plugin-composition": "^14.0.0",
 		"@atlaskit/editor-plugin-limited-mode": "^12.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
+		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/tmp-editor-statsig": "^149.0.0",
 		"@babel/runtime": "^7.0.0",
 		"raf-schd": "^4.0.3"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.7.0",
+		"@atlaskit/editor-common": "^119.8.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"devDependencies": {