@datalayer/lexical-loro 0.2.5 → 1.0.1

package/lib/collab/loro/utils/LexicalToLoro.js

@@ -1,100 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the MIT License.
- */
-/**
- * Convert a Lexical JSON structure to a Loro tree
- * This is used to initialize a Loro tree from existing Lexical content
- */
-export function lexicalToLoroTree(lexicalJson, tree) {
-    let parsedJson;
-    if (typeof lexicalJson === 'string') {
-        try {
-            parsedJson = JSON.parse(lexicalJson);
-        }
-        catch (error) {
-            throw new Error(`Failed to parse Lexical JSON: ${error}`);
-        }
-    }
-    else {
-        parsedJson = lexicalJson;
-    }
-    // Start with the root node - create it without a parent
-    const rootTreeNode = tree.createNode();
-    const rootTreeID = rootTreeNode.id;
-    processLexicalNode(parsedJson.root, tree, rootTreeNode);
-    return rootTreeID;
-}
-/**
- * Recursively process a Lexical node and add it to the Loro tree
- */
-function processLexicalNode(lexicalNode, tree, treeNode) {
-    // Store the lexical data in the tree node
-    const nodeData = treeNode.data;
-    if (nodeData) {
-        // Store element type for quick access
-        nodeData.set('elementType', lexicalNode.type);
-        // Store lexical node data directly as JSON object
-        const lexicalNodeData = createLexicalNodeFromJSON(lexicalNode);
-        const lexicalNodeJSON = lexicalNodeData.lexicalNode.exportJSON();
-        // Remove all key-related fields to avoid duplication (TreeID serves as the key)
-        if ('__key' in lexicalNodeJSON || 'key' in lexicalNodeJSON || 'lexicalKey' in lexicalNodeJSON) {
-            const { __key, key, lexicalKey, ...cleanedData } = lexicalNodeJSON;
-            nodeData.set('lexical', cleanedData);
-        }
-        else {
-            nodeData.set('lexical', lexicalNodeJSON);
-        }
-    }
-    // Process children if they exist
-    if (lexicalNode.children && Array.isArray(lexicalNode.children)) {
-        lexicalNode.children.forEach((child, childIndex) => {
-            // Create child node under current node
-            const childTreeNode = tree.createNode(treeNode.id, childIndex);
-            processLexicalNode(child, tree, childTreeNode);
-        });
-    }
-}
-/**
- * Create a minimal Lexical node representation from JSON data
- * This doesn't create actual Lexical nodes, just the data structure needed for serialization
- */
-function createLexicalNodeFromJSON(nodeJson) {
-    // Create a minimal node-like object with the essential properties
-    const nodeData = {
-        __key: generateNodeKey(), // Generate a temporary key
-        __type: nodeJson.type,
-        __parent: null, // Will be set during tree construction
-        __text: nodeJson.text || undefined,
-        __format: nodeJson.format || 0,
-        __style: nodeJson.style || '',
-        __mode: nodeJson.mode || undefined,
-        __detail: nodeJson.detail || undefined,
-        __indent: nodeJson.indent || 0,
-        __direction: nodeJson.direction || null,
-        __tag: nodeJson.tag || undefined,
-        __textFormat: nodeJson.textFormat || undefined,
-        __textStyle: nodeJson.textStyle || undefined,
-        __version: nodeJson.version || 1
-    };
-    // Remove undefined properties
-    Object.keys(nodeData).forEach(key => {
-        if (nodeData[key] === undefined) {
-            delete nodeData[key];
-        }
-    });
-    // Return in the format expected by LexicalNodeDataHelper
-    return {
-        lexicalNode: {
-            getType: () => nodeJson.type,
-            exportJSON: () => nodeData,
-            getKey: () => nodeData.__key
-        }
-    };
-}
-/**
- * Generate a simple node key for temporary use
- */
-function generateNodeKey() {
-    return Math.random().toString(36).substr(2, 9);
-}

package/lib/collab/loro/utils/Utils.d.ts

@@ -1,44 +0,0 @@
-import { LoroDoc, TreeID } from 'loro-crdt';
-import { EditorState, LexicalNode, NodeKey, RangeSelection, TextNode } from 'lexical';
-export declare const DEFAULT_TREE_NAME = "lexical-tree";
-/**
- * Generates a consistent client ID from a Loro document.
- * Uses the numeric peer ID directly to ensure consistency across all components.
- *
- * @param doc - The Loro document
- * @returns A number representing the client ID
- */
-export declare function generateClientID(doc: LoroDoc): number;
-/**
- * Generates a client ID for cases where no document is available.
- * Creates a random ID within the safe integer range.
- *
- * @returns A randomly generated client ID
- */
-export declare function generateRandomClientID(): number;
-/**
- * Ensure doc has a LoroTree instance
- */
-export declare function getLoroTree(doc: LoroDoc, treeName?: string): import("loro-crdt").LoroTree<Record<string, unknown>>;
-/**
- * Helper function to parse TreeID back to nodeKey and peerId
- */
-export declare function parseTreeID(treeId: TreeID): {
-    nodeKey: NodeKey;
-    peerId: number;
-};
-/**
- * Helper function to get Lexical node information for Loro sync
- */
-export declare function getLexicalNodeInfo(node: LexicalNode): {
-    parentKey?: string;
-    index?: number;
-};
-/**
- * Check if a class extends another class (proper inheritance checking)
- */
-export declare function isClassExtending(Klass: any, BaseClass: any): boolean;
-export declare function toKeyNodeNumber(nodeKey: NodeKey): number;
-export declare function $diffTextContentAndApplyDelta(textNode: TextNode, key: NodeKey, prevText: string, nextText: string): void;
-export declare function doesSelectionNeedRecovering(selection: RangeSelection): boolean;
-export declare function $moveSelectionToPreviousNode(anchorNodeKey: string, currentEditorState: EditorState): void;

package/lib/collab/loro/utils/Utils.js

@@ -1,157 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the MIT License.
- */
-import { $getNodeByKey, $getRoot, $getSelection, $isRangeSelection, $isTextNode } from 'lexical';
-import simpleDiffWithCursor from '../../utils/simpleDiffWithCursor';
-export const DEFAULT_TREE_NAME = 'lexical-tree';
-/**
- * Generates a consistent client ID from a Loro document.
- * Uses the numeric peer ID directly to ensure consistency across all components.
- *
- * @param doc - The Loro document
- * @returns A number representing the client ID
- */
-export function generateClientID(doc) {
-    return Number(doc.peerId);
-}
-/**
- * Generates a client ID for cases where no document is available.
- * Creates a random ID within the safe integer range.
- *
- * @returns A randomly generated client ID
- */
-export function generateRandomClientID() {
-    return Math.floor(Math.random() * 2147483647);
-}
-/**
- * Ensure doc has a LoroTree instance
- */
-export function getLoroTree(doc, treeName = DEFAULT_TREE_NAME) {
-    const tree = doc.getTree(treeName);
-    // Enable fractional index for ordered siblings (useful for maintaining order)
-    // tree.enableFractionalIndex(0.001);
-    return tree;
-}
-/**
- * Helper function to parse TreeID back to nodeKey and peerId
- */
-export function parseTreeID(treeId) {
-    const [nodeKey, peerId] = treeId.split('@');
-    return {
-        nodeKey: nodeKey,
-        peerId: Number(peerId)
-    };
-}
-/**
- * Helper function to get Lexical node information for Loro sync
- */
-export function getLexicalNodeInfo(node) {
-    // TODO: Implement logic to get parent and index from Lexical node
-    // This is a placeholder that should be replaced with actual Lexical API calls
-    return {
-        parentKey: node.getParent()?.getKey(),
-        index: node.getIndexWithinParent()
-    };
-}
-/**
- * Check if a class extends another class (proper inheritance checking)
- */
-export function isClassExtending(Klass, BaseClass) {
-    // Direct class equality
-    if (Klass === BaseClass) {
-        return true;
-    }
-    // Check by name (for cases where classes might be different instances)
-    if (Klass.name === BaseClass.name) {
-        return true;
-    }
-    // Check prototype chain for inheritance
-    if (Klass.prototype && Object.prototype.isPrototypeOf.call(BaseClass, Klass)) {
-        return true;
-    }
-    return false;
-}
-export function toKeyNodeNumber(nodeKey) {
-    // Special case for root node
-    if (nodeKey === "root") {
-        return 0;
-    }
-    // Attempt to convert NodeKey (string) to a number
-    const keyAsNumber = Number(nodeKey);
-    if (!isNaN(keyAsNumber)) {
-        return keyAsNumber;
-    }
-    // If conversion fails, throw an error
-    throw new Error(`NodeKey "${nodeKey}" cannot be converted to a number. Expected numeric string or "root".`);
-}
-export function $diffTextContentAndApplyDelta(textNode, key, prevText, nextText) {
-    const selection = $getSelection();
-    let cursorOffset = nextText.length;
-    if ($isRangeSelection(selection) && selection.isCollapsed()) {
-        const anchor = selection.anchor;
-        if (anchor.key === key) {
-            // Ensure cursor offset doesn't exceed the new text length
-            // This prevents errors when text is split or content changes significantly
-            cursorOffset = Math.min(anchor.offset, nextText.length);
-        }
-    }
-    const diff = simpleDiffWithCursor(prevText, nextText, cursorOffset);
-    const beforeSplice = textNode.getTextContent();
-    textNode.spliceText(diff.index, diff.remove, diff.insert);
-    const afterSplice = textNode.getTextContent();
-}
-export function doesSelectionNeedRecovering(selection) {
-    const anchor = selection.anchor;
-    const focus = selection.focus;
-    let recoveryNeeded = false;
-    try {
-        const anchorNode = anchor.getNode();
-        const focusNode = focus.getNode();
-        if (
-        // We might have removed a node that no longer exists
-        !anchorNode.isAttached() ||
-            !focusNode.isAttached() ||
-            // If we've split a node, then the offset might not be right
-            ($isTextNode(anchorNode) &&
-                anchor.offset > anchorNode.getTextContentSize()) ||
-            ($isTextNode(focusNode) && focus.offset > focusNode.getTextContentSize())) {
-            recoveryNeeded = true;
-        }
-    }
-    catch (e) {
-        // Sometimes checking nor a node via getNode might trigger
-        // an error, so we need recovery then too.
-        recoveryNeeded = true;
-    }
-    return recoveryNeeded;
-}
-export function $moveSelectionToPreviousNode(anchorNodeKey, currentEditorState) {
-    const anchorNode = currentEditorState._nodeMap.get(anchorNodeKey);
-    if (!anchorNode) {
-        $getRoot().selectStart();
-        return;
-    }
-    // Get previous node
-    const prevNodeKey = anchorNode.__prev;
-    let prevNode = null;
-    if (prevNodeKey) {
-        prevNode = $getNodeByKey(prevNodeKey);
-    }
-    // If previous node not found, get parent node
-    if (prevNode === null && anchorNode.__parent !== null) {
-        prevNode = $getNodeByKey(anchorNode.__parent);
-    }
-    if (prevNode === null) {
-        $getRoot().selectStart();
-        return;
-    }
-    if (prevNode !== null && prevNode.isAttached()) {
-        prevNode.selectEnd();
-        return;
-    }
-    else {
-        // If the found node is also deleted, select the next one
-        $moveSelectionToPreviousNode(prevNode.__key, currentEditorState);
-    }
-}

package/lib/collab/loro/wsProvider.d.ts

@@ -1,8 +0,0 @@
-import { LoroDoc } from 'loro-crdt';
-import { Provider } from './State';
-/**
- * Create a WebSocket provider for Loro collaboration with periodic ephemeral state synchronization.
- * The resyncInterval enables client-side periodic querying to complement server-side cleanup,
- * preventing stale user states from accumulating after browser refreshes.
- */
-export declare function createWebsocketProvider(id: string, docMap: Map<string, LoroDoc>, websocketUrl?: string): Provider;

package/lib/collab/loro/wsProvider.js

@@ -1,35 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the MIT License.
- */
-import { LoroDoc } from 'loro-crdt';
-import { WebsocketProvider } from './provider/websocket';
-const url = new URL(window.location.href);
-const params = new URLSearchParams(url.search);
-const RESYNC_INTERVAL = parseInt(params.get('resyncInterval') || '30000', 10); // Default 30s, configurable via URL
-/**
- * Create a WebSocket provider for Loro collaboration with periodic ephemeral state synchronization.
- * The resyncInterval enables client-side periodic querying to complement server-side cleanup,
- * preventing stale user states from accumulating after browser refreshes.
- */
-export function createWebsocketProvider(id, docMap, websocketUrl) {
-    let doc = docMap.get(id);
-    if (doc === undefined) {
-        doc = new LoroDoc();
-        docMap.set(id, doc);
-    }
-    const providerInstanceId = Math.random().toString(36).substr(2, 9);
-    console.log(`🏭 Creating WebsocketProvider instance (ID: ${providerInstanceId}) for docId: ${id}`);
-    // Use provided websocketUrl or fallback to URL parameters/defaults
-    const finalWebsocketUrl = websocketUrl || (() => {
-        const url = new URL(window.location.href);
-        const params = new URLSearchParams(url.search);
-        return params.get('collabEndpoint') || 'ws://localhost:3002';
-    })();
-    const websocketProvider = new WebsocketProvider(finalWebsocketUrl, id, doc, {
-        connect: false,
-        resyncInterval: RESYNC_INTERVAL, // Poll ephemeral state periodically to prevent stale user accumulation
-    });
-    console.log(`🏭 WebsocketProvider created for: ${finalWebsocketUrl}/${id} with resyncInterval: ${RESYNC_INTERVAL}ms`);
-    return websocketProvider;
-}

package/lib/collab/utils/invariant.d.ts

@@ -1 +0,0 @@
-export default function invariant(cond?: boolean, message?: string, ...args: string[]): asserts cond;

package/lib/collab/utils/invariant.js

@@ -1,15 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the MIT License.
- */
-// invariant(condition, message) will refine types based on "condition", and
-// if "condition" is false will throw an error. This function is special-cased
-// in flow itself, so we can't name it anything else.
-export default function invariant(cond, message, ...args) {
-    if (cond) {
-        return;
-    }
-    throw new Error('Internal Lexical error: invariant() is meant to be replaced at compile ' +
-        'time. There is no runtime version. Error: ' +
-        message);
-}

package/lib/collab/utils/simpleDiffWithCursor.d.ts

@@ -1,5 +0,0 @@
-export default function simpleDiffWithCursor(a: string, b: string, cursor: number): {
-    index: number;
-    insert: string;
-    remove: number;
-};

package/lib/collab/utils/simpleDiffWithCursor.js

@@ -1,35 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the MIT License.
- */
-export default function simpleDiffWithCursor(a, b, cursor) {
-    const aLength = a.length;
-    const bLength = b.length;
-    let left = 0; // number of same characters counting from left
-    let right = 0; // number of same characters counting from right
-    // Iterate left to the right until we find a changed character
-    // First iteration considers the current cursor position
-    while (left < aLength &&
-        left < bLength &&
-        a[left] === b[left] &&
-        left < cursor) {
-        left++;
-    }
-    // Iterate right to the left until we find a changed character
-    while (right + left < aLength &&
-        right + left < bLength &&
-        a[aLength - right - 1] === b[bLength - right - 1]) {
-        right++;
-    }
-    // Try to iterate left further to the right without caring about the current cursor position
-    while (right + left < aLength &&
-        right + left < bLength &&
-        a[left] === b[left]) {
-        left++;
-    }
-    return {
-        index: left,
-        insert: b.slice(left, bLength - right),
-        remove: aLength - left - right,
-    };
-}

package/lib/collab/yjs/Bindings.d.ts

@@ -1,23 +0,0 @@
-import type { LexicalEditor, NodeKey } from 'lexical';
-import { Klass, LexicalNode } from 'lexical';
-import type { Doc } from 'yjs';
-import type { CollabElementNode } from './nodes/CollabElementNode';
-import { AnyCollabNode } from './nodes/AnyCollabNode';
-import type { Cursor } from './sync/SyncCursors';
-import { Provider } from './State';
-export type ClientID = number;
-export type Binding = {
-    clientID: ClientID;
-    collabNodeMap: Map<NodeKey, AnyCollabNode>;
-    cursors: Map<ClientID, Cursor>;
-    cursorsContainer: null | HTMLElement;
-    doc: Doc;
-    docMap: Map<string, Doc>;
-    editor: LexicalEditor;
-    id: string;
-    nodeProperties: Map<string, Array<string>>;
-    root: CollabElementNode;
-    excludedProperties: ExcludedProperties;
-};
-export type ExcludedProperties = Map<Klass<LexicalNode>, Set<string>>;
-export declare function createBinding(editor: LexicalEditor, provider: Provider, id: string, doc: Doc | null | undefined, docMap: Map<string, Doc>, excludedProperties?: ExcludedProperties): Binding;

package/lib/collab/yjs/Bindings.js

@@ -1,26 +0,0 @@
-import { XmlText } from 'yjs';
-import invariant from '../utils/invariant';
-import { $createCollabElementNode } from './nodes/CollabElementNode';
-import { setupYjsDebugging } from './Debug';
-export function createBinding(editor, provider, id, doc, docMap, excludedProperties) {
-    invariant(doc !== undefined && doc !== null, 'createBinding: doc is null or undefined');
-    const rootXmlText = doc.get('root', XmlText);
-    const collabRoot = $createCollabElementNode(rootXmlText, null, 'root');
-    collabRoot._key = 'root';
-    const binding = {
-        clientID: doc.clientID,
-        collabNodeMap: new Map(),
-        cursors: new Map(),
-        cursorsContainer: null,
-        doc,
-        docMap,
-        editor,
-        excludedProperties: excludedProperties || new Map(),
-        id,
-        nodeProperties: new Map(),
-        root: collabRoot,
-    };
-    // Setup Y.js debugging utilities
-    setupYjsDebugging(binding);
-    return binding;
-}

package/lib/collab/yjs/Debug.d.ts

@@ -1,23 +0,0 @@
-import type { Binding } from './Bindings';
-/**
- * YJS Debugging Interface - Provides comprehensive debugging utilities for Y.js collaboration
- */
-export interface YjsDebugger {
-    binding: Binding | null;
-    logStructure: () => void;
-    verifyStructure: () => void;
-    inspectNode: (nodeKey: string) => void;
-    generateTreeHTML: (node: any, prefix?: string, isLast?: boolean) => string;
-    addDebugToPage: () => void;
-}
-/**
- * Setup global debugging utilities for Y.js collaboration
- * This function creates comprehensive debugging tools including:
- * - Tree structure visualization
- * - Node inspection utilities
- * - Interactive debug panel
- * - Console logging functions
- *
- * @param binding - The Y.js binding instance to debug
- */
-export declare function setupYjsDebugging(binding: Binding): void;