loro-crdt 1.3.4 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.4.0
+
+### Minor Changes
+
+- 2f3364a: refactor!: use better data type for doc.diff #646
+
+### Patch Changes
+
+- 72699ae: fix: getting values by path in LoroTree (#643)
+
+## 1.3.5
+
+### Patch Changes
+
+- c2a61f3: fix: improve shallow snapshot and JSON export handling #639
+
 ## 1.3.4
 
 ### Patch Changes

package/base64/index.js

@@ -2610,8 +2610,32 @@ class LoroDoc {
         }
     }
     /**
-    * Apply a diff batch to the document
-    * @param {Record<ContainerID, Diff>} diff
+    * Apply a batch of diff to the document
+    *
+    * A diff batch represents a set of changes between two versions of the document.
+    * You can calculate a diff batch using `doc.diff()`.
+    *
+    * Changes are associated with container IDs. During diff application, if new containers were created in the source
+    * document, they will be assigned fresh IDs in the target document. Loro automatically handles remapping these
+    * container IDs from their original IDs to the new IDs as the diff is applied.
+    *
+    * @example
+    * ```ts
+    * const doc1 = new LoroDoc();
+    * const doc2 = new LoroDoc();
+    *
+    * // Make some changes to doc1
+    * const text = doc1.getText("text");
+    * text.insert(0, "Hello");
+    *
+    * // Calculate diff between empty and current state
+    * const diff = doc1.diff([], doc1.frontiers());
+    *
+    * // Apply changes to doc2
+    * doc2.applyDiff(diff);
+    * console.log(doc2.getText("text").toString()); // "Hello"
+    * ```
+    * @param {[ContainerID, Diff|JsonDiff][]} diff
     */
     applyDiff(diff) {
         try {
@@ -2633,16 +2657,17 @@ class LoroDoc {
     * presented before its use.
     * @param {({ peer: PeerID, counter: number })[]} from
     * @param {({ peer: PeerID, counter: number })[]} to
-    * @returns {Record<ContainerID, Diff>}
+    * @param {boolean | undefined} [for_json]
+    * @returns {[ContainerID, Diff|JsonDiff][]}
     */
-    diff(from, to) {
+    diff(from, to, for_json) {
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
             const ptr0 = passArrayJsValueToWasm0(from, wasm.__wbindgen_export_0);
             const len0 = WASM_VECTOR_LEN;
             const ptr1 = passArrayJsValueToWasm0(to, wasm.__wbindgen_export_0);
             const len1 = WASM_VECTOR_LEN;
-            wasm.lorodoc_diff(retptr, this.__wbg_ptr, ptr0, len0, ptr1, len1);
+            wasm.lorodoc_diff(retptr, this.__wbg_ptr, ptr0, len0, ptr1, len1, isLikeNone(for_json) ? 0xFFFFFF : for_json ? 1 : 0);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
             var r2 = getInt32Memory0()[retptr / 4 + 2];
@@ -5991,32 +6016,32 @@ function __wbg_lorotreenode_new(arg0) {
     const ret = LoroTreeNode.__wrap(arg0);
     return addHeapObject(ret);
 }
-function __wbg_lorocounter_new(arg0) {
-    const ret = LoroCounter.__wrap(arg0);
-    return addHeapObject(ret);
-}
-function __wbg_lorotext_new(arg0) {
-    const ret = LoroText.__wrap(arg0);
+function __wbg_lorotree_new(arg0) {
+    const ret = LoroTree.__wrap(arg0);
     return addHeapObject(ret);
 }
 function __wbg_lorolist_new(arg0) {
     const ret = LoroList.__wrap(arg0);
     return addHeapObject(ret);
 }
-function __wbg_loromap_new(arg0) {
-    const ret = LoroMap.__wrap(arg0);
+function __wbg_lorocounter_new(arg0) {
+    const ret = LoroCounter.__wrap(arg0);
     return addHeapObject(ret);
 }
-function __wbg_cursor_new(arg0) {
-    const ret = Cursor.__wrap(arg0);
+function __wbg_loromap_new(arg0) {
+    const ret = LoroMap.__wrap(arg0);
     return addHeapObject(ret);
 }
 function __wbg_loromovablelist_new(arg0) {
     const ret = LoroMovableList.__wrap(arg0);
     return addHeapObject(ret);
 }
-function __wbg_lorotree_new(arg0) {
-    const ret = LoroTree.__wrap(arg0);
+function __wbg_lorotext_new(arg0) {
+    const ret = LoroText.__wrap(arg0);
+    return addHeapObject(ret);
+}
+function __wbg_cursor_new(arg0) {
+    const ret = Cursor.__wrap(arg0);
     return addHeapObject(ret);
 }
 function __wbg_versionvector_new(arg0) {
@@ -6211,7 +6236,7 @@ function __wbg_error_f851667af71bcfc6(arg0, arg1) {
         wasm.__wbindgen_export_5(deferred0_0, deferred0_1, 1);
     }
 }
-const __wbg_now_6dd635953150ee31 = typeof Date.now == 'function' ? Date.now : notDefined('Date.now');
+const __wbg_now_bc6f749123583eb9 = typeof Date.now == 'function' ? Date.now : notDefined('Date.now');
 
 function __wbg_crypto_1d1f22824a6a080c(arg0) {
     const ret = getObject(arg0).crypto;
@@ -6476,11 +6501,11 @@ function __wbindgen_memory() {
     return addHeapObject(ret);
 }
 function __wbindgen_closure_wrapper482(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 8, __wbg_adapter_60);
+    const ret = makeMutClosure(arg0, arg1, 10, __wbg_adapter_60);
     return addHeapObject(ret);
 }
-function __wbindgen_closure_wrapper484(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 10, __wbg_adapter_63);
+function __wbindgen_closure_wrapper485(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 8, __wbg_adapter_63);
     return addHeapObject(ret);
 }
 
@@ -6554,7 +6579,7 @@ var imports = /*#__PURE__*/Object.freeze({
     __wbg_next_196c84450b364254: __wbg_next_196c84450b364254,
     __wbg_next_40fc327bfc8770e6: __wbg_next_40fc327bfc8770e6,
     __wbg_node_104a2ff8d6ea03a2: __wbg_node_104a2ff8d6ea03a2,
-    __wbg_now_6dd635953150ee31: __wbg_now_6dd635953150ee31,
+    __wbg_now_bc6f749123583eb9: __wbg_now_bc6f749123583eb9,
     __wbg_ownKeys_658942b7f28d1fe9: __wbg_ownKeys_658942b7f28d1fe9,
     __wbg_process_4a72847cc503995b: __wbg_process_4a72847cc503995b,
     __wbg_push_a5b05aedc7234f9f: __wbg_push_a5b05aedc7234f9f,
@@ -6583,7 +6608,7 @@ var imports = /*#__PURE__*/Object.freeze({
     __wbindgen_boolean_get: __wbindgen_boolean_get,
     __wbindgen_cb_drop: __wbindgen_cb_drop,
     __wbindgen_closure_wrapper482: __wbindgen_closure_wrapper482,
-    __wbindgen_closure_wrapper484: __wbindgen_closure_wrapper484,
+    __wbindgen_closure_wrapper485: __wbindgen_closure_wrapper485,
     __wbindgen_debug_string: __wbindgen_debug_string,
     __wbindgen_error_new: __wbindgen_error_new,
     __wbindgen_in: __wbindgen_in,
@@ -6618,7 +6643,7 @@ var imports = /*#__PURE__*/Object.freeze({
 // Without this patch, Cloudflare Worker would raise issue like: "Uncaught TypeError: wasm2.__wbindgen_start is not a function"
 
 
-import loro_wasm_bg_js from './loro_wasm_bg-05a04d94.js';
+import loro_wasm_bg_js from './loro_wasm_bg-9c66a53e.js';
 const instance = new WebAssembly.Instance(loro_wasm_bg_js(), {
     "./loro_wasm_bg.js": imports,
 });
@@ -6823,4 +6848,4 @@ LoroDoc.prototype.toJsonWithReplacer = function (replacer) {
     return run(layer);
 };
 
-export { Awareness, AwarenessWasm, Cursor, Loro, LoroCounter, LoroDoc, LoroList, LoroMap, LoroMovableList, LoroText, LoroTree, LoroTreeNode, UndoManager, VersionVector, __wbg_String_b9412f8799faab3e, __wbg_apply_0a5aa603881e6d79, __wbg_buffer_12d079cc21e14bdb, __wbg_call_27c0f87801dedf93, __wbg_call_8e7cb608789c2528, __wbg_call_938992c832f74314, __wbg_call_b3ca7c6051f9bec1, __wbg_crypto_1d1f22824a6a080c, __wbg_cursor_new, __wbg_done_298b57d23c0fc80c, __wbg_entries_95cc2c823b285a09, __wbg_entries_ce844941d0c51880, __wbg_error_9384d761bf46409d, __wbg_error_f851667af71bcfc6, __wbg_from_89e3fc3ba5e6fb48, __wbg_getRandomValues_3aa56aa6edec874c, __wbg_get_bd8e338fbd5f5cc8, __wbg_get_e3c254076557e348, __wbg_getindex_03d06b4e7ea3475e, __wbg_getwithrefkey_edc2c8960f0f1191, __wbg_globalThis_d1e6af4856ba331b, __wbg_global_207b558942527489, __wbg_instanceof_ArrayBuffer_836825be07d4c9d2, __wbg_instanceof_Map_87917e0a7aaf4012, __wbg_instanceof_Object_71ca3c0a59266746, __wbg_instanceof_Uint8Array_2b3bbecd033d19f6, __wbg_isArray_2ab64d95e09ea0ae, __wbg_isSafeInteger_f7b04ef02296c4d2, __wbg_iterator_2cee6dadfd956dfa, __wbg_length_c20a40f15020d68a, __wbg_length_cd7af8117672b8b8, __wbg_log_aba5996d9bde071f, __wbg_log_c86c3e1bf097ba35, __wbg_log_c9486ca5d8e2cbe8, __wbg_lorocounter_new, __wbg_lorolist_new, __wbg_loromap_new, __wbg_loromovablelist_new, __wbg_lorotext_new, __wbg_lorotree_new, __wbg_lorotreenode_new, __wbg_mark_40e050a77cc39fea, __wbg_measure_aa7a73f17813f708, __wbg_msCrypto_eb05e62b530a1508, __wbg_new_16b304a2cfa7ff4a, __wbg_new_63b92bc8671ed464, __wbg_new_72fb9a18b5ae2624, __wbg_new_abda76e883ba8a5f, __wbg_new_d9bc3a0147634640, __wbg_newnoargs_e258087cd0daa0ea, __wbg_newwithbyteoffsetandlength_aa4a17c33a06e5cb, __wbg_newwithlength_66ae46612e7f0234, __wbg_newwithlength_e9b4878cebadb3d3, __wbg_next_196c84450b364254, __wbg_next_40fc327bfc8770e6, __wbg_node_104a2ff8d6ea03a2, __wbg_now_6dd635953150ee31, __wbg_ownKeys_658942b7f28d1fe9, __wbg_process_4a72847cc503995b, __wbg_push_a5b05aedc7234f9f, __wbg_randomFillSync_5c9c955aa56b6049, __wbg_require_cca90b1a94a0255b, __wbg_resolve_b0083a7967828ec8, __wbg_self_ce0dbfc45cf2f5be, __wbg_set_1f9b04f170055d33, __wbg_set_8417257aaedc936b, __wbg_set_a47bac70306a19a7, __wbg_set_d4638f722068f043, __wbg_set_f975102236d3c502, __wbg_set_wasm, __wbg_setindex_0b7ede192dc5eca8, __wbg_stack_658279fe44541cf6, __wbg_subarray_a1f73cd4b5b42fe1, __wbg_then_0c86a60e8fcfe9f6, __wbg_value_d93c65011f51a456, __wbg_versions_f686565e586dd935, __wbg_versionvector_new, __wbg_window_c6fb939a7f436783, __wbindgen_as_number, __wbindgen_bigint_from_i64, __wbindgen_bigint_from_u64, __wbindgen_bigint_get_as_i64, __wbindgen_boolean_get, __wbindgen_cb_drop, __wbindgen_closure_wrapper482, __wbindgen_closure_wrapper484, __wbindgen_debug_string, __wbindgen_error_new, __wbindgen_in, __wbindgen_is_array, __wbindgen_is_bigint, __wbindgen_is_falsy, __wbindgen_is_function, __wbindgen_is_null, __wbindgen_is_object, __wbindgen_is_string, __wbindgen_is_undefined, __wbindgen_jsval_eq, __wbindgen_jsval_loose_eq, __wbindgen_memory, __wbindgen_number_get, __wbindgen_number_new, __wbindgen_object_clone_ref, __wbindgen_object_drop_ref, __wbindgen_rethrow, __wbindgen_string_get, __wbindgen_string_new, __wbindgen_throw, __wbindgen_typeof, decodeFrontiers, decodeImportBlobMeta, encodeFrontiers, getType, isContainer, isContainerId, newContainerID, newRootContainerID, run, setDebug };
+export { Awareness, AwarenessWasm, Cursor, Loro, LoroCounter, LoroDoc, LoroList, LoroMap, LoroMovableList, LoroText, LoroTree, LoroTreeNode, UndoManager, VersionVector, __wbg_String_b9412f8799faab3e, __wbg_apply_0a5aa603881e6d79, __wbg_buffer_12d079cc21e14bdb, __wbg_call_27c0f87801dedf93, __wbg_call_8e7cb608789c2528, __wbg_call_938992c832f74314, __wbg_call_b3ca7c6051f9bec1, __wbg_crypto_1d1f22824a6a080c, __wbg_cursor_new, __wbg_done_298b57d23c0fc80c, __wbg_entries_95cc2c823b285a09, __wbg_entries_ce844941d0c51880, __wbg_error_9384d761bf46409d, __wbg_error_f851667af71bcfc6, __wbg_from_89e3fc3ba5e6fb48, __wbg_getRandomValues_3aa56aa6edec874c, __wbg_get_bd8e338fbd5f5cc8, __wbg_get_e3c254076557e348, __wbg_getindex_03d06b4e7ea3475e, __wbg_getwithrefkey_edc2c8960f0f1191, __wbg_globalThis_d1e6af4856ba331b, __wbg_global_207b558942527489, __wbg_instanceof_ArrayBuffer_836825be07d4c9d2, __wbg_instanceof_Map_87917e0a7aaf4012, __wbg_instanceof_Object_71ca3c0a59266746, __wbg_instanceof_Uint8Array_2b3bbecd033d19f6, __wbg_isArray_2ab64d95e09ea0ae, __wbg_isSafeInteger_f7b04ef02296c4d2, __wbg_iterator_2cee6dadfd956dfa, __wbg_length_c20a40f15020d68a, __wbg_length_cd7af8117672b8b8, __wbg_log_aba5996d9bde071f, __wbg_log_c86c3e1bf097ba35, __wbg_log_c9486ca5d8e2cbe8, __wbg_lorocounter_new, __wbg_lorolist_new, __wbg_loromap_new, __wbg_loromovablelist_new, __wbg_lorotext_new, __wbg_lorotree_new, __wbg_lorotreenode_new, __wbg_mark_40e050a77cc39fea, __wbg_measure_aa7a73f17813f708, __wbg_msCrypto_eb05e62b530a1508, __wbg_new_16b304a2cfa7ff4a, __wbg_new_63b92bc8671ed464, __wbg_new_72fb9a18b5ae2624, __wbg_new_abda76e883ba8a5f, __wbg_new_d9bc3a0147634640, __wbg_newnoargs_e258087cd0daa0ea, __wbg_newwithbyteoffsetandlength_aa4a17c33a06e5cb, __wbg_newwithlength_66ae46612e7f0234, __wbg_newwithlength_e9b4878cebadb3d3, __wbg_next_196c84450b364254, __wbg_next_40fc327bfc8770e6, __wbg_node_104a2ff8d6ea03a2, __wbg_now_bc6f749123583eb9, __wbg_ownKeys_658942b7f28d1fe9, __wbg_process_4a72847cc503995b, __wbg_push_a5b05aedc7234f9f, __wbg_randomFillSync_5c9c955aa56b6049, __wbg_require_cca90b1a94a0255b, __wbg_resolve_b0083a7967828ec8, __wbg_self_ce0dbfc45cf2f5be, __wbg_set_1f9b04f170055d33, __wbg_set_8417257aaedc936b, __wbg_set_a47bac70306a19a7, __wbg_set_d4638f722068f043, __wbg_set_f975102236d3c502, __wbg_set_wasm, __wbg_setindex_0b7ede192dc5eca8, __wbg_stack_658279fe44541cf6, __wbg_subarray_a1f73cd4b5b42fe1, __wbg_then_0c86a60e8fcfe9f6, __wbg_value_d93c65011f51a456, __wbg_versions_f686565e586dd935, __wbg_versionvector_new, __wbg_window_c6fb939a7f436783, __wbindgen_as_number, __wbindgen_bigint_from_i64, __wbindgen_bigint_from_u64, __wbindgen_bigint_get_as_i64, __wbindgen_boolean_get, __wbindgen_cb_drop, __wbindgen_closure_wrapper482, __wbindgen_closure_wrapper485, __wbindgen_debug_string, __wbindgen_error_new, __wbindgen_in, __wbindgen_is_array, __wbindgen_is_bigint, __wbindgen_is_falsy, __wbindgen_is_function, __wbindgen_is_null, __wbindgen_is_object, __wbindgen_is_string, __wbindgen_is_undefined, __wbindgen_jsval_eq, __wbindgen_jsval_loose_eq, __wbindgen_memory, __wbindgen_number_get, __wbindgen_number_new, __wbindgen_object_clone_ref, __wbindgen_object_drop_ref, __wbindgen_rethrow, __wbindgen_string_get, __wbindgen_string_new, __wbindgen_throw, __wbindgen_typeof, decodeFrontiers, decodeImportBlobMeta, encodeFrontiers, getType, isContainer, isContainerId, newContainerID, newRootContainerID, run, setDebug };

package/base64/loro_wasm.d.ts

@@ -155,36 +155,55 @@ 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. 
+     *                  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({ start: 0, end: 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;
+
+    /**
+     * Calculate the differences between two frontiers
+     *
+     * The entries in the returned object are sorted by causal order: the creation of a child container will be
+     * presented before its use.
+     *
+     * @param from - The source frontier to diff from. A frontier represents a consistent version of the document.
+     * @param to - The target frontier to diff to. A frontier represents a consistent version of the document.
+     * @param for_json - Controls the diff format:
+     *                   - If true, returns JsonDiff format suitable for JSON serialization
+     *                   - If false, returns Diff format that shares the same type as LoroEvent
+     *                   - The default value is `true`
+     */
+    diff(from: OpId[], to: OpId[], for_json: false): [ContainerID, Diff][];
+    diff(from: OpId[], to: OpId[], for_json: true): [ContainerID, JsonDiff][];
+    diff(from: OpId[], to: OpId[], for_json: undefined): [ContainerID, JsonDiff][];
+    diff(from: OpId[], to: OpId[], for_json?: boolean): [ContainerID, JsonDiff|Diff][];
 }
 
 /**
@@ -672,6 +691,11 @@ export type ListDiff = {
     diff: Delta<(Value | Container)[]>[];
 };
 
+export type ListJsonDiff = {
+    type: "list";
+    diff: Delta<(Value | JsonContainerID )[]>[];
+};
+
 export type TextDiff = {
     type: "text";
     diff: Delta<string>[];
@@ -682,6 +706,11 @@ export type MapDiff = {
     updated: Record<string, Value | Container | undefined>;
 };
 
+export type MapJsonDiff = {
+    type: "map";
+    updated: Record<string, Value | JsonContainerID | undefined>;
+};
+
 export type TreeDiffItem =
     | {
         target: TreeID;
@@ -717,6 +746,7 @@ export type CounterDiff = {
 };
 
 export type Diff = ListDiff | TextDiff | MapDiff | TreeDiff | CounterDiff;
+export type JsonDiff = ListJsonDiff | TextDiff | MapJsonDiff | CounterDiff | TreeDiff;
 export type Subscription = () => void;
 type NonNullableType<T> = Exclude<T, null | undefined>;
 export type AwarenessListener = (
@@ -1082,7 +1112,7 @@ interface LoroMap<T extends Record<string, unknown> = Record<string, unknown>> {
      *  If the key already exists, its value will be updated. If the key doesn't exist,
      *  a new key-value pair will be created.
      *
-     *  > **Note**: When calling `map.set(key, value)` on a LoroMap, if `map.get(key)` already returns `value`, 
+     *  > **Note**: When calling `map.set(key, value)` on a LoroMap, if `map.get(key)` already returns `value`,
      *  > the operation will be a no-op (no operation recorded) to avoid unnecessary updates.
      *
      *  @example
@@ -2318,20 +2348,34 @@ export class LoroDoc {
 */
   revertTo(frontiers: ({ peer: PeerID, counter: number })[]): void;
 /**
-* Apply a diff batch to the document
-* @param {Record<ContainerID, Diff>} diff
-*/
-  applyDiff(diff: Record<ContainerID, Diff>): void;
-/**
-* Calculate the differences between two frontiers
+* Apply a batch of diff to the document
 *
-* The entries in the returned object are sorted by causal order: the creation of a child container will be
-* presented before its use.
-* @param {({ peer: PeerID, counter: number })[]} from
-* @param {({ peer: PeerID, counter: number })[]} to
-* @returns {Record<ContainerID, Diff>}
+* A diff batch represents a set of changes between two versions of the document.
+* You can calculate a diff batch using `doc.diff()`.
+*
+* Changes are associated with container IDs. During diff application, if new containers were created in the source
+* document, they will be assigned fresh IDs in the target document. Loro automatically handles remapping these
+* container IDs from their original IDs to the new IDs as the diff is applied.
+*
+* @example
+* ```ts
+* const doc1 = new LoroDoc();
+* const doc2 = new LoroDoc();
+*
+* // Make some changes to doc1
+* const text = doc1.getText("text");
+* text.insert(0, "Hello");
+*
+* // Calculate diff between empty and current state
+* const diff = doc1.diff([], doc1.frontiers());
+*
+* // Apply changes to doc2
+* doc2.applyDiff(diff);
+* console.log(doc2.getText("text").toString()); // "Hello"
+* ```
+* @param {[ContainerID, Diff|JsonDiff][]} diff
 */
-  diff(from: ({ peer: PeerID, counter: number })[], to: ({ peer: PeerID, counter: number })[]): Record<ContainerID, Diff>;
+  applyDiff(diff: [ContainerID, Diff|JsonDiff][]): void;
 /**
 * Peer ID of the current writer.
 */