loro-crdt 1.5.4 → 1.5.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.5.6
+
+### Patch Changes
+
+- 60876bb: Feat: redact
+
+## 1.5.5
+
+### Patch Changes
+
+- 0bfbb3b: fix: update EphemeralStore to support generic types (#718)
+
 ## 1.5.4
 
 ### Patch Changes

package/base64/index.d.ts

@@ -102,16 +102,17 @@ export declare class Awareness<T extends Value = Value> {
  * store2.apply(encoded);
  * ```
  */
-export declare class EphemeralStore<T extends Value = Value> {
-    inner: EphemeralStoreWasm<T>;
+export declare class EphemeralStore<T extends Record<string, Value> = Record<string, Value>> {
+    inner: EphemeralStoreWasm;
     private timer;
     private timeout;
     constructor(timeout?: number);
     apply(bytes: Uint8Array): void;
-    set(key: string, value: T): void;
-    get(key: string): T | undefined;
-    getAllStates(): Record<string, T>;
-    encode(key: string): Uint8Array;
+    set<K extends keyof T>(key: K, value: T[K]): void;
+    delete<K extends keyof T>(key: K): void;
+    get<K extends keyof T>(key: K): T[K] | undefined;
+    getAllStates(): Partial<T>;
+    encode<K extends keyof T>(key: K): Uint8Array;
     encodeAll(): Uint8Array;
     keys(): string[];
     destroy(): void;

package/base64/index.js

@@ -383,6 +383,44 @@ function decodeImportBlobMeta(blob, check_checksum) {
     }
 }
 
+/**
+ * Redacts sensitive content in JSON updates within the specified version range.
+ *
+ * This function allows you to share document history while removing potentially sensitive content.
+ * It preserves the document structure and collaboration capabilities while replacing content with
+ * placeholders according to these redaction rules:
+ *
+ * - Preserves delete and move operations
+ * - Replaces text insertion content with the Unicode replacement character
+ * - Substitutes list and map insert values with null
+ * - Maintains structure of child containers
+ * - Replaces text mark values with null
+ * - Preserves map keys and text annotation keys
+ *
+ * @param {Object|string} jsonUpdates - The JSON updates to redact (object or JSON string)
+ * @param {Object} versionRange - Version range defining what content to redact,
+ *                  format: { peerId: [startCounter, endCounter], ... }
+ * @returns {Object} The redacted JSON updates
+ * @param {string | JsonSchema} json_updates
+ * @param {any} version_range
+ * @returns {JsonSchema}
+ */
+function redactJsonUpdates(json_updates, version_range) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.redactJsonUpdates(retptr, addHeapObject(json_updates), addHeapObject(version_range));
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+        if (r2) {
+            throw takeObject(r1);
+        }
+        return takeObject(r0);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
 function __wbg_adapter_60(arg0, arg1, arg2) {
     wasm.__wbindgen_export_5(arg0, arg1, addHeapObject(arg2));
 }
@@ -6812,7 +6850,7 @@ function __wbindgen_closure_wrapper483(arg0, arg1, arg2) {
     const ret = makeMutClosure(arg0, arg1, 10, __wbg_adapter_60);
     return addHeapObject(ret);
 }
-function __wbindgen_closure_wrapper486(arg0, arg1, arg2) {
+function __wbindgen_closure_wrapper485(arg0, arg1, arg2) {
     const ret = makeMutClosure(arg0, arg1, 8, __wbg_adapter_63);
     return addHeapObject(ret);
 }
@@ -7019,7 +7057,7 @@ var imports = /*#__PURE__*/Object.freeze({
     __wbindgen_boolean_get: __wbindgen_boolean_get,
     __wbindgen_cb_drop: __wbindgen_cb_drop,
     __wbindgen_closure_wrapper483: __wbindgen_closure_wrapper483,
-    __wbindgen_closure_wrapper486: __wbindgen_closure_wrapper486,
+    __wbindgen_closure_wrapper485: __wbindgen_closure_wrapper485,
     __wbindgen_debug_string: __wbindgen_debug_string,
     __wbindgen_error_new: __wbindgen_error_new,
     __wbindgen_in: __wbindgen_in,
@@ -7046,6 +7084,7 @@ var imports = /*#__PURE__*/Object.freeze({
     decodeFrontiers: decodeFrontiers,
     decodeImportBlobMeta: decodeImportBlobMeta,
     encodeFrontiers: encodeFrontiers,
+    redactJsonUpdates: redactJsonUpdates,
     run: run,
     setDebug: setDebug
 });
@@ -7054,7 +7093,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-cf5679c4.js';
+import loro_wasm_bg_js from './loro_wasm_bg-f48ca64a.js';
 const instance = new WebAssembly.Instance(loro_wasm_bg_js(), {
     "./loro_wasm_bg.js": imports,
 });
@@ -7256,6 +7295,9 @@ class EphemeralStore {
         this.inner.set(key, value);
         this.startTimerIfNotEmpty();
     }
+    delete(key) {
+        this.inner.delete(key);
+    }
     get(key) {
         return this.inner.get(key);
     }
@@ -7356,4 +7398,4 @@ function idStrToId(idStr) {
     };
 }
 
-export { Awareness, AwarenessWasm, ChangeModifier, Cursor, EphemeralStore, EphemeralStoreWasm, LORO_VERSION, Loro, LoroCounter, LoroDoc, LoroList, LoroMap, LoroMovableList, LoroText, LoroTree, LoroTreeNode, UndoManager, VersionVector, __wbg_String_8f0eb39a4a4c2f66, __wbg_apply_9bb7fe8fff013a3f, __wbg_buffer_ef9774282e5dab94, __wbg_call_0ad083564791763a, __wbg_call_a34b6b4765f27be0, __wbg_call_d00953b926be4879, __wbg_call_efe5a4db7065d1a2, __wbg_changemodifier_new, __wbg_crypto_ed58b8e10a292839, __wbg_cursor_new, __wbg_done_f4c254830a095eaf, __wbg_entries_4dce6361e3ba6fbc, __wbg_entries_83beb641792ccb9c, __wbg_error_7534b8e9a36f1ab4, __wbg_error_9912f7d6d7835a4b, __wbg_from_3aa0fcaa8eef0104, __wbg_getRandomValues_bcb4912f16000dc4, __wbg_get_0c3cc364764a0b98, __wbg_get_b996a12be035ef4f, __wbg_getindex_a471648b3037c750, __wbg_getwithrefkey_1dc361bd10053bfe, __wbg_globalThis_6b4d52a0b6aaeaea, __wbg_global_49324ce12193de77, __wbg_instanceof_ArrayBuffer_ff40e55b5978e215, __wbg_instanceof_Map_0f3f3653f757ced1, __wbg_instanceof_Object_9108547bac1f91b1, __wbg_instanceof_Uint8Array_db97368f94b1373f, __wbg_isArray_8738f1062fa88586, __wbg_isSafeInteger_a1b3e0811faecf2f, __wbg_iterator_c0c688f37fa815e6, __wbg_length_12246a78d2f65d3a, __wbg_length_c24da17096edfe57, __wbg_log_0cc1b7768397bcfe, __wbg_log_0fd6c49475c7bece, __wbg_log_cb9e190acc5753fb, __wbg_lorocounter_new, __wbg_lorolist_new, __wbg_loromap_new, __wbg_loromovablelist_new, __wbg_lorotext_new, __wbg_lorotree_new, __wbg_lorotreenode_new, __wbg_mark_7438147ce31e9d4b, __wbg_measure_fb7825c11612c823, __wbg_msCrypto_0a36e2ec3a343d26, __wbg_new_518e2184725aa711, __wbg_new_59845962d1127937, __wbg_new_67abf4a77618ee3e, __wbg_new_8a6f238a6ece86ea, __wbg_new_e2d07398d7689006, __wbg_newnoargs_a136448eeb7d48ac, __wbg_newwithbyteoffsetandlength_84908302a4c137cf, __wbg_newwithlength_4c216eaaf23f2f9a, __wbg_newwithlength_88b49de1eb24d63e, __wbg_next_928df8c15fc0c9b0, __wbg_next_9dc0926f351c7090, __wbg_node_02999533c4ea02e3, __wbg_now_3e8577e703add0ba, __wbg_ownKeys_b16312a839a4152c, __wbg_process_5c1d670bc53614b8, __wbg_push_e7d7247e69dad3ee, __wbg_randomFillSync_ab2cfe79ebbf2740, __wbg_require_79b1e9274cde3c87, __wbg_resolve_267ff08e7e1d2ce4, __wbg_self_cca3ca60d61220f4, __wbg_set_1b50d2de855a9d50, __wbg_set_393f510a6b7e9da5, __wbg_set_3f1d0b984ed272ed, __wbg_set_5deee49b10b2b780, __wbg_set_93ba9407b5476ec6, __wbg_set_wasm, __wbg_setindex_e0b7b31bfc87ba3f, __wbg_stack_0ed75d68575b0f3c, __wbg_subarray_2dc34705c0dc7cdb, __wbg_then_84907e7a6730461e, __wbg_value_51f8a88d4a1805fb, __wbg_versions_c71aa1626a93e0a1, __wbg_versionvector_new, __wbg_window_2aba046d3fc4ad7c, __wbindgen_as_number, __wbindgen_bigint_from_i64, __wbindgen_bigint_from_u64, __wbindgen_bigint_get_as_i64, __wbindgen_boolean_get, __wbindgen_cb_drop, __wbindgen_closure_wrapper483, __wbindgen_closure_wrapper486, __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, idStrToId, isContainer, isContainerId, newContainerID, newRootContainerID, run, setDebug };
+export { Awareness, AwarenessWasm, ChangeModifier, Cursor, EphemeralStore, EphemeralStoreWasm, LORO_VERSION, Loro, LoroCounter, LoroDoc, LoroList, LoroMap, LoroMovableList, LoroText, LoroTree, LoroTreeNode, UndoManager, VersionVector, __wbg_String_8f0eb39a4a4c2f66, __wbg_apply_9bb7fe8fff013a3f, __wbg_buffer_ef9774282e5dab94, __wbg_call_0ad083564791763a, __wbg_call_a34b6b4765f27be0, __wbg_call_d00953b926be4879, __wbg_call_efe5a4db7065d1a2, __wbg_changemodifier_new, __wbg_crypto_ed58b8e10a292839, __wbg_cursor_new, __wbg_done_f4c254830a095eaf, __wbg_entries_4dce6361e3ba6fbc, __wbg_entries_83beb641792ccb9c, __wbg_error_7534b8e9a36f1ab4, __wbg_error_9912f7d6d7835a4b, __wbg_from_3aa0fcaa8eef0104, __wbg_getRandomValues_bcb4912f16000dc4, __wbg_get_0c3cc364764a0b98, __wbg_get_b996a12be035ef4f, __wbg_getindex_a471648b3037c750, __wbg_getwithrefkey_1dc361bd10053bfe, __wbg_globalThis_6b4d52a0b6aaeaea, __wbg_global_49324ce12193de77, __wbg_instanceof_ArrayBuffer_ff40e55b5978e215, __wbg_instanceof_Map_0f3f3653f757ced1, __wbg_instanceof_Object_9108547bac1f91b1, __wbg_instanceof_Uint8Array_db97368f94b1373f, __wbg_isArray_8738f1062fa88586, __wbg_isSafeInteger_a1b3e0811faecf2f, __wbg_iterator_c0c688f37fa815e6, __wbg_length_12246a78d2f65d3a, __wbg_length_c24da17096edfe57, __wbg_log_0cc1b7768397bcfe, __wbg_log_0fd6c49475c7bece, __wbg_log_cb9e190acc5753fb, __wbg_lorocounter_new, __wbg_lorolist_new, __wbg_loromap_new, __wbg_loromovablelist_new, __wbg_lorotext_new, __wbg_lorotree_new, __wbg_lorotreenode_new, __wbg_mark_7438147ce31e9d4b, __wbg_measure_fb7825c11612c823, __wbg_msCrypto_0a36e2ec3a343d26, __wbg_new_518e2184725aa711, __wbg_new_59845962d1127937, __wbg_new_67abf4a77618ee3e, __wbg_new_8a6f238a6ece86ea, __wbg_new_e2d07398d7689006, __wbg_newnoargs_a136448eeb7d48ac, __wbg_newwithbyteoffsetandlength_84908302a4c137cf, __wbg_newwithlength_4c216eaaf23f2f9a, __wbg_newwithlength_88b49de1eb24d63e, __wbg_next_928df8c15fc0c9b0, __wbg_next_9dc0926f351c7090, __wbg_node_02999533c4ea02e3, __wbg_now_3e8577e703add0ba, __wbg_ownKeys_b16312a839a4152c, __wbg_process_5c1d670bc53614b8, __wbg_push_e7d7247e69dad3ee, __wbg_randomFillSync_ab2cfe79ebbf2740, __wbg_require_79b1e9274cde3c87, __wbg_resolve_267ff08e7e1d2ce4, __wbg_self_cca3ca60d61220f4, __wbg_set_1b50d2de855a9d50, __wbg_set_393f510a6b7e9da5, __wbg_set_3f1d0b984ed272ed, __wbg_set_5deee49b10b2b780, __wbg_set_93ba9407b5476ec6, __wbg_set_wasm, __wbg_setindex_e0b7b31bfc87ba3f, __wbg_stack_0ed75d68575b0f3c, __wbg_subarray_2dc34705c0dc7cdb, __wbg_then_84907e7a6730461e, __wbg_value_51f8a88d4a1805fb, __wbg_versions_c71aa1626a93e0a1, __wbg_versionvector_new, __wbg_window_2aba046d3fc4ad7c, __wbindgen_as_number, __wbindgen_bigint_from_i64, __wbindgen_bigint_from_u64, __wbindgen_bigint_get_as_i64, __wbindgen_boolean_get, __wbindgen_cb_drop, __wbindgen_closure_wrapper483, __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, idStrToId, isContainer, isContainerId, newContainerID, newRootContainerID, redactJsonUpdates, run, setDebug };

package/base64/loro_wasm.d.ts

@@ -24,6 +24,26 @@ export function setDebug(): void;
  * - changeNum
  */
 export function decodeImportBlobMeta(blob: Uint8Array, check_checksum: boolean): ImportBlobMetadata;
+/**
+ * Redacts sensitive content in JSON updates within the specified version range.
+ *
+ * This function allows you to share document history while removing potentially sensitive content.
+ * It preserves the document structure and collaboration capabilities while replacing content with
+ * placeholders according to these redaction rules:
+ *
+ * - Preserves delete and move operations
+ * - Replaces text insertion content with the Unicode replacement character
+ * - Substitutes list and map insert values with null
+ * - Maintains structure of child containers
+ * - Replaces text mark values with null
+ * - Preserves map keys and text annotation keys
+ *
+ * @param {Object|string} jsonUpdates - The JSON updates to redact (object or JSON string)
+ * @param {Object} versionRange - Version range defining what content to redact,
+ *                  format: { peerId: [startCounter, endCounter], ... }
+ * @returns {Object} The redacted JSON updates
+ */
+export function redactJsonUpdates(json_updates: string | JsonSchema, version_range: any): JsonSchema;
 
 /**
 * Container types supported by loro.
@@ -194,11 +214,11 @@ interface LoroDoc {
      * doc.commit();
      * expect(doc.getChangeAt({ peer: "0", counter: 0 }).message).toBe("test");
      * ```
-     * 
+     *
      * ### Advanced Example: Creating a Merkle DAG
-     * 
+     *
      * By combining `doc.subscribePreCommit` with `doc.exportJsonInIdSpan`, you can implement advanced features like representing Loro's editing history as a Merkle DAG:
-     * 
+     *
      * ```ts
      * const doc = new LoroDoc();
      * doc.setPeerId(0);
@@ -218,7 +238,7 @@ interface LoroDoc {
      *   const sha256Hash = hash.digest('hex');
      *   e.modifier.setMessage(sha256Hash);
      * });
-     * 
+     *
      * doc.getList("list").insert(0, 100);
      * doc.commit();
      * // Change 0
@@ -236,8 +256,8 @@ interface LoroDoc {
      * //     }
      * //   ]
      * // }
-     * 
-     * 
+     *
+     *
      * doc.getList("list").insert(0, 200);
      * doc.commit();
      * // Change 1
@@ -257,13 +277,13 @@ interface LoroDoc {
      * //     }
      * //   ]
      * // }
-     * 
+     *
      * expect(doc.getChangeAt({ peer: "0", counter: 0 }).message).toBe("2af99cf93869173984bcf6b1ce5412610b0413d027a5511a8f720a02a4432853");
      * expect(doc.getChangeAt({ peer: "0", counter: 1 }).message).toBe("aedbb442c554ecf59090e0e8339df1d8febf647f25cc37c67be0c6e27071d37f");
      * ```
-     * 
+     *
      * @param f - A callback function that receives a pre commit event.
-     * 
+     *
      **/
     subscribePreCommit(f: (e: { changeMeta: Change, origin: string, modifier: ChangeModifier }) => void): () => void
 
@@ -587,9 +607,6 @@ interface LoroMovableList {
 }
 
 export type Side = -1 | 0 | 1;
-
-
-
 export type JsonOpID = `${number}@${PeerID}`;
 export type JsonContainerID =  `🦜:${ContainerID}` ;
 export type JsonValue  =
@@ -931,7 +948,7 @@ interface LoroDoc<T extends Record<string, Container> = Record<string, Container
      * import { LoroDoc } from "loro-crdt";
      *
      * const doc = new LoroDoc();
-     * const list = doc.getList("list");
+     * const list = doc.getMovableList("list");
      * ```
      */
     getMovableList<Key extends keyof T | ContainerID>(name: Key): T[Key] extends LoroMovableList ? T[Key] : LoroMovableList;
@@ -967,9 +984,9 @@ interface LoroDoc<T extends Record<string, Container> = Record<string, Container
      * It ensures deterministic output, making it ideal for hash calculations and integrity checks.
      *
      * This method can also export pending changes from the uncommitted transaction that have not yet been applied to the OpLog.
-     * 
+     *
      * This method will NOT trigger a new commit implicitly.
-     * 
+     *
      * @param idSpan - The id span to export.
      * @returns The changes in the given id span.
      */