@quadrats/common 0.6.7 → 0.7.0

package/list/constants.js

@@ -1,7 +1,7 @@
-const LIST_TYPES = {
-    ol: 'ol',
-    ul: 'ul',
-    li: 'li',
+const LIST_TYPES = {
+    ol: 'ol',
+    ul: 'ul',
+    li: 'li',
 };
 
 export { LIST_TYPES };

package/list/createList.js

@@ -1,190 +1,190 @@
-import { Range, isSelectionAtBlockEdge, deleteSelectionFragmentIfExpanded, isAboveBlockEmpty, Transforms, isNodesTypeIn, getAboveByTypes, getParent, unwrapNodesByTypes, PARAGRAPH_TYPE, wrapNodesWithUnhangRange, getNodesByTypes, isFirstChild, Editor, Path } from '@quadrats/core';
+import { Range, isSelectionAtBlockEdge, deleteSelectionFragmentIfExpanded, isAboveBlockEmpty, Transforms, isNodesTypeIn, getAboveByTypes, getParent, unwrapNodesByTypes, wrapNodesWithUnhangRange, getNodesByTypes, PARAGRAPH_TYPE, isFirstChild, Editor, Path } from '@quadrats/core';
 import { LIST_TYPES } from './constants.js';
 
-function createList(options = {}) {
-    const types = Object.assign(Object.assign({}, LIST_TYPES), options.types);
-    const isListElement = (node) => [types.ol, types.ul].includes(node.type);
-    const isListItemElement = (node) => node.type === types.li;
-    const isSelectionInList = (editor, listTypeKey) => isNodesTypeIn(editor, [types[listTypeKey]]);
-    const getAboveListAndItem = (editor, options = {}) => {
-        const { at = editor.selection } = options;
-        /**
-         * (ul|ol) > li > p
-         */
-        if (at && isNodesTypeIn(editor, [types.li])) {
-            const parentEntry = getAboveByTypes(editor, [types.li]) || getParent(editor, at);
-            if (parentEntry && isListItemElement(parentEntry[0])) {
-                const [, listItemPath] = parentEntry;
-                const parentOfListItemEntry = getParent(editor, listItemPath);
-                if (parentOfListItemEntry && isListElement(parentOfListItemEntry[0])) {
-                    return {
-                        list: parentOfListItemEntry,
-                        listItem: parentEntry,
-                    };
-                }
-            }
-        }
-    };
-    const unwrapList = (editor) => {
-        unwrapNodesByTypes(editor, [types.li]);
-        unwrapNodesByTypes(editor, [types.ol, types.ul], { split: true });
-    };
-    const toggleList = (editor, listTypeKey, defaultType = PARAGRAPH_TYPE) => {
-        if (!editor.selection) {
-            return;
-        }
-        const isActive = isSelectionInList(editor, listTypeKey);
-        unwrapList(editor);
-        Transforms.setNodes(editor, {
-            type: defaultType,
-        });
-        if (!isActive) {
-            wrapNodesWithUnhangRange(editor, { type: types[listTypeKey], children: [] });
-            const nodeEntries = getNodesByTypes(editor, [defaultType]);
-            const listItem = { type: types.li, children: [] };
-            for (const [, path] of nodeEntries) {
-                wrapNodesWithUnhangRange(editor, listItem, {
-                    at: path,
-                });
-            }
-        }
-    };
-    const increaseListItemDepth = (editor, entries) => {
-        var _a, _b, _c, _d, _e;
-        const { list: [listNode], listItem: [, listItemPath], } = entries;
-        if (!isFirstChild(listItemPath)) {
-            const previousEntry = Editor.node(editor, Path.previous(listItemPath));
-            if (previousEntry) {
-                const [previousNode, previousPath] = previousEntry;
-                const lastNodeOfPreviousNode = ((_a = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _a !== void 0 ? _a : [])[((_b = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _b !== void 0 ? _b : []).length - 1];
-                /**
-                 * Move list item next to the last node of previous node of list item.
-                 */
-                if (isListElement(lastNodeOfPreviousNode)) {
-                    Transforms.moveNodes(editor, {
-                        at: listItemPath,
-                        to: [
-                            ...previousPath,
-                            ((_c = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _c !== void 0 ? _c : []).length - 1,
-                            ((_d = lastNodeOfPreviousNode === null || lastNodeOfPreviousNode === void 0 ? void 0 : lastNodeOfPreviousNode.children) !== null && _d !== void 0 ? _d : []).length,
-                        ],
-                    });
-                    /**
-                     * Wrap list item by a new list and move the new list next to the last node of previous node.
-                     */
-                }
-                else {
-                    const newSubListElement = { type: listNode.type, children: [] };
-                    Transforms.wrapNodes(editor, newSubListElement, { at: listItemPath });
-                    Transforms.moveNodes(editor, {
-                        at: listItemPath,
-                        to: [...previousPath, ((_e = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _e !== void 0 ? _e : []).length],
-                    });
-                }
-            }
-        }
-    };
-    const decreaseListItemDepth = (editor, entries) => {
-        var _a, _b, _c;
-        const { list: [listNode, listPath], listItem: [listItemNode, listItemPath], } = entries;
-        const [listParentNode, listParentPath] = Editor.parent(editor, listPath);
-        /**
-         * Decreasable if parent of list is list item.
-         */
-        if (!isListItemElement(listParentNode)) {
-            return;
-        }
-        const newListItemPath = Path.next(listParentPath);
-        const listItemIndex = listItemPath[listItemPath.length - 1];
-        const nextSiblingListItems = ((_a = listNode === null || listNode === void 0 ? void 0 : listNode.children) !== null && _a !== void 0 ? _a : []).slice(listItemIndex + 1, ((_b = listNode === null || listNode === void 0 ? void 0 : listNode.children) !== null && _b !== void 0 ? _b : []).length);
-        Transforms.moveNodes(editor, {
-            at: listItemPath,
-            to: newListItemPath,
-        });
-        /**
-         * After list item moved to parent list, if there are some sibling list items next to list item, move them to a new list in list item.
-         */
-        if (nextSiblingListItems.length) {
-            const newSubListElement = { type: listNode.type, children: [] };
-            const newSubListPath = [...newListItemPath, ((_c = listItemNode === null || listItemNode === void 0 ? void 0 : listItemNode.children) !== null && _c !== void 0 ? _c : []).length];
-            Transforms.insertNodes(editor, newSubListElement, { at: newSubListPath });
-            nextSiblingListItems.forEach((_, index) => {
-                Transforms.moveNodes(editor, {
-                    /**
-                     * Path of each nextSiblingListItems is the same as listItemPath.
-                     * Since each time list item moved, path of next list item will be unshifted.
-                     */
-                    at: listItemPath,
-                    to: [...newSubListPath, index],
-                });
-            });
-        }
-        /**
-         * Remove the stale sublist if there are no previous sibling list items.
-         */
-        if (listItemIndex <= 0) {
-            Transforms.removeNodes(editor, {
-                at: listPath,
-            });
-        }
-    };
-    const decreaseListItemDepthOrUnwrapIfNeed = (editor, entries) => {
-        const { list: [, listPath], } = entries;
-        const [listParentNode] = Editor.parent(editor, listPath);
-        if (listParentNode.type !== types.li) {
-            unwrapList(editor);
-        }
-        else {
-            decreaseListItemDepth(editor, entries);
-        }
-    };
-    return {
-        types,
-        isListElement,
-        isListItemElement,
-        isSelectionInList,
-        getAboveListAndItem,
-        unwrapList,
-        toggleList,
-        increaseListItemDepth,
-        decreaseListItemDepth,
-        decreaseListItemDepthOrUnwrapIfNeed,
-        with(editor) {
-            const { deleteBackward, insertBreak } = editor;
-            editor.deleteBackward = (unit) => {
-                const { selection } = editor;
-                if (selection && Range.isCollapsed(selection)) {
-                    const entries = getAboveListAndItem(editor);
-                    if (entries && isSelectionAtBlockEdge(editor) === 'start') {
-                        decreaseListItemDepthOrUnwrapIfNeed(editor, entries);
-                        return;
-                    }
-                }
-                deleteBackward(unit);
-            };
-            editor.insertBreak = () => {
-                var _a;
-                const entries = getAboveListAndItem(editor);
-                if (entries) {
-                    deleteSelectionFragmentIfExpanded(editor);
-                    if (isAboveBlockEmpty(editor, { match: isListItemElement })) {
-                        decreaseListItemDepthOrUnwrapIfNeed(editor, entries);
-                    }
-                    else {
-                        Transforms.splitNodes(editor, {
-                            at: (_a = editor.selection) === null || _a === void 0 ? void 0 : _a.focus,
-                            match: isListItemElement,
-                            always: true,
-                        });
-                    }
-                }
-                else {
-                    insertBreak();
-                }
-            };
-            return editor;
-        },
-    };
+function createList(options = {}) {
+    const types = Object.assign(Object.assign({}, LIST_TYPES), options.types);
+    const isListElement = (node) => [types.ol, types.ul].includes(node.type);
+    const isListItemElement = (node) => node.type === types.li;
+    const isSelectionInList = (editor, listTypeKey) => isNodesTypeIn(editor, [types[listTypeKey]]);
+    const getAboveListAndItem = (editor, options = {}) => {
+        const { at = editor.selection } = options;
+        /**
+         * (ul|ol) > li > p
+         */
+        if (at && isNodesTypeIn(editor, [types.li])) {
+            const parentEntry = getAboveByTypes(editor, [types.li]) || getParent(editor, at);
+            if (parentEntry && isListItemElement(parentEntry[0])) {
+                const [, listItemPath] = parentEntry;
+                const parentOfListItemEntry = getParent(editor, listItemPath);
+                if (parentOfListItemEntry && isListElement(parentOfListItemEntry[0])) {
+                    return {
+                        list: parentOfListItemEntry,
+                        listItem: parentEntry,
+                    };
+                }
+            }
+        }
+    };
+    const unwrapList = (editor) => {
+        unwrapNodesByTypes(editor, [types.li]);
+        unwrapNodesByTypes(editor, [types.ol, types.ul], { split: true });
+    };
+    const toggleList = (editor, listTypeKey, defaultType = PARAGRAPH_TYPE) => {
+        if (!editor.selection) {
+            return;
+        }
+        const isActive = isSelectionInList(editor, listTypeKey);
+        unwrapList(editor);
+        Transforms.setNodes(editor, {
+            type: defaultType,
+        });
+        if (!isActive) {
+            wrapNodesWithUnhangRange(editor, { type: types[listTypeKey], children: [] });
+            const nodeEntries = getNodesByTypes(editor, [defaultType]);
+            const listItem = { type: types.li, children: [] };
+            for (const [, path] of nodeEntries) {
+                wrapNodesWithUnhangRange(editor, listItem, {
+                    at: path,
+                });
+            }
+        }
+    };
+    const increaseListItemDepth = (editor, entries) => {
+        var _a, _b, _c, _d, _e;
+        const { list: [listNode], listItem: [, listItemPath], } = entries;
+        if (!isFirstChild(listItemPath)) {
+            const previousEntry = Editor.node(editor, Path.previous(listItemPath));
+            if (previousEntry) {
+                const [previousNode, previousPath] = previousEntry;
+                const lastNodeOfPreviousNode = ((_a = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _a !== void 0 ? _a : [])[((_b = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _b !== void 0 ? _b : []).length - 1];
+                /**
+                 * Move list item next to the last node of previous node of list item.
+                 */
+                if (isListElement(lastNodeOfPreviousNode)) {
+                    Transforms.moveNodes(editor, {
+                        at: listItemPath,
+                        to: [
+                            ...previousPath,
+                            ((_c = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _c !== void 0 ? _c : []).length - 1,
+                            ((_d = lastNodeOfPreviousNode === null || lastNodeOfPreviousNode === void 0 ? void 0 : lastNodeOfPreviousNode.children) !== null && _d !== void 0 ? _d : []).length,
+                        ],
+                    });
+                    /**
+                     * Wrap list item by a new list and move the new list next to the last node of previous node.
+                     */
+                }
+                else {
+                    const newSubListElement = { type: listNode.type, children: [] };
+                    Transforms.wrapNodes(editor, newSubListElement, { at: listItemPath });
+                    Transforms.moveNodes(editor, {
+                        at: listItemPath,
+                        to: [...previousPath, ((_e = previousNode === null || previousNode === void 0 ? void 0 : previousNode.children) !== null && _e !== void 0 ? _e : []).length],
+                    });
+                }
+            }
+        }
+    };
+    const decreaseListItemDepth = (editor, entries) => {
+        var _a, _b, _c;
+        const { list: [listNode, listPath], listItem: [listItemNode, listItemPath], } = entries;
+        const [listParentNode, listParentPath] = Editor.parent(editor, listPath);
+        /**
+         * Decreasable if parent of list is list item.
+         */
+        if (!isListItemElement(listParentNode)) {
+            return;
+        }
+        const newListItemPath = Path.next(listParentPath);
+        const listItemIndex = listItemPath[listItemPath.length - 1];
+        const nextSiblingListItems = ((_a = listNode === null || listNode === void 0 ? void 0 : listNode.children) !== null && _a !== void 0 ? _a : []).slice(listItemIndex + 1, ((_b = listNode === null || listNode === void 0 ? void 0 : listNode.children) !== null && _b !== void 0 ? _b : []).length);
+        Transforms.moveNodes(editor, {
+            at: listItemPath,
+            to: newListItemPath,
+        });
+        /**
+         * After list item moved to parent list, if there are some sibling list items next to list item, move them to a new list in list item.
+         */
+        if (nextSiblingListItems.length) {
+            const newSubListElement = { type: listNode.type, children: [] };
+            const newSubListPath = [...newListItemPath, ((_c = listItemNode === null || listItemNode === void 0 ? void 0 : listItemNode.children) !== null && _c !== void 0 ? _c : []).length];
+            Transforms.insertNodes(editor, newSubListElement, { at: newSubListPath });
+            nextSiblingListItems.forEach((_, index) => {
+                Transforms.moveNodes(editor, {
+                    /**
+                     * Path of each nextSiblingListItems is the same as listItemPath.
+                     * Since each time list item moved, path of next list item will be unshifted.
+                     */
+                    at: listItemPath,
+                    to: [...newSubListPath, index],
+                });
+            });
+        }
+        /**
+         * Remove the stale sublist if there are no previous sibling list items.
+         */
+        if (listItemIndex <= 0) {
+            Transforms.removeNodes(editor, {
+                at: listPath,
+            });
+        }
+    };
+    const decreaseListItemDepthOrUnwrapIfNeed = (editor, entries) => {
+        const { list: [, listPath], } = entries;
+        const [listParentNode] = Editor.parent(editor, listPath);
+        if (listParentNode.type !== types.li) {
+            unwrapList(editor);
+        }
+        else {
+            decreaseListItemDepth(editor, entries);
+        }
+    };
+    return {
+        types,
+        isListElement,
+        isListItemElement,
+        isSelectionInList,
+        getAboveListAndItem,
+        unwrapList,
+        toggleList,
+        increaseListItemDepth,
+        decreaseListItemDepth,
+        decreaseListItemDepthOrUnwrapIfNeed,
+        with(editor) {
+            const { deleteBackward, insertBreak } = editor;
+            editor.deleteBackward = (unit) => {
+                const { selection } = editor;
+                if (selection && Range.isCollapsed(selection)) {
+                    const entries = getAboveListAndItem(editor);
+                    if (entries && isSelectionAtBlockEdge(editor) === 'start') {
+                        decreaseListItemDepthOrUnwrapIfNeed(editor, entries);
+                        return;
+                    }
+                }
+                deleteBackward(unit);
+            };
+            editor.insertBreak = () => {
+                var _a;
+                const entries = getAboveListAndItem(editor);
+                if (entries) {
+                    deleteSelectionFragmentIfExpanded(editor);
+                    if (isAboveBlockEmpty(editor, { match: isListItemElement })) {
+                        decreaseListItemDepthOrUnwrapIfNeed(editor, entries);
+                    }
+                    else {
+                        Transforms.splitNodes(editor, {
+                            at: (_a = editor.selection) === null || _a === void 0 ? void 0 : _a.focus,
+                            match: isListItemElement,
+                            always: true,
+                        });
+                    }
+                }
+                else {
+                    insertBreak();
+                }
+            };
+            return editor;
+        },
+    };
 }
 
 export { createList };