@atlaskit/editor-plugin-local-id 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-local-id
 
+## 1.0.5
+
+### Patch Changes
+
+- [`e5f37a1deec51`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e5f37a1deec51) -
+  Added check for localId in the node spec to prevent adding id's to nodes that may not allow it.
+
+## 1.0.4
+
+### Patch Changes
+
+- [`84d49ebfb038b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/84d49ebfb038b) -
+  EDITOR-1426 Updated addLocalIdToNode to use setNodeAttribute which creates an attr step instead of
+  a replace step as localId attribute changes should not result in a document change.
+- Updated dependencies
+
 ## 1.0.3
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -24,4 +24,4 @@
 			"path": "../../editor-common/afm-cc/tsconfig.json"
 		}
 	]
-}
+}

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

@@ -1,18 +1,14 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.localIdPluginKey = exports.createPlugin = exports.addLocalIdToNode = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
-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; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 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; }
@@ -47,10 +43,10 @@ var createPlugin = exports.createPlugin = function createPlugin() {
         // https://bitbucket.org/atlassian/adf-schema/src/fb2236147a0c2bc9c8efbdb75fd8f8c411df44ba/packages/adf-schema/src/next-schema/nodes/mediaGroup.ts#lines-12
         var ignoredNodeTypes = mediaGroup ? [text.name, hardBreak.name, mediaGroup.name] : [text.name, hardBreak.name];
         editorView.state.doc.descendants(function (node, pos) {
-          // Skip text nodes, hard breaks and nodes that already have local IDs
-          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+          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(node, pos, tr);
+            addLocalIdToNode(pos, tr);
           }
           return true; // Continue traversing
         });
@@ -70,7 +66,6 @@ var createPlugin = exports.createPlugin = function createPlugin() {
      * This ensures uniqueness of localIds on nodes being created or edited
      */
     appendTransaction: function appendTransaction(transactions, _oldState, newState) {
-      var _caret$resolve;
       var modified = false;
       var tr = newState.tr;
       var _newState$schema$node = newState.schema.nodes,
@@ -83,7 +78,7 @@ var createPlugin = exports.createPlugin = function createPlugin() {
       var addedNodes = new Set();
       var addedNodePos = new Map();
       var localIds = new Set();
-      var caret = newState.selection.getBookmark();
+
       // Process only the nodes added in the transactions
       transactions.forEach(function (transaction) {
         if (!transaction.docChanged) {
@@ -99,7 +94,8 @@ var createPlugin = exports.createPlugin = function createPlugin() {
           step.getMap().forEach(function (oldStart, oldEnd, newStart, newEnd) {
             // Scan the changed range to find all nodes
             tr.doc.nodesBetween(newStart, Math.min(newEnd, tr.doc.content.size), function (node, pos) {
-              if (ignoredNodeTypes.includes(node.type.name)) {
+              var _node$type$spec$attrs2;
+              if (ignoredNodeTypes.includes(node.type.name) || !((_node$type$spec$attrs2 = node.type.spec.attrs) !== null && _node$type$spec$attrs2 !== void 0 && _node$type$spec$attrs2.localId)) {
                 return true;
               }
               modified = true;
@@ -109,7 +105,7 @@ var createPlugin = exports.createPlugin = function createPlugin() {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(node, pos, tr);
+                  addLocalIdToNode(pos, tr);
                 }
               }
               return true;
@@ -133,7 +129,7 @@ var createPlugin = exports.createPlugin = function createPlugin() {
             if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
               var pos = addedNodePos.get(node);
               if (pos !== undefined) {
-                addLocalIdToNode(node, pos, tr);
+                addLocalIdToNode(pos, tr);
                 modified = true;
               }
             }
@@ -144,10 +140,6 @@ var createPlugin = exports.createPlugin = function createPlugin() {
           _iterator.f();
         }
       }
-
-      // Restore caret to where the user left it.
-      var restored = (_caret$resolve = caret.resolve(tr.doc)) !== null && _caret$resolve !== void 0 ? _caret$resolve : _state.Selection.near(tr.doc.resolve(Math.min(newState.selection.from, tr.doc.content.size)), 1);
-      tr.setSelection(restored);
       return modified ? tr : undefined;
     }
   });
@@ -156,15 +148,10 @@ var createPlugin = exports.createPlugin = function createPlugin() {
  * Adds a local ID to a ProseMirror node
  *
  * This utility function updates a node's attributes to include a unique local ID.
- * It preserves all existing attributes and marks while adding the new localId.
  *
- * @param node - The ProseMirror node to add a local ID to
  * @param pos - The position of the node in the document
  * @param tr - The transaction to apply the change to
- * @returns The updated transaction with the node markup change
  */
-var addLocalIdToNode = exports.addLocalIdToNode = function addLocalIdToNode(node, pos, tr) {
-  tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
-    localId: _adfSchema.uuid.generate()
-  }), node.marks);
+var addLocalIdToNode = exports.addLocalIdToNode = function addLocalIdToNode(pos, tr) {
+  tr.setNodeAttribute(pos, 'localId', _adfSchema.uuid.generate());
 };

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

@@ -1,7 +1,7 @@
 import { uuid } from '@atlaskit/adf-schema';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
-import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { fg } from '@atlaskit/platform-feature-flags';
 export const localIdPluginKey = new PluginKey('localIdPlugin');
 
@@ -35,10 +35,10 @@ export const createPlugin = () => {
         // https://bitbucket.org/atlassian/adf-schema/src/fb2236147a0c2bc9c8efbdb75fd8f8c411df44ba/packages/adf-schema/src/next-schema/nodes/mediaGroup.ts#lines-12
         const ignoredNodeTypes = mediaGroup ? [text.name, hardBreak.name, mediaGroup.name] : [text.name, hardBreak.name];
         editorView.state.doc.descendants((node, pos) => {
-          // Skip text nodes, hard breaks and nodes that already have local IDs
-          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+          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(node, pos, tr);
+            addLocalIdToNode(pos, tr);
           }
           return true; // Continue traversing
         });
@@ -58,7 +58,6 @@ export const createPlugin = () => {
      * This ensures uniqueness of localIds on nodes being created or edited
      */
     appendTransaction: (transactions, _oldState, newState) => {
-      var _caret$resolve;
       let modified = false;
       const tr = newState.tr;
       const {
@@ -72,7 +71,7 @@ export const createPlugin = () => {
       const addedNodes = new Set();
       const addedNodePos = new Map();
       const localIds = new Set();
-      const caret = newState.selection.getBookmark();
+
       // Process only the nodes added in the transactions
       transactions.forEach(transaction => {
         if (!transaction.docChanged) {
@@ -88,7 +87,8 @@ export const createPlugin = () => {
           step.getMap().forEach((oldStart, oldEnd, newStart, newEnd) => {
             // Scan the changed range to find all nodes
             tr.doc.nodesBetween(newStart, Math.min(newEnd, tr.doc.content.size), (node, pos) => {
-              if (ignoredNodeTypes.includes(node.type.name)) {
+              var _node$type$spec$attrs2;
+              if (ignoredNodeTypes.includes(node.type.name) || !((_node$type$spec$attrs2 = node.type.spec.attrs) !== null && _node$type$spec$attrs2 !== void 0 && _node$type$spec$attrs2.localId)) {
                 return true;
               }
               modified = true;
@@ -98,7 +98,7 @@ export const createPlugin = () => {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(node, pos, tr);
+                  addLocalIdToNode(pos, tr);
                 }
               }
               return true;
@@ -118,16 +118,12 @@ export const createPlugin = () => {
           if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
             const pos = addedNodePos.get(node);
             if (pos !== undefined) {
-              addLocalIdToNode(node, pos, tr);
+              addLocalIdToNode(pos, tr);
               modified = true;
             }
           }
         }
       }
-
-      // Restore caret to where the user left it.
-      const restored = (_caret$resolve = caret.resolve(tr.doc)) !== null && _caret$resolve !== void 0 ? _caret$resolve : Selection.near(tr.doc.resolve(Math.min(newState.selection.from, tr.doc.content.size)), 1);
-      tr.setSelection(restored);
       return modified ? tr : undefined;
     }
   });
@@ -136,16 +132,10 @@ export const createPlugin = () => {
  * Adds a local ID to a ProseMirror node
  *
  * This utility function updates a node's attributes to include a unique local ID.
- * It preserves all existing attributes and marks while adding the new localId.
  *
- * @param node - The ProseMirror node to add a local ID to
  * @param pos - The position of the node in the document
  * @param tr - The transaction to apply the change to
- * @returns The updated transaction with the node markup change
  */
-export const addLocalIdToNode = (node, pos, tr) => {
-  tr.setNodeMarkup(pos, node.type, {
-    ...node.attrs,
-    localId: uuid.generate()
-  }, node.marks);
+export const addLocalIdToNode = (pos, tr) => {
+  tr.setNodeAttribute(pos, 'localId', uuid.generate());
 };

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

@@ -1,13 +1,10 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-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; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 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 { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { stepHasSlice } from '@atlaskit/editor-common/utils';
-import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { fg } from '@atlaskit/platform-feature-flags';
 export var localIdPluginKey = new PluginKey('localIdPlugin');
 
@@ -40,10 +37,10 @@ export var createPlugin = function createPlugin() {
         // https://bitbucket.org/atlassian/adf-schema/src/fb2236147a0c2bc9c8efbdb75fd8f8c411df44ba/packages/adf-schema/src/next-schema/nodes/mediaGroup.ts#lines-12
         var ignoredNodeTypes = mediaGroup ? [text.name, hardBreak.name, mediaGroup.name] : [text.name, hardBreak.name];
         editorView.state.doc.descendants(function (node, pos) {
-          // Skip text nodes, hard breaks and nodes that already have local IDs
-          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+          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(node, pos, tr);
+            addLocalIdToNode(pos, tr);
           }
           return true; // Continue traversing
         });
@@ -63,7 +60,6 @@ export var createPlugin = function createPlugin() {
      * This ensures uniqueness of localIds on nodes being created or edited
      */
     appendTransaction: function appendTransaction(transactions, _oldState, newState) {
-      var _caret$resolve;
       var modified = false;
       var tr = newState.tr;
       var _newState$schema$node = newState.schema.nodes,
@@ -76,7 +72,7 @@ export var createPlugin = function createPlugin() {
       var addedNodes = new Set();
       var addedNodePos = new Map();
       var localIds = new Set();
-      var caret = newState.selection.getBookmark();
+
       // Process only the nodes added in the transactions
       transactions.forEach(function (transaction) {
         if (!transaction.docChanged) {
@@ -92,7 +88,8 @@ export var createPlugin = function createPlugin() {
           step.getMap().forEach(function (oldStart, oldEnd, newStart, newEnd) {
             // Scan the changed range to find all nodes
             tr.doc.nodesBetween(newStart, Math.min(newEnd, tr.doc.content.size), function (node, pos) {
-              if (ignoredNodeTypes.includes(node.type.name)) {
+              var _node$type$spec$attrs2;
+              if (ignoredNodeTypes.includes(node.type.name) || !((_node$type$spec$attrs2 = node.type.spec.attrs) !== null && _node$type$spec$attrs2 !== void 0 && _node$type$spec$attrs2.localId)) {
                 return true;
               }
               modified = true;
@@ -102,7 +99,7 @@ export var createPlugin = function createPlugin() {
                 addedNodePos.set(node, pos);
               } else {
                 if (!(node !== null && node !== void 0 && node.attrs.localId)) {
-                  addLocalIdToNode(node, pos, tr);
+                  addLocalIdToNode(pos, tr);
                 }
               }
               return true;
@@ -126,7 +123,7 @@ export var createPlugin = function createPlugin() {
             if (!node.attrs.localId || localIds.has(node.attrs.localId)) {
               var pos = addedNodePos.get(node);
               if (pos !== undefined) {
-                addLocalIdToNode(node, pos, tr);
+                addLocalIdToNode(pos, tr);
                 modified = true;
               }
             }
@@ -137,10 +134,6 @@ export var createPlugin = function createPlugin() {
           _iterator.f();
         }
       }
-
-      // Restore caret to where the user left it.
-      var restored = (_caret$resolve = caret.resolve(tr.doc)) !== null && _caret$resolve !== void 0 ? _caret$resolve : Selection.near(tr.doc.resolve(Math.min(newState.selection.from, tr.doc.content.size)), 1);
-      tr.setSelection(restored);
       return modified ? tr : undefined;
     }
   });
@@ -149,15 +142,10 @@ export var createPlugin = function createPlugin() {
  * Adds a local ID to a ProseMirror node
  *
  * This utility function updates a node's attributes to include a unique local ID.
- * It preserves all existing attributes and marks while adding the new localId.
  *
- * @param node - The ProseMirror node to add a local ID to
  * @param pos - The position of the node in the document
  * @param tr - The transaction to apply the change to
- * @returns The updated transaction with the node markup change
  */
-export var addLocalIdToNode = function addLocalIdToNode(node, pos, tr) {
-  tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
-    localId: uuid.generate()
-  }), node.marks);
+export var addLocalIdToNode = function addLocalIdToNode(pos, tr) {
+  tr.setNodeAttribute(pos, 'localId', uuid.generate());
 };

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

@@ -1,5 +1,4 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey, type Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const localIdPluginKey: PluginKey<any>;
 export declare const createPlugin: () => SafePlugin<any>;
@@ -7,11 +6,8 @@ export declare const createPlugin: () => SafePlugin<any>;
  * Adds a local ID to a ProseMirror node
  *
  * This utility function updates a node's attributes to include a unique local ID.
- * It preserves all existing attributes and marks while adding the new localId.
  *
- * @param node - The ProseMirror node to add a local ID to
  * @param pos - The position of the node in the document
  * @param tr - The transaction to apply the change to
- * @returns The updated transaction with the node markup change
  */
-export declare const addLocalIdToNode: (node: PMNode, pos: number, tr: Transaction) => void;
+export declare const addLocalIdToNode: (pos: number, tr: Transaction) => void;

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

@@ -1,5 +1,4 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey, type Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const localIdPluginKey: PluginKey<any>;
 export declare const createPlugin: () => SafePlugin<any>;
@@ -7,11 +6,8 @@ export declare const createPlugin: () => SafePlugin<any>;
  * Adds a local ID to a ProseMirror node
  *
  * This utility function updates a node's attributes to include a unique local ID.
- * It preserves all existing attributes and marks while adding the new localId.
  *
- * @param node - The ProseMirror node to add a local ID to
  * @param pos - The position of the node in the document
  * @param tr - The transaction to apply the change to
- * @returns The updated transaction with the node markup change
  */
-export declare const addLocalIdToNode: (node: PMNode, pos: number, tr: Transaction) => void;
+export declare const addLocalIdToNode: (pos: number, tr: Transaction) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-local-id",
-	"version": "1.0.3",
+	"version": "1.0.5",
 	"description": "LocalId plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,9 +27,6 @@
 	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		".": "./src/index.ts"
-	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^50.2.2",
 		"@atlaskit/editor-prosemirror": "7.0.0",
@@ -38,7 +35,7 @@
 		"raf-schd": "^4.0.3"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.31.0",
+		"@atlaskit/editor-common": "^107.32.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {