@ckeditor/ckeditor5-list 39.0.1 → 40.0.0

package/src/documentlist/utils/postfixers.d.ts

@@ -1,37 +1,37 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist/utils/postfixers
- */
-import type { Position, Writer } from 'ckeditor5/src/engine';
-import { type ListIteratorValue } from './listwalker';
-import { type ListElement } from './model';
-/**
- * Based on the provided positions looks for the list head and stores it in the provided map.
- *
- * @internal
- * @param position The search starting position.
- * @param itemToListHead The map from list item element to the list head element.
- */
-export declare function findAndAddListHeadToMap(position: Position, itemToListHead: Map<ListElement, ListElement>): void;
-/**
- * Scans the list starting from the given list head element and fixes items' indentation.
- *
- * @internal
- * @param listNodes The iterable of list nodes.
- * @param writer The model writer.
- * @returns Whether the model was modified.
- */
-export declare function fixListIndents(listNodes: Iterable<ListIteratorValue>, writer: Writer): boolean;
-/**
- * Scans the list starting from the given list head element and fixes items' types.
- *
- * @internal
- * @param listNodes The iterable of list nodes.
- * @param seenIds The set of already known IDs.
- * @param writer The model writer.
- * @returns Whether the model was modified.
- */
-export declare function fixListItemIds(listNodes: Iterable<ListIteratorValue>, seenIds: Set<string>, writer: Writer): boolean;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlist/utils/postfixers
+ */
+import type { Position, Writer } from 'ckeditor5/src/engine';
+import { type ListIteratorValue } from './listwalker';
+import { type ListElement } from './model';
+/**
+ * Based on the provided positions looks for the list head and stores it in the provided map.
+ *
+ * @internal
+ * @param position The search starting position.
+ * @param itemToListHead The map from list item element to the list head element.
+ */
+export declare function findAndAddListHeadToMap(position: Position, itemToListHead: Map<ListElement, ListElement>): void;
+/**
+ * Scans the list starting from the given list head element and fixes items' indentation.
+ *
+ * @internal
+ * @param listNodes The iterable of list nodes.
+ * @param writer The model writer.
+ * @returns Whether the model was modified.
+ */
+export declare function fixListIndents(listNodes: Iterable<ListIteratorValue>, writer: Writer): boolean;
+/**
+ * Scans the list starting from the given list head element and fixes items' types.
+ *
+ * @internal
+ * @param listNodes The iterable of list nodes.
+ * @param seenIds The set of already known IDs.
+ * @param writer The model writer.
+ * @returns Whether the model was modified.
+ */
+export declare function fixListItemIds(listNodes: Iterable<ListIteratorValue>, seenIds: Set<string>, writer: Writer): boolean;

package/src/documentlist/utils/postfixers.js

@@ -1,118 +1,126 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { iterateSiblingListBlocks } from './listwalker';
-import { getListItemBlocks, isListItemBlock, ListItemUid } from './model';
-/**
- * Based on the provided positions looks for the list head and stores it in the provided map.
- *
- * @internal
- * @param position The search starting position.
- * @param itemToListHead The map from list item element to the list head element.
- */
-export function findAndAddListHeadToMap(position, itemToListHead) {
-    const previousNode = position.nodeBefore;
-    if (!isListItemBlock(previousNode)) {
-        const item = position.nodeAfter;
-        if (isListItemBlock(item)) {
-            itemToListHead.set(item, item);
-        }
-    }
-    else {
-        let listHead = previousNode;
-        // Previously, the loop below was defined like this:
-        //
-        // 		for ( { node: listHead } of iterateSiblingListBlocks( listHead, 'backward' ) )
-        //
-        // Unfortunately, such a destructuring is incorrectly transpiled by Babel and the loop never ends.
-        // See: https://github.com/ckeditor/ckeditor5-react/issues/345.
-        for (const { node } of iterateSiblingListBlocks(listHead, 'backward')) {
-            listHead = node;
-            if (itemToListHead.has(listHead)) {
-                return;
-            }
-        }
-        itemToListHead.set(previousNode, listHead);
-    }
-}
-/**
- * Scans the list starting from the given list head element and fixes items' indentation.
- *
- * @internal
- * @param listNodes The iterable of list nodes.
- * @param writer The model writer.
- * @returns Whether the model was modified.
- */
-export function fixListIndents(listNodes, writer) {
-    let maxIndent = 0; // Guards local sublist max indents that need fixing.
-    let prevIndent = -1; // Previous item indent.
-    let fixBy = null;
-    let applied = false;
-    for (const { node } of listNodes) {
-        const itemIndent = node.getAttribute('listIndent');
-        if (itemIndent > maxIndent) {
-            let newIndent;
-            if (fixBy === null) {
-                fixBy = itemIndent - maxIndent;
-                newIndent = maxIndent;
-            }
-            else {
-                if (fixBy > itemIndent) {
-                    fixBy = itemIndent;
-                }
-                newIndent = itemIndent - fixBy;
-            }
-            if (newIndent > prevIndent + 1) {
-                newIndent = prevIndent + 1;
-            }
-            writer.setAttribute('listIndent', newIndent, node);
-            applied = true;
-            prevIndent = newIndent;
-        }
-        else {
-            fixBy = null;
-            maxIndent = itemIndent + 1;
-            prevIndent = itemIndent;
-        }
-    }
-    return applied;
-}
-/**
- * Scans the list starting from the given list head element and fixes items' types.
- *
- * @internal
- * @param listNodes The iterable of list nodes.
- * @param seenIds The set of already known IDs.
- * @param writer The model writer.
- * @returns Whether the model was modified.
- */
-export function fixListItemIds(listNodes, seenIds, writer) {
-    const visited = new Set();
-    let applied = false;
-    for (const { node } of listNodes) {
-        if (visited.has(node)) {
-            continue;
-        }
-        let listType = node.getAttribute('listType');
-        let listItemId = node.getAttribute('listItemId');
-        // Use a new ID if this one was spot earlier (even in other list).
-        if (seenIds.has(listItemId)) {
-            listItemId = ListItemUid.next();
-        }
-        seenIds.add(listItemId);
-        for (const block of getListItemBlocks(node, { direction: 'forward' })) {
-            visited.add(block);
-            // Use a new ID if a block of a bigger list item has different type.
-            if (block.getAttribute('listType') != listType) {
-                listItemId = ListItemUid.next();
-                listType = block.getAttribute('listType');
-            }
-            if (block.getAttribute('listItemId') != listItemId) {
-                writer.setAttribute('listItemId', listItemId, block);
-                applied = true;
-            }
-        }
-    }
-    return applied;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { iterateSiblingListBlocks } from './listwalker';
+import { getListItemBlocks, isListItemBlock, ListItemUid } from './model';
+/**
+ * Based on the provided positions looks for the list head and stores it in the provided map.
+ *
+ * @internal
+ * @param position The search starting position.
+ * @param itemToListHead The map from list item element to the list head element.
+ */
+export function findAndAddListHeadToMap(position, itemToListHead) {
+    const previousNode = position.nodeBefore;
+    if (!isListItemBlock(previousNode)) {
+        const item = position.nodeAfter;
+        if (isListItemBlock(item)) {
+            itemToListHead.set(item, item);
+        }
+    }
+    else {
+        let listHead = previousNode;
+        // Previously, the loop below was defined like this:
+        //
+        // 		for ( { node: listHead } of iterateSiblingListBlocks( listHead, 'backward' ) )
+        //
+        // Unfortunately, such a destructuring is incorrectly transpiled by Babel and the loop never ends.
+        // See: https://github.com/ckeditor/ckeditor5-react/issues/345.
+        for (const { node } of iterateSiblingListBlocks(listHead, 'backward')) {
+            listHead = node;
+            if (itemToListHead.has(listHead)) {
+                return;
+            }
+        }
+        itemToListHead.set(previousNode, listHead);
+    }
+}
+/**
+ * Scans the list starting from the given list head element and fixes items' indentation.
+ *
+ * @internal
+ * @param listNodes The iterable of list nodes.
+ * @param writer The model writer.
+ * @returns Whether the model was modified.
+ */
+export function fixListIndents(listNodes, writer) {
+    let maxIndent = 0; // Guards local sublist max indents that need fixing.
+    let prevIndent = -1; // Previous item indent.
+    let fixBy = null;
+    let applied = false;
+    for (const { node } of listNodes) {
+        const itemIndent = node.getAttribute('listIndent');
+        if (itemIndent > maxIndent) {
+            let newIndent;
+            if (fixBy === null) {
+                fixBy = itemIndent - maxIndent;
+                newIndent = maxIndent;
+            }
+            else {
+                if (fixBy > itemIndent) {
+                    fixBy = itemIndent;
+                }
+                newIndent = itemIndent - fixBy;
+            }
+            if (newIndent > prevIndent + 1) {
+                newIndent = prevIndent + 1;
+            }
+            writer.setAttribute('listIndent', newIndent, node);
+            applied = true;
+            prevIndent = newIndent;
+        }
+        else {
+            fixBy = null;
+            maxIndent = itemIndent + 1;
+            prevIndent = itemIndent;
+        }
+    }
+    return applied;
+}
+/**
+ * Scans the list starting from the given list head element and fixes items' types.
+ *
+ * @internal
+ * @param listNodes The iterable of list nodes.
+ * @param seenIds The set of already known IDs.
+ * @param writer The model writer.
+ * @returns Whether the model was modified.
+ */
+export function fixListItemIds(listNodes, seenIds, writer) {
+    const visited = new Set();
+    let applied = false;
+    for (const { node } of listNodes) {
+        if (visited.has(node)) {
+            continue;
+        }
+        let listType = node.getAttribute('listType');
+        let listItemId = node.getAttribute('listItemId');
+        // Use a new ID if this one was spot earlier (even in other list).
+        if (seenIds.has(listItemId)) {
+            listItemId = ListItemUid.next();
+        }
+        seenIds.add(listItemId);
+        // Make sure that all items in a simple list have unique IDs.
+        if (node.is('element', 'listItem')) {
+            if (node.getAttribute('listItemId') != listItemId) {
+                writer.setAttribute('listItemId', listItemId, node);
+                applied = true;
+            }
+            continue;
+        }
+        for (const block of getListItemBlocks(node, { direction: 'forward' })) {
+            visited.add(block);
+            // Use a new ID if a block of a bigger list item has different type.
+            if (block.getAttribute('listType') != listType) {
+                listItemId = ListItemUid.next();
+                listType = block.getAttribute('listType');
+            }
+            if (block.getAttribute('listItemId') != listItemId) {
+                writer.setAttribute('listItemId', listItemId, block);
+                applied = true;
+            }
+        }
+    }
+    return applied;
+}

package/src/documentlist/utils/view.d.ts

@@ -1,81 +1,81 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist/utils/view
- */
-import type { DowncastWriter, ViewAttributeElement, ViewDocumentFragment, ViewElement, ViewNode } from 'ckeditor5/src/engine';
-/**
- * Checks if view element is a list type (ul or ol).
- *
- * @internal
- */
-export declare function isListView(viewElement: ViewNode | ViewDocumentFragment): viewElement is ViewElement & {
-    name: 'ul' | 'ol';
-};
-/**
- * Checks if view element is a list item (li).
- *
- * @internal
- */
-export declare function isListItemView(viewElement: ViewNode | ViewDocumentFragment): viewElement is ViewElement & {
-    name: 'li';
-};
-/**
- * Calculates the indent value for a list item. Handles HTML compliant and non-compliant lists.
- *
- * Also, fixes non HTML compliant lists indents:
- *
- * ```
- * before:                                     fixed list:
- * OL                                          OL
- * |-> LI (parent LIs: 0)                      |-> LI     (indent: 0)
- *     |-> OL                                  |-> OL
- *         |-> OL                                  |
- *         |   |-> OL                              |
- *         |       |-> OL                          |
- *         |           |-> LI (parent LIs: 1)      |-> LI (indent: 1)
- *         |-> LI (parent LIs: 1)                  |-> LI (indent: 1)
- *
- * before:                                     fixed list:
- * OL                                          OL
- * |-> OL                                      |
- *     |-> OL                                  |
- *          |-> OL                             |
- *              |-> LI (parent LIs: 0)         |-> LI        (indent: 0)
- *
- * before:                                     fixed list:
- * OL                                          OL
- * |-> LI (parent LIs: 0)                      |-> LI         (indent: 0)
- * |-> OL                                          |-> OL
- *     |-> LI (parent LIs: 0)                          |-> LI (indent: 1)
- * ```
- *
- * @internal
- */
-export declare function getIndent(listItem: ViewElement): number;
-/**
- * Creates a list attribute element (ol or ul).
- *
- * @internal
- */
-export declare function createListElement(writer: DowncastWriter, indent: number, type: 'bulleted' | 'numbered', id?: string): ViewAttributeElement;
-/**
- * Creates a list item attribute element (li).
- *
- * @internal
- */
-export declare function createListItemElement(writer: DowncastWriter, indent: number, id: string): ViewAttributeElement;
-/**
- * Returns a view element name for the given list type.
- *
- * @internal
- */
-export declare function getViewElementNameForListType(type?: 'bulleted' | 'numbered'): 'ol' | 'ul';
-/**
- * Returns a view element ID for the given list type and indent.
- *
- * @internal
- */
-export declare function getViewElementIdForListType(type?: 'bulleted' | 'numbered', indent?: number): string;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlist/utils/view
+ */
+import type { DowncastWriter, ViewAttributeElement, ViewDocumentFragment, ViewElement, ViewNode } from 'ckeditor5/src/engine';
+/**
+ * Checks if view element is a list type (ul or ol).
+ *
+ * @internal
+ */
+export declare function isListView(viewElement: ViewNode | ViewDocumentFragment): viewElement is ViewElement & {
+    name: 'ul' | 'ol';
+};
+/**
+ * Checks if view element is a list item (li).
+ *
+ * @internal
+ */
+export declare function isListItemView(viewElement: ViewNode | ViewDocumentFragment): viewElement is ViewElement & {
+    name: 'li';
+};
+/**
+ * Calculates the indent value for a list item. Handles HTML compliant and non-compliant lists.
+ *
+ * Also, fixes non HTML compliant lists indents:
+ *
+ * ```
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> LI (parent LIs: 0)                      |-> LI     (indent: 0)
+ *     |-> OL                                  |-> OL
+ *         |-> OL                                  |
+ *         |   |-> OL                              |
+ *         |       |-> OL                          |
+ *         |           |-> LI (parent LIs: 1)      |-> LI (indent: 1)
+ *         |-> LI (parent LIs: 1)                  |-> LI (indent: 1)
+ *
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> OL                                      |
+ *     |-> OL                                  |
+ *          |-> OL                             |
+ *              |-> LI (parent LIs: 0)         |-> LI        (indent: 0)
+ *
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> LI (parent LIs: 0)                      |-> LI         (indent: 0)
+ * |-> OL                                          |-> OL
+ *     |-> LI (parent LIs: 0)                          |-> LI (indent: 1)
+ * ```
+ *
+ * @internal
+ */
+export declare function getIndent(listItem: ViewElement): number;
+/**
+ * Creates a list attribute element (ol or ul).
+ *
+ * @internal
+ */
+export declare function createListElement(writer: DowncastWriter, indent: number, type: 'bulleted' | 'numbered' | 'todo', id?: string): ViewAttributeElement;
+/**
+ * Creates a list item attribute element (li).
+ *
+ * @internal
+ */
+export declare function createListItemElement(writer: DowncastWriter, indent: number, id: string): ViewAttributeElement;
+/**
+ * Returns a view element name for the given list type.
+ *
+ * @internal
+ */
+export declare function getViewElementNameForListType(type?: 'bulleted' | 'numbered' | 'todo'): 'ol' | 'ul';
+/**
+ * Returns a view element ID for the given list type and indent.
+ *
+ * @internal
+ */
+export declare function getViewElementIdForListType(type?: 'bulleted' | 'numbered' | 'todo', indent?: number): string;