loro-crdt 0.14.2 → 0.14.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.14.3
+
+### Patch Changes
+
+- a1fc2e3: Feat: Awareness (#318)
+- Updated dependencies [a1fc2e3]
+  - loro-wasm@0.14.3
+
 ## 0.14.2
 
 ### Patch Changes

package/deno/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "deno.enable": true
+}

package/deno/deno.json

@@ -0,0 +1,5 @@
+{
+  "name": "@loro/loro",
+  "version": "0.1.0",
+  "exports": "./mod.ts"
+}

package/deno/mod.ts

@@ -0,0 +1 @@
+export * from "npm:loro-crdt@0.14.2";

package/deno/test.ts

@@ -0,0 +1,13 @@
+import { Loro } from "./mod.ts";
+import { expect } from 'npm:expect'
+
+Deno.test("test", () => {
+  const doc = new Loro();
+  const text = doc.getText("text");
+  text.insert(0, "123")
+  expect(text.toString()).toEqual("123");
+  text.insert(0, "123")
+  expect(text.toString()).toEqual("123123");
+  const docB = Loro.fromSnapshot(doc.exportSnapshot());
+  expect(docB.getText('text').toString()).toEqual("123123");
+})

package/dist/loro.d.ts

@@ -1,7 +1,38 @@
-import { Container, ContainerID, TreeID, OpId, Delta, Value, LoroText, LoroMap, LoroTree, LoroList } from 'loro-wasm';
+import { AwarenessWasm, PeerID as PeerID$1, Container, ContainerID, TreeID, OpId, Delta, Value, LoroText, LoroMap, LoroTree, LoroList } from 'loro-wasm';
 export * from 'loro-wasm';
 export { Loro } from 'loro-wasm';
 
+type AwarenessListener = (arg: {
+    updated: PeerID$1[];
+    added: PeerID$1[];
+    removed: PeerID$1[];
+}, origin: "local" | "timeout" | "remote" | string) => void;
+/**
+ * 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.
+ */
+declare class Awareness<T> {
+    inner: AwarenessWasm<T>;
+    private peer;
+    private timer;
+    private timeout;
+    private listeners;
+    constructor(peer: PeerID$1, timeout?: number);
+    apply(bytes: Uint8Array, origin?: string): void;
+    setLocalState(state: T): void;
+    getLocalState(): T | undefined;
+    getAllStates(): Record<PeerID$1, T>;
+    encode(peers: PeerID$1[]): Uint8Array;
+    encodeAll(): Uint8Array;
+    addListener(listener: AwarenessListener): void;
+    removeListener(listener: AwarenessListener): void;
+    peers(): PeerID$1[];
+    destroy(): void;
+    private startTimerIfNotEmpty;
+}
+
 type Frontiers = OpId[];
 /**
  * Represents a path to identify the exact location of an event's target.
@@ -339,7 +370,14 @@ declare module "loro-wasm" {
         parent(): LoroTreeNode<T> | undefined;
         children(): Array<LoroTreeNode<T>>;
     }
+    interface AwarenessWasm<T = unknown> {
+        getState(peer: PeerID): T | undefined;
+        getTimestamp(peer: PeerID): number | undefined;
+        getAllStates(): Record<PeerID, T>;
+        setLocalState(value: T): void;
+        removeOutdated(): PeerID[];
+    }
 }
 type NonNullableType<T> = Exclude<T, null | undefined>;
 
-export { Diff, Frontiers, ListDiff, LoroEvent, LoroEventBatch, MapDiff, Path, TextDiff, TreeDiff, TreeDiffItem, getType, isContainer, isContainerId };
+export { Awareness, Diff, Frontiers, ListDiff, LoroEvent, LoroEventBatch, MapDiff, Path, TextDiff, TreeDiff, TreeDiffItem, getType, isContainer, isContainerId };

package/dist/loro.js

@@ -2,6 +2,88 @@
 
 var loroWasm = require('loro-wasm');
 
+class Awareness {
+  inner;
+  peer;
+  timer;
+  timeout;
+  listeners = /* @__PURE__ */ new Set();
+  constructor(peer, timeout = 3e4) {
+    this.inner = new loroWasm.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 = void 0;
+      }
+    }, this.timeout / 2);
+  }
+}
+
 const CONTAINER_TYPES = ["Map", "Text", "List", "Tree"];
 function isContainerId(s) {
   return s.startsWith("cid:");
@@ -27,6 +109,7 @@ Object.defineProperty(exports, 'Loro', {
   enumerable: true,
   get: function () { return loroWasm.Loro; }
 });
+exports.Awareness = Awareness;
 exports.getType = getType;
 exports.isContainer = isContainer;
 exports.isContainerId = isContainerId;

package/dist/loro.js.map

@@ -1 +1 @@
-{"version":3,"file":"loro.js","sources":["../src/index.ts"],"sourcesContent":["export * from \"loro-wasm\";\nimport {\n  Container,\n  ContainerID,\n  Delta,\n  Loro,\n  LoroList,\n  LoroMap,\n  LoroText,\n  LoroTree,\n  OpId,\n  TreeID,\n  Value,\n} from \"loro-wasm\";\n\nexport type Frontiers = OpId[];\n\n/**\n * Represents a path to identify the exact location of an event's target.\n * The path is composed of numbers (e.g., indices of a list container) strings\n * (e.g., keys of a map container) and TreeID (the node of a tree container),\n * indicating the absolute position of the event's source within a loro document.\n */\nexport type Path = (number | string | TreeID)[];\n\n/**\n * A batch of events that created by a single `import`/`transaction`/`checkout`.\n *\n * @prop by - How the event is triggered.\n * @prop origin - (Optional) Provides information about the origin of the event.\n * @prop diff - Contains the differential information related to the event.\n * @prop target - Identifies the container ID of the event's target.\n * @prop path - Specifies the absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n */\nexport interface LoroEventBatch {\n  /**\n   * How the event is triggered.\n   *\n   * - `local`: The event is triggered by a local transaction.\n   * - `import`: The event is triggered by an import operation.\n   * - `checkout`: The event is triggered by a checkout operation.\n   */\n  by: \"local\" | \"import\" | \"checkout\";\n  origin?: string;\n  /**\n   * The container ID of the current event receiver.\n   * It's undefined if the subscriber is on the root document.\n   */\n  currentTarget?: ContainerID;\n  events: LoroEvent[];\n}\n\n/**\n * The concrete event of Loro.\n */\nexport interface LoroEvent {\n  /**\n   * The container ID of the event's target.\n   */\n  target: ContainerID;\n  diff: Diff;\n  /**\n   * The absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n   */\n  path: Path;\n}\n\nexport type ListDiff = {\n  type: \"list\";\n  diff: Delta<(Value | Container)[]>[];\n};\n\nexport type TextDiff = {\n  type: \"text\";\n  diff: Delta<string>[];\n};\n\nexport type MapDiff = {\n  type: \"map\";\n  updated: Record<string, Value | Container | undefined>;\n};\n\nexport type TreeDiffItem =\n  | { target: TreeID; action: \"create\"; parent: TreeID | undefined }\n  | { target: TreeID; action: \"delete\" }\n  | { target: TreeID; action: \"move\"; parent: TreeID | undefined };\n\nexport type TreeDiff = {\n  type: \"tree\";\n  diff: TreeDiffItem[];\n};\n\nexport type Diff = ListDiff | TextDiff | MapDiff | TreeDiff;\n\ninterface Listener {\n  (event: LoroEventBatch): void;\n}\n\nconst CONTAINER_TYPES = [\"Map\", \"Text\", \"List\", \"Tree\"];\n\nexport function isContainerId(s: string): s is ContainerID {\n  return s.startsWith(\"cid:\");\n}\n\nexport { Loro };\n\n/**  Whether the value is a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * isContainer(map); // true\n * isContainer(list); // true\n * isContainer(text); // true\n * isContainer(123); // false\n * isContainer(\"123\"); // false\n * isContainer({}); // false\n */\nexport function isContainer(value: any): value is Container {\n  if (typeof value !== \"object\" || value == null) {\n    return false;\n  }\n\n  const p = Object.getPrototypeOf(value);\n  if (p == null || typeof p !== \"object\" || typeof p[\"kind\"] !== \"function\") {\n    return false;\n  }\n\n  return CONTAINER_TYPES.includes(value.kind());\n}\n\n/**  Get the type of a value that may be a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * getType(map); // \"Map\"\n * getType(list); // \"List\"\n * getType(text); // \"Text\"\n * getType(123); // \"Json\"\n * getType(\"123\"); // \"Json\"\n * getType({}); // \"Json\"\n * ```\n */\nexport function getType<T>(\n  value: T,\n): T extends LoroText ? \"Text\"\n  : T extends LoroMap<any> ? \"Map\"\n  : T extends LoroTree<any> ? \"Tree\"\n  : T extends LoroList<any> ? \"List\"\n  : \"Json\" {\n  if (isContainer(value)) {\n    return value.kind() as unknown as any;\n  }\n\n  return \"Json\" as any;\n}\n\ndeclare module \"loro-wasm\" {\n  interface Loro {\n    subscribe(listener: Listener): number;\n  }\n\n  interface Loro<\n    T extends Record<string, Container> = Record<string, Container>,\n  > {\n    /**\n     * Get a LoroMap by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const map = doc.getMap(\"map\");\n     * ```\n     */\n    getMap<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroMap ? T[Key] : LoroMap;\n    /**\n     * Get a LoroList by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const list = doc.getList(\"list\");\n     * ```\n     */\n    getList<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroList ? T[Key] : LoroList;\n    /**\n     * Get a LoroTree by container id\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const tree = doc.getTree(\"tree\");\n     *  ```\n     */\n    getTree<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroTree ? T[Key] : LoroTree;\n    getText(key: string | ContainerID): LoroText;\n  }\n\n  interface LoroList<T = unknown> {\n    new (): LoroList<T>;\n    /**\n     *  Get elements of the list. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  list.insertContainer(3, new LoroText());\n     *  console.log(list.value);  // [100, \"foo\", true, LoroText];\n     *  ```\n     */\n    toArray(): T[];\n    /**\n     * Insert a container at the index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  const text = list.insertContainer(1, new LoroText());\n     *  text.insert(0, \"Hello\");\n     *  console.log(list.getDeepValue());  // [100, \"Hello\"];\n     *  ```\n     */\n    insertContainer<C extends Container>(\n      pos: number,\n      child: C,\n    ): T extends C ? T : C;\n    /**\n     * Get the value at the index. If the value is a container, the corresponding handler will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  console.log(list.get(0));  // 100\n     *  console.log(list.get(1));  // undefined\n     *  ```\n     */\n    get(index: number): T;\n    /**\n     *  Insert a value at index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  console.log(list.value);  // [100, \"foo\", true];\n     *  ```\n     */\n    insert(pos: number, value: Exclude<T, Container>): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n    getAttached(): undefined | LoroList<T>;\n  }\n\n  interface LoroMap<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroMap<T>;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    getOrCreateContainer<C extends Container>(key: string, child: C): C;\n    /**\n     * Set the key with a container.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const text = map.setContainer(\"text\", new LoroText());\n     *  const list = map.setContainer(\"list\", new LoroText());\n     *  ```\n     */\n    setContainer<C extends Container, Key extends keyof T>(\n      key: Key,\n      child: C,\n    ): NonNullableType<T[Key]> extends C ? NonNullableType<T[Key]> : C;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object/value returned is a new js object/value each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    get<Key extends keyof T>(key: Key): T[Key];\n    /**\n     * Set the key with the value.\n     *\n     *  If the value of the key is exist, the old value will be updated.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  map.set(\"foo\", \"baz\");\n     *  ```\n     */\n    set<Key extends keyof T>(key: Key, value: Exclude<T[Key], Container>): void;\n    delete(key: string): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroText {\n    new (): LoroText;\n    insert(pos: number, text: string): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTree<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroTree<T>;\n    createNode(parent: TreeID | undefined): LoroTreeNode<T>;\n    move(target: TreeID, parent: TreeID | undefined): void;\n    delete(target: TreeID): void;\n    has(target: TreeID): boolean;\n    getNodeByID(target: TreeID): LoroTreeNode;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTreeNode<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    /**\n     * Get the associated metadata map container of a tree node.\n     */\n    readonly data: LoroMap<T>;\n    createNode(): LoroTreeNode<T>;\n    setAsRoot(): void;\n    moveTo(parent: LoroTreeNode<T>): void;\n    parent(): LoroTreeNode<T> | undefined;\n    children(): Array<LoroTreeNode<T>>;\n  }\n}\n\ntype NonNullableType<T> = Exclude<T, null | undefined>;\n"],"names":[],"mappings":";;;;AAkGA,MAAM,eAAkB,GAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAE/C,SAAS,cAAc,CAA6B,EAAA;AACzD,EAAO,OAAA,CAAA,CAAE,WAAW,MAAM,CAAA,CAAA;AAC5B,CAAA;AAoBO,SAAS,YAAY,KAAgC,EAAA;AAC1D,EAAA,IAAI,OAAO,KAAA,KAAU,QAAY,IAAA,KAAA,IAAS,IAAM,EAAA;AAC9C,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,CAAA,GAAI,MAAO,CAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACrC,EAAI,IAAA,CAAA,IAAK,QAAQ,OAAO,CAAA,KAAM,YAAY,OAAO,CAAA,CAAE,MAAM,CAAA,KAAM,UAAY,EAAA;AACzE,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,eAAgB,CAAA,QAAA,CAAS,KAAM,CAAA,IAAA,EAAM,CAAA,CAAA;AAC9C,CAAA;AAmBO,SAAS,QACd,KAKS,EAAA;AACT,EAAI,IAAA,WAAA,CAAY,KAAK,CAAG,EAAA;AACtB,IAAA,OAAO,MAAM,IAAK,EAAA,CAAA;AAAA,GACpB;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"loro.js","sources":["../src/awareness.ts","../src/index.ts"],"sourcesContent":["import { AwarenessWasm, PeerID } from \"loro-wasm\";\n\nexport type AwarenessListener = (\n  arg: { updated: PeerID[]; added: PeerID[]; removed: PeerID[] },\n  origin: \"local\" | \"timeout\" | \"remote\" | string,\n) => void;\n\n/**\n * Awareness is a structure that allows to track the ephemeral state of the peers.\n *\n * If we don't receive a state update from a peer within the timeout, we will remove their state.\n * The timeout is in milliseconds. This can be used to handle the off-line state of a peer.\n */\nexport class Awareness<T> {\n  inner: AwarenessWasm<T>;\n  private peer: PeerID;\n  private timer: number | undefined;\n  private timeout: number;\n  private listeners: Set<AwarenessListener> = new Set();\n  constructor(peer: PeerID, timeout: number = 30000) {\n    this.inner = new AwarenessWasm(peer, timeout);\n    this.peer = peer;\n    this.timeout = timeout;\n  }\n\n  apply(bytes: Uint8Array, origin = \"remote\") {\n    const { updated, added } = this.inner.apply(bytes);\n    this.listeners.forEach((listener) => {\n      listener({ updated, added, removed: [] }, origin);\n    });\n\n    this.startTimerIfNotEmpty();\n  }\n\n  setLocalState(state: T) {\n    const wasEmpty = this.inner.getState(this.peer) == null;\n    this.inner.setLocalState(state);\n    if (wasEmpty) {\n      this.listeners.forEach((listener) => {\n        listener(\n          { updated: [], added: [this.inner.peer()], removed: [] },\n          \"local\",\n        );\n      });\n    } else {\n      this.listeners.forEach((listener) => {\n        listener(\n          { updated: [this.inner.peer()], added: [], removed: [] },\n          \"local\",\n        );\n      });\n    }\n\n    this.startTimerIfNotEmpty();\n  }\n\n  getLocalState(): T | undefined {\n    return this.inner.getState(this.peer);\n  }\n\n  getAllStates(): Record<PeerID, T> {\n    return this.inner.getAllStates();\n  }\n\n  encode(peers: PeerID[]): Uint8Array {\n    return this.inner.encode(peers);\n  }\n\n  encodeAll(): Uint8Array {\n    return this.inner.encodeAll();\n  }\n\n  addListener(listener: AwarenessListener) {\n    this.listeners.add(listener);\n  }\n\n  removeListener(listener: AwarenessListener) {\n    this.listeners.delete(listener);\n  }\n\n  peers(): PeerID[] {\n    return this.inner.peers();\n  }\n\n  destroy() {\n    clearInterval(this.timer);\n    this.listeners.clear();\n  }\n\n  private startTimerIfNotEmpty() {\n    if (this.inner.isEmpty() || this.timer != null) {\n      return;\n    }\n\n    this.timer = setInterval(() => {\n      const removed = this.inner.removeOutdated();\n      if (removed.length > 0) {\n        this.listeners.forEach((listener) => {\n          listener({ updated: [], added: [], removed }, \"timeout\");\n        });\n      }\n      if (this.inner.isEmpty()) {\n        clearInterval(this.timer);\n        this.timer = undefined;\n      }\n    }, this.timeout / 2) as unknown as number;\n  }\n}\n","export * from \"loro-wasm\";\nimport {\n  Container,\n  ContainerID,\n  Delta,\n  Loro,\n  LoroList,\n  LoroMap,\n  LoroText,\n  LoroTree,\n  OpId,\n  TreeID,\n  Value,\n} from \"loro-wasm\";\nexport { Awareness } from \"./awareness\";\n\nexport type Frontiers = OpId[];\n\n/**\n * Represents a path to identify the exact location of an event's target.\n * The path is composed of numbers (e.g., indices of a list container) strings\n * (e.g., keys of a map container) and TreeID (the node of a tree container),\n * indicating the absolute position of the event's source within a loro document.\n */\nexport type Path = (number | string | TreeID)[];\n\n/**\n * A batch of events that created by a single `import`/`transaction`/`checkout`.\n *\n * @prop by - How the event is triggered.\n * @prop origin - (Optional) Provides information about the origin of the event.\n * @prop diff - Contains the differential information related to the event.\n * @prop target - Identifies the container ID of the event's target.\n * @prop path - Specifies the absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n */\nexport interface LoroEventBatch {\n  /**\n   * How the event is triggered.\n   *\n   * - `local`: The event is triggered by a local transaction.\n   * - `import`: The event is triggered by an import operation.\n   * - `checkout`: The event is triggered by a checkout operation.\n   */\n  by: \"local\" | \"import\" | \"checkout\";\n  origin?: string;\n  /**\n   * The container ID of the current event receiver.\n   * It's undefined if the subscriber is on the root document.\n   */\n  currentTarget?: ContainerID;\n  events: LoroEvent[];\n}\n\n/**\n * The concrete event of Loro.\n */\nexport interface LoroEvent {\n  /**\n   * The container ID of the event's target.\n   */\n  target: ContainerID;\n  diff: Diff;\n  /**\n   * The absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n   */\n  path: Path;\n}\n\nexport type ListDiff = {\n  type: \"list\";\n  diff: Delta<(Value | Container)[]>[];\n};\n\nexport type TextDiff = {\n  type: \"text\";\n  diff: Delta<string>[];\n};\n\nexport type MapDiff = {\n  type: \"map\";\n  updated: Record<string, Value | Container | undefined>;\n};\n\nexport type TreeDiffItem =\n  | { target: TreeID; action: \"create\"; parent: TreeID | undefined }\n  | { target: TreeID; action: \"delete\" }\n  | { target: TreeID; action: \"move\"; parent: TreeID | undefined };\n\nexport type TreeDiff = {\n  type: \"tree\";\n  diff: TreeDiffItem[];\n};\n\nexport type Diff = ListDiff | TextDiff | MapDiff | TreeDiff;\n\ninterface Listener {\n  (event: LoroEventBatch): void;\n}\n\nconst CONTAINER_TYPES = [\"Map\", \"Text\", \"List\", \"Tree\"];\n\nexport function isContainerId(s: string): s is ContainerID {\n  return s.startsWith(\"cid:\");\n}\n\nexport { Loro };\n\n/**  Whether the value is a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * isContainer(map); // true\n * isContainer(list); // true\n * isContainer(text); // true\n * isContainer(123); // false\n * isContainer(\"123\"); // false\n * isContainer({}); // false\n */\nexport function isContainer(value: any): value is Container {\n  if (typeof value !== \"object\" || value == null) {\n    return false;\n  }\n\n  const p = Object.getPrototypeOf(value);\n  if (p == null || typeof p !== \"object\" || typeof p[\"kind\"] !== \"function\") {\n    return false;\n  }\n\n  return CONTAINER_TYPES.includes(value.kind());\n}\n\n/**  Get the type of a value that may be a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * getType(map); // \"Map\"\n * getType(list); // \"List\"\n * getType(text); // \"Text\"\n * getType(123); // \"Json\"\n * getType(\"123\"); // \"Json\"\n * getType({}); // \"Json\"\n * ```\n */\nexport function getType<T>(\n  value: T,\n): T extends LoroText ? \"Text\"\n  : T extends LoroMap<any> ? \"Map\"\n  : T extends LoroTree<any> ? \"Tree\"\n  : T extends LoroList<any> ? \"List\"\n  : \"Json\" {\n  if (isContainer(value)) {\n    return value.kind() as unknown as any;\n  }\n\n  return \"Json\" as any;\n}\n\ndeclare module \"loro-wasm\" {\n  interface Loro {\n    subscribe(listener: Listener): number;\n  }\n\n  interface Loro<\n    T extends Record<string, Container> = Record<string, Container>,\n  > {\n    /**\n     * Get a LoroMap by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const map = doc.getMap(\"map\");\n     * ```\n     */\n    getMap<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroMap ? T[Key] : LoroMap;\n    /**\n     * Get a LoroList by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const list = doc.getList(\"list\");\n     * ```\n     */\n    getList<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroList ? T[Key] : LoroList;\n    /**\n     * Get a LoroTree by container id\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const tree = doc.getTree(\"tree\");\n     *  ```\n     */\n    getTree<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroTree ? T[Key] : LoroTree;\n    getText(key: string | ContainerID): LoroText;\n  }\n\n  interface LoroList<T = unknown> {\n    new (): LoroList<T>;\n    /**\n     *  Get elements of the list. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  list.insertContainer(3, new LoroText());\n     *  console.log(list.value);  // [100, \"foo\", true, LoroText];\n     *  ```\n     */\n    toArray(): T[];\n    /**\n     * Insert a container at the index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  const text = list.insertContainer(1, new LoroText());\n     *  text.insert(0, \"Hello\");\n     *  console.log(list.getDeepValue());  // [100, \"Hello\"];\n     *  ```\n     */\n    insertContainer<C extends Container>(\n      pos: number,\n      child: C,\n    ): T extends C ? T : C;\n    /**\n     * Get the value at the index. If the value is a container, the corresponding handler will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  console.log(list.get(0));  // 100\n     *  console.log(list.get(1));  // undefined\n     *  ```\n     */\n    get(index: number): T;\n    /**\n     *  Insert a value at index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  console.log(list.value);  // [100, \"foo\", true];\n     *  ```\n     */\n    insert(pos: number, value: Exclude<T, Container>): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n    getAttached(): undefined | LoroList<T>;\n  }\n\n  interface LoroMap<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroMap<T>;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    getOrCreateContainer<C extends Container>(key: string, child: C): C;\n    /**\n     * Set the key with a container.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const text = map.setContainer(\"text\", new LoroText());\n     *  const list = map.setContainer(\"list\", new LoroText());\n     *  ```\n     */\n    setContainer<C extends Container, Key extends keyof T>(\n      key: Key,\n      child: C,\n    ): NonNullableType<T[Key]> extends C ? NonNullableType<T[Key]> : C;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object/value returned is a new js object/value each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    get<Key extends keyof T>(key: Key): T[Key];\n    /**\n     * Set the key with the value.\n     *\n     *  If the value of the key is exist, the old value will be updated.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  map.set(\"foo\", \"baz\");\n     *  ```\n     */\n    set<Key extends keyof T>(key: Key, value: Exclude<T[Key], Container>): void;\n    delete(key: string): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroText {\n    new (): LoroText;\n    insert(pos: number, text: string): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTree<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroTree<T>;\n    createNode(parent: TreeID | undefined): LoroTreeNode<T>;\n    move(target: TreeID, parent: TreeID | undefined): void;\n    delete(target: TreeID): void;\n    has(target: TreeID): boolean;\n    getNodeByID(target: TreeID): LoroTreeNode;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTreeNode<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    /**\n     * Get the associated metadata map container of a tree node.\n     */\n    readonly data: LoroMap<T>;\n    createNode(): LoroTreeNode<T>;\n    setAsRoot(): void;\n    moveTo(parent: LoroTreeNode<T>): void;\n    parent(): LoroTreeNode<T> | undefined;\n    children(): Array<LoroTreeNode<T>>;\n  }\n\n  interface AwarenessWasm<\n    T = unknown,\n  > {\n    getState(peer: PeerID): T | undefined;\n    getTimestamp(peer: PeerID): number | undefined;\n    getAllStates(): Record<PeerID, T>;\n    setLocalState(value: T): void;\n    removeOutdated(): PeerID[];\n  }\n}\n\ntype NonNullableType<T> = Exclude<T, null | undefined>;\n"],"names":["AwarenessWasm"],"mappings":";;;;AAaO,MAAM,SAAa,CAAA;AAAA,EACxB,KAAA,CAAA;AAAA,EACQ,IAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EACA,SAAA,uBAAwC,GAAI,EAAA,CAAA;AAAA,EACpD,WAAA,CAAY,IAAc,EAAA,OAAA,GAAkB,GAAO,EAAA;AACjD,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAIA,sBAAc,CAAA,IAAA,EAAM,OAAO,CAAA,CAAA;AAC5C,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AACZ,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AAAA,EAEA,KAAA,CAAM,KAAmB,EAAA,MAAA,GAAS,QAAU,EAAA;AAC1C,IAAA,MAAM,EAAE,OAAS,EAAA,KAAA,KAAU,IAAK,CAAA,KAAA,CAAM,MAAM,KAAK,CAAA,CAAA;AACjD,IAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,MAAA,QAAA,CAAS,EAAE,OAAS,EAAA,KAAA,EAAO,SAAS,EAAC,IAAK,MAAM,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAED,IAAA,IAAA,CAAK,oBAAqB,EAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,cAAc,KAAU,EAAA;AACtB,IAAA,MAAM,WAAW,IAAK,CAAA,KAAA,CAAM,QAAS,CAAA,IAAA,CAAK,IAAI,CAAK,IAAA,IAAA,CAAA;AACnD,IAAK,IAAA,CAAA,KAAA,CAAM,cAAc,KAAK,CAAA,CAAA;AAC9B,IAAA,IAAI,QAAU,EAAA;AACZ,MAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,QAAA,QAAA;AAAA,UACE,EAAE,OAAA,EAAS,EAAC,EAAG,KAAO,EAAA,CAAC,IAAK,CAAA,KAAA,CAAM,IAAK,EAAC,CAAG,EAAA,OAAA,EAAS,EAAG,EAAA;AAAA,UACvD,OAAA;AAAA,SACF,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,QAAA,QAAA;AAAA,UACE,EAAE,OAAA,EAAS,CAAC,IAAA,CAAK,KAAM,CAAA,IAAA,EAAM,CAAA,EAAG,KAAO,EAAA,EAAI,EAAA,OAAA,EAAS,EAAG,EAAA;AAAA,UACvD,OAAA;AAAA,SACF,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,IAAA,CAAK,oBAAqB,EAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,aAA+B,GAAA;AAC7B,IAAA,OAAO,IAAK,CAAA,KAAA,CAAM,QAAS,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,YAAkC,GAAA;AAChC,IAAO,OAAA,IAAA,CAAK,MAAM,YAAa,EAAA,CAAA;AAAA,GACjC;AAAA,EAEA,OAAO,KAA6B,EAAA;AAClC,IAAO,OAAA,IAAA,CAAK,KAAM,CAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,GAChC;AAAA,EAEA,SAAwB,GAAA;AACtB,IAAO,OAAA,IAAA,CAAK,MAAM,SAAU,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,YAAY,QAA6B,EAAA;AACvC,IAAK,IAAA,CAAA,SAAA,CAAU,IAAI,QAAQ,CAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,eAAe,QAA6B,EAAA;AAC1C,IAAK,IAAA,CAAA,SAAA,CAAU,OAAO,QAAQ,CAAA,CAAA;AAAA,GAChC;AAAA,EAEA,KAAkB,GAAA;AAChB,IAAO,OAAA,IAAA,CAAK,MAAM,KAAM,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,OAAU,GAAA;AACR,IAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,UAAU,KAAM,EAAA,CAAA;AAAA,GACvB;AAAA,EAEQ,oBAAuB,GAAA;AAC7B,IAAA,IAAI,KAAK,KAAM,CAAA,OAAA,EAAa,IAAA,IAAA,CAAK,SAAS,IAAM,EAAA;AAC9C,MAAA,OAAA;AAAA,KACF;AAEA,IAAK,IAAA,CAAA,KAAA,GAAQ,YAAY,MAAM;AAC7B,MAAM,MAAA,OAAA,GAAU,IAAK,CAAA,KAAA,CAAM,cAAe,EAAA,CAAA;AAC1C,MAAI,IAAA,OAAA,CAAQ,SAAS,CAAG,EAAA;AACtB,QAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,UAAS,QAAA,CAAA,EAAE,SAAS,EAAC,EAAG,OAAO,EAAC,EAAG,OAAQ,EAAA,EAAG,SAAS,CAAA,CAAA;AAAA,SACxD,CAAA,CAAA;AAAA,OACH;AACA,MAAI,IAAA,IAAA,CAAK,KAAM,CAAA,OAAA,EAAW,EAAA;AACxB,QAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACxB,QAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA,CAAA;AAAA,OACf;AAAA,KACF,EAAG,IAAK,CAAA,OAAA,GAAU,CAAC,CAAA,CAAA;AAAA,GACrB;AACF;;ACRA,MAAM,eAAkB,GAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAE/C,SAAS,cAAc,CAA6B,EAAA;AACzD,EAAO,OAAA,CAAA,CAAE,WAAW,MAAM,CAAA,CAAA;AAC5B,CAAA;AAoBO,SAAS,YAAY,KAAgC,EAAA;AAC1D,EAAA,IAAI,OAAO,KAAA,KAAU,QAAY,IAAA,KAAA,IAAS,IAAM,EAAA;AAC9C,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,CAAA,GAAI,MAAO,CAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACrC,EAAI,IAAA,CAAA,IAAK,QAAQ,OAAO,CAAA,KAAM,YAAY,OAAO,CAAA,CAAE,MAAM,CAAA,KAAM,UAAY,EAAA;AACzE,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,eAAgB,CAAA,QAAA,CAAS,KAAM,CAAA,IAAA,EAAM,CAAA,CAAA;AAC9C,CAAA;AAmBO,SAAS,QACd,KAKS,EAAA;AACT,EAAI,IAAA,WAAA,CAAY,KAAK,CAAG,EAAA;AACtB,IAAA,OAAO,MAAM,IAAK,EAAA,CAAA;AAAA,GACpB;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;;;;;;;;;;;;;;"}

package/dist/loro.mjs

@@ -1,6 +1,89 @@
+import { AwarenessWasm } from 'loro-wasm';
 export * from 'loro-wasm';
 export { Loro } from 'loro-wasm';
 
+class Awareness {
+  inner;
+  peer;
+  timer;
+  timeout;
+  listeners = /* @__PURE__ */ new Set();
+  constructor(peer, timeout = 3e4) {
+    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 = void 0;
+      }
+    }, this.timeout / 2);
+  }
+}
+
 const CONTAINER_TYPES = ["Map", "Text", "List", "Tree"];
 function isContainerId(s) {
   return s.startsWith("cid:");
@@ -22,5 +105,5 @@ function getType(value) {
   return "Json";
 }
 
-export { getType, isContainer, isContainerId };
+export { Awareness, getType, isContainer, isContainerId };
 //# sourceMappingURL=loro.mjs.map

package/dist/loro.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"loro.mjs","sources":["../src/index.ts"],"sourcesContent":["export * from \"loro-wasm\";\nimport {\n  Container,\n  ContainerID,\n  Delta,\n  Loro,\n  LoroList,\n  LoroMap,\n  LoroText,\n  LoroTree,\n  OpId,\n  TreeID,\n  Value,\n} from \"loro-wasm\";\n\nexport type Frontiers = OpId[];\n\n/**\n * Represents a path to identify the exact location of an event's target.\n * The path is composed of numbers (e.g., indices of a list container) strings\n * (e.g., keys of a map container) and TreeID (the node of a tree container),\n * indicating the absolute position of the event's source within a loro document.\n */\nexport type Path = (number | string | TreeID)[];\n\n/**\n * A batch of events that created by a single `import`/`transaction`/`checkout`.\n *\n * @prop by - How the event is triggered.\n * @prop origin - (Optional) Provides information about the origin of the event.\n * @prop diff - Contains the differential information related to the event.\n * @prop target - Identifies the container ID of the event's target.\n * @prop path - Specifies the absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n */\nexport interface LoroEventBatch {\n  /**\n   * How the event is triggered.\n   *\n   * - `local`: The event is triggered by a local transaction.\n   * - `import`: The event is triggered by an import operation.\n   * - `checkout`: The event is triggered by a checkout operation.\n   */\n  by: \"local\" | \"import\" | \"checkout\";\n  origin?: string;\n  /**\n   * The container ID of the current event receiver.\n   * It's undefined if the subscriber is on the root document.\n   */\n  currentTarget?: ContainerID;\n  events: LoroEvent[];\n}\n\n/**\n * The concrete event of Loro.\n */\nexport interface LoroEvent {\n  /**\n   * The container ID of the event's target.\n   */\n  target: ContainerID;\n  diff: Diff;\n  /**\n   * The absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n   */\n  path: Path;\n}\n\nexport type ListDiff = {\n  type: \"list\";\n  diff: Delta<(Value | Container)[]>[];\n};\n\nexport type TextDiff = {\n  type: \"text\";\n  diff: Delta<string>[];\n};\n\nexport type MapDiff = {\n  type: \"map\";\n  updated: Record<string, Value | Container | undefined>;\n};\n\nexport type TreeDiffItem =\n  | { target: TreeID; action: \"create\"; parent: TreeID | undefined }\n  | { target: TreeID; action: \"delete\" }\n  | { target: TreeID; action: \"move\"; parent: TreeID | undefined };\n\nexport type TreeDiff = {\n  type: \"tree\";\n  diff: TreeDiffItem[];\n};\n\nexport type Diff = ListDiff | TextDiff | MapDiff | TreeDiff;\n\ninterface Listener {\n  (event: LoroEventBatch): void;\n}\n\nconst CONTAINER_TYPES = [\"Map\", \"Text\", \"List\", \"Tree\"];\n\nexport function isContainerId(s: string): s is ContainerID {\n  return s.startsWith(\"cid:\");\n}\n\nexport { Loro };\n\n/**  Whether the value is a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * isContainer(map); // true\n * isContainer(list); // true\n * isContainer(text); // true\n * isContainer(123); // false\n * isContainer(\"123\"); // false\n * isContainer({}); // false\n */\nexport function isContainer(value: any): value is Container {\n  if (typeof value !== \"object\" || value == null) {\n    return false;\n  }\n\n  const p = Object.getPrototypeOf(value);\n  if (p == null || typeof p !== \"object\" || typeof p[\"kind\"] !== \"function\") {\n    return false;\n  }\n\n  return CONTAINER_TYPES.includes(value.kind());\n}\n\n/**  Get the type of a value that may be a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * getType(map); // \"Map\"\n * getType(list); // \"List\"\n * getType(text); // \"Text\"\n * getType(123); // \"Json\"\n * getType(\"123\"); // \"Json\"\n * getType({}); // \"Json\"\n * ```\n */\nexport function getType<T>(\n  value: T,\n): T extends LoroText ? \"Text\"\n  : T extends LoroMap<any> ? \"Map\"\n  : T extends LoroTree<any> ? \"Tree\"\n  : T extends LoroList<any> ? \"List\"\n  : \"Json\" {\n  if (isContainer(value)) {\n    return value.kind() as unknown as any;\n  }\n\n  return \"Json\" as any;\n}\n\ndeclare module \"loro-wasm\" {\n  interface Loro {\n    subscribe(listener: Listener): number;\n  }\n\n  interface Loro<\n    T extends Record<string, Container> = Record<string, Container>,\n  > {\n    /**\n     * Get a LoroMap by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const map = doc.getMap(\"map\");\n     * ```\n     */\n    getMap<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroMap ? T[Key] : LoroMap;\n    /**\n     * Get a LoroList by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const list = doc.getList(\"list\");\n     * ```\n     */\n    getList<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroList ? T[Key] : LoroList;\n    /**\n     * Get a LoroTree by container id\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const tree = doc.getTree(\"tree\");\n     *  ```\n     */\n    getTree<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroTree ? T[Key] : LoroTree;\n    getText(key: string | ContainerID): LoroText;\n  }\n\n  interface LoroList<T = unknown> {\n    new (): LoroList<T>;\n    /**\n     *  Get elements of the list. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  list.insertContainer(3, new LoroText());\n     *  console.log(list.value);  // [100, \"foo\", true, LoroText];\n     *  ```\n     */\n    toArray(): T[];\n    /**\n     * Insert a container at the index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  const text = list.insertContainer(1, new LoroText());\n     *  text.insert(0, \"Hello\");\n     *  console.log(list.getDeepValue());  // [100, \"Hello\"];\n     *  ```\n     */\n    insertContainer<C extends Container>(\n      pos: number,\n      child: C,\n    ): T extends C ? T : C;\n    /**\n     * Get the value at the index. If the value is a container, the corresponding handler will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  console.log(list.get(0));  // 100\n     *  console.log(list.get(1));  // undefined\n     *  ```\n     */\n    get(index: number): T;\n    /**\n     *  Insert a value at index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  console.log(list.value);  // [100, \"foo\", true];\n     *  ```\n     */\n    insert(pos: number, value: Exclude<T, Container>): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n    getAttached(): undefined | LoroList<T>;\n  }\n\n  interface LoroMap<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroMap<T>;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    getOrCreateContainer<C extends Container>(key: string, child: C): C;\n    /**\n     * Set the key with a container.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const text = map.setContainer(\"text\", new LoroText());\n     *  const list = map.setContainer(\"list\", new LoroText());\n     *  ```\n     */\n    setContainer<C extends Container, Key extends keyof T>(\n      key: Key,\n      child: C,\n    ): NonNullableType<T[Key]> extends C ? NonNullableType<T[Key]> : C;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object/value returned is a new js object/value each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    get<Key extends keyof T>(key: Key): T[Key];\n    /**\n     * Set the key with the value.\n     *\n     *  If the value of the key is exist, the old value will be updated.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  map.set(\"foo\", \"baz\");\n     *  ```\n     */\n    set<Key extends keyof T>(key: Key, value: Exclude<T[Key], Container>): void;\n    delete(key: string): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroText {\n    new (): LoroText;\n    insert(pos: number, text: string): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTree<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroTree<T>;\n    createNode(parent: TreeID | undefined): LoroTreeNode<T>;\n    move(target: TreeID, parent: TreeID | undefined): void;\n    delete(target: TreeID): void;\n    has(target: TreeID): boolean;\n    getNodeByID(target: TreeID): LoroTreeNode;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTreeNode<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    /**\n     * Get the associated metadata map container of a tree node.\n     */\n    readonly data: LoroMap<T>;\n    createNode(): LoroTreeNode<T>;\n    setAsRoot(): void;\n    moveTo(parent: LoroTreeNode<T>): void;\n    parent(): LoroTreeNode<T> | undefined;\n    children(): Array<LoroTreeNode<T>>;\n  }\n}\n\ntype NonNullableType<T> = Exclude<T, null | undefined>;\n"],"names":[],"mappings":";;;AAkGA,MAAM,eAAkB,GAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAE/C,SAAS,cAAc,CAA6B,EAAA;AACzD,EAAO,OAAA,CAAA,CAAE,WAAW,MAAM,CAAA,CAAA;AAC5B,CAAA;AAoBO,SAAS,YAAY,KAAgC,EAAA;AAC1D,EAAA,IAAI,OAAO,KAAA,KAAU,QAAY,IAAA,KAAA,IAAS,IAAM,EAAA;AAC9C,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,CAAA,GAAI,MAAO,CAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACrC,EAAI,IAAA,CAAA,IAAK,QAAQ,OAAO,CAAA,KAAM,YAAY,OAAO,CAAA,CAAE,MAAM,CAAA,KAAM,UAAY,EAAA;AACzE,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,eAAgB,CAAA,QAAA,CAAS,KAAM,CAAA,IAAA,EAAM,CAAA,CAAA;AAC9C,CAAA;AAmBO,SAAS,QACd,KAKS,EAAA;AACT,EAAI,IAAA,WAAA,CAAY,KAAK,CAAG,EAAA;AACtB,IAAA,OAAO,MAAM,IAAK,EAAA,CAAA;AAAA,GACpB;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}
+{"version":3,"file":"loro.mjs","sources":["../src/awareness.ts","../src/index.ts"],"sourcesContent":["import { AwarenessWasm, PeerID } from \"loro-wasm\";\n\nexport type AwarenessListener = (\n  arg: { updated: PeerID[]; added: PeerID[]; removed: PeerID[] },\n  origin: \"local\" | \"timeout\" | \"remote\" | string,\n) => void;\n\n/**\n * Awareness is a structure that allows to track the ephemeral state of the peers.\n *\n * If we don't receive a state update from a peer within the timeout, we will remove their state.\n * The timeout is in milliseconds. This can be used to handle the off-line state of a peer.\n */\nexport class Awareness<T> {\n  inner: AwarenessWasm<T>;\n  private peer: PeerID;\n  private timer: number | undefined;\n  private timeout: number;\n  private listeners: Set<AwarenessListener> = new Set();\n  constructor(peer: PeerID, timeout: number = 30000) {\n    this.inner = new AwarenessWasm(peer, timeout);\n    this.peer = peer;\n    this.timeout = timeout;\n  }\n\n  apply(bytes: Uint8Array, origin = \"remote\") {\n    const { updated, added } = this.inner.apply(bytes);\n    this.listeners.forEach((listener) => {\n      listener({ updated, added, removed: [] }, origin);\n    });\n\n    this.startTimerIfNotEmpty();\n  }\n\n  setLocalState(state: T) {\n    const wasEmpty = this.inner.getState(this.peer) == null;\n    this.inner.setLocalState(state);\n    if (wasEmpty) {\n      this.listeners.forEach((listener) => {\n        listener(\n          { updated: [], added: [this.inner.peer()], removed: [] },\n          \"local\",\n        );\n      });\n    } else {\n      this.listeners.forEach((listener) => {\n        listener(\n          { updated: [this.inner.peer()], added: [], removed: [] },\n          \"local\",\n        );\n      });\n    }\n\n    this.startTimerIfNotEmpty();\n  }\n\n  getLocalState(): T | undefined {\n    return this.inner.getState(this.peer);\n  }\n\n  getAllStates(): Record<PeerID, T> {\n    return this.inner.getAllStates();\n  }\n\n  encode(peers: PeerID[]): Uint8Array {\n    return this.inner.encode(peers);\n  }\n\n  encodeAll(): Uint8Array {\n    return this.inner.encodeAll();\n  }\n\n  addListener(listener: AwarenessListener) {\n    this.listeners.add(listener);\n  }\n\n  removeListener(listener: AwarenessListener) {\n    this.listeners.delete(listener);\n  }\n\n  peers(): PeerID[] {\n    return this.inner.peers();\n  }\n\n  destroy() {\n    clearInterval(this.timer);\n    this.listeners.clear();\n  }\n\n  private startTimerIfNotEmpty() {\n    if (this.inner.isEmpty() || this.timer != null) {\n      return;\n    }\n\n    this.timer = setInterval(() => {\n      const removed = this.inner.removeOutdated();\n      if (removed.length > 0) {\n        this.listeners.forEach((listener) => {\n          listener({ updated: [], added: [], removed }, \"timeout\");\n        });\n      }\n      if (this.inner.isEmpty()) {\n        clearInterval(this.timer);\n        this.timer = undefined;\n      }\n    }, this.timeout / 2) as unknown as number;\n  }\n}\n","export * from \"loro-wasm\";\nimport {\n  Container,\n  ContainerID,\n  Delta,\n  Loro,\n  LoroList,\n  LoroMap,\n  LoroText,\n  LoroTree,\n  OpId,\n  TreeID,\n  Value,\n} from \"loro-wasm\";\nexport { Awareness } from \"./awareness\";\n\nexport type Frontiers = OpId[];\n\n/**\n * Represents a path to identify the exact location of an event's target.\n * The path is composed of numbers (e.g., indices of a list container) strings\n * (e.g., keys of a map container) and TreeID (the node of a tree container),\n * indicating the absolute position of the event's source within a loro document.\n */\nexport type Path = (number | string | TreeID)[];\n\n/**\n * A batch of events that created by a single `import`/`transaction`/`checkout`.\n *\n * @prop by - How the event is triggered.\n * @prop origin - (Optional) Provides information about the origin of the event.\n * @prop diff - Contains the differential information related to the event.\n * @prop target - Identifies the container ID of the event's target.\n * @prop path - Specifies the absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n */\nexport interface LoroEventBatch {\n  /**\n   * How the event is triggered.\n   *\n   * - `local`: The event is triggered by a local transaction.\n   * - `import`: The event is triggered by an import operation.\n   * - `checkout`: The event is triggered by a checkout operation.\n   */\n  by: \"local\" | \"import\" | \"checkout\";\n  origin?: string;\n  /**\n   * The container ID of the current event receiver.\n   * It's undefined if the subscriber is on the root document.\n   */\n  currentTarget?: ContainerID;\n  events: LoroEvent[];\n}\n\n/**\n * The concrete event of Loro.\n */\nexport interface LoroEvent {\n  /**\n   * The container ID of the event's target.\n   */\n  target: ContainerID;\n  diff: Diff;\n  /**\n   * The absolute path of the event's emitter, which can be an index of a list container or a key of a map container.\n   */\n  path: Path;\n}\n\nexport type ListDiff = {\n  type: \"list\";\n  diff: Delta<(Value | Container)[]>[];\n};\n\nexport type TextDiff = {\n  type: \"text\";\n  diff: Delta<string>[];\n};\n\nexport type MapDiff = {\n  type: \"map\";\n  updated: Record<string, Value | Container | undefined>;\n};\n\nexport type TreeDiffItem =\n  | { target: TreeID; action: \"create\"; parent: TreeID | undefined }\n  | { target: TreeID; action: \"delete\" }\n  | { target: TreeID; action: \"move\"; parent: TreeID | undefined };\n\nexport type TreeDiff = {\n  type: \"tree\";\n  diff: TreeDiffItem[];\n};\n\nexport type Diff = ListDiff | TextDiff | MapDiff | TreeDiff;\n\ninterface Listener {\n  (event: LoroEventBatch): void;\n}\n\nconst CONTAINER_TYPES = [\"Map\", \"Text\", \"List\", \"Tree\"];\n\nexport function isContainerId(s: string): s is ContainerID {\n  return s.startsWith(\"cid:\");\n}\n\nexport { Loro };\n\n/**  Whether the value is a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * isContainer(map); // true\n * isContainer(list); // true\n * isContainer(text); // true\n * isContainer(123); // false\n * isContainer(\"123\"); // false\n * isContainer({}); // false\n */\nexport function isContainer(value: any): value is Container {\n  if (typeof value !== \"object\" || value == null) {\n    return false;\n  }\n\n  const p = Object.getPrototypeOf(value);\n  if (p == null || typeof p !== \"object\" || typeof p[\"kind\"] !== \"function\") {\n    return false;\n  }\n\n  return CONTAINER_TYPES.includes(value.kind());\n}\n\n/**  Get the type of a value that may be a container.\n *\n * # Example\n *\n * ```ts\n * const doc = new Loro();\n * const map = doc.getMap(\"map\");\n * const list = doc.getList(\"list\");\n * const text = doc.getText(\"text\");\n * getType(map); // \"Map\"\n * getType(list); // \"List\"\n * getType(text); // \"Text\"\n * getType(123); // \"Json\"\n * getType(\"123\"); // \"Json\"\n * getType({}); // \"Json\"\n * ```\n */\nexport function getType<T>(\n  value: T,\n): T extends LoroText ? \"Text\"\n  : T extends LoroMap<any> ? \"Map\"\n  : T extends LoroTree<any> ? \"Tree\"\n  : T extends LoroList<any> ? \"List\"\n  : \"Json\" {\n  if (isContainer(value)) {\n    return value.kind() as unknown as any;\n  }\n\n  return \"Json\" as any;\n}\n\ndeclare module \"loro-wasm\" {\n  interface Loro {\n    subscribe(listener: Listener): number;\n  }\n\n  interface Loro<\n    T extends Record<string, Container> = Record<string, Container>,\n  > {\n    /**\n     * Get a LoroMap by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const map = doc.getMap(\"map\");\n     * ```\n     */\n    getMap<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroMap ? T[Key] : LoroMap;\n    /**\n     * Get a LoroList by container id\n     *\n     * The object returned is a new js object each time because it need to cross\n     * the WASM boundary.\n     *\n     * @example\n     * ```ts\n     * import { Loro } from \"loro-crdt\";\n     *\n     * const doc = new Loro();\n     * const list = doc.getList(\"list\");\n     * ```\n     */\n    getList<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroList ? T[Key] : LoroList;\n    /**\n     * Get a LoroTree by container id\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const tree = doc.getTree(\"tree\");\n     *  ```\n     */\n    getTree<Key extends keyof T>(\n      name: Key,\n    ): T[Key] extends LoroTree ? T[Key] : LoroTree;\n    getText(key: string | ContainerID): LoroText;\n  }\n\n  interface LoroList<T = unknown> {\n    new (): LoroList<T>;\n    /**\n     *  Get elements of the list. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  list.insertContainer(3, new LoroText());\n     *  console.log(list.value);  // [100, \"foo\", true, LoroText];\n     *  ```\n     */\n    toArray(): T[];\n    /**\n     * Insert a container at the index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  const text = list.insertContainer(1, new LoroText());\n     *  text.insert(0, \"Hello\");\n     *  console.log(list.getDeepValue());  // [100, \"Hello\"];\n     *  ```\n     */\n    insertContainer<C extends Container>(\n      pos: number,\n      child: C,\n    ): T extends C ? T : C;\n    /**\n     * Get the value at the index. If the value is a container, the corresponding handler will be returned.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  console.log(list.get(0));  // 100\n     *  console.log(list.get(1));  // undefined\n     *  ```\n     */\n    get(index: number): T;\n    /**\n     *  Insert a value at index.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const list = doc.getList(\"list\");\n     *  list.insert(0, 100);\n     *  list.insert(1, \"foo\");\n     *  list.insert(2, true);\n     *  console.log(list.value);  // [100, \"foo\", true];\n     *  ```\n     */\n    insert(pos: number, value: Exclude<T, Container>): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n    getAttached(): undefined | LoroList<T>;\n  }\n\n  interface LoroMap<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroMap<T>;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object returned is a new js object each time because it need to cross\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    getOrCreateContainer<C extends Container>(key: string, child: C): C;\n    /**\n     * Set the key with a container.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const text = map.setContainer(\"text\", new LoroText());\n     *  const list = map.setContainer(\"list\", new LoroText());\n     *  ```\n     */\n    setContainer<C extends Container, Key extends keyof T>(\n      key: Key,\n      child: C,\n    ): NonNullableType<T[Key]> extends C ? NonNullableType<T[Key]> : C;\n    /**\n     *  Get the value of the key. If the value is a child container, the corresponding\n     *  `Container` will be returned.\n     *\n     *  The object/value returned is a new js object/value each time because it need to cross\n     *  the WASM boundary.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  const bar = map.get(\"foo\");\n     *  ```\n     */\n    get<Key extends keyof T>(key: Key): T[Key];\n    /**\n     * Set the key with the value.\n     *\n     *  If the value of the key is exist, the old value will be updated.\n     *\n     *  @example\n     *  ```ts\n     *  import { Loro } from \"loro-crdt\";\n     *\n     *  const doc = new Loro();\n     *  const map = doc.getMap(\"map\");\n     *  map.set(\"foo\", \"bar\");\n     *  map.set(\"foo\", \"baz\");\n     *  ```\n     */\n    set<Key extends keyof T>(key: Key, value: Exclude<T[Key], Container>): void;\n    delete(key: string): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroText {\n    new (): LoroText;\n    insert(pos: number, text: string): void;\n    delete(pos: number, len: number): void;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTree<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    new (): LoroTree<T>;\n    createNode(parent: TreeID | undefined): LoroTreeNode<T>;\n    move(target: TreeID, parent: TreeID | undefined): void;\n    delete(target: TreeID): void;\n    has(target: TreeID): boolean;\n    getNodeByID(target: TreeID): LoroTreeNode;\n    subscribe(txn: Loro, listener: Listener): number;\n  }\n\n  interface LoroTreeNode<\n    T extends Record<string, unknown> = Record<string, unknown>,\n  > {\n    /**\n     * Get the associated metadata map container of a tree node.\n     */\n    readonly data: LoroMap<T>;\n    createNode(): LoroTreeNode<T>;\n    setAsRoot(): void;\n    moveTo(parent: LoroTreeNode<T>): void;\n    parent(): LoroTreeNode<T> | undefined;\n    children(): Array<LoroTreeNode<T>>;\n  }\n\n  interface AwarenessWasm<\n    T = unknown,\n  > {\n    getState(peer: PeerID): T | undefined;\n    getTimestamp(peer: PeerID): number | undefined;\n    getAllStates(): Record<PeerID, T>;\n    setLocalState(value: T): void;\n    removeOutdated(): PeerID[];\n  }\n}\n\ntype NonNullableType<T> = Exclude<T, null | undefined>;\n"],"names":[],"mappings":";;;;AAaO,MAAM,SAAa,CAAA;AAAA,EACxB,KAAA,CAAA;AAAA,EACQ,IAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EACA,SAAA,uBAAwC,GAAI,EAAA,CAAA;AAAA,EACpD,WAAA,CAAY,IAAc,EAAA,OAAA,GAAkB,GAAO,EAAA;AACjD,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAI,aAAc,CAAA,IAAA,EAAM,OAAO,CAAA,CAAA;AAC5C,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AACZ,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AAAA,EAEA,KAAA,CAAM,KAAmB,EAAA,MAAA,GAAS,QAAU,EAAA;AAC1C,IAAA,MAAM,EAAE,OAAS,EAAA,KAAA,KAAU,IAAK,CAAA,KAAA,CAAM,MAAM,KAAK,CAAA,CAAA;AACjD,IAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,MAAA,QAAA,CAAS,EAAE,OAAS,EAAA,KAAA,EAAO,SAAS,EAAC,IAAK,MAAM,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAED,IAAA,IAAA,CAAK,oBAAqB,EAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,cAAc,KAAU,EAAA;AACtB,IAAA,MAAM,WAAW,IAAK,CAAA,KAAA,CAAM,QAAS,CAAA,IAAA,CAAK,IAAI,CAAK,IAAA,IAAA,CAAA;AACnD,IAAK,IAAA,CAAA,KAAA,CAAM,cAAc,KAAK,CAAA,CAAA;AAC9B,IAAA,IAAI,QAAU,EAAA;AACZ,MAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,QAAA,QAAA;AAAA,UACE,EAAE,OAAA,EAAS,EAAC,EAAG,KAAO,EAAA,CAAC,IAAK,CAAA,KAAA,CAAM,IAAK,EAAC,CAAG,EAAA,OAAA,EAAS,EAAG,EAAA;AAAA,UACvD,OAAA;AAAA,SACF,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,QAAA,QAAA;AAAA,UACE,EAAE,OAAA,EAAS,CAAC,IAAA,CAAK,KAAM,CAAA,IAAA,EAAM,CAAA,EAAG,KAAO,EAAA,EAAI,EAAA,OAAA,EAAS,EAAG,EAAA;AAAA,UACvD,OAAA;AAAA,SACF,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,IAAA,CAAK,oBAAqB,EAAA,CAAA;AAAA,GAC5B;AAAA,EAEA,aAA+B,GAAA;AAC7B,IAAA,OAAO,IAAK,CAAA,KAAA,CAAM,QAAS,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,YAAkC,GAAA;AAChC,IAAO,OAAA,IAAA,CAAK,MAAM,YAAa,EAAA,CAAA;AAAA,GACjC;AAAA,EAEA,OAAO,KAA6B,EAAA;AAClC,IAAO,OAAA,IAAA,CAAK,KAAM,CAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,GAChC;AAAA,EAEA,SAAwB,GAAA;AACtB,IAAO,OAAA,IAAA,CAAK,MAAM,SAAU,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,YAAY,QAA6B,EAAA;AACvC,IAAK,IAAA,CAAA,SAAA,CAAU,IAAI,QAAQ,CAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,eAAe,QAA6B,EAAA;AAC1C,IAAK,IAAA,CAAA,SAAA,CAAU,OAAO,QAAQ,CAAA,CAAA;AAAA,GAChC;AAAA,EAEA,KAAkB,GAAA;AAChB,IAAO,OAAA,IAAA,CAAK,MAAM,KAAM,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,OAAU,GAAA;AACR,IAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,UAAU,KAAM,EAAA,CAAA;AAAA,GACvB;AAAA,EAEQ,oBAAuB,GAAA;AAC7B,IAAA,IAAI,KAAK,KAAM,CAAA,OAAA,EAAa,IAAA,IAAA,CAAK,SAAS,IAAM,EAAA;AAC9C,MAAA,OAAA;AAAA,KACF;AAEA,IAAK,IAAA,CAAA,KAAA,GAAQ,YAAY,MAAM;AAC7B,MAAM,MAAA,OAAA,GAAU,IAAK,CAAA,KAAA,CAAM,cAAe,EAAA,CAAA;AAC1C,MAAI,IAAA,OAAA,CAAQ,SAAS,CAAG,EAAA;AACtB,QAAK,IAAA,CAAA,SAAA,CAAU,OAAQ,CAAA,CAAC,QAAa,KAAA;AACnC,UAAS,QAAA,CAAA,EAAE,SAAS,EAAC,EAAG,OAAO,EAAC,EAAG,OAAQ,EAAA,EAAG,SAAS,CAAA,CAAA;AAAA,SACxD,CAAA,CAAA;AAAA,OACH;AACA,MAAI,IAAA,IAAA,CAAK,KAAM,CAAA,OAAA,EAAW,EAAA;AACxB,QAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACxB,QAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA,CAAA;AAAA,OACf;AAAA,KACF,EAAG,IAAK,CAAA,OAAA,GAAU,CAAC,CAAA,CAAA;AAAA,GACrB;AACF;;ACRA,MAAM,eAAkB,GAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAE/C,SAAS,cAAc,CAA6B,EAAA;AACzD,EAAO,OAAA,CAAA,CAAE,WAAW,MAAM,CAAA,CAAA;AAC5B,CAAA;AAoBO,SAAS,YAAY,KAAgC,EAAA;AAC1D,EAAA,IAAI,OAAO,KAAA,KAAU,QAAY,IAAA,KAAA,IAAS,IAAM,EAAA;AAC9C,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,CAAA,GAAI,MAAO,CAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACrC,EAAI,IAAA,CAAA,IAAK,QAAQ,OAAO,CAAA,KAAM,YAAY,OAAO,CAAA,CAAE,MAAM,CAAA,KAAM,UAAY,EAAA;AACzE,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,eAAgB,CAAA,QAAA,CAAS,KAAM,CAAA,IAAA,EAAM,CAAA,CAAA;AAC9C,CAAA;AAmBO,SAAS,QACd,KAKS,EAAA;AACT,EAAI,IAAA,WAAA,CAAY,KAAK,CAAG,EAAA;AACtB,IAAA,OAAO,MAAM,IAAK,EAAA,CAAA;AAAA,GACpB;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loro-crdt",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
   "keywords": [
     "crdt",
@@ -17,7 +17,7 @@
   "homepage": "https://loro.dev",
   "license": "MIT",
   "dependencies": {
-    "loro-wasm": "0.14.2"
+    "loro-wasm": "0.14.3"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^15.0.1",

package/src/awareness.ts

@@ -0,0 +1,108 @@
+import { AwarenessWasm, PeerID } from "loro-wasm";
+
+export type AwarenessListener = (
+  arg: { updated: PeerID[]; added: PeerID[]; removed: PeerID[] },
+  origin: "local" | "timeout" | "remote" | string,
+) => void;
+
+/**
+ * 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> {
+  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;
+  }
+}

package/src/index.ts

@@ -12,6 +12,7 @@ import {
   TreeID,
   Value,
 } from "loro-wasm";
+export { Awareness } from "./awareness";
 
 export type Frontiers = OpId[];
 
@@ -410,6 +411,16 @@ declare module "loro-wasm" {
     parent(): LoroTreeNode<T> | undefined;
     children(): Array<LoroTreeNode<T>>;
   }
+
+  interface AwarenessWasm<
+    T = unknown,
+  > {
+    getState(peer: PeerID): T | undefined;
+    getTimestamp(peer: PeerID): number | undefined;
+    getAllStates(): Record<PeerID, T>;
+    setLocalState(value: T): void;
+    removeOutdated(): PeerID[];
+  }
 }
 
 type NonNullableType<T> = Exclude<T, null | undefined>;

package/tsconfig.json

@@ -97,5 +97,10 @@
     /* Completeness */
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
     "skipLibCheck": true /* Skip type checking all .d.ts files. */
-  }
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "deno"
+  ]
 }

package/vite.config.ts

@@ -1,10 +1,12 @@
-/// <reference types="vitest" />
+import { configDefaults, defineConfig } from 'vitest/config'
 import wasm from "vite-plugin-wasm";
-import { defineConfig } from "vite";
 
 export default defineConfig({
   plugins: [wasm()],
-  // test: {
-  //   reporters:['hanging-process']
-  // },
+  test: {
+    exclude: [
+      ...configDefaults.exclude,
+      "deno/*"
+    ]
+  },
 });