loro-crdt 1.0.8-alpha.0 → 1.0.8-alpha.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.8-alpha.1
+
+### Patch Changes
+
+- Include the build for web
+
 ## 1.0.8-alpha.0
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loro-crdt",
-  "version": "1.0.8-alpha.0",
+  "version": "1.0.8-alpha.1",
   "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
   "keywords": [
     "crdt",

package/web/index.d.ts

@@ -0,0 +1,72 @@
+export * from "./loro_wasm";
+export type * from "./loro_wasm";
+import { AwarenessWasm, PeerID, Container, ContainerID, ContainerType, LoroCounter, LoroDoc, LoroList, LoroMap, LoroText, LoroTree, OpId, Value, AwarenessListener } from "./loro_wasm";
+/**
+ * @deprecated Please use LoroDoc
+ */
+export declare class Loro extends LoroDoc {
+}
+export declare function isContainerId(s: string): s is ContainerID;
+/**  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 declare function isContainer(value: any): value is Container;
+/**  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 declare 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";
+export declare function newContainerID(id: OpId, type: ContainerType): ContainerID;
+export declare function newRootContainerID(name: string, type: ContainerType): ContainerID;
+/**
+ * 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 declare class Awareness<T extends Value = Value> {
+    inner: AwarenessWasm<T>;
+    private peer;
+    private timer;
+    private timeout;
+    private listeners;
+    constructor(peer: PeerID, timeout?: number);
+    apply(bytes: Uint8Array, origin?: string): void;
+    setLocalState(state: T): void;
+    getLocalState(): T | undefined;
+    getAllStates(): Record<PeerID, T>;
+    encode(peers: PeerID[]): Uint8Array;
+    encodeAll(): Uint8Array;
+    addListener(listener: AwarenessListener): void;
+    removeListener(listener: AwarenessListener): void;
+    peers(): PeerID[];
+    destroy(): void;
+    private startTimerIfNotEmpty;
+}

package/web/index.js

@@ -0,0 +1,156 @@
+import { LoroDoc, AwarenessWasm } from "./loro_wasm";
+export * from "./loro_wasm";
+
+/**
+ * @deprecated Please use LoroDoc
+ */
+class Loro extends LoroDoc {
+}
+const CONTAINER_TYPES = [
+    "Map",
+    "Text",
+    "List",
+    "Tree",
+    "MovableList",
+    "Counter",
+];
+function isContainerId(s) {
+    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
+ * ```
+ */
+function isContainer(value) {
+    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"
+ * ```
+ */
+function getType(value) {
+    if (isContainer(value)) {
+        return value.kind();
+    }
+    return "Json";
+}
+function newContainerID(id, type) {
+    return `cid:${id.counter}@${id.peer}:${type}`;
+}
+function newRootContainerID(name, type) {
+    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.
+ */
+class Awareness {
+    constructor(peer, timeout = 30000) {
+        this.listeners = new Set();
+        this.inner = new AwarenessWasm(peer, timeout);
+        this.peer = peer;
+        this.timeout = timeout;
+    }
+    apply(bytes, origin = "remote") {
+        const { updated, added } = this.inner.apply(bytes);
+        this.listeners.forEach((listener) => {
+            listener({ updated, added, removed: [] }, origin);
+        });
+        this.startTimerIfNotEmpty();
+    }
+    setLocalState(state) {
+        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() {
+        return this.inner.getState(this.peer);
+    }
+    getAllStates() {
+        return this.inner.getAllStates();
+    }
+    encode(peers) {
+        return this.inner.encode(peers);
+    }
+    encodeAll() {
+        return this.inner.encodeAll();
+    }
+    addListener(listener) {
+        this.listeners.add(listener);
+    }
+    removeListener(listener) {
+        this.listeners.delete(listener);
+    }
+    peers() {
+        return this.inner.peers();
+    }
+    destroy() {
+        clearInterval(this.timer);
+        this.listeners.clear();
+    }
+    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);
+    }
+}
+
+export { Awareness, Loro, getType, isContainer, isContainerId, newContainerID, newRootContainerID };
+//# sourceMappingURL=index.js.map

package/web/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../ts/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAoBA;;AAEG;AACG,MAAO,IAAK,SAAQ,OAAO,CAAA;AAAI,CAAA;AAErC,MAAM,eAAe,GAAG;IACpB,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,aAAa;IACb,SAAS;CACZ,CAAC;AAEI,SAAU,aAAa,CAAC,CAAS,EAAA;AACnC,IAAA,OAAO,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;AAgBG;AACG,SAAU,WAAW,CAAC,KAAU,EAAA;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;AAC5C,QAAA,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACvC,IAAA,IAAI,CAAC,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,UAAU,EAAE;AACvE,QAAA,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAClD,CAAC;AAGD;;;;;;;;;;;;;;;;AAgBG;AACG,SAAU,OAAO,CACnB,KAAQ,EAAA;AAOR,IAAA,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;AACpB,QAAA,OAAO,KAAK,CAAC,IAAI,EAAoB,CAAC;KACzC;AAED,IAAA,OAAO,MAAa,CAAC;AACzB,CAAC;AAGe,SAAA,cAAc,CAAC,EAAQ,EAAE,IAAmB,EAAA;IACxD,OAAO,CAAA,IAAA,EAAO,EAAE,CAAC,OAAO,CAAA,CAAA,EAAI,EAAE,CAAC,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAC;AAClD,CAAC;AAEe,SAAA,kBAAkB,CAC9B,IAAY,EACZ,IAAmB,EAAA;AAEnB,IAAA,OAAO,CAAY,SAAA,EAAA,IAAI,CAAI,CAAA,EAAA,IAAI,EAAE,CAAC;AACtC,CAAC;AAID;;;;;AAKG;MACU,SAAS,CAAA;IAMlB,WAAY,CAAA,IAAY,EAAE,OAAA,GAAkB,KAAK,EAAA;AADzC,QAAA,IAAA,CAAA,SAAS,GAA2B,IAAI,GAAG,EAAE,CAAC;QAElD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC9C,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjB,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;KAC1B;AAED,IAAA,KAAK,CAAC,KAAiB,EAAE,MAAM,GAAG,QAAQ,EAAA;AACtC,QAAA,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAI;AAChC,YAAA,QAAQ,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;AACtD,SAAC,CAAC,CAAC;QAEH,IAAI,CAAC,oBAAoB,EAAE,CAAC;KAC/B;AAED,IAAA,aAAa,CAAC,KAAQ,EAAA;AAClB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACxD,QAAA,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAI;gBAChC,QAAQ,CACJ,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EACxD,OAAO,CACV,CAAC;AACN,aAAC,CAAC,CAAC;SACN;aAAM;YACH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAI;gBAChC,QAAQ,CACJ,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EACxD,OAAO,CACV,CAAC;AACN,aAAC,CAAC,CAAC;SACN;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;KAC/B;IAED,aAAa,GAAA;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACzC;IAED,YAAY,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;KACpC;AAED,IAAA,MAAM,CAAC,KAAe,EAAA;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KACnC;IAED,SAAS,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;KACjC;AAED,IAAA,WAAW,CAAC,QAA2B,EAAA;AACnC,QAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KAChC;AAED,IAAA,cAAc,CAAC,QAA2B,EAAA;AACtC,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;KACnC;IAED,KAAK,GAAA;AACD,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;KAC7B;IAED,OAAO,GAAA;AACH,QAAA,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1B,QAAA,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;KAC1B;IAEO,oBAAoB,GAAA;AACxB,QAAA,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YAC5C,OAAO;SACV;AAED,QAAA,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,MAAK;YAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;AAC5C,YAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAI;AAChC,oBAAA,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;AAC7D,iBAAC,CAAC,CAAC;aACN;AACD,YAAA,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE;AACtB,gBAAA,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1B,gBAAA,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;aAC1B;AACL,SAAC,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,CAAsB,CAAC;KAC7C;AACJ;;;;"}