loro-crdt 1.5.4 → 1.5.6

package/web/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.
      */
@@ -3958,6 +3975,7 @@ export interface InitOutput {
   readonly __wbg_changemodifier_free: (a: number, b: number) => void;
   readonly changemodifier_setMessage: (a: number, b: number, c: number) => number;
   readonly changemodifier_setTimestamp: (a: number, b: number) => number;
+  readonly redactJsonUpdates: (a: number, b: number, c: number) => void;
   readonly lorodoc_importUpdateBatch: (a: number, b: number, c: number) => void;
   readonly __wbg_loromovablelist_free: (a: number, b: number) => void;
   readonly __wbindgen_export_0: (a: number, b: number) => number;

package/web/loro_wasm.js

@@ -375,6 +375,44 @@ export 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}
+ */
+export 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));
 }
@@ -6838,7 +6876,7 @@ function __wbg_get_imports() {
         const ret = makeMutClosure(arg0, arg1, 10, __wbg_adapter_60);
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper486 = function(arg0, arg1, arg2) {
+    imports.wbg.__wbindgen_closure_wrapper485 = function(arg0, arg1, arg2) {
         const ret = makeMutClosure(arg0, arg1, 8, __wbg_adapter_63);
         return addHeapObject(ret);
     };

package/web/loro_wasm_bg.wasm.d.ts

@@ -304,6 +304,7 @@ export const decodeImportBlobMeta: (a: number, b: number, c: number, d: number)
 export const __wbg_changemodifier_free: (a: number, b: number) => void;
 export const changemodifier_setMessage: (a: number, b: number, c: number) => number;
 export const changemodifier_setTimestamp: (a: number, b: number) => number;
+export const redactJsonUpdates: (a: number, b: number, c: number) => void;
 export const lorodoc_importUpdateBatch: (a: number, b: number, c: number) => void;
 export const __wbg_loromovablelist_free: (a: number, b: number) => void;
 export const __wbindgen_export_0: (a: number, b: number) => number;