@atlaskit/editor-plugin-list 14.1.18 → 14.1.20

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-list
 
+## 14.1.20
+
+### Patch Changes
+
+- Updated dependencies
+
+## 14.1.19
+
+### Patch Changes
+
+- [`3c4994f354f5f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3c4994f354f5f) -
+  [ux] Fix content order being corrupted when indenting or outdenting a list item that has content
+  placed between its sub-lists (e.g. `li(p, ul, p, ul)`).
+- Updated dependencies
+
 ## 14.1.18
 
 ### Patch Changes

package/dist/cjs/pm-plugins/utils/list-indentation.js

@@ -7,6 +7,7 @@ exports.buildReplacementFragment = buildReplacementFragment;
 exports.flattenList = flattenList;
 var _lists = require("@atlaskit/editor-common/lists");
 var _utils = require("@atlaskit/editor-common/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 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; }
@@ -30,14 +31,107 @@ function contentSize(listItem) {
 }
 
 /**
- * Flatten a root list into a flat array of content-bearing items
- * and simultaneously determine which elements intersect the user's selection.
- *
- * Delegates to the shared `flattenListLike` with list-specific callbacks.
- * Selection intersection is checked against each item's content-only
- * span (excluding nested lists).
+ * Flattens a list, splitting each list item into one item per run of content.
+ * An item like `li(p, ul, p, ul)` becomes separate sibling items, so content
+ * placed between sub-lists keeps its order. Also records which items the
+ * selection touches.
  */
+function flattenListImpl(options) {
+  var doc = options.doc,
+    rootListStart = options.rootListStart,
+    selectionFrom = options.selectionFrom,
+    selectionTo = options.selectionTo,
+    indentDelta = options.indentDelta,
+    maxDepth = options.maxDepth;
+  var rootList = doc.nodeAt(rootListStart);
+  if (!rootList) {
+    return null;
+  }
+  var schema = rootList.type.schema;
+  var items = [];
+  var startIndex = -1;
+  var endIndex = -1;
+  var exceedsMaxDepth = false;
+  var isPointSelection = selectionFrom === selectionTo;
+  var pushSegment = function pushSegment(segmentNode, contentStart, contentEnd, depth, parentList) {
+    var isSelected = isPointSelection ? selectionFrom >= contentStart && selectionFrom <= contentEnd : contentStart < selectionTo && contentEnd > selectionFrom;
+    var effectiveDepth = depth + (isSelected ? indentDelta : 0);
+    items.push({
+      node: segmentNode,
+      pos: contentStart - 1,
+      depth: effectiveDepth,
+      isSelected: isSelected,
+      listType: parentList.type.name,
+      parentListAttrs: parentList.attrs
+    });
+    if (isSelected) {
+      var index = items.length - 1;
+      if (startIndex === -1) {
+        startIndex = index;
+      }
+      endIndex = index;
+      if (maxDepth != null && effectiveDepth >= maxDepth) {
+        exceedsMaxDepth = true;
+      }
+    }
+  };
+  var _walkList = function walkList(listNode, listPos, depth) {
+    var childPos = listPos + 1;
+    listNode.forEach(function (listItemNode) {
+      if (!(0, _utils.isListItemNode)(listItemNode)) {
+        childPos += listItemNode.nodeSize;
+        return;
+      }
+      var itemStart = childPos;
+      var innerPos = itemStart + 1;
+      // Content collected since the last sub-list. Each run becomes its own item.
+      var segmentContent = [];
+      var segmentContentStart = innerPos;
+      var segmentContentSize = 0;
+      var emitSegment = function emitSegment(parentList) {
+        if (segmentContent.length === 0) {
+          return;
+        }
+        var segmentItem = schema.nodes.listItem.create(listItemNode.attrs, segmentContent);
+        pushSegment(segmentItem, segmentContentStart, segmentContentStart + segmentContentSize, depth, parentList);
+      };
+      listItemNode.forEach(function (child) {
+        if ((0, _utils.isListNode)(child)) {
+          // A sub-list ends the current run: emit it, then walk the sub-list deeper.
+          emitSegment(listNode);
+          segmentContent = [];
+          segmentContentSize = 0;
+          _walkList(child, innerPos, depth + 1);
+          innerPos += child.nodeSize;
+          segmentContentStart = innerPos;
+        } else {
+          if (segmentContent.length === 0) {
+            segmentContentStart = innerPos;
+          }
+          segmentContent.push(child);
+          segmentContentSize += child.nodeSize;
+          innerPos += child.nodeSize;
+        }
+      });
+      // Emit any remaining content after the last sub-list.
+      emitSegment(listNode);
+      childPos += listItemNode.nodeSize;
+    });
+  };
+  _walkList(rootList, rootListStart, 0);
+  if (items.length === 0 || startIndex === -1 || exceedsMaxDepth) {
+    return null;
+  }
+  return {
+    items: items,
+    startIndex: startIndex,
+    endIndex: endIndex
+  };
+}
 function flattenList(options) {
+  if ((0, _platformFeatureFlags.fg)('platform_editor_flexible_list_normalization_fix')) {
+    return flattenListImpl(options);
+  }
   return (0, _lists.flattenList)(options, {
     isContentNode: function isContentNode(node, parent) {
       return (0, _utils.isListItemNode)(node) && hasContentChildren(node) && (0, _utils.isListNode)(parent);

package/dist/es2019/pm-plugins/utils/list-indentation.js

@@ -1,5 +1,7 @@
 import { buildReplacementFragment as buildReplacementFragmentBase, flattenList as flattenListBase } from '@atlaskit/editor-common/lists';
 import { isListItemNode, isListNode } from '@atlaskit/editor-common/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
+
 /**
  * Returns true if a listItem has at least one non-list child (paragraph, etc.).
  */
@@ -18,14 +20,109 @@ function contentSize(listItem) {
 }
 
 /**
- * Flatten a root list into a flat array of content-bearing items
- * and simultaneously determine which elements intersect the user's selection.
- *
- * Delegates to the shared `flattenListLike` with list-specific callbacks.
- * Selection intersection is checked against each item's content-only
- * span (excluding nested lists).
+ * Flattens a list, splitting each list item into one item per run of content.
+ * An item like `li(p, ul, p, ul)` becomes separate sibling items, so content
+ * placed between sub-lists keeps its order. Also records which items the
+ * selection touches.
  */
+function flattenListImpl(options) {
+  const {
+    doc,
+    rootListStart,
+    selectionFrom,
+    selectionTo,
+    indentDelta,
+    maxDepth
+  } = options;
+  const rootList = doc.nodeAt(rootListStart);
+  if (!rootList) {
+    return null;
+  }
+  const schema = rootList.type.schema;
+  const items = [];
+  let startIndex = -1;
+  let endIndex = -1;
+  let exceedsMaxDepth = false;
+  const isPointSelection = selectionFrom === selectionTo;
+  const pushSegment = (segmentNode, contentStart, contentEnd, depth, parentList) => {
+    const isSelected = isPointSelection ? selectionFrom >= contentStart && selectionFrom <= contentEnd : contentStart < selectionTo && contentEnd > selectionFrom;
+    const effectiveDepth = depth + (isSelected ? indentDelta : 0);
+    items.push({
+      node: segmentNode,
+      pos: contentStart - 1,
+      depth: effectiveDepth,
+      isSelected,
+      listType: parentList.type.name,
+      parentListAttrs: parentList.attrs
+    });
+    if (isSelected) {
+      const index = items.length - 1;
+      if (startIndex === -1) {
+        startIndex = index;
+      }
+      endIndex = index;
+      if (maxDepth != null && effectiveDepth >= maxDepth) {
+        exceedsMaxDepth = true;
+      }
+    }
+  };
+  const walkList = (listNode, listPos, depth) => {
+    let childPos = listPos + 1;
+    listNode.forEach(listItemNode => {
+      if (!isListItemNode(listItemNode)) {
+        childPos += listItemNode.nodeSize;
+        return;
+      }
+      const itemStart = childPos;
+      let innerPos = itemStart + 1;
+      // Content collected since the last sub-list. Each run becomes its own item.
+      let segmentContent = [];
+      let segmentContentStart = innerPos;
+      let segmentContentSize = 0;
+      const emitSegment = parentList => {
+        if (segmentContent.length === 0) {
+          return;
+        }
+        const segmentItem = schema.nodes.listItem.create(listItemNode.attrs, segmentContent);
+        pushSegment(segmentItem, segmentContentStart, segmentContentStart + segmentContentSize, depth, parentList);
+      };
+      listItemNode.forEach(child => {
+        if (isListNode(child)) {
+          // A sub-list ends the current run: emit it, then walk the sub-list deeper.
+          emitSegment(listNode);
+          segmentContent = [];
+          segmentContentSize = 0;
+          walkList(child, innerPos, depth + 1);
+          innerPos += child.nodeSize;
+          segmentContentStart = innerPos;
+        } else {
+          if (segmentContent.length === 0) {
+            segmentContentStart = innerPos;
+          }
+          segmentContent.push(child);
+          segmentContentSize += child.nodeSize;
+          innerPos += child.nodeSize;
+        }
+      });
+      // Emit any remaining content after the last sub-list.
+      emitSegment(listNode);
+      childPos += listItemNode.nodeSize;
+    });
+  };
+  walkList(rootList, rootListStart, 0);
+  if (items.length === 0 || startIndex === -1 || exceedsMaxDepth) {
+    return null;
+  }
+  return {
+    items,
+    startIndex,
+    endIndex
+  };
+}
 export function flattenList(options) {
+  if (fg('platform_editor_flexible_list_normalization_fix')) {
+    return flattenListImpl(options);
+  }
   return flattenListBase(options, {
     isContentNode: (node, parent) => isListItemNode(node) && hasContentChildren(node) && isListNode(parent),
     // +1 shifts from the listItem node boundary to the start of its content children

package/dist/esm/pm-plugins/utils/list-indentation.js

@@ -3,6 +3,8 @@ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r)
 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 { buildReplacementFragment as buildReplacementFragmentBase, flattenList as flattenListBase } from '@atlaskit/editor-common/lists';
 import { isListItemNode, isListNode } from '@atlaskit/editor-common/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
+
 /**
  * Returns true if a listItem has at least one non-list child (paragraph, etc.).
  */
@@ -23,14 +25,107 @@ function contentSize(listItem) {
 }
 
 /**
- * Flatten a root list into a flat array of content-bearing items
- * and simultaneously determine which elements intersect the user's selection.
- *
- * Delegates to the shared `flattenListLike` with list-specific callbacks.
- * Selection intersection is checked against each item's content-only
- * span (excluding nested lists).
+ * Flattens a list, splitting each list item into one item per run of content.
+ * An item like `li(p, ul, p, ul)` becomes separate sibling items, so content
+ * placed between sub-lists keeps its order. Also records which items the
+ * selection touches.
  */
+function flattenListImpl(options) {
+  var doc = options.doc,
+    rootListStart = options.rootListStart,
+    selectionFrom = options.selectionFrom,
+    selectionTo = options.selectionTo,
+    indentDelta = options.indentDelta,
+    maxDepth = options.maxDepth;
+  var rootList = doc.nodeAt(rootListStart);
+  if (!rootList) {
+    return null;
+  }
+  var schema = rootList.type.schema;
+  var items = [];
+  var startIndex = -1;
+  var endIndex = -1;
+  var exceedsMaxDepth = false;
+  var isPointSelection = selectionFrom === selectionTo;
+  var pushSegment = function pushSegment(segmentNode, contentStart, contentEnd, depth, parentList) {
+    var isSelected = isPointSelection ? selectionFrom >= contentStart && selectionFrom <= contentEnd : contentStart < selectionTo && contentEnd > selectionFrom;
+    var effectiveDepth = depth + (isSelected ? indentDelta : 0);
+    items.push({
+      node: segmentNode,
+      pos: contentStart - 1,
+      depth: effectiveDepth,
+      isSelected: isSelected,
+      listType: parentList.type.name,
+      parentListAttrs: parentList.attrs
+    });
+    if (isSelected) {
+      var index = items.length - 1;
+      if (startIndex === -1) {
+        startIndex = index;
+      }
+      endIndex = index;
+      if (maxDepth != null && effectiveDepth >= maxDepth) {
+        exceedsMaxDepth = true;
+      }
+    }
+  };
+  var _walkList = function walkList(listNode, listPos, depth) {
+    var childPos = listPos + 1;
+    listNode.forEach(function (listItemNode) {
+      if (!isListItemNode(listItemNode)) {
+        childPos += listItemNode.nodeSize;
+        return;
+      }
+      var itemStart = childPos;
+      var innerPos = itemStart + 1;
+      // Content collected since the last sub-list. Each run becomes its own item.
+      var segmentContent = [];
+      var segmentContentStart = innerPos;
+      var segmentContentSize = 0;
+      var emitSegment = function emitSegment(parentList) {
+        if (segmentContent.length === 0) {
+          return;
+        }
+        var segmentItem = schema.nodes.listItem.create(listItemNode.attrs, segmentContent);
+        pushSegment(segmentItem, segmentContentStart, segmentContentStart + segmentContentSize, depth, parentList);
+      };
+      listItemNode.forEach(function (child) {
+        if (isListNode(child)) {
+          // A sub-list ends the current run: emit it, then walk the sub-list deeper.
+          emitSegment(listNode);
+          segmentContent = [];
+          segmentContentSize = 0;
+          _walkList(child, innerPos, depth + 1);
+          innerPos += child.nodeSize;
+          segmentContentStart = innerPos;
+        } else {
+          if (segmentContent.length === 0) {
+            segmentContentStart = innerPos;
+          }
+          segmentContent.push(child);
+          segmentContentSize += child.nodeSize;
+          innerPos += child.nodeSize;
+        }
+      });
+      // Emit any remaining content after the last sub-list.
+      emitSegment(listNode);
+      childPos += listItemNode.nodeSize;
+    });
+  };
+  _walkList(rootList, rootListStart, 0);
+  if (items.length === 0 || startIndex === -1 || exceedsMaxDepth) {
+    return null;
+  }
+  return {
+    items: items,
+    startIndex: startIndex,
+    endIndex: endIndex
+  };
+}
 export function flattenList(options) {
+  if (fg('platform_editor_flexible_list_normalization_fix')) {
+    return flattenListImpl(options);
+  }
   return flattenListBase(options, {
     isContentNode: function isContentNode(node, parent) {
       return isListItemNode(node) && hasContentChildren(node) && isListNode(parent);

package/dist/types/pm-plugins/utils/list-indentation.d.ts

@@ -1,13 +1,5 @@
-import { type BuildResult, type FlattenedItem, type FlattenListOptions, type FlattenListResult } from '@atlaskit/editor-common/lists';
+import { type BuildResult, type FlattenListOptions, type FlattenListResult, type FlattenedItem } from '@atlaskit/editor-common/lists';
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
-/**
- * Flatten a root list into a flat array of content-bearing items
- * and simultaneously determine which elements intersect the user's selection.
- *
- * Delegates to the shared `flattenListLike` with list-specific callbacks.
- * Selection intersection is checked against each item's content-only
- * span (excluding nested lists).
- */
 export declare function flattenList(options: FlattenListOptions): FlattenListResult | null;
 /**
  * Build a replacement Fragment from a flat array of `FlattenedItem` objects.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-list",
-	"version": "14.1.18",
+	"version": "14.1.20",
 	"description": "List plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,16 +25,16 @@
 		"@atlaskit/editor-plugin-feature-flags": "^11.0.0",
 		"@atlaskit/editor-plugin-toolbar": "^9.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
-		"@atlaskit/editor-toolbar": "^2.2.0",
+		"@atlaskit/editor-toolbar": "^2.3.0",
 		"@atlaskit/icon": "^37.0.0",
 		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@atlaskit/prosemirror-history": "^1.0.0",
 		"@atlaskit/prosemirror-input-rules": "^4.0.0",
-		"@atlaskit/tmp-editor-statsig": "^126.0.0",
+		"@atlaskit/tmp-editor-statsig": "^128.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.30.0",
+		"@atlaskit/editor-common": "^116.33.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -79,6 +79,9 @@
 		},
 		"platform_editor_block_menu_v2_patch_3": {
 			"type": "boolean"
+		},
+		"platform_editor_flexible_list_normalization_fix": {
+			"type": "boolean"
 		}
 	},
 	"stricter": {