@atlaskit/editor-plugin-list 10.0.6 → 10.0.8

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-list
 
+## 10.0.8
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.0.7
+
+### Patch Changes
+
+- [`66fc14c10e82b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/66fc14c10e82b) -
+  EDITOR-5862: Preserve list attributes (order, localId) during flatten-rebuild indentation
+  operations
+- Updated dependencies
+
 ## 10.0.6
 
 ### Patch Changes

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

@@ -70,7 +70,9 @@ function flattenList(_ref) {
       node: node,
       pos: pos,
       depth: depth,
-      listType: parent.type.name
+      listType: parent.type.name,
+      parentListAttrs: parent.attrs,
+      isSelected: isSelected
     });
     if (isSelected) {
       var index = elements.length - 1;
@@ -124,9 +126,10 @@ function rebuildPMList(elements, schema) {
   // items[] accumulates the PMNode children (listItem nodes) for that list.
 
   var stack = [];
-  function openList(listType) {
+  function openList(listType, listAttrs) {
     stack.push({
       listType: listType,
+      listAttrs: listAttrs,
       items: []
     });
   }
@@ -141,7 +144,7 @@ function rebuildPMList(elements, schema) {
       if (!closed) {
         return 1; // break
       }
-      var listNode = schema.nodes[closed.listType].create(null, closed.items);
+      var listNode = schema.nodes[closed.listType].create(closed.listAttrs, closed.items);
 
       // Attach the closed list to the last listItem on the parent frame
       var parentFrame = stack[stack.length - 1];
@@ -165,8 +168,8 @@ function rebuildPMList(elements, schema) {
     }
   }
 
-  // Seed the root list
-  openList(elements[0].listType);
+  // Seed the root list with the first element's parent list attributes
+  openList(elements[0].listType, elements[0].parentListAttrs);
   var _iterator = _createForOfIteratorHelper(elements),
     _step;
   try {
@@ -182,8 +185,12 @@ function rebuildPMList(elements, schema) {
       // Open lists if we need to go deeper.
       // We do NOT create wrapper listItems here — closeToDepth handles
       // creating wrappers that contain only the nested list (no empty paragraph).
+      // For unselected elements, the list structure already existed so we
+      // preserve the parent list's attributes. For selected (moved) elements,
+      // this is a new nesting level so we use null (the localId plugin will
+      // backfill a fresh UUID).
       while (stack.length < targetDepth + 1) {
-        openList(el.listType);
+        openList(el.listType, el.isSelected ? null : el.parentListAttrs);
       }
 
       // Build the listItem for this element using its content children
@@ -200,7 +207,7 @@ function rebuildPMList(elements, schema) {
   }
   closeToDepth(0);
   var root = stack[0];
-  return schema.nodes[root.listType].create(null, root.items);
+  return schema.nodes[root.listType].create(root.listAttrs, root.items);
 }
 /**
  * Build a replacement Fragment from a flat array of `ListElement` objects.

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

@@ -59,7 +59,9 @@ export function flattenList({
       node,
       pos,
       depth,
-      listType: parent.type.name
+      listType: parent.type.name,
+      parentListAttrs: parent.attrs,
+      isSelected
     });
     if (isSelected) {
       const index = elements.length - 1;
@@ -113,9 +115,10 @@ function rebuildPMList(elements, schema) {
   // items[] accumulates the PMNode children (listItem nodes) for that list.
 
   const stack = [];
-  function openList(listType) {
+  function openList(listType, listAttrs) {
     stack.push({
       listType,
+      listAttrs,
       items: []
     });
   }
@@ -130,7 +133,7 @@ function rebuildPMList(elements, schema) {
       if (!closed) {
         break;
       }
-      const listNode = schema.nodes[closed.listType].create(null, closed.items);
+      const listNode = schema.nodes[closed.listType].create(closed.listAttrs, closed.items);
 
       // Attach the closed list to the last listItem on the parent frame
       const parentFrame = stack[stack.length - 1];
@@ -149,8 +152,8 @@ function rebuildPMList(elements, schema) {
     }
   }
 
-  // Seed the root list
-  openList(elements[0].listType);
+  // Seed the root list with the first element's parent list attributes
+  openList(elements[0].listType, elements[0].parentListAttrs);
   for (const el of elements) {
     const targetDepth = el.depth;
 
@@ -162,8 +165,12 @@ function rebuildPMList(elements, schema) {
     // Open lists if we need to go deeper.
     // We do NOT create wrapper listItems here — closeToDepth handles
     // creating wrappers that contain only the nested list (no empty paragraph).
+    // For unselected elements, the list structure already existed so we
+    // preserve the parent list's attributes. For selected (moved) elements,
+    // this is a new nesting level so we use null (the localId plugin will
+    // backfill a fresh UUID).
     while (stack.length < targetDepth + 1) {
-      openList(el.listType);
+      openList(el.listType, el.isSelected ? null : el.parentListAttrs);
     }
 
     // Build the listItem for this element using its content children
@@ -175,7 +182,7 @@ function rebuildPMList(elements, schema) {
   // Close all remaining open lists
   closeToDepth(0);
   const root = stack[0];
-  return schema.nodes[root.listType].create(null, root.items);
+  return schema.nodes[root.listType].create(root.listAttrs, root.items);
 }
 /**
  * Build a replacement Fragment from a flat array of `ListElement` objects.

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

@@ -63,7 +63,9 @@ export function flattenList(_ref) {
       node: node,
       pos: pos,
       depth: depth,
-      listType: parent.type.name
+      listType: parent.type.name,
+      parentListAttrs: parent.attrs,
+      isSelected: isSelected
     });
     if (isSelected) {
       var index = elements.length - 1;
@@ -117,9 +119,10 @@ function rebuildPMList(elements, schema) {
   // items[] accumulates the PMNode children (listItem nodes) for that list.
 
   var stack = [];
-  function openList(listType) {
+  function openList(listType, listAttrs) {
     stack.push({
       listType: listType,
+      listAttrs: listAttrs,
       items: []
     });
   }
@@ -134,7 +137,7 @@ function rebuildPMList(elements, schema) {
       if (!closed) {
         return 1; // break
       }
-      var listNode = schema.nodes[closed.listType].create(null, closed.items);
+      var listNode = schema.nodes[closed.listType].create(closed.listAttrs, closed.items);
 
       // Attach the closed list to the last listItem on the parent frame
       var parentFrame = stack[stack.length - 1];
@@ -158,8 +161,8 @@ function rebuildPMList(elements, schema) {
     }
   }
 
-  // Seed the root list
-  openList(elements[0].listType);
+  // Seed the root list with the first element's parent list attributes
+  openList(elements[0].listType, elements[0].parentListAttrs);
   var _iterator = _createForOfIteratorHelper(elements),
     _step;
   try {
@@ -175,8 +178,12 @@ function rebuildPMList(elements, schema) {
       // Open lists if we need to go deeper.
       // We do NOT create wrapper listItems here — closeToDepth handles
       // creating wrappers that contain only the nested list (no empty paragraph).
+      // For unselected elements, the list structure already existed so we
+      // preserve the parent list's attributes. For selected (moved) elements,
+      // this is a new nesting level so we use null (the localId plugin will
+      // backfill a fresh UUID).
       while (stack.length < targetDepth + 1) {
-        openList(el.listType);
+        openList(el.listType, el.isSelected ? null : el.parentListAttrs);
       }
 
       // Build the listItem for this element using its content children
@@ -193,7 +200,7 @@ function rebuildPMList(elements, schema) {
   }
   closeToDepth(0);
   var root = stack[0];
-  return schema.nodes[root.listType].create(null, root.items);
+  return schema.nodes[root.listType].create(root.listAttrs, root.items);
 }
 /**
  * Build a replacement Fragment from a flat array of `ListElement` objects.

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

@@ -1,4 +1,4 @@
-import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { Attrs, Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { Selection } from '@atlaskit/editor-prosemirror/state';
@@ -8,24 +8,28 @@ import { Selection } from '@atlaskit/editor-prosemirror/state';
  * only items the user can actually see and select are represented.
  */
 export interface ListElement {
-    node: PMNode;
-    pos: number;
     depth: number;
+    /** Whether this element was within the user's selection (and had its depth adjusted). */
+    isSelected: boolean;
     listType: 'bulletList' | 'orderedList';
+    node: PMNode;
+    /** Attributes of the immediate parent list node (bulletList/orderedList). */
+    parentListAttrs: Attrs | null;
+    pos: number;
 }
 export interface FlattenListResult {
     elements: ListElement[];
-    startIndex: number;
     endIndex: number;
     maxDepth: number;
+    startIndex: number;
 }
 export interface FlattenListOptions {
+    delta: number;
     doc: PMNode;
-    rootListStart: number;
     rootListEnd: number;
+    rootListStart: number;
     selectionFrom: number;
     selectionTo: number;
-    delta: number;
 }
 /**
  * Flatten a root list into a flat array of content-bearing `ListElement`
@@ -36,7 +40,6 @@ export interface FlattenListOptions {
  */
 export declare function flattenList({ doc, rootListStart, rootListEnd, selectionFrom, selectionTo, delta, }: FlattenListOptions): FlattenListResult | null;
 export interface BuildResult {
-    fragment: Fragment;
     /**
      * For each element (by index), the offset within the fragment where the
      * element's content begins. For list elements this is the position just
@@ -47,6 +50,7 @@ export interface BuildResult {
      * add `rangeStart` to the offset.
      */
     contentStartOffsets: number[];
+    fragment: Fragment;
 }
 /**
  * Build a replacement Fragment from a flat array of `ListElement` objects.
@@ -58,10 +62,10 @@ export interface BuildResult {
  */
 export declare function buildReplacementFragment(elements: ListElement[], schema: Schema): BuildResult;
 export interface RestoreSelectionOptions {
-    tr: Transaction;
-    originalSelection: Selection;
     from: number;
+    originalSelection: Selection;
     to: number;
+    tr: Transaction;
 }
 /**
  * Restore the transaction's selection after a list structural change.

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

@@ -1,4 +1,4 @@
-import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { Attrs, Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { Selection } from '@atlaskit/editor-prosemirror/state';
@@ -8,24 +8,28 @@ import { Selection } from '@atlaskit/editor-prosemirror/state';
  * only items the user can actually see and select are represented.
  */
 export interface ListElement {
-    node: PMNode;
-    pos: number;
     depth: number;
+    /** Whether this element was within the user's selection (and had its depth adjusted). */
+    isSelected: boolean;
     listType: 'bulletList' | 'orderedList';
+    node: PMNode;
+    /** Attributes of the immediate parent list node (bulletList/orderedList). */
+    parentListAttrs: Attrs | null;
+    pos: number;
 }
 export interface FlattenListResult {
     elements: ListElement[];
-    startIndex: number;
     endIndex: number;
     maxDepth: number;
+    startIndex: number;
 }
 export interface FlattenListOptions {
+    delta: number;
     doc: PMNode;
-    rootListStart: number;
     rootListEnd: number;
+    rootListStart: number;
     selectionFrom: number;
     selectionTo: number;
-    delta: number;
 }
 /**
  * Flatten a root list into a flat array of content-bearing `ListElement`
@@ -36,7 +40,6 @@ export interface FlattenListOptions {
  */
 export declare function flattenList({ doc, rootListStart, rootListEnd, selectionFrom, selectionTo, delta, }: FlattenListOptions): FlattenListResult | null;
 export interface BuildResult {
-    fragment: Fragment;
     /**
      * For each element (by index), the offset within the fragment where the
      * element's content begins. For list elements this is the position just
@@ -47,6 +50,7 @@ export interface BuildResult {
      * add `rangeStart` to the offset.
      */
     contentStartOffsets: number[];
+    fragment: Fragment;
 }
 /**
  * Build a replacement Fragment from a flat array of `ListElement` objects.
@@ -58,10 +62,10 @@ export interface BuildResult {
  */
 export declare function buildReplacementFragment(elements: ListElement[], schema: Schema): BuildResult;
 export interface RestoreSelectionOptions {
-    tr: Transaction;
-    originalSelection: Selection;
     from: number;
+    originalSelection: Selection;
     to: number;
+    tr: Transaction;
 }
 /**
  * Restore the transaction's selection after a list structural change.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-list",
-	"version": "10.0.6",
+	"version": "10.0.8",
 	"description": "List plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^52.3.0",
+		"@atlaskit/adf-schema": "^52.4.0",
 		"@atlaskit/editor-plugin-analytics": "^8.0.0",
 		"@atlaskit/editor-plugin-block-menu": "^7.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^7.0.0",
@@ -38,11 +38,11 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-history": "^0.2.0",
 		"@atlaskit/prosemirror-input-rules": "^3.6.0",
-		"@atlaskit/tmp-editor-statsig": "^40.2.0",
+		"@atlaskit/tmp-editor-statsig": "^41.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.4.0",
+		"@atlaskit/editor-common": "^112.6.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},