@atlaskit/editor-plugin-paste 11.0.2 → 11.0.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-paste
 
+## 11.0.3
+
+### Patch Changes
+
+- [`402738b592e0b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/402738b592e0b) -
+  Fix invalid flexible list structures caused by delete, paste, and typing operations.
+
+  Under platform_editor_flexible_list_schema, operations that remove content spanning list or task
+  list items could leave nodes with a nested list as their first child instead of a required
+  paragraph/item. Normalisation now runs efficiently on all relevant transactions in
+  appendTransaction.
+
+- Updated dependencies
+
 ## 11.0.2
 
 ### Patch Changes

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

@@ -45,30 +45,6 @@ var _tinyMCE = require("./util/tinyMCE");
 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; } // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
-function isListIntoListPaste(tr, state) {
-  var _state$schema$nodes = state.schema.nodes,
-    listItem = _state$schema$nodes.listItem,
-    bulletList = _state$schema$nodes.bulletList,
-    orderedList = _state$schema$nodes.orderedList;
-  var _state$selection = state.selection,
-    $from = _state$selection.$from,
-    $to = _state$selection.$to;
-  var selectionInList = !!(0, _utils2.findParentNodeOfTypeClosestToPos)($from, [listItem]) || !!(0, _utils2.findParentNodeOfTypeClosestToPos)($to, [listItem]);
-  if (!selectionInList) {
-    return false;
-  }
-  return tr.steps.some(function (step) {
-    var _slice$content;
-    var slice = (0, _utils.extractSliceFromStep)(step);
-    var listExists = false;
-    slice === null || slice === void 0 || (_slice$content = slice.content) === null || _slice$content === void 0 || _slice$content.forEach(function (node) {
-      if (node.type === bulletList || node.type === orderedList) {
-        listExists = true;
-      }
-    });
-    return listExists;
-  });
-}
 var isInsideBlockQuote = exports.isInsideBlockQuote = function isInsideBlockQuote(state) {
   var blockquote = state.schema.nodes.blockquote;
   return (0, _utils2.hasParentNodeOfType)(blockquote)(state.selection);
@@ -307,10 +283,10 @@ function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFlags, pl
           // to split those repairing transactions in prosemirror-history when they're being added to the
           // "done" stack
           var isPastingTable = tr.steps.some(function (step) {
-            var _slice$content2;
+            var _slice$content;
             var slice = (0, _utils.extractSliceFromStep)(step);
             var tableExists = false;
-            slice === null || slice === void 0 || (_slice$content2 = slice.content) === null || _slice$content2 === void 0 || _slice$content2.forEach(function (node) {
+            slice === null || slice === void 0 || (_slice$content = slice.content) === null || _slice$content === void 0 || _slice$content.forEach(function (node) {
               if (node.type === state.schema.nodes.table) {
                 tableExists = true;
               }
@@ -318,14 +294,26 @@ function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFlags, pl
             return tableExists;
           });
 
-          // Don't add closeHistory if we're pasting a list into a list, as the list plugin will
-          // appendTransaction to normalise the list structure and we want to keep the paste and
-          // normalisation as one undo event. We also set a meta on the transaction so the list
-          // plugin's appendTransaction can cheaply detect this case without re-checking flags.
-          if ((0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_flexible_list_schema', 'isEnabled', true) && isListIntoListPaste(tr, state)) {
-            tr = tr.setMeta('listPasteNormalisation', true);
+          // Don't flag as a paste event (add closeHistory) when the paste affects a list and
+          // the list plugin's appendTransaction will normalise the structure, and we want the
+          // paste + normalisation to be a single undo step.
+          // Pasting into an existing list — selection is inside a list node.
+          var isPastingIntoList = false;
+          // Pasting list content from an external source — slice top-level contains a list node.
+          var isPastingListContent = false;
+          if ((0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_flexible_list_schema', 'isEnabled', true)) {
+            var listNodeTypes = [state.schema.nodes.bulletList, state.schema.nodes.orderedList, state.schema.nodes.taskList].filter(function (n) {
+              return Boolean(n);
+            });
+            isPastingIntoList = (0, _utils2.hasParentNodeOfType)(listNodeTypes)(state.selection);
+            for (var i = 0; i < slice.content.childCount; i++) {
+              if (listNodeTypes.includes(slice.content.child(i).type)) {
+                isPastingListContent = true;
+                break;
+              }
+            }
           }
-          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !tr.getMeta('listPasteNormalisation') && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
+          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !isPastingIntoList && !isPastingListContent && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
             var _pluginInjectionApi$b;
             tr = pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$b = pluginInjectionApi.betterTypeHistory) === null || _pluginInjectionApi$b === void 0 ? void 0 : _pluginInjectionApi$b.actions.flagPasteEvent(tr);
           }

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

@@ -13,7 +13,7 @@ import { removeBreakoutFromRendererSyncBlockHTML, transformSingleColumnLayout, t
 import { containsAnyAnnotations, extractSliceFromStep, linkifyContent, mapChildren } from '@atlaskit/editor-common/utils';
 import { MarkdownTransformer } from '@atlaskit/editor-markdown-transformer';
 import { Fragment, Slice } from '@atlaskit/editor-prosemirror/model';
-import { contains, findParentNodeOfTypeClosestToPos, hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { contains, hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { handlePaste as handlePasteTable } from '@atlaskit/editor-tables/utils';
 import { insm } from '@atlaskit/insm';
 import { extractClientIdsFromHtml } from '@atlaskit/media-common';
@@ -32,32 +32,6 @@ import { handleVSCodeBlock } from './util/edge-cases/handleVSCodeBlock';
 import { handleMacroAutoConvert, handleMention, handleParagraphBlockMarks, handlePasteExpand, handleTableContentPasteInBodiedExtension } from './util/handlers';
 import { handleSyncBlocksPaste } from './util/sync-block';
 import { htmlHasIncompleteTable, isPastedFromTinyMCEConfluence, tryRebuildCompleteTableHtml } from './util/tinyMCE';
-function isListIntoListPaste(tr, state) {
-  const {
-    listItem,
-    bulletList,
-    orderedList
-  } = state.schema.nodes;
-  const {
-    $from,
-    $to
-  } = state.selection;
-  const selectionInList = !!findParentNodeOfTypeClosestToPos($from, [listItem]) || !!findParentNodeOfTypeClosestToPos($to, [listItem]);
-  if (!selectionInList) {
-    return false;
-  }
-  return tr.steps.some(step => {
-    var _slice$content;
-    const slice = extractSliceFromStep(step);
-    let listExists = false;
-    slice === null || slice === void 0 ? void 0 : (_slice$content = slice.content) === null || _slice$content === void 0 ? void 0 : _slice$content.forEach(node => {
-      if (node.type === bulletList || node.type === orderedList) {
-        listExists = true;
-      }
-    });
-    return listExists;
-  });
-}
 export const isInsideBlockQuote = state => {
   const {
     blockquote
@@ -271,10 +245,10 @@ export function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFl
           // to split those repairing transactions in prosemirror-history when they're being added to the
           // "done" stack
           const isPastingTable = tr.steps.some(step => {
-            var _slice$content2;
+            var _slice$content;
             const slice = extractSliceFromStep(step);
             let tableExists = false;
-            slice === null || slice === void 0 ? void 0 : (_slice$content2 = slice.content) === null || _slice$content2 === void 0 ? void 0 : _slice$content2.forEach(node => {
+            slice === null || slice === void 0 ? void 0 : (_slice$content = slice.content) === null || _slice$content === void 0 ? void 0 : _slice$content.forEach(node => {
               if (node.type === state.schema.nodes.table) {
                 tableExists = true;
               }
@@ -282,14 +256,24 @@ export function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFl
             return tableExists;
           });
 
-          // Don't add closeHistory if we're pasting a list into a list, as the list plugin will
-          // appendTransaction to normalise the list structure and we want to keep the paste and
-          // normalisation as one undo event. We also set a meta on the transaction so the list
-          // plugin's appendTransaction can cheaply detect this case without re-checking flags.
-          if (expValEqualsNoExposure('platform_editor_flexible_list_schema', 'isEnabled', true) && isListIntoListPaste(tr, state)) {
-            tr = tr.setMeta('listPasteNormalisation', true);
+          // Don't flag as a paste event (add closeHistory) when the paste affects a list and
+          // the list plugin's appendTransaction will normalise the structure, and we want the
+          // paste + normalisation to be a single undo step.
+          // Pasting into an existing list — selection is inside a list node.
+          let isPastingIntoList = false;
+          // Pasting list content from an external source — slice top-level contains a list node.
+          let isPastingListContent = false;
+          if (expValEqualsNoExposure('platform_editor_flexible_list_schema', 'isEnabled', true)) {
+            const listNodeTypes = [state.schema.nodes.bulletList, state.schema.nodes.orderedList, state.schema.nodes.taskList].filter(n => Boolean(n));
+            isPastingIntoList = hasParentNodeOfType(listNodeTypes)(state.selection);
+            for (let i = 0; i < slice.content.childCount; i++) {
+              if (listNodeTypes.includes(slice.content.child(i).type)) {
+                isPastingListContent = true;
+                break;
+              }
+            }
           }
-          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !tr.getMeta('listPasteNormalisation') && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
+          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !isPastingIntoList && !isPastingListContent && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
             var _pluginInjectionApi$b;
             tr = pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$b = pluginInjectionApi.betterTypeHistory) === null || _pluginInjectionApi$b === void 0 ? void 0 : _pluginInjectionApi$b.actions.flagPasteEvent(tr);
           }

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

@@ -18,7 +18,7 @@ import { removeBreakoutFromRendererSyncBlockHTML, transformSingleColumnLayout, t
 import { containsAnyAnnotations, extractSliceFromStep, linkifyContent, mapChildren } from '@atlaskit/editor-common/utils';
 import { MarkdownTransformer } from '@atlaskit/editor-markdown-transformer';
 import { Fragment, Slice } from '@atlaskit/editor-prosemirror/model';
-import { contains, findParentNodeOfTypeClosestToPos, hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { contains, hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { handlePaste as handlePasteTable } from '@atlaskit/editor-tables/utils';
 import { insm } from '@atlaskit/insm';
 import { extractClientIdsFromHtml } from '@atlaskit/media-common';
@@ -37,30 +37,6 @@ import { handleVSCodeBlock } from './util/edge-cases/handleVSCodeBlock';
 import { handleMacroAutoConvert, handleMention, handleParagraphBlockMarks, handlePasteExpand, handleTableContentPasteInBodiedExtension } from './util/handlers';
 import { handleSyncBlocksPaste } from './util/sync-block';
 import { htmlHasIncompleteTable, isPastedFromTinyMCEConfluence, tryRebuildCompleteTableHtml } from './util/tinyMCE';
-function isListIntoListPaste(tr, state) {
-  var _state$schema$nodes = state.schema.nodes,
-    listItem = _state$schema$nodes.listItem,
-    bulletList = _state$schema$nodes.bulletList,
-    orderedList = _state$schema$nodes.orderedList;
-  var _state$selection = state.selection,
-    $from = _state$selection.$from,
-    $to = _state$selection.$to;
-  var selectionInList = !!findParentNodeOfTypeClosestToPos($from, [listItem]) || !!findParentNodeOfTypeClosestToPos($to, [listItem]);
-  if (!selectionInList) {
-    return false;
-  }
-  return tr.steps.some(function (step) {
-    var _slice$content;
-    var slice = extractSliceFromStep(step);
-    var listExists = false;
-    slice === null || slice === void 0 || (_slice$content = slice.content) === null || _slice$content === void 0 || _slice$content.forEach(function (node) {
-      if (node.type === bulletList || node.type === orderedList) {
-        listExists = true;
-      }
-    });
-    return listExists;
-  });
-}
 export var isInsideBlockQuote = function isInsideBlockQuote(state) {
   var blockquote = state.schema.nodes.blockquote;
   return hasParentNodeOfType(blockquote)(state.selection);
@@ -299,10 +275,10 @@ export function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFl
           // to split those repairing transactions in prosemirror-history when they're being added to the
           // "done" stack
           var isPastingTable = tr.steps.some(function (step) {
-            var _slice$content2;
+            var _slice$content;
             var slice = extractSliceFromStep(step);
             var tableExists = false;
-            slice === null || slice === void 0 || (_slice$content2 = slice.content) === null || _slice$content2 === void 0 || _slice$content2.forEach(function (node) {
+            slice === null || slice === void 0 || (_slice$content = slice.content) === null || _slice$content === void 0 || _slice$content.forEach(function (node) {
               if (node.type === state.schema.nodes.table) {
                 tableExists = true;
               }
@@ -310,14 +286,26 @@ export function createPlugin(schema, dispatchAnalyticsEvent, dispatch, featureFl
             return tableExists;
           });
 
-          // Don't add closeHistory if we're pasting a list into a list, as the list plugin will
-          // appendTransaction to normalise the list structure and we want to keep the paste and
-          // normalisation as one undo event. We also set a meta on the transaction so the list
-          // plugin's appendTransaction can cheaply detect this case without re-checking flags.
-          if (expValEqualsNoExposure('platform_editor_flexible_list_schema', 'isEnabled', true) && isListIntoListPaste(tr, state)) {
-            tr = tr.setMeta('listPasteNormalisation', true);
+          // Don't flag as a paste event (add closeHistory) when the paste affects a list and
+          // the list plugin's appendTransaction will normalise the structure, and we want the
+          // paste + normalisation to be a single undo step.
+          // Pasting into an existing list — selection is inside a list node.
+          var isPastingIntoList = false;
+          // Pasting list content from an external source — slice top-level contains a list node.
+          var isPastingListContent = false;
+          if (expValEqualsNoExposure('platform_editor_flexible_list_schema', 'isEnabled', true)) {
+            var listNodeTypes = [state.schema.nodes.bulletList, state.schema.nodes.orderedList, state.schema.nodes.taskList].filter(function (n) {
+              return Boolean(n);
+            });
+            isPastingIntoList = hasParentNodeOfType(listNodeTypes)(state.selection);
+            for (var i = 0; i < slice.content.childCount; i++) {
+              if (listNodeTypes.includes(slice.content.child(i).type)) {
+                isPastingListContent = true;
+                break;
+              }
+            }
           }
-          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !tr.getMeta('listPasteNormalisation') && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
+          if (!isPastingTextInsidePlaceholderText && !isPastingTable && !isPastingOverLayoutColumns && !isPastingIntoList && !isPastingListContent && pluginInjectionApi !== null && pluginInjectionApi !== void 0 && pluginInjectionApi.betterTypeHistory) {
             var _pluginInjectionApi$b;
             tr = pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$b = pluginInjectionApi.betterTypeHistory) === null || _pluginInjectionApi$b === void 0 ? void 0 : _pluginInjectionApi$b.actions.flagPasteEvent(tr);
           }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-paste",
-	"version": "11.0.2",
+	"version": "11.0.3",
 	"description": "Paste plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -55,7 +55,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.2.0",
+		"@atlaskit/editor-common": "^114.3.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"