@datalayer/lexical-loro 0.2.3 → 0.2.5

package/lib/plugins/CollapsiblePlugin/CollapsibleTitleNode.js

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the MIT License.
+ */
+import { IS_CHROME } from '@lexical/utils';
+import { $createParagraphNode, $isElementNode, buildImportMap, ElementNode, } from 'lexical';
+import { $isCollapsibleContainerNode } from './CollapsibleContainerNode';
+import { $isCollapsibleContentNode } from './CollapsibleContentNode';
+export function $convertSummaryElement(domNode) {
+    const node = $createCollapsibleTitleNode();
+    return {
+        node,
+    };
+}
+/** @noInheritDoc */
+export class CollapsibleTitleNode extends ElementNode {
+    /** @internal */
+    $config() {
+        return this.config('collapsible-title', {
+            $transform(node) {
+                if (node.isEmpty()) {
+                    node.remove();
+                }
+            },
+            extends: ElementNode,
+            importDOM: buildImportMap({
+                summary: () => ({
+                    conversion: $convertSummaryElement,
+                    priority: 1,
+                }),
+            }),
+        });
+    }
+    createDOM(config, editor) {
+        const dom = document.createElement('summary');
+        dom.classList.add('Collapsible__title');
+        if (IS_CHROME) {
+            dom.addEventListener('click', () => {
+                editor.update(() => {
+                    const collapsibleContainer = this.getLatest().getParentOrThrow();
+                    if (!$isCollapsibleContainerNode(collapsibleContainer)) {
+                        throw new Error('Expected parent node to be a CollapsibleContainerNode');
+                    }
+                    collapsibleContainer.toggleOpen();
+                });
+            });
+        }
+        return dom;
+    }
+    updateDOM(prevNode, dom) {
+        return false;
+    }
+    insertNewAfter(_, restoreSelection = true) {
+        const containerNode = this.getParentOrThrow();
+        if (!$isCollapsibleContainerNode(containerNode)) {
+            throw new Error('CollapsibleTitleNode expects to be child of CollapsibleContainerNode');
+        }
+        if (containerNode.getOpen()) {
+            const contentNode = this.getNextSibling();
+            if (!$isCollapsibleContentNode(contentNode)) {
+                throw new Error('CollapsibleTitleNode expects to have CollapsibleContentNode sibling');
+            }
+            const firstChild = contentNode.getFirstChild();
+            if ($isElementNode(firstChild)) {
+                return firstChild;
+            }
+            else {
+                const paragraph = $createParagraphNode();
+                contentNode.append(paragraph);
+                return paragraph;
+            }
+        }
+        else {
+            const paragraph = $createParagraphNode();
+            containerNode.insertAfter(paragraph, restoreSelection);
+            return paragraph;
+        }
+    }
+}
+export function $createCollapsibleTitleNode() {
+    return new CollapsibleTitleNode();
+}
+export function $isCollapsibleTitleNode(node) {
+    return node instanceof CollapsibleTitleNode;
+}

package/lib/plugins/CollapsiblePlugin/CollapsibleUtils.d.ts

@@ -0,0 +1,2 @@
+export declare function setDomHiddenUntilFound(dom: HTMLElement): void;
+export declare function domOnBeforeMatch(dom: HTMLElement, callback: () => void): void;

package/lib/plugins/CollapsiblePlugin/CollapsibleUtils.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the MIT License.
+ */
+export function setDomHiddenUntilFound(dom) {
+    // @ts-expect-error
+    dom.hidden = 'until-found';
+}
+export function domOnBeforeMatch(dom, callback) {
+    // dom.onbeforematch = callback; // IGNORE
+    dom.addEventListener('beforematch', callback);
+}

package/lib/plugins/CollapsiblePlugin/index.d.ts

@@ -0,0 +1,3 @@
+import './Collapsible.css';
+export declare const INSERT_COLLAPSIBLE_COMMAND: import("lexical").LexicalCommand<void>;
+export default function CollapsiblePlugin(): null;

package/lib/plugins/CollapsiblePlugin/index.js

@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the MIT License.
+ */
+import './Collapsible.css';
+import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext';
+import { $findMatchingParent, $insertNodeToNearestRoot, mergeRegister, } from '@lexical/utils';
+import { $createParagraphNode, $getSelection, $isRangeSelection, COMMAND_PRIORITY_LOW, createCommand, INSERT_PARAGRAPH_COMMAND, KEY_ARROW_DOWN_COMMAND, KEY_ARROW_LEFT_COMMAND, KEY_ARROW_RIGHT_COMMAND, KEY_ARROW_UP_COMMAND, } from 'lexical';
+import { useEffect } from 'react';
+import { $createCollapsibleContainerNode, $isCollapsibleContainerNode, CollapsibleContainerNode, } from './CollapsibleContainerNode';
+import { $createCollapsibleContentNode, $isCollapsibleContentNode, CollapsibleContentNode, } from './CollapsibleContentNode';
+import { $createCollapsibleTitleNode, $isCollapsibleTitleNode, CollapsibleTitleNode, } from './CollapsibleTitleNode';
+export const INSERT_COLLAPSIBLE_COMMAND = createCommand('INSERT_COLLAPSIBLE_COMMAND');
+export default function CollapsiblePlugin() {
+    const [editor] = useLexicalComposerContext();
+    useEffect(() => {
+        if (!editor.hasNodes([
+            CollapsibleContainerNode,
+            CollapsibleTitleNode,
+            CollapsibleContentNode,
+        ])) {
+            throw new Error('CollapsiblePlugin: CollapsibleContainerNode, CollapsibleTitleNode, or CollapsibleContentNode not registered on editor');
+        }
+        const $onEscapeUp = () => {
+            const selection = $getSelection();
+            if ($isRangeSelection(selection) &&
+                selection.isCollapsed() &&
+                selection.anchor.offset === 0) {
+                const container = $findMatchingParent(selection.anchor.getNode(), $isCollapsibleContainerNode);
+                if ($isCollapsibleContainerNode(container)) {
+                    const parent = container.getParent();
+                    if (parent !== null &&
+                        parent.getFirstChild() === container &&
+                        selection.anchor.key === container.getFirstDescendant()?.getKey()) {
+                        container.insertBefore($createParagraphNode());
+                    }
+                }
+            }
+            return false;
+        };
+        const $onEscapeDown = () => {
+            const selection = $getSelection();
+            if ($isRangeSelection(selection) && selection.isCollapsed()) {
+                const container = $findMatchingParent(selection.anchor.getNode(), $isCollapsibleContainerNode);
+                if ($isCollapsibleContainerNode(container)) {
+                    const parent = container.getParent();
+                    if (parent !== null && parent.getLastChild() === container) {
+                        const titleParagraph = container.getFirstDescendant();
+                        const contentParagraph = container.getLastDescendant();
+                        if ((contentParagraph !== null &&
+                            selection.anchor.key === contentParagraph.getKey() &&
+                            selection.anchor.offset ===
+                                contentParagraph.getTextContentSize()) ||
+                            (titleParagraph !== null &&
+                                selection.anchor.key === titleParagraph.getKey() &&
+                                selection.anchor.offset === titleParagraph.getTextContentSize())) {
+                            container.insertAfter($createParagraphNode());
+                        }
+                    }
+                }
+            }
+            return false;
+        };
+        return mergeRegister(
+        // Structure enforcing transformers for each node type. In case nesting structure is not
+        // "Container > Title + Content" it'll unwrap nodes and convert it back
+        // to regular content.
+        editor.registerNodeTransform(CollapsibleContentNode, (node) => {
+            const parent = node.getParent();
+            if (!$isCollapsibleContainerNode(parent)) {
+                const children = node.getChildren();
+                for (const child of children) {
+                    node.insertBefore(child);
+                }
+                node.remove();
+            }
+        }), editor.registerNodeTransform(CollapsibleTitleNode, (node) => {
+            const parent = node.getParent();
+            if (!$isCollapsibleContainerNode(parent)) {
+                node.replace($createParagraphNode().append(...node.getChildren()));
+                return;
+            }
+        }), editor.registerNodeTransform(CollapsibleContainerNode, (node) => {
+            const children = node.getChildren();
+            if (children.length !== 2 ||
+                !$isCollapsibleTitleNode(children[0]) ||
+                !$isCollapsibleContentNode(children[1])) {
+                for (const child of children) {
+                    node.insertBefore(child);
+                }
+                node.remove();
+            }
+        }), 
+        // When collapsible is the last child pressing down/right arrow will insert paragraph
+        // below it to allow adding more content. It's similar what $insertBlockNode
+        // (mainly for decorators), except it'll always be possible to continue adding
+        // new content even if trailing paragraph is accidentally deleted
+        editor.registerCommand(KEY_ARROW_DOWN_COMMAND, $onEscapeDown, COMMAND_PRIORITY_LOW), editor.registerCommand(KEY_ARROW_RIGHT_COMMAND, $onEscapeDown, COMMAND_PRIORITY_LOW), 
+        // When collapsible is the first child pressing up/left arrow will insert paragraph
+        // above it to allow adding more content. It's similar what $insertBlockNode
+        // (mainly for decorators), except it'll always be possible to continue adding
+        // new content even if leading paragraph is accidentally deleted
+        editor.registerCommand(KEY_ARROW_UP_COMMAND, $onEscapeUp, COMMAND_PRIORITY_LOW), editor.registerCommand(KEY_ARROW_LEFT_COMMAND, $onEscapeUp, COMMAND_PRIORITY_LOW), 
+        // Enter goes from Title to Content rather than a new line inside Title
+        editor.registerCommand(INSERT_PARAGRAPH_COMMAND, () => {
+            const selection = $getSelection();
+            if ($isRangeSelection(selection)) {
+                const titleNode = $findMatchingParent(selection.anchor.getNode(), (node) => $isCollapsibleTitleNode(node));
+                if ($isCollapsibleTitleNode(titleNode)) {
+                    const container = titleNode.getParent();
+                    if (container && $isCollapsibleContainerNode(container)) {
+                        if (!container.getOpen()) {
+                            container.toggleOpen();
+                        }
+                        titleNode.getNextSibling()?.selectEnd();
+                        return true;
+                    }
+                }
+            }
+            return false;
+        }, COMMAND_PRIORITY_LOW), editor.registerCommand(INSERT_COLLAPSIBLE_COMMAND, () => {
+            editor.update(() => {
+                const title = $createCollapsibleTitleNode();
+                const paragraph = $createParagraphNode();
+                $insertNodeToNearestRoot($createCollapsibleContainerNode(true).append(title.append(paragraph), $createCollapsibleContentNode().append($createParagraphNode())));
+                paragraph.select();
+            });
+            return true;
+        }, COMMAND_PRIORITY_LOW));
+    }, [editor]);
+    return null;
+}

package/lib/plugins/CommentPlugin/index.d.ts

@@ -0,0 +1,9 @@
+import type { LexicalCommand } from 'lexical';
+import type { JSX } from 'react';
+import type { Doc } from 'yjs';
+import './index.css';
+import { Provider } from '../../collab/yjs/State';
+export declare const INSERT_INLINE_COMMAND: LexicalCommand<void>;
+export default function CommentPlugin({ providerFactory, }: {
+    providerFactory?: (id: string, yjsDocMap: Map<string, Doc>) => Provider;
+}): JSX.Element;