cojson 0.8.12 → 0.8.17

package/src/coValues/coMap.ts

@@ -1,327 +1,325 @@
-import { JsonObject, JsonValue } from "../jsonValue.js";
-import { AgentID, TransactionID } from "../ids.js";
 import { CoID, RawCoValue } from "../coValue.js";
-import { isCoValue } from "../typeUtils/isCoValue.js";
 import { CoValueCore } from "../coValueCore.js";
+import { AgentID, TransactionID } from "../ids.js";
+import { JsonObject, JsonValue } from "../jsonValue.js";
 import { accountOrAgentIDfromSessionID } from "../typeUtils/accountOrAgentIDfromSessionID.js";
+import { isCoValue } from "../typeUtils/isCoValue.js";
 import { RawAccountID } from "./account.js";
 import type { RawGroup } from "./group.js";
 
 type MapOp<K extends string, V extends JsonValue | undefined> = {
-    txID: TransactionID;
-    madeAt: number;
-    changeIdx: number;
+  txID: TransactionID;
+  madeAt: number;
+  changeIdx: number;
 } & MapOpPayload<K, V>;
 // TODO: add after TransactionID[] for conflicts/ordering
 
 export type MapOpPayload<K extends string, V extends JsonValue | undefined> =
-    | {
-          op: "set";
-          key: K;
-          value: V;
-      }
-    | {
-          op: "del";
-          key: K;
-      };
+  | {
+      op: "set";
+      key: K;
+      value: V;
+    }
+  | {
+      op: "del";
+      key: K;
+    };
 
 export class RawCoMapView<
-    Shape extends { [key: string]: JsonValue | undefined } = {
-        [key: string]: JsonValue | undefined;
-    },
-    Meta extends JsonObject | null = JsonObject | null,
+  Shape extends { [key: string]: JsonValue | undefined } = {
+    [key: string]: JsonValue | undefined;
+  },
+  Meta extends JsonObject | null = JsonObject | null,
 > implements RawCoValue
 {
-    /** @category 6. Meta */
-    id: CoID<this>;
-    /** @category 6. Meta */
-    type = "comap" as const;
-    /** @category 6. Meta */
-    core: CoValueCore;
-    /** @internal */
-    ops: {
-        [Key in keyof Shape & string]?: MapOp<Key, Shape[Key]>[];
-    };
-    /** @internal */
-    atTimeFilter?: number = undefined;
-    /** @category 6. Meta */
-    readonly _shape!: Shape;
-
-    /** @internal */
-    constructor(
-        core: CoValueCore,
-        options?: { ignorePrivateTransactions: true },
-    ) {
-        this.id = core.id as CoID<this>;
-        this.core = core;
-        this.ops = {};
-
-        for (const { txID, changes, madeAt } of core.getValidSortedTransactions(
-            options,
-        )) {
-            for (const [changeIdx, changeUntyped] of changes.entries()) {
-                const change = changeUntyped as MapOpPayload<
-                    keyof Shape & string,
-                    Shape[keyof Shape & string]
-                >;
-                let entries = this.ops[change.key];
-                if (!entries) {
-                    entries = [];
-                    this.ops[change.key] = entries;
-                }
-                entries.push({
-                    txID,
-                    madeAt,
-                    changeIdx,
-                    ...(change as MapOpPayload<
-                        keyof Shape & string,
-                        Shape[keyof Shape & string]
-                    >),
-                });
-            }
+  /** @category 6. Meta */
+  id: CoID<this>;
+  /** @category 6. Meta */
+  type = "comap" as const;
+  /** @category 6. Meta */
+  core: CoValueCore;
+  /** @internal */
+  ops: {
+    [Key in keyof Shape & string]?: MapOp<Key, Shape[Key]>[];
+  };
+  /** @internal */
+  atTimeFilter?: number = undefined;
+  /** @category 6. Meta */
+  readonly _shape!: Shape;
+
+  /** @internal */
+  constructor(
+    core: CoValueCore,
+    options?: { ignorePrivateTransactions: true },
+  ) {
+    this.id = core.id as CoID<this>;
+    this.core = core;
+    this.ops = {};
+
+    for (const { txID, changes, madeAt } of core.getValidSortedTransactions(
+      options,
+    )) {
+      for (const [changeIdx, changeUntyped] of changes.entries()) {
+        const change = changeUntyped as MapOpPayload<
+          keyof Shape & string,
+          Shape[keyof Shape & string]
+        >;
+        let entries = this.ops[change.key];
+        if (!entries) {
+          entries = [];
+          this.ops[change.key] = entries;
         }
+        entries.push({
+          txID,
+          madeAt,
+          changeIdx,
+          ...(change as MapOpPayload<
+            keyof Shape & string,
+            Shape[keyof Shape & string]
+          >),
+        });
+      }
     }
-
-    /** @category 6. Meta */
-    get headerMeta(): Meta {
-        return this.core.header.meta as Meta;
-    }
-
-    /** @category 6. Meta */
-    get group(): RawGroup {
-        return this.core.getGroup();
+  }
+
+  /** @category 6. Meta */
+  get headerMeta(): Meta {
+    return this.core.header.meta as Meta;
+  }
+
+  /** @category 6. Meta */
+  get group(): RawGroup {
+    return this.core.getGroup();
+  }
+
+  /** @category 4. Time travel */
+  atTime(time: number): this {
+    const clone = Object.create(this) as this;
+    clone.id = this.id;
+    clone.type = this.type;
+    clone.core = this.core;
+    clone.ops = this.ops;
+    clone.atTimeFilter = time;
+    return clone;
+  }
+
+  /** @internal */
+  timeFilteredOps<K extends keyof Shape & string>(
+    key: K,
+  ): MapOp<K, Shape[K]>[] | undefined {
+    if (this.atTimeFilter) {
+      return this.ops[key]?.filter((op) => op.madeAt <= this.atTimeFilter!);
+    } else {
+      return this.ops[key];
     }
+  }
+
+  /**
+   * Get all keys currently in the map.
+   *
+   * @category 1. Reading */
+  keys<K extends keyof Shape & string = keyof Shape & string>(): K[] {
+    return (Object.keys(this.ops) as K[]).filter((key) => {
+      const ops = this.ops[key];
+      if (!ops) {
+        return undefined;
+      }
 
-    /** @category 4. Time travel */
-    atTime(time: number): this {
-        const clone = Object.create(this) as this;
-        clone.id = this.id;
-        clone.type = this.type;
-        clone.core = this.core;
-        clone.ops = this.ops;
-        clone.atTimeFilter = time;
-        return clone;
-    }
+      const includeUntil = this.atTimeFilter;
+      const lastEntry = includeUntil
+        ? ops.findLast((entry) => entry.madeAt <= includeUntil)
+        : ops[ops.length - 1]!;
 
-    /** @internal */
-    timeFilteredOps<K extends keyof Shape & string>(
-        key: K,
-    ): MapOp<K, Shape[K]>[] | undefined {
-        if (this.atTimeFilter) {
-            return this.ops[key]?.filter(
-                (op) => op.madeAt <= this.atTimeFilter!,
-            );
-        } else {
-            return this.ops[key];
-        }
+      if (lastEntry?.op === "del") {
+        return false;
+      } else {
+        return true;
+      }
+    });
+  }
+
+  /**
+   * Returns the current value for the given key.
+   *
+   * @category 1. Reading
+   **/
+  get<K extends keyof Shape & string>(key: K): Shape[K] | undefined {
+    const ops = this.ops[key];
+    if (!ops) {
+      return undefined;
     }
 
-    /**
-     * Get all keys currently in the map.
-     *
-     * @category 1. Reading */
-    keys<K extends keyof Shape & string = keyof Shape & string>(): K[] {
-        return (Object.keys(this.ops) as K[]).filter((key) => {
-            const ops = this.ops[key];
-            if (!ops) {
-                return undefined;
-            }
-
-            const includeUntil = this.atTimeFilter;
-            const lastEntry = includeUntil
-                ? ops.findLast((entry) => entry.madeAt <= includeUntil)
-                : ops[ops.length - 1]!;
-
-            if (lastEntry?.op === "del") {
-                return false;
-            } else {
-                return true;
-            }
-        });
-    }
+    const includeUntil = this.atTimeFilter;
+    const lastEntry = includeUntil
+      ? ops.findLast((entry) => entry.madeAt <= includeUntil)
+      : ops[ops.length - 1]!;
 
-    /**
-     * Returns the current value for the given key.
-     *
-     * @category 1. Reading
-     **/
-    get<K extends keyof Shape & string>(key: K): Shape[K] | undefined {
-        const ops = this.ops[key];
-        if (!ops) {
-            return undefined;
-        }
-
-        const includeUntil = this.atTimeFilter;
-        const lastEntry = includeUntil
-            ? ops.findLast((entry) => entry.madeAt <= includeUntil)
-            : ops[ops.length - 1]!;
-
-        if (lastEntry?.op === "del") {
-            return undefined;
-        } else {
-            return lastEntry?.value;
-        }
+    if (lastEntry?.op === "del") {
+      return undefined;
+    } else {
+      return lastEntry?.value;
     }
-
-    /** @category 1. Reading */
-    asObject(): {
-        [K in keyof Shape & string]: Shape[K];
-    } {
-        const object: Partial<{
-            [K in keyof Shape & string]: Shape[K];
-        }> = {};
-
-        for (const key of this.keys()) {
-            const value = this.get(key);
-            if (value !== undefined) {
-                object[key] = value;
-            }
-        }
-
-        return object as {
-            [K in keyof Shape & string]: Shape[K];
-        };
+  }
+
+  /** @category 1. Reading */
+  asObject(): {
+    [K in keyof Shape & string]: Shape[K];
+  } {
+    const object: Partial<{
+      [K in keyof Shape & string]: Shape[K];
+    }> = {};
+
+    for (const key of this.keys()) {
+      const value = this.get(key);
+      if (value !== undefined) {
+        object[key] = value;
+      }
     }
 
-    /** @category 1. Reading */
-    toJSON(): {
-        [K in keyof Shape & string]: Shape[K];
-    } {
-        return this.asObject();
+    return object as {
+      [K in keyof Shape & string]: Shape[K];
+    };
+  }
+
+  /** @category 1. Reading */
+  toJSON(): {
+    [K in keyof Shape & string]: Shape[K];
+  } {
+    return this.asObject();
+  }
+
+  /** @category 5. Edit history */
+  nthEditAt<K extends keyof Shape & string>(
+    key: K,
+    n: number,
+  ):
+    | {
+        by: RawAccountID | AgentID;
+        tx: TransactionID;
+        at: Date;
+        value?: Shape[K];
+      }
+    | undefined {
+    const ops = this.timeFilteredOps(key);
+    if (!ops || ops.length <= n) {
+      return undefined;
     }
 
-    /** @category 5. Edit history */
-    nthEditAt<K extends keyof Shape & string>(
-        key: K,
-        n: number,
-    ):
-        | {
-              by: RawAccountID | AgentID;
-              tx: TransactionID;
-              at: Date;
-              value?: Shape[K];
-          }
-        | undefined {
-        const ops = this.timeFilteredOps(key);
-        if (!ops || ops.length <= n) {
-            return undefined;
-        }
+    const entry = ops[n]!;
 
-        const entry = ops[n]!;
-
-        if (this.atTimeFilter && entry.madeAt > this.atTimeFilter) {
-            return undefined;
-        }
-
-        return {
-            by: accountOrAgentIDfromSessionID(entry.txID.sessionID),
-            tx: entry.txID,
-            at: new Date(entry.madeAt),
-            value: entry.op === "del" ? undefined : entry.value,
-        };
+    if (this.atTimeFilter && entry.madeAt > this.atTimeFilter) {
+      return undefined;
     }
 
-    /** @category 5. Edit history */
-    lastEditAt<K extends keyof Shape & string>(
-        key: K,
-    ):
-        | {
-              by: RawAccountID | AgentID;
-              tx: TransactionID;
-              at: Date;
-              value?: Shape[K];
-          }
-        | undefined {
-        const ops = this.timeFilteredOps(key);
-        if (!ops || ops.length === 0) {
-            return undefined;
-        }
-        return this.nthEditAt(key, ops.length - 1);
-    }
-
-    /** @category 5. Edit history */
-    *editsAt<K extends keyof Shape & string>(key: K) {
-        const ops = this.timeFilteredOps(key);
-        if (!ops) {
-            return;
-        }
+    return {
+      by: accountOrAgentIDfromSessionID(entry.txID.sessionID),
+      tx: entry.txID,
+      at: new Date(entry.madeAt),
+      value: entry.op === "del" ? undefined : entry.value,
+    };
+  }
 
-        for (let i = 0; i < ops.length; i++) {
-            yield this.nthEditAt(key, i)!;
-        }
+  /** @category 5. Edit history */
+  lastEditAt<K extends keyof Shape & string>(
+    key: K,
+  ):
+    | {
+        by: RawAccountID | AgentID;
+        tx: TransactionID;
+        at: Date;
+        value?: Shape[K];
+      }
+    | undefined {
+    const ops = this.timeFilteredOps(key);
+    if (!ops || ops.length === 0) {
+      return undefined;
+    }
+    return this.nthEditAt(key, ops.length - 1);
+  }
+
+  /** @category 5. Edit history */
+  *editsAt<K extends keyof Shape & string>(key: K) {
+    const ops = this.timeFilteredOps(key);
+    if (!ops) {
+      return;
     }
 
-    /** @category 3. Subscription */
-    subscribe(listener: (coMap: this) => void): () => void {
-        return this.core.subscribe((content) => {
-            listener(content as this);
-        });
+    for (let i = 0; i < ops.length; i++) {
+      yield this.nthEditAt(key, i)!;
     }
+  }
+
+  /** @category 3. Subscription */
+  subscribe(listener: (coMap: this) => void): () => void {
+    return this.core.subscribe((content) => {
+      listener(content as this);
+    });
+  }
 }
 
 /** A collaborative map with precise shape `Shape` and optional static metadata `Meta` */
 export class RawCoMap<
-        Shape extends { [key: string]: JsonValue | undefined } = {
-            [key: string]: JsonValue | undefined;
-        },
-        Meta extends JsonObject | null = JsonObject | null,
-    >
-    extends RawCoMapView<Shape, Meta>
-    implements RawCoValue
+    Shape extends { [key: string]: JsonValue | undefined } = {
+      [key: string]: JsonValue | undefined;
+    },
+    Meta extends JsonObject | null = JsonObject | null,
+  >
+  extends RawCoMapView<Shape, Meta>
+  implements RawCoValue
 {
-    /** Set a new value for the given key.
-     *
-     * If `privacy` is `"private"` **(default)**, both `key` and `value` are encrypted in the transaction, only readable by other members of the group this `CoMap` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, both `key` and `value` are stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Editing
-     **/
-    set<K extends keyof Shape & string>(
-        key: K,
-        value: Shape[K],
-        privacy: "private" | "trusting" = "private",
-    ): void {
-        this.core.makeTransaction(
-            [
-                {
-                    op: "set",
-                    key,
-                    value: isCoValue(value) ? value.id : value,
-                },
-            ],
-            privacy,
-        );
-
-        const after = new RawCoMap(this.core) as this;
-
-        this.ops = after.ops;
-    }
+  /** Set a new value for the given key.
+   *
+   * If `privacy` is `"private"` **(default)**, both `key` and `value` are encrypted in the transaction, only readable by other members of the group this `CoMap` belongs to. Not even sync servers can see the content in plaintext.
+   *
+   * If `privacy` is `"trusting"`, both `key` and `value` are stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
+   *
+   * @category 2. Editing
+   **/
+  set<K extends keyof Shape & string>(
+    key: K,
+    value: Shape[K],
+    privacy: "private" | "trusting" = "private",
+  ): void {
+    this.core.makeTransaction(
+      [
+        {
+          op: "set",
+          key,
+          value: isCoValue(value) ? value.id : value,
+        },
+      ],
+      privacy,
+    );
+
+    const after = new RawCoMap(this.core) as this;
+
+    this.ops = after.ops;
+  }
+
+  /** Delete the given key (setting it to undefined).
+   *
+   * If `privacy` is `"private"` **(default)**, `key` is encrypted in the transaction, only readable by other members of the group this `CoMap` belongs to. Not even sync servers can see the content in plaintext.
+   *
+   * If `privacy` is `"trusting"`, `key` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
+   *
+   * @category 2. Editing
+   **/
+  delete(
+    key: keyof Shape & string,
+    privacy: "private" | "trusting" = "private",
+  ) {
+    this.core.makeTransaction(
+      [
+        {
+          op: "del",
+          key,
+        },
+      ],
+      privacy,
+    );
 
-    /** Delete the given key (setting it to undefined).
-     *
-     * If `privacy` is `"private"` **(default)**, `key` is encrypted in the transaction, only readable by other members of the group this `CoMap` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `key` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Editing
-     **/
-    delete(
-        key: keyof Shape & string,
-        privacy: "private" | "trusting" = "private",
-    ) {
-        this.core.makeTransaction(
-            [
-                {
-                    op: "del",
-                    key,
-                },
-            ],
-            privacy,
-        );
-
-        const after = new RawCoMap(this.core) as this;
-
-        this.ops = after.ops;
-    }
+    const after = new RawCoMap(this.core) as this;
+
+    this.ops = after.ops;
+  }
 }