loro-crdt 1.2.1 → 1.2.2

package/web/loro_wasm.js

@@ -853,6 +853,14 @@ export class LoroCounter {
         const ret = wasm.lorocounter_getAttached(this.__wbg_ptr);
         return takeObject(ret);
     }
+    /**
+    * Get the value of the counter.
+    * @returns {number}
+    */
+    getShallowValue() {
+        const ret = wasm.lorocounter_getShallowValue(this.__wbg_ptr);
+        return ret;
+    }
 }
 
 const LoroDocFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -1979,10 +1987,12 @@ export class LoroDoc {
         }
     }
     /**
-    * Import a batch of updates.
+    * Import a batch of updates and snapshots.
     *
     * It's more efficient than importing updates one by one.
     *
+    * @deprecated Use `importBatch` instead.
+    *
     * @example
     * ```ts
     * import { LoroDoc } from "loro-crdt";
@@ -1993,9 +2003,9 @@ export class LoroDoc {
     * const updates = doc.export({ mode: "update" });
     * const snapshot = doc.export({ mode: "snapshot" });
     * const doc2 = new LoroDoc();
-    * doc2.importUpdateBatch([snapshot, updates]);
+    * doc2.importBatch([snapshot, updates]);
     * ```
-    * @param {Array<any>} data
+    * @param {Uint8Array[]} data
     * @returns {ImportStatus}
     */
     importUpdateBatch(data) {
@@ -2014,8 +2024,46 @@ export class LoroDoc {
         }
     }
     /**
+    * Import a batch of updates or snapshots.
+    *
+    * It's more efficient than importing updates one by one.
+    *
+    * @example
+    * ```ts
+    * import { LoroDoc } from "loro-crdt";
+    *
+    * const doc = new LoroDoc();
+    * const text = doc.getText("text");
+    * text.insert(0, "Hello");
+    * const updates = doc.export({ mode: "update" });
+    * const snapshot = doc.export({ mode: "snapshot" });
+    * const doc2 = new LoroDoc();
+    * doc2.importBatch([snapshot, updates]);
+    * ```
+    * @param {Uint8Array[]} data
+    * @returns {ImportStatus}
+    */
+    importBatch(data) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.lorodoc_importBatch(retptr, this.__wbg_ptr, addHeapObject(data));
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
     * Get the shallow json format of the document state.
     *
+    * Unlike `toJSON()` which recursively resolves all containers to their values,
+    * `getShallowValue()` returns container IDs as strings for any nested containers.
+    *
     * @example
     * ```ts
     * import { LoroDoc } from "loro-crdt";
@@ -2025,12 +2073,17 @@ export class LoroDoc {
     * const tree = doc.getTree("tree");
     * const map = doc.getMap("map");
     * const shallowValue = doc.getShallowValue();
-    * /*
-    * {"list": ..., "tree": ..., "map": ...}
-    *  *\/
     * console.log(shallowValue);
+    * // {
+    * //   list: 'cid:root-list:List',
+    * //   tree: 'cid:root-tree:Tree',
+    * //   map: 'cid:root-map:Map'
+    * // }
+    *
+    * // It points to the same container as `list`
+    * const listB = doc.getContainerById(shallowValue.list);
     * ```
-    * @returns {any}
+    * @returns {Record<string, ContainerID>}
     */
     getShallowValue() {
         try {
@@ -2050,9 +2103,12 @@ export class LoroDoc {
     /**
     * Get the json format of the entire document state.
     *
+    * Unlike `getShallowValue()` which returns container IDs as strings,
+    * `toJSON()` recursively resolves all containers to their actual values.
+    *
     * @example
     * ```ts
-    * import { LoroDoc, LoroText, LoroMap } from "loro-crdt";
+    * import { LoroDoc, LoroText } from "loro-crdt";
     *
     * const doc = new LoroDoc();
     * const list = doc.getList("list");
@@ -2061,10 +2117,8 @@ export class LoroDoc {
     * text.insert(0, "Hello");
     * const map = list.insertContainer(1, new LoroMap());
     * map.set("foo", "bar");
-    * /*
-    * {"list": ["Hello", {"foo": "bar"}]}
-    *  *\/
     * console.log(doc.toJSON());
+    * // {"list": ["Hello", {"foo": "bar"}]}
     * ```
     * @returns {any}
     */
@@ -2819,6 +2873,29 @@ export class LoroList {
         const ret = wasm.lorolist_isDeleted(this.__wbg_ptr);
         return ret !== 0;
     }
+    /**
+    * Get the shallow value of the list.
+    *
+    * Unlike `toJSON()` which recursively resolves all containers to their values,
+    * `getShallowValue()` returns container IDs as strings for any nested containers.
+    *
+    * ```js
+    * const doc = new LoroDoc();
+    * doc.setPeerId("1");
+    * const list = doc.getList("list");
+    * list.insert(0, 1);
+    * list.insert(1, "two");
+    * const subList = list.insertContainer(2, new LoroList());
+    * subList.insert(0, "sub");
+    * list.getShallowValue(); // [1, "two", "cid:2@1:List"]
+    * list.toJSON(); // [1, "two", ["sub"]]
+    * ```
+    * @returns {Value[]}
+    */
+    getShallowValue() {
+        const ret = wasm.lorolist_getShallowValue(this.__wbg_ptr);
+        return takeObject(ret);
+    }
 }
 
 const LoroMapFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -3269,6 +3346,37 @@ export class LoroMap {
         const ret = wasm.loromap_isDeleted(this.__wbg_ptr);
         return ret !== 0;
     }
+    /**
+    * Get the shallow value of the map.
+    *
+    * Unlike `toJSON()` which recursively resolves all containers to their values,
+    * `getShallowValue()` returns container IDs as strings for any nested containers.
+    *
+    * @example
+    * ```ts
+    * import { LoroDoc } from "loro-crdt";
+    *
+    * const doc = new LoroDoc();
+    * doc.setPeerId("1");
+    * const map = doc.getMap("map");
+    * map.set("key", "value");
+    * const subText = map.setContainer("text", new LoroText());
+    * subText.insert(0, "Hello");
+    *
+    * // Get shallow value - nested containers are represented by their IDs
+    * console.log(map.getShallowValue());
+    * // Output: { key: "value", text: "cid:1@1:Text" }
+    *
+    * // Get full value with nested containers resolved by `toJSON()`
+    * console.log(map.toJSON());
+    * // Output: { key: "value", text: "Hello" }
+    * ```
+    * @returns {Record<string, Value>}
+    */
+    getShallowValue() {
+        const ret = wasm.loromap_getShallowValue(this.__wbg_ptr);
+        return takeObject(ret);
+    }
 }
 
 const LoroMovableListFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -3776,6 +3884,29 @@ export class LoroMovableList {
         const ret = wasm.loromovablelist_isDeleted(this.__wbg_ptr);
         return ret !== 0;
     }
+    /**
+    * Get the shallow value of the movable list.
+    *
+    * Unlike `toJSON()` which recursively resolves all containers to their values,
+    * `getShallowValue()` returns container IDs as strings for any nested containers.
+    *
+    * ```js
+    * const doc = new LoroDoc();
+    * doc.setPeerId("1");
+    * const list = doc.getMovableList("list");
+    * list.insert(0, 1);
+    * list.insert(1, "two");
+    * const subList = list.insertContainer(2, new LoroList());
+    * subList.insert(0, "sub");
+    * list.getShallowValue(); // [1, "two", "cid:2@1:List"]
+    * list.toJSON(); // [1, "two", ["sub"]]
+    * ```
+    * @returns {Value[]}
+    */
+    getShallowValue() {
+        const ret = wasm.loromovablelist_getShallowValue(this.__wbg_ptr);
+        return takeObject(ret);
+    }
 }
 
 const LoroTextFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -4431,6 +4562,26 @@ export class LoroText {
         const ret = wasm.lorotext_isDeleted(this.__wbg_ptr);
         return ret !== 0;
     }
+    /**
+    * Get the shallow value of the text. This equals to `text.toString()`.
+    * @returns {string}
+    */
+    getShallowValue() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.lorotext_getShallowValue(retptr, this.__wbg_ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            deferred1_0 = r0;
+            deferred1_1 = r1;
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_export_5(deferred1_0, deferred1_1, 1);
+        }
+    }
 }
 
 const LoroTreeFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -4878,6 +5029,51 @@ export class LoroTree {
         const ret = wasm.lorotree_isDeleted(this.__wbg_ptr);
         return ret !== 0;
     }
+    /**
+    * Get the shallow value of the tree.
+    *
+    * Unlike `toJSON()` which recursively resolves nested containers to their values,
+    * `getShallowValue()` returns container IDs as strings for any nested containers.
+    *
+    * @example
+    * ```ts
+    * const doc = new LoroDoc();
+    * doc.setPeerId("1");
+    * const tree = doc.getTree("tree");
+    * const root = tree.createNode();
+    * root.data.set("name", "root");
+    * const text = root.data.setContainer("content", new LoroText());
+    * text.insert(0, "Hello");
+    *
+    * console.log(tree.getShallowValue());
+    * // [{
+    * //   id: "0@1",
+    * //   parent: null,
+    * //   index: 0,
+    * //   fractional_index: "80",
+    * //   meta: "cid:0@1:Map",
+    * //   children: []
+    * // }]
+    *
+    * console.log(tree.toJSON());
+    * // [{
+    * //   id: "0@1",
+    * //   parent: null,
+    * //   index: 0,
+    * //   fractional_index: "80",
+    * //   meta: {
+    * //     name: "root",
+    * //     content: "Hello"
+    * //   },
+    * //   children: []
+    * // }]
+    * ```
+    * @returns {TreeNodeShallowValue[]}
+    */
+    getShallowValue() {
+        const ret = wasm.lorotree_getShallowValue(this.__wbg_ptr);
+        return takeObject(ret);
+    }
 }
 
 const LoroTreeNodeFinalization = (typeof FinalizationRegistry === 'undefined')

package/web/loro_wasm_bg.wasm.d.ts

@@ -10,6 +10,7 @@ export function lorocounter_subscribe(a: number, b: number, c: number): void;
 export function lorocounter_parent(a: number): number;
 export function lorocounter_isAttached(a: number): number;
 export function lorocounter_getAttached(a: number): number;
+export function lorocounter_getShallowValue(a: number): number;
 export function __wbg_awarenesswasm_free(a: number): void;
 export function awarenesswasm_new(a: number, b: number): number;
 export function awarenesswasm_encode(a: number, b: number, c: number): void;
@@ -76,6 +77,7 @@ export function lorodoc_exportJsonUpdates(a: number, b: number, c: number, d: nu
 export function lorodoc_importJsonUpdates(a: number, b: number, c: number): void;
 export function lorodoc_import(a: number, b: number, c: number, d: number): void;
 export function lorodoc_importUpdateBatch(a: number, b: number, c: number): void;
+export function lorodoc_importBatch(a: number, b: number, c: number): void;
 export function lorodoc_getShallowValue(a: number, b: number): void;
 export function lorodoc_toJSON(a: number, b: number): void;
 export function lorodoc_subscribe(a: number, b: number): number;
@@ -119,6 +121,7 @@ export function lorotext_getCursor(a: number, b: number, c: number): number;
 export function lorotext_push(a: number, b: number, c: number, d: number): void;
 export function lorotext_getEditorOf(a: number, b: number): number;
 export function lorotext_isDeleted(a: number): number;
+export function lorotext_getShallowValue(a: number, b: number): void;
 export function __wbg_loromap_free(a: number): void;
 export function loromap_new(): number;
 export function loromap_kind(a: number): number;
@@ -139,6 +142,7 @@ export function loromap_getAttached(a: number): number;
 export function loromap_clear(a: number, b: number): void;
 export function loromap_getLastEditor(a: number, b: number, c: number): number;
 export function loromap_isDeleted(a: number): number;
+export function loromap_getShallowValue(a: number): number;
 export function __wbg_lorolist_free(a: number): void;
 export function lorolist_new(): number;
 export function lorolist_kind(a: number): number;
@@ -161,6 +165,7 @@ export function lorolist_pop(a: number, b: number): void;
 export function lorolist_clear(a: number, b: number): void;
 export function lorolist_getIdAt(a: number, b: number): number;
 export function lorolist_isDeleted(a: number): number;
+export function lorolist_getShallowValue(a: number): number;
 export function loromovablelist_new(): number;
 export function loromovablelist_kind(a: number): number;
 export function loromovablelist_insert(a: number, b: number, c: number, d: number): void;
@@ -185,6 +190,7 @@ export function loromovablelist_getCreatorAt(a: number, b: number): number;
 export function loromovablelist_getLastMoverAt(a: number, b: number): number;
 export function loromovablelist_getLastEditorAt(a: number, b: number): number;
 export function loromovablelist_isDeleted(a: number): number;
+export function loromovablelist_getShallowValue(a: number): number;
 export function __wbg_lorotree_free(a: number): void;
 export function lorotreenode___getClassname(a: number, b: number): void;
 export function __wbg_lorotreenode_free(a: number): void;
@@ -225,6 +231,7 @@ export function lorotree_enableFractionalIndex(a: number, b: number): void;
 export function lorotree_disableFractionalIndex(a: number): void;
 export function lorotree_isFractionalIndexEnabled(a: number): number;
 export function lorotree_isDeleted(a: number): number;
+export function lorotree_getShallowValue(a: number): number;
 export function __wbg_cursor_free(a: number): void;
 export function cursor_containerId(a: number): number;
 export function cursor_pos(a: number): number;