loro-crdt 1.0.7 → 1.0.8-alpha.0

package/nodejs/loro_wasm_bg.wasm.d.ts

@@ -0,0 +1,249 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export function __wbg_lorocounter_free(a: number): void;
+export function lorocounter_new(): number;
+export function lorocounter_increment(a: number, b: number, c: number): void;
+export function lorocounter_decrement(a: number, b: number, c: number): void;
+export function lorocounter_value(a: number): number;
+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 __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;
+export function awarenesswasm_encodeAll(a: number, b: number): void;
+export function awarenesswasm_apply(a: number, b: number, c: number, d: number): void;
+export function awarenesswasm_setLocalState(a: number, b: number): void;
+export function awarenesswasm_peer(a: number): number;
+export function awarenesswasm_getAllStates(a: number): number;
+export function awarenesswasm_getState(a: number, b: number): number;
+export function awarenesswasm_getTimestamp(a: number, b: number, c: number): void;
+export function awarenesswasm_removeOutdated(a: number, b: number): void;
+export function awarenesswasm_length(a: number): number;
+export function awarenesswasm_isEmpty(a: number): number;
+export function awarenesswasm_peers(a: number, b: number): void;
+export function run(): void;
+export function encodeFrontiers(a: number, b: number, c: number): void;
+export function decodeFrontiers(a: number, b: number, c: number): void;
+export function setDebug(): void;
+export function __wbg_lorodoc_free(a: number): void;
+export function lorodoc_new(): number;
+export function lorodoc_setDetachedEditing(a: number, b: number): void;
+export function lorodoc_isDetachedEditingEnabled(a: number): number;
+export function lorodoc_setRecordTimestamp(a: number, b: number): void;
+export function lorodoc_setChangeMergeInterval(a: number, b: number): void;
+export function lorodoc_configTextStyle(a: number, b: number, c: number): void;
+export function lorodoc_fromSnapshot(a: number, b: number, c: number): void;
+export function lorodoc_attach(a: number): void;
+export function lorodoc_isDetached(a: number): number;
+export function lorodoc_detach(a: number): void;
+export function lorodoc_fork(a: number): number;
+export function lorodoc_forkAt(a: number, b: number, c: number, d: number): void;
+export function lorodoc_checkoutToLatest(a: number, b: number): void;
+export function lorodoc_travelChangeAncestors(a: number, b: number, c: number, d: number, e: number): void;
+export function lorodoc_checkout(a: number, b: number, c: number, d: number): void;
+export function lorodoc_peerId(a: number): number;
+export function lorodoc_peerIdStr(a: number): number;
+export function lorodoc_setPeerId(a: number, b: number, c: number): void;
+export function lorodoc_commit(a: number, b: number, c: number): void;
+export function lorodoc_getPendingTxnLength(a: number): number;
+export function lorodoc_getText(a: number, b: number, c: number): void;
+export function lorodoc_getMap(a: number, b: number, c: number): void;
+export function lorodoc_getList(a: number, b: number, c: number): void;
+export function lorodoc_getMovableList(a: number, b: number, c: number): void;
+export function lorodoc_getCounter(a: number, b: number, c: number): void;
+export function lorodoc_getTree(a: number, b: number, c: number): void;
+export function lorodoc_getContainerById(a: number, b: number, c: number): void;
+export function lorodoc_setNextCommitMessage(a: number, b: number, c: number): void;
+export function lorodoc_getDeepValueWithID(a: number): number;
+export function lorodoc_getPathToContainer(a: number, b: number, c: number): void;
+export function lorodoc_JSONPath(a: number, b: number, c: number, d: number): void;
+export function lorodoc_version(a: number): number;
+export function lorodoc_shallowSinceVV(a: number): number;
+export function lorodoc_isShallow(a: number): number;
+export function lorodoc_shallowSinceFrontiers(a: number): number;
+export function lorodoc_oplogVersion(a: number): number;
+export function lorodoc_frontiers(a: number): number;
+export function lorodoc_oplogFrontiers(a: number): number;
+export function lorodoc_cmpWithFrontiers(a: number, b: number, c: number, d: number): void;
+export function lorodoc_cmpFrontiers(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function lorodoc_exportSnapshot(a: number, b: number): void;
+export function lorodoc_exportFrom(a: number, b: number, c: number): void;
+export function lorodoc_export(a: number, b: number, c: number): void;
+export function lorodoc_exportJsonUpdates(a: number, b: number, c: number, d: number): void;
+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_getShallowValue(a: number, b: number): void;
+export function lorodoc_toJSON(a: number, b: number): void;
+export function lorodoc_subscribe(a: number, b: number): number;
+export function lorodoc_subscribeLocalUpdates(a: number, b: number): number;
+export function lorodoc_debugHistory(a: number): void;
+export function lorodoc_getAllChanges(a: number): number;
+export function lorodoc_getChangeAt(a: number, b: number, c: number): void;
+export function lorodoc_getChangeAtLamport(a: number, b: number, c: number, d: number, e: number): void;
+export function lorodoc_getOpsInChange(a: number, b: number, c: number): void;
+export function lorodoc_frontiersToVV(a: number, b: number, c: number, d: number): void;
+export function lorodoc_vvToFrontiers(a: number, b: number, c: number): void;
+export function lorodoc_getByPath(a: number, b: number, c: number): number;
+export function lorodoc_getCursorPos(a: number, b: number, c: number): void;
+export function __wbg_lorotext_free(a: number): void;
+export function lorotext_new(): number;
+export function lorotext_kind(a: number): number;
+export function lorotext_iter(a: number, b: number): void;
+export function lorotext_update(a: number, b: number, c: number): void;
+export function lorotext_updateByLine(a: number, b: number, c: number): void;
+export function lorotext_insert(a: number, b: number, c: number, d: number, e: number): void;
+export function lorotext_slice(a: number, b: number, c: number, d: number): void;
+export function lorotext_charAt(a: number, b: number, c: number): void;
+export function lorotext_splice(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function lorotext_insertUtf8(a: number, b: number, c: number, d: number, e: number): void;
+export function lorotext_delete(a: number, b: number, c: number, d: number): void;
+export function lorotext_deleteUtf8(a: number, b: number, c: number, d: number): void;
+export function lorotext_mark(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function lorotext_unmark(a: number, b: number, c: number, d: number, e: number): void;
+export function lorotext_toString(a: number, b: number): void;
+export function lorotext_toDelta(a: number): number;
+export function lorotext_id(a: number): number;
+export function lorotext_length(a: number): number;
+export function lorotext_subscribe(a: number, b: number, c: number): void;
+export function lorotext_applyDelta(a: number, b: number, c: number): void;
+export function lorotext_parent(a: number): number;
+export function lorotext_getAttached(a: number): number;
+export function lorotext_getCursor(a: number, b: number, c: number): number;
+export function __wbg_loromap_free(a: number): void;
+export function loromap_new(): number;
+export function loromap_kind(a: number): number;
+export function loromap_set(a: number, b: number, c: number, d: number, e: number): void;
+export function loromap_delete(a: number, b: number, c: number, d: number): void;
+export function loromap_get(a: number, b: number, c: number): number;
+export function loromap_getOrCreateContainer(a: number, b: number, c: number, d: number, e: number): void;
+export function loromap_keys(a: number, b: number): void;
+export function loromap_values(a: number, b: number): void;
+export function loromap_entries(a: number, b: number): void;
+export function loromap_id(a: number): number;
+export function loromap_toJSON(a: number): number;
+export function loromap_setContainer(a: number, b: number, c: number, d: number, e: number): void;
+export function loromap_subscribe(a: number, b: number, c: number): void;
+export function loromap_size(a: number): number;
+export function loromap_parent(a: number): number;
+export function loromap_getAttached(a: number): number;
+export function loromap_clear(a: number, b: number): void;
+export function __wbg_lorolist_free(a: number): void;
+export function lorolist_new(): number;
+export function lorolist_kind(a: number): number;
+export function lorolist_insert(a: number, b: number, c: number, d: number): void;
+export function lorolist_delete(a: number, b: number, c: number, d: number): void;
+export function lorolist_get(a: number, b: number): number;
+export function lorolist_id(a: number): number;
+export function lorolist_toArray(a: number, b: number): void;
+export function lorolist_toJSON(a: number): number;
+export function lorolist_insertContainer(a: number, b: number, c: number, d: number): void;
+export function lorolist_subscribe(a: number, b: number, c: number): void;
+export function lorolist_length(a: number): number;
+export function lorolist_parent(a: number): number;
+export function lorolist_isAttached(a: number): number;
+export function lorolist_getAttached(a: number): number;
+export function lorolist_getCursor(a: number, b: number, c: number): number;
+export function lorolist_push(a: number, b: number, c: number): void;
+export function lorolist_pop(a: number, b: number): void;
+export function lorolist_clear(a: number, b: number): void;
+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;
+export function loromovablelist_delete(a: number, b: number, c: number, d: number): void;
+export function loromovablelist_get(a: number, b: number): number;
+export function loromovablelist_id(a: number): number;
+export function loromovablelist_toArray(a: number, b: number): void;
+export function loromovablelist_toJSON(a: number): number;
+export function loromovablelist_insertContainer(a: number, b: number, c: number, d: number): void;
+export function loromovablelist_subscribe(a: number, b: number, c: number): void;
+export function loromovablelist_length(a: number): number;
+export function loromovablelist_getAttached(a: number): number;
+export function loromovablelist_getCursor(a: number, b: number, c: number): number;
+export function loromovablelist_move(a: number, b: number, c: number, d: number): void;
+export function loromovablelist_set(a: number, b: number, c: number, d: number): void;
+export function loromovablelist_setContainer(a: number, b: number, c: number, d: number): void;
+export function loromovablelist_push(a: number, b: number, c: number): void;
+export function loromovablelist_pop(a: number, b: number): void;
+export function loromovablelist_clear(a: number, b: number): void;
+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;
+export function lorotreenode_id(a: number): number;
+export function lorotreenode_createNode(a: number, b: number, c: number, d: number): void;
+export function lorotreenode_move(a: number, b: number, c: number, d: number, e: number): void;
+export function lorotreenode_moveAfter(a: number, b: number, c: number): void;
+export function lorotreenode_moveBefore(a: number, b: number, c: number): void;
+export function lorotreenode_index(a: number, b: number): void;
+export function lorotreenode_fractionalIndex(a: number, b: number): void;
+export function lorotreenode_data(a: number, b: number): void;
+export function lorotreenode_parent(a: number, b: number): void;
+export function lorotreenode_children(a: number): number;
+export function lorotreenode_isDeleted(a: number, b: number): void;
+export function lorotree_new(): number;
+export function lorotree_kind(a: number): number;
+export function lorotree_createNode(a: number, b: number, c: number, d: number, e: number): void;
+export function lorotree_move(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function lorotree_delete(a: number, b: number, c: number): void;
+export function lorotree_getNodeByID(a: number, b: number): number;
+export function lorotree_id(a: number): number;
+export function lorotree_has(a: number, b: number): number;
+export function lorotree_isNodeDeleted(a: number, b: number, c: number): void;
+export function lorotree_toArray(a: number, b: number): void;
+export function lorotree_getNodes(a: number, b: number, c: number): void;
+export function lorotree_toJSON(a: number): number;
+export function lorotree_nodes(a: number, b: number): void;
+export function lorotree_roots(a: number, b: number): void;
+export function lorotree_subscribe(a: number, b: number, c: number): void;
+export function lorotree_parent(a: number): number;
+export function lorotree_isAttached(a: number): number;
+export function lorotree_getAttached(a: number): number;
+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 __wbg_cursor_free(a: number): void;
+export function cursor_containerId(a: number): number;
+export function cursor_pos(a: number): number;
+export function cursor_side(a: number): number;
+export function cursor_encode(a: number, b: number): void;
+export function cursor_decode(a: number, b: number, c: number): void;
+export function cursor_kind(a: number): number;
+export function __wbg_undomanager_free(a: number): void;
+export function undomanager_new(a: number, b: number): number;
+export function undomanager_undo(a: number, b: number): void;
+export function undomanager_redo(a: number, b: number): void;
+export function undomanager_canUndo(a: number): number;
+export function undomanager_canRedo(a: number): number;
+export function undomanager_setMaxUndoSteps(a: number, b: number): void;
+export function undomanager_setMergeInterval(a: number, b: number): void;
+export function undomanager_addExcludeOriginPrefix(a: number, b: number, c: number): void;
+export function undomanager_checkBinding(a: number, b: number): number;
+export function undomanager_setOnPush(a: number, b: number): void;
+export function undomanager_setOnPop(a: number, b: number): void;
+export function undomanager_clear(a: number): void;
+export function __wbg_versionvector_free(a: number): void;
+export function versionvector_new(a: number, b: number): void;
+export function versionvector_parseJSON(a: number, b: number): void;
+export function versionvector_toJSON(a: number): number;
+export function versionvector_encode(a: number, b: number): void;
+export function versionvector_decode(a: number, b: number, c: number): void;
+export function versionvector_get(a: number, b: number, c: number): void;
+export function versionvector_compare(a: number, b: number, c: number): void;
+export function decodeImportBlobMeta(a: number, b: number, c: number): void;
+export function __wbg_loromovablelist_free(a: number): void;
+export function loromovablelist_parent(a: number): number;
+export function lorotext_isAttached(a: number): number;
+export function loromap_isAttached(a: number): number;
+export function loromovablelist_isAttached(a: number): number;
+export function __wbindgen_export_0(a: number, b: number): number;
+export function __wbindgen_export_1(a: number, b: number, c: number, d: number): number;
+export const __wbindgen_export_2: WebAssembly.Table;
+export function __wbindgen_export_3(a: number, b: number, c: number): void;
+export function __wbindgen_export_4(a: number, b: number): void;
+export function __wbindgen_add_to_stack_pointer(a: number): number;
+export function __wbindgen_export_5(a: number, b: number, c: number): void;
+export function __wbindgen_export_6(a: number): void;
+export function __wbindgen_start(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loro-crdt",
-  "version": "1.0.7",
+  "version": "1.0.8-alpha.0",
   "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
   "keywords": [
     "crdt",
@@ -14,36 +14,25 @@
     "type": "git",
     "url": "git+https://github.com/loro-dev/loro.git"
   },
-  "main": "dist/loro.js",
-  "module": "dist/loro.mjs",
-  "typings": "dist/loro.d.ts",
-  "author": "Loro",
+  "main": "nodejs/index.js",
+  "module": "bundler/index.js",
+  "types": "bundler/index.d.ts",
+  "scripts": {
+    "build-dev": "deno run -A ./scripts/build.ts dev && rollup -c && deno run -A ./scripts/post-rollup.ts && npm run test",
+    "build-release": "deno run -A ./scripts/build.ts release && rollup -c && deno run -A ./scripts/post-rollup.ts && npm run test",
+    "test": "cd ./deno_tests && deno test -A"
+  },
   "homepage": "https://loro.dev",
+  "author": "",
   "license": "MIT",
-  "dependencies": {
-    "loro-wasm": "1.0.7"
-  },
   "devDependencies": {
+    "@rollup/plugin-alias": "^5.1.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@typescript-eslint/parser": "^6.2.0",
-    "@vitest/ui": "^1.0.4",
-    "esbuild": "^0.18.20",
-    "eslint": "^8.46.0",
-    "loro-crdt-old": "npm:loro-crdt@=0.16.0",
-    "loro-crdt-alpha-4": "npm:loro-crdt@=1.0.0-alpha.4",
-    "prettier": "^3.0.0",
+    "@rollup/plugin-typescript": "^12.1.1",
     "rollup": "^3.20.1",
-    "rollup-plugin-dts": "^5.3.0",
-    "rollup-plugin-esbuild": "^5.0.0",
-    "typescript": "^5.0.2",
-    "vite": "^4.2.1",
-    "vite-plugin-wasm": "^3.2.2",
-    "vitest": "^1.4.0"
-  },
-  "scripts": {
-    "build": "rollup -c",
-    "watch": "rollup -c -w",
-    "test": "node --expose-gc ./node_modules/vitest/vitest.mjs run && npx tsc --noEmit",
-    "prepublish": "pnpm run build"
+    "tslib": "^2.8.0",
+    "typescript": "^5.6.3",
+    "vite-plugin-top-level-await": "^1.2.2",
+    "vite-plugin-wasm": "^3.1.0"
   }
-}
+}

package/ts/index.ts

@@ -0,0 +1,216 @@
+export * from "loro-wasm";
+export type * from "loro-wasm";
+import {
+    AwarenessWasm,
+    PeerID,
+    Container,
+    ContainerID,
+    ContainerType,
+    Delta,
+    LoroCounter,
+    LoroDoc,
+    LoroList,
+    LoroMap,
+    LoroText,
+    LoroTree,
+    OpId,
+    Value,
+    AwarenessListener,
+} from "loro-wasm";
+
+/**
+ * @deprecated Please use LoroDoc
+ */
+export class Loro extends LoroDoc { }
+
+const CONTAINER_TYPES = [
+    "Map",
+    "Text",
+    "List",
+    "Tree",
+    "MovableList",
+    "Counter",
+];
+
+export function isContainerId(s: string): s is ContainerID {
+    return s.startsWith("cid:");
+}
+
+/**  Whether the value is a container.
+ *
+ * # Example
+ *
+ * ```ts
+ * const doc = new LoroDoc();
+ * const map = doc.getMap("map");
+ * const list = doc.getList("list");
+ * const text = doc.getText("text");
+ * isContainer(map); // true
+ * isContainer(list); // true
+ * isContainer(text); // true
+ * isContainer(123); // false
+ * isContainer("123"); // false
+ * isContainer({}); // false
+ * ```
+ */
+export function isContainer(value: any): value is Container {
+    if (typeof value !== "object" || value == null) {
+        return false;
+    }
+
+    const p = Object.getPrototypeOf(value);
+    if (p == null || typeof p !== "object" || typeof p["kind"] !== "function") {
+        return false;
+    }
+
+    return CONTAINER_TYPES.includes(value.kind());
+}
+
+
+/**  Get the type of a value that may be a container.
+ *
+ * # Example
+ *
+ * ```ts
+ * const doc = new LoroDoc();
+ * const map = doc.getMap("map");
+ * const list = doc.getList("list");
+ * const text = doc.getText("text");
+ * getType(map); // "Map"
+ * getType(list); // "List"
+ * getType(text); // "Text"
+ * getType(123); // "Json"
+ * getType("123"); // "Json"
+ * getType({}); // "Json"
+ * ```
+ */
+export function getType<T>(
+    value: T,
+): T extends LoroText ? "Text"
+    : T extends LoroMap<any> ? "Map"
+    : T extends LoroTree<any> ? "Tree"
+    : T extends LoroList<any> ? "List"
+    : T extends LoroCounter ? "Counter"
+    : "Json" {
+    if (isContainer(value)) {
+        return value.kind() as unknown as any;
+    }
+
+    return "Json" as any;
+}
+
+
+export function newContainerID(id: OpId, type: ContainerType): ContainerID {
+    return `cid:${id.counter}@${id.peer}:${type}`;
+}
+
+export function newRootContainerID(
+    name: string,
+    type: ContainerType,
+): ContainerID {
+    return `cid:root-${name}:${type}`;
+}
+
+
+
+/**
+ * Awareness is a structure that allows to track the ephemeral state of the peers.
+ *
+ * If we don't receive a state update from a peer within the timeout, we will remove their state.
+ * The timeout is in milliseconds. This can be used to handle the off-line state of a peer.
+ */
+export class Awareness<T extends Value = Value> {
+    inner: AwarenessWasm<T>;
+    private peer: PeerID;
+    private timer: number | undefined;
+    private timeout: number;
+    private listeners: Set<AwarenessListener> = new Set();
+    constructor(peer: PeerID, timeout: number = 30000) {
+        this.inner = new AwarenessWasm(peer, timeout);
+        this.peer = peer;
+        this.timeout = timeout;
+    }
+
+    apply(bytes: Uint8Array, origin = "remote") {
+        const { updated, added } = this.inner.apply(bytes);
+        this.listeners.forEach((listener) => {
+            listener({ updated, added, removed: [] }, origin);
+        });
+
+        this.startTimerIfNotEmpty();
+    }
+
+    setLocalState(state: T) {
+        const wasEmpty = this.inner.getState(this.peer) == null;
+        this.inner.setLocalState(state);
+        if (wasEmpty) {
+            this.listeners.forEach((listener) => {
+                listener(
+                    { updated: [], added: [this.inner.peer()], removed: [] },
+                    "local",
+                );
+            });
+        } else {
+            this.listeners.forEach((listener) => {
+                listener(
+                    { updated: [this.inner.peer()], added: [], removed: [] },
+                    "local",
+                );
+            });
+        }
+
+        this.startTimerIfNotEmpty();
+    }
+
+    getLocalState(): T | undefined {
+        return this.inner.getState(this.peer);
+    }
+
+    getAllStates(): Record<PeerID, T> {
+        return this.inner.getAllStates();
+    }
+
+    encode(peers: PeerID[]): Uint8Array {
+        return this.inner.encode(peers);
+    }
+
+    encodeAll(): Uint8Array {
+        return this.inner.encodeAll();
+    }
+
+    addListener(listener: AwarenessListener) {
+        this.listeners.add(listener);
+    }
+
+    removeListener(listener: AwarenessListener) {
+        this.listeners.delete(listener);
+    }
+
+    peers(): PeerID[] {
+        return this.inner.peers();
+    }
+
+    destroy() {
+        clearInterval(this.timer);
+        this.listeners.clear();
+    }
+
+    private startTimerIfNotEmpty() {
+        if (this.inner.isEmpty() || this.timer != null) {
+            return;
+        }
+
+        this.timer = setInterval(() => {
+            const removed = this.inner.removeOutdated();
+            if (removed.length > 0) {
+                this.listeners.forEach((listener) => {
+                    listener({ updated: [], added: [], removed }, "timeout");
+                });
+            }
+            if (this.inner.isEmpty()) {
+                clearInterval(this.timer);
+                this.timer = undefined;
+            }
+        }, this.timeout / 2) as unknown as number;
+    }
+}