loro-crdt 1.2.5 → 1.2.7

package/bundler/loro_wasm.d.ts

@@ -397,11 +397,6 @@ export type TreeNodeJSON<T> = Omit<TreeNodeValue, 'meta' | 'children'> & {
     children: TreeNodeJSON<T>[],
 }
 
-interface LoroTree{
-    toArray(): TreeNodeValue[];
-    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode[];
-}
-
 interface LoroMovableList {
     /**
      * Get the cursor position at the given pos.
@@ -1129,6 +1124,8 @@ interface LoroTree<T extends Record<string, unknown> = Record<string, unknown>>
      */
     getNodeByID(target: TreeID): LoroTreeNode<T>;
     subscribe(listener: Listener): Subscription;
+    toArray(): TreeNodeValue[];
+    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode<T>[];
 }
 interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknown>> {
     /**
@@ -1156,7 +1153,36 @@ interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknow
      * ```
      */
     createNode(index?: number): LoroTreeNode<T>;
+    /**
+     * Move this tree node to be a child of the parent.
+     * If the parent is undefined, this node will be a root node.
+     *
+     * If the index is not provided, the node will be appended to the end.
+     *
+     * It's not allowed that the target is an ancestor of the parent.
+     *
+     * @example
+     * ```ts
+     * const doc = new LoroDoc();
+     * const tree = doc.getTree("tree");
+     * const root = tree.createNode();
+     * const node = root.createNode();
+     * const node2 = node.createNode();
+     * node2.move(undefined, 0);
+     * // node2   root
+     * //          |
+     * //         node
+     *
+     * ```
+     */
     move(parent?: LoroTreeNode<T>, index?: number): void;
+    /**
+     * Get the parent node of this node.
+     *
+     * - The parent of the root node is `undefined`.
+     * - The object returned is a new js object each time because it need to cross
+     *   the WASM boundary.
+     */
     parent(): LoroTreeNode<T> | undefined;
     /**
      * Get the children of this node.
@@ -2099,6 +2125,21 @@ export class LoroDoc {
 /**
 * Get the value or container at the given path
 *
+* The path can be specified in different ways depending on the container type:
+*
+* For Tree:
+* 1. Using node IDs: `tree/{node_id}/property`
+* 2. Using indices: `tree/0/1/property`
+*
+* For List and MovableList:
+* - Using indices: `list/0` or `list/1/property`
+*
+* For Map:
+* - Using keys: `map/key` or `map/nested/property`
+*
+* For tree structures, index-based paths follow depth-first traversal order.
+* The indices start from 0 and represent the position of a node among its siblings.
+*
 * @example
 * ```ts
 * import { LoroDoc } from "loro-crdt";
@@ -3179,31 +3220,6 @@ export class LoroTreeNode {
 */
   __getClassname(): string;
 /**
-* Move this tree node to be a child of the parent.
-* If the parent is undefined, this node will be a root node.
-*
-* If the index is not provided, the node will be appended to the end.
-*
-* It's not allowed that the target is an ancestor of the parent.
-*
-* @example
-* ```ts
-* const doc = new LoroDoc();
-* const tree = doc.getTree("tree");
-* const root = tree.createNode();
-* const node = root.createNode();
-* const node2 = node.createNode();
-* node2.move(undefined, 0);
-* // node2   root
-* //          |
-* //         node
-*
-* ```
-* @param {LoroTreeNode | undefined} parent
-* @param {number | undefined} [index]
-*/
-  move(parent: LoroTreeNode | undefined, index?: number): void;
-/**
 * Move the tree node to be after the target node.
 *
 * @example
@@ -3256,15 +3272,6 @@ export class LoroTreeNode {
 */
   fractionalIndex(): string | undefined;
 /**
-* Get the parent node of this node.
-*
-* - The parent of the root node is `undefined`.
-* - The object returned is a new js object each time because it need to cross
-*   the WASM boundary.
-* @returns {LoroTreeNode | undefined}
-*/
-  parent(): LoroTreeNode | undefined;
-/**
 * Check if the node is deleted.
 * @returns {boolean}
 */

package/bundler/loro_wasm_bg.js

@@ -2359,6 +2359,21 @@ export class LoroDoc {
     /**
     * Get the value or container at the given path
     *
+    * The path can be specified in different ways depending on the container type:
+    *
+    * For Tree:
+    * 1. Using node IDs: `tree/{node_id}/property`
+    * 2. Using indices: `tree/0/1/property`
+    *
+    * For List and MovableList:
+    * - Using indices: `list/0` or `list/1/property`
+    *
+    * For Map:
+    * - Using keys: `map/key` or `map/nested/property`
+    *
+    * For tree structures, index-based paths follow depth-first traversal order.
+    * The indices start from 0 and represent the position of a node among its siblings.
+    *
     * @example
     * ```ts
     * import { LoroDoc } from "loro-crdt";
@@ -5161,26 +5176,6 @@ export class LoroTreeNode {
         }
     }
     /**
-    * Move this tree node to be a child of the parent.
-    * If the parent is undefined, this node will be a root node.
-    *
-    * If the index is not provided, the node will be appended to the end.
-    *
-    * It's not allowed that the target is an ancestor of the parent.
-    *
-    * @example
-    * ```ts
-    * const doc = new LoroDoc();
-    * const tree = doc.getTree("tree");
-    * const root = tree.createNode();
-    * const node = root.createNode();
-    * const node2 = node.createNode();
-    * node2.move(undefined, 0);
-    * // node2   root
-    * //          |
-    * //         node
-    *
-    * ```
     * @param {LoroTreeNode | undefined} parent
     * @param {number | undefined} [index]
     */
@@ -5343,11 +5338,6 @@ export class LoroTreeNode {
         }
     }
     /**
-    * Get the parent node of this node.
-    *
-    * - The parent of the root node is `undefined`.
-    * - The object returned is a new js object each time because it need to cross
-    *   the WASM boundary.
     * @returns {LoroTreeNode | undefined}
     */
     parent() {

package/nodejs/loro_wasm.d.ts

@@ -397,11 +397,6 @@ export type TreeNodeJSON<T> = Omit<TreeNodeValue, 'meta' | 'children'> & {
     children: TreeNodeJSON<T>[],
 }
 
-interface LoroTree{
-    toArray(): TreeNodeValue[];
-    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode[];
-}
-
 interface LoroMovableList {
     /**
      * Get the cursor position at the given pos.
@@ -1129,6 +1124,8 @@ interface LoroTree<T extends Record<string, unknown> = Record<string, unknown>>
      */
     getNodeByID(target: TreeID): LoroTreeNode<T>;
     subscribe(listener: Listener): Subscription;
+    toArray(): TreeNodeValue[];
+    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode<T>[];
 }
 interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknown>> {
     /**
@@ -1156,7 +1153,36 @@ interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknow
      * ```
      */
     createNode(index?: number): LoroTreeNode<T>;
+    /**
+     * Move this tree node to be a child of the parent.
+     * If the parent is undefined, this node will be a root node.
+     *
+     * If the index is not provided, the node will be appended to the end.
+     *
+     * It's not allowed that the target is an ancestor of the parent.
+     *
+     * @example
+     * ```ts
+     * const doc = new LoroDoc();
+     * const tree = doc.getTree("tree");
+     * const root = tree.createNode();
+     * const node = root.createNode();
+     * const node2 = node.createNode();
+     * node2.move(undefined, 0);
+     * // node2   root
+     * //          |
+     * //         node
+     *
+     * ```
+     */
     move(parent?: LoroTreeNode<T>, index?: number): void;
+    /**
+     * Get the parent node of this node.
+     *
+     * - The parent of the root node is `undefined`.
+     * - The object returned is a new js object each time because it need to cross
+     *   the WASM boundary.
+     */
     parent(): LoroTreeNode<T> | undefined;
     /**
      * Get the children of this node.
@@ -2099,6 +2125,21 @@ export class LoroDoc {
 /**
 * Get the value or container at the given path
 *
+* The path can be specified in different ways depending on the container type:
+*
+* For Tree:
+* 1. Using node IDs: `tree/{node_id}/property`
+* 2. Using indices: `tree/0/1/property`
+*
+* For List and MovableList:
+* - Using indices: `list/0` or `list/1/property`
+*
+* For Map:
+* - Using keys: `map/key` or `map/nested/property`
+*
+* For tree structures, index-based paths follow depth-first traversal order.
+* The indices start from 0 and represent the position of a node among its siblings.
+*
 * @example
 * ```ts
 * import { LoroDoc } from "loro-crdt";
@@ -3179,31 +3220,6 @@ export class LoroTreeNode {
 */
   __getClassname(): string;
 /**
-* Move this tree node to be a child of the parent.
-* If the parent is undefined, this node will be a root node.
-*
-* If the index is not provided, the node will be appended to the end.
-*
-* It's not allowed that the target is an ancestor of the parent.
-*
-* @example
-* ```ts
-* const doc = new LoroDoc();
-* const tree = doc.getTree("tree");
-* const root = tree.createNode();
-* const node = root.createNode();
-* const node2 = node.createNode();
-* node2.move(undefined, 0);
-* // node2   root
-* //          |
-* //         node
-*
-* ```
-* @param {LoroTreeNode | undefined} parent
-* @param {number | undefined} [index]
-*/
-  move(parent: LoroTreeNode | undefined, index?: number): void;
-/**
 * Move the tree node to be after the target node.
 *
 * @example
@@ -3256,15 +3272,6 @@ export class LoroTreeNode {
 */
   fractionalIndex(): string | undefined;
 /**
-* Get the parent node of this node.
-*
-* - The parent of the root node is `undefined`.
-* - The object returned is a new js object each time because it need to cross
-*   the WASM boundary.
-* @returns {LoroTreeNode | undefined}
-*/
-  parent(): LoroTreeNode | undefined;
-/**
 * Check if the node is deleted.
 * @returns {boolean}
 */

package/nodejs/loro_wasm.js

@@ -2357,6 +2357,21 @@ class LoroDoc {
     /**
     * Get the value or container at the given path
     *
+    * The path can be specified in different ways depending on the container type:
+    *
+    * For Tree:
+    * 1. Using node IDs: `tree/{node_id}/property`
+    * 2. Using indices: `tree/0/1/property`
+    *
+    * For List and MovableList:
+    * - Using indices: `list/0` or `list/1/property`
+    *
+    * For Map:
+    * - Using keys: `map/key` or `map/nested/property`
+    *
+    * For tree structures, index-based paths follow depth-first traversal order.
+    * The indices start from 0 and represent the position of a node among its siblings.
+    *
     * @example
     * ```ts
     * import { LoroDoc } from "loro-crdt";
@@ -5165,26 +5180,6 @@ class LoroTreeNode {
         }
     }
     /**
-    * Move this tree node to be a child of the parent.
-    * If the parent is undefined, this node will be a root node.
-    *
-    * If the index is not provided, the node will be appended to the end.
-    *
-    * It's not allowed that the target is an ancestor of the parent.
-    *
-    * @example
-    * ```ts
-    * const doc = new LoroDoc();
-    * const tree = doc.getTree("tree");
-    * const root = tree.createNode();
-    * const node = root.createNode();
-    * const node2 = node.createNode();
-    * node2.move(undefined, 0);
-    * // node2   root
-    * //          |
-    * //         node
-    *
-    * ```
     * @param {LoroTreeNode | undefined} parent
     * @param {number | undefined} [index]
     */
@@ -5347,11 +5342,6 @@ class LoroTreeNode {
         }
     }
     /**
-    * Get the parent node of this node.
-    *
-    * - The parent of the root node is `undefined`.
-    * - The object returned is a new js object each time because it need to cross
-    *   the WASM boundary.
     * @returns {LoroTreeNode | undefined}
     */
     parent() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loro-crdt",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
   "keywords": [
     "crdt",

package/web/loro_wasm.d.ts

@@ -397,11 +397,6 @@ export type TreeNodeJSON<T> = Omit<TreeNodeValue, 'meta' | 'children'> & {
     children: TreeNodeJSON<T>[],
 }
 
-interface LoroTree{
-    toArray(): TreeNodeValue[];
-    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode[];
-}
-
 interface LoroMovableList {
     /**
      * Get the cursor position at the given pos.
@@ -1129,6 +1124,8 @@ interface LoroTree<T extends Record<string, unknown> = Record<string, unknown>>
      */
     getNodeByID(target: TreeID): LoroTreeNode<T>;
     subscribe(listener: Listener): Subscription;
+    toArray(): TreeNodeValue[];
+    getNodes(options?: { withDeleted?: boolean } ): LoroTreeNode<T>[];
 }
 interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknown>> {
     /**
@@ -1156,7 +1153,36 @@ interface LoroTreeNode<T extends Record<string, unknown> = Record<string, unknow
      * ```
      */
     createNode(index?: number): LoroTreeNode<T>;
+    /**
+     * Move this tree node to be a child of the parent.
+     * If the parent is undefined, this node will be a root node.
+     *
+     * If the index is not provided, the node will be appended to the end.
+     *
+     * It's not allowed that the target is an ancestor of the parent.
+     *
+     * @example
+     * ```ts
+     * const doc = new LoroDoc();
+     * const tree = doc.getTree("tree");
+     * const root = tree.createNode();
+     * const node = root.createNode();
+     * const node2 = node.createNode();
+     * node2.move(undefined, 0);
+     * // node2   root
+     * //          |
+     * //         node
+     *
+     * ```
+     */
     move(parent?: LoroTreeNode<T>, index?: number): void;
+    /**
+     * Get the parent node of this node.
+     *
+     * - The parent of the root node is `undefined`.
+     * - The object returned is a new js object each time because it need to cross
+     *   the WASM boundary.
+     */
     parent(): LoroTreeNode<T> | undefined;
     /**
      * Get the children of this node.
@@ -2099,6 +2125,21 @@ export class LoroDoc {
 /**
 * Get the value or container at the given path
 *
+* The path can be specified in different ways depending on the container type:
+*
+* For Tree:
+* 1. Using node IDs: `tree/{node_id}/property`
+* 2. Using indices: `tree/0/1/property`
+*
+* For List and MovableList:
+* - Using indices: `list/0` or `list/1/property`
+*
+* For Map:
+* - Using keys: `map/key` or `map/nested/property`
+*
+* For tree structures, index-based paths follow depth-first traversal order.
+* The indices start from 0 and represent the position of a node among its siblings.
+*
 * @example
 * ```ts
 * import { LoroDoc } from "loro-crdt";
@@ -3179,31 +3220,6 @@ export class LoroTreeNode {
 */
   __getClassname(): string;
 /**
-* Move this tree node to be a child of the parent.
-* If the parent is undefined, this node will be a root node.
-*
-* If the index is not provided, the node will be appended to the end.
-*
-* It's not allowed that the target is an ancestor of the parent.
-*
-* @example
-* ```ts
-* const doc = new LoroDoc();
-* const tree = doc.getTree("tree");
-* const root = tree.createNode();
-* const node = root.createNode();
-* const node2 = node.createNode();
-* node2.move(undefined, 0);
-* // node2   root
-* //          |
-* //         node
-*
-* ```
-* @param {LoroTreeNode | undefined} parent
-* @param {number | undefined} [index]
-*/
-  move(parent: LoroTreeNode | undefined, index?: number): void;
-/**
 * Move the tree node to be after the target node.
 *
 * @example
@@ -3256,15 +3272,6 @@ export class LoroTreeNode {
 */
   fractionalIndex(): string | undefined;
 /**
-* Get the parent node of this node.
-*
-* - The parent of the root node is `undefined`.
-* - The object returned is a new js object each time because it need to cross
-*   the WASM boundary.
-* @returns {LoroTreeNode | undefined}
-*/
-  parent(): LoroTreeNode | undefined;
-/**
 * Check if the node is deleted.
 * @returns {boolean}
 */

package/web/loro_wasm.js

@@ -2351,6 +2351,21 @@ export class LoroDoc {
     /**
     * Get the value or container at the given path
     *
+    * The path can be specified in different ways depending on the container type:
+    *
+    * For Tree:
+    * 1. Using node IDs: `tree/{node_id}/property`
+    * 2. Using indices: `tree/0/1/property`
+    *
+    * For List and MovableList:
+    * - Using indices: `list/0` or `list/1/property`
+    *
+    * For Map:
+    * - Using keys: `map/key` or `map/nested/property`
+    *
+    * For tree structures, index-based paths follow depth-first traversal order.
+    * The indices start from 0 and represent the position of a node among its siblings.
+    *
     * @example
     * ```ts
     * import { LoroDoc } from "loro-crdt";
@@ -5153,26 +5168,6 @@ export class LoroTreeNode {
         }
     }
     /**
-    * Move this tree node to be a child of the parent.
-    * If the parent is undefined, this node will be a root node.
-    *
-    * If the index is not provided, the node will be appended to the end.
-    *
-    * It's not allowed that the target is an ancestor of the parent.
-    *
-    * @example
-    * ```ts
-    * const doc = new LoroDoc();
-    * const tree = doc.getTree("tree");
-    * const root = tree.createNode();
-    * const node = root.createNode();
-    * const node2 = node.createNode();
-    * node2.move(undefined, 0);
-    * // node2   root
-    * //          |
-    * //         node
-    *
-    * ```
     * @param {LoroTreeNode | undefined} parent
     * @param {number | undefined} [index]
     */
@@ -5335,11 +5330,6 @@ export class LoroTreeNode {
         }
     }
     /**
-    * Get the parent node of this node.
-    *
-    * - The parent of the root node is `undefined`.
-    * - The object returned is a new js object each time because it need to cross
-    *   the WASM boundary.
     * @returns {LoroTreeNode | undefined}
     */
     parent() {