loro-crdt 1.2.1 → 1.2.3

package/base64/loro_wasm.d.ts

@@ -155,6 +155,36 @@ interface LoroDoc {
      * ```
      */
     subscribeLocalUpdates(f: (bytes: Uint8Array) => void): () => void
+    /**
+     * Convert the document to a JSON value with a custom replacer function.
+     * 
+     * This method works similarly to `JSON.stringify`'s replacer parameter.
+     * The replacer function is called for each value in the document and can transform
+     * how values are serialized to JSON.
+     * 
+     * @param replacer - A function that takes a key and value, and returns how that value
+     *                  should be serialized. Similar to JSON.stringify's replacer. 
+     *                  If return undefined, the value will be skipped.
+     * @returns The JSON representation of the document after applying the replacer function.
+     * 
+     * @example
+     * ```ts
+     * const doc = new LoroDoc();
+     * const text = doc.getText("text");
+     * text.insert(0, "Hello");
+     * text.mark(0, 2, {bold: true});
+     * 
+     * // Use delta to represent text
+     * const json = doc.toJsonWithReplacer((key, value) => {
+     *   if (value instanceof LoroText) {
+     *     return value.toDelta();
+     *   } 
+     * 
+     *   return value;
+     * });
+     * ```
+     */
+    toJsonWithReplacer(replacer: (key: string | index, value: Value | Container) => Value | Container | undefined): Value;
 }
 
 /**
@@ -231,13 +261,14 @@ export type Value =
   | null
   | { [key: string]: Value }
   | Uint8Array
-  | Value[];
+  | Value[]
+  | undefined;
 
 export type UndoConfig = {
     mergeInterval?: number,
     maxUndoSteps?: number,
     excludeOriginPrefixes?: string[],
-    onPush?: (isUndo: boolean, counterRange: { start: number, end: number }) => { value: Value, cursors: Cursor[] },
+    onPush?: (isUndo: boolean, counterRange: { start: number, end: number }, event?: LoroEventBatch) => { value: Value, cursors: Cursor[] },
     onPop?: (isUndo: boolean, value: { value: Value, cursors: Cursor[] }, counterRange: { start: number, end: number }) => void
 };
 export type Container = LoroList | LoroMap | LoroText | LoroTree | LoroMovableList;
@@ -343,6 +374,15 @@ interface LoroList {
     getCursor(pos: number, side?: Side): Cursor | undefined;
 }
 
+export type TreeNodeShallowValue = {
+    id: TreeID,
+    parent: TreeID | undefined,
+    index: number,
+    fractionalIndex: string,
+    meta: ContainerID,
+    children: TreeNodeShallowValue[],
+}
+
 export type TreeNodeValue = {
     id: TreeID,
     parent: TreeID | undefined,
@@ -753,6 +793,14 @@ interface LoroDoc<T extends Record<string, Container> = Record<string, Container
      */
     getTree<Key extends keyof T | ContainerID>(name: Key): T[Key] extends LoroTree ? T[Key] : LoroTree;
     getText(key: string | ContainerID): LoroText;
+    /**
+     * Export the updates in the given range.
+     *
+     * @param start - The start version vector.
+     * @param end - The end version vector.
+     * @returns The updates in the given range.
+     */
+    exportJsonUpdates(start?: VersionVector, end?: VersionVector): JsonSchema;
 }
 interface LoroList<T = unknown> {
     new(): LoroList<T>;
@@ -1320,6 +1368,11 @@ export class LoroCounter {
   getAttached(): LoroTree | undefined;
 /**
 * Get the value of the counter.
+* @returns {number}
+*/
+  getShallowValue(): number;
+/**
+* Get the value of the counter.
 */
   readonly value: number;
 }
@@ -1821,13 +1874,6 @@ export class LoroDoc {
 */
   export(mode: ExportMode): Uint8Array;
 /**
-* Export updates in the given range in JSON format.
-* @param {VersionVector | undefined} [start_vv]
-* @param {VersionVector | undefined} [end_vv]
-* @returns {JsonSchema}
-*/
-  exportJsonUpdates(start_vv?: VersionVector, end_vv?: VersionVector): JsonSchema;
-/**
 * Import updates from the JSON format.
 *
 * only supports backward compatibility but not forward compatibility.
@@ -1863,10 +1909,12 @@ export class LoroDoc {
 */
   import(update_or_snapshot: Uint8Array): ImportStatus;
 /**
-* 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";
@@ -1877,15 +1925,39 @@ 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: Array<any>): ImportStatus;
+  importUpdateBatch(data: Uint8Array[]): ImportStatus;
+/**
+* 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: Uint8Array[]): ImportStatus;
 /**
 * 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";
@@ -1895,20 +1967,28 @@ 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(): any;
+  getShallowValue(): Record<string, ContainerID>;
 /**
 * 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");
@@ -1917,10 +1997,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}
 */
@@ -2181,6 +2259,26 @@ export class LoroList {
 */
   isDeleted(): boolean;
 /**
+* 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(): Value[];
+/**
 * Get the id of this container.
 */
   readonly id: ContainerID;
@@ -2342,6 +2440,34 @@ export class LoroMap {
 */
   isDeleted(): boolean;
 /**
+* 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(): Record<string, Value>;
+/**
 * The container id of this handler.
 */
   readonly id: ContainerID;
@@ -2485,6 +2611,26 @@ export class LoroMovableList {
 */
   isDeleted(): boolean;
 /**
+* 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(): Value[];
+/**
 * Get the id of this container.
 */
   readonly id: ContainerID;
@@ -2800,6 +2946,11 @@ export class LoroText {
 */
   isDeleted(): boolean;
 /**
+* Get the shallow value of the text. This equals to `text.toString()`.
+* @returns {string}
+*/
+  getShallowValue(): string;
+/**
 * Get the container id of the text.
 */
   readonly id: ContainerID;
@@ -2972,6 +3123,48 @@ export class LoroTree {
 */
   isDeleted(): boolean;
 /**
+* 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(): TreeNodeShallowValue[];
+/**
 * Get the id of the container.
 */
   readonly id: ContainerID;