cojson 0.6.6 → 0.7.0-alpha.0

package/src/coValues/coMap.ts

@@ -1,11 +1,11 @@
 import { JsonObject, JsonValue } from "../jsonValue.js";
 import { AgentID, TransactionID } from "../ids.js";
-import { CoID, CoValue } from "../coValue.js";
+import { CoID, RawCoValue } from "../coValue.js";
 import { isCoValue } from "../typeUtils/isCoValue.js";
 import { CoValueCore } from "../coValueCore.js";
 import { accountOrAgentIDfromSessionID } from "../typeUtils/accountOrAgentIDfromSessionID.js";
 import { AccountID } from "./account.js";
-import type { Group } from "./group.js";
+import type { RawGroup } from "./group.js";
 
 type MapOp<K extends string, V extends JsonValue | undefined> = {
     txID: TransactionID;
@@ -25,12 +25,12 @@ export type MapOpPayload<K extends string, V extends JsonValue | undefined> =
           key: K;
       };
 
-export class CoMapView<
+export class RawCoMapView<
     Shape extends { [key: string]: JsonValue | undefined } = {
         [key: string]: JsonValue | undefined;
     },
-    Meta extends JsonObject | null = JsonObject | null
-> implements CoValue
+    Meta extends JsonObject | null = JsonObject | null,
+> implements RawCoValue
 {
     /** @category 6. Meta */
     id: CoID<this>;
@@ -88,7 +88,7 @@ export class CoMapView<
     }
 
     /** @category 6. Meta */
-    get group(): Group {
+    get group(): RawGroup {
         return this.core.getGroup();
     }
 
@@ -250,16 +250,16 @@ export class CoMapView<
 }
 
 /** A collaborative map with precise shape `Shape` and optional static metadata `Meta` */
-export class CoMap<
+export class RawCoMap<
         Shape extends { [key: string]: JsonValue | undefined } = {
             [key: string]: JsonValue | undefined;
         },
-        Meta extends JsonObject | null = JsonObject | null
+        Meta extends JsonObject | null = JsonObject | null,
     >
-    extends CoMapView<Shape, Meta>
-    implements CoValue
+    extends RawCoMapView<Shape, Meta>
+    implements RawCoValue
 {
-    /** Returns a new version of this CoMap with a new value for the given key.
+    /** 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.
      *
@@ -270,64 +270,25 @@ export class CoMap<
     set<K extends keyof Shape & string>(
         key: K,
         value: Shape[K],
-        privacy?: "private" | "trusting"
-    ): this;
-    set(
-        kv: {
-            [K in keyof Shape & string]?: Shape[K];
-        },
-        privacy?: "private" | "trusting"
-    ): this;
-    set<K extends keyof Shape & string>(
-        ...args:
-            | [
-                  {
-                      [K in keyof Shape & string]?: Shape[K];
-                  },
-                  ("private" | "trusting")?
-              ]
-            | [K, Shape[K], ("private" | "trusting")?]
-    ): this {
-        if (typeof args[0] === "string") {
-            const [key, value, privacy = "private"] = args;
-            this.core.makeTransaction(
-                [
-                    {
-                        op: "set",
-                        key,
-                        value: isCoValue(value) ? value.id : value,
-                    },
-                ],
-                privacy
-            );
-        } else {
-            const [kv, privacy = "private"] = args as [
+        privacy: "private" | "trusting" = "private"
+    ): void {
+        this.core.makeTransaction(
+            [
                 {
-                    [K in keyof Shape & string]: Shape[K] extends CoValue
-                        ? Shape[K] | CoID<Shape[K]>
-                        : Shape[K];
+                    op: "set",
+                    key,
+                    value: isCoValue(value) ? value.id : value,
                 },
-                "private" | "trusting" | undefined
-            ];
-
-            for (const [key, value] of Object.entries(kv)) {
-                this.core.makeTransaction(
-                    [
-                        {
-                            op: "set",
-                            key,
-                            value: isCoValue(value) ? value.id : value,
-                        },
-                    ],
-                    privacy
-                );
-            }
-        }
+            ],
+            privacy
+        );
+
+        const after = new RawCoMap(this.core) as this;
 
-        return new CoMap(this.core) as this;
+        this.ops = after.ops;
     }
 
-    /** Returns a new version of this CoMap with the given key deleted (setting it to undefined).
+    /** 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.
      *
@@ -338,7 +299,7 @@ export class CoMap<
     delete(
         key: keyof Shape & string,
         privacy: "private" | "trusting" = "private"
-    ): this {
+    ) {
         this.core.makeTransaction(
             [
                 {
@@ -349,71 +310,8 @@ export class CoMap<
             privacy
         );
 
-        return new CoMap(this.core) as this;
-    }
+        const after = new RawCoMap(this.core) as this;
 
-    /** @category 2. Editing */
-    mutate(mutator: (mutable: MutableCoMap<Shape, Meta>) => void): this {
-        const mutable = new MutableCoMap<Shape, Meta>(this.core);
-        mutator(mutable);
-        return new (this.constructor as new (core: CoValueCore) => this)(
-            this.core
-        );
-    }
-
-    /** @deprecated Use `mutate` instead. */
-    edit(mutator: (mutable: MutableCoMap<Shape, Meta>) => void): this {
-        return this.mutate(mutator);
-    }
-}
-
-export class MutableCoMap<
-        Shape extends { [key: string]: JsonValue | undefined } = {
-            [key: string]: JsonValue | undefined;
-        },
-        Meta extends JsonObject | null = JsonObject | null
-    >
-    extends CoMapView<Shape, Meta>
-    implements CoValue
-{
-    /** Sets 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. Mutation
-     */
-    set<K extends keyof Shape & string>(
-        key: K,
-        value: Shape[K],
-        privacy: "private" | "trusting" = "private"
-    ): void {
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        const after = (CoMap.prototype.set as Function).call(
-            this,
-            key,
-            value,
-            privacy
-        ) as CoMap<Shape, Meta>;
-        this.ops = after.ops;
-    }
-
-    /** Deletes the value for 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. Mutation
-     */
-    delete(
-        key: keyof Shape & string,
-        privacy: "private" | "trusting" = "private"
-    ): void {
-        const after = CoMap.prototype.delete.call(this, key, privacy) as CoMap<
-            Shape,
-            Meta
-        >;
         this.ops = after.ops;
     }
 }

package/src/coValues/coStream.ts

@@ -1,10 +1,10 @@
 import { JsonObject, JsonValue } from "../jsonValue.js";
-import { CoValue, CoID } from "../coValue.js";
+import { RawCoValue, CoID } from "../coValue.js";
 import { isAccountID } from "../typeUtils/isAccountID.js";
 import { isCoValue } from "../typeUtils/isCoValue.js";
 import { CoValueCore } from "../coValueCore.js";
 import { accountOrAgentIDfromSessionID } from "../typeUtils/accountOrAgentIDfromSessionID.js";
-import { Group } from "./group.js";
+import { RawGroup } from "./group.js";
 import { AgentID, SessionID, TransactionID } from "../ids.js";
 import { base64URLtoBytes, bytesToBase64url } from "../base64url.js";
 import { AccountID } from "./account.js";
@@ -41,10 +41,10 @@ export type CoStreamItem<Item extends JsonValue> = {
     madeAt: number;
 };
 
-export class CoStreamView<
+export class RawCoStreamView<
     Item extends JsonValue = JsonValue,
     Meta extends JsonObject | null = JsonObject | null
-> implements CoValue
+> implements RawCoValue
 {
     id: CoID<this>;
     type = "costream" as const;
@@ -65,7 +65,7 @@ export class CoStreamView<
         return this.core.header.meta as Meta;
     }
 
-    get group(): Group {
+    get group(): RawGroup {
         return this.core.getGroup();
     }
 
@@ -95,9 +95,7 @@ export class CoStreamView<
         }
     }
 
-    getSingleStream():
-        | (Item)[]
-        | undefined {
+    getSingleStream(): Item[] | undefined {
         if (Object.keys(this.items).length === 0) {
             return undefined;
         } else if (Object.keys(this.items).length !== 1) {
@@ -114,7 +112,11 @@ export class CoStreamView<
     }
 
     accounts(): Set<AccountID> {
-        return new Set(this.sessions().map(accountOrAgentIDfromSessionID).filter(isAccountID));
+        return new Set(
+            this.sessions()
+                .map(accountOrAgentIDfromSessionID)
+                .filter(isAccountID)
+        );
     }
 
     nthItemIn(
@@ -224,7 +226,7 @@ export class CoStreamView<
     }
 
     toJSON(): {
-        [key: SessionID]: (Item )[];
+        [key: SessionID]: Item[];
     } {
         return Object.fromEntries(
             Object.entries(this.items).map(([sessionID, items]) => [
@@ -241,44 +243,14 @@ export class CoStreamView<
     }
 }
 
-export class CoStream<
+export class RawCoStream<
         Item extends JsonValue = JsonValue,
         Meta extends JsonObject | null = JsonObject | null
     >
-    extends CoStreamView<Item, Meta>
-    implements CoValue
+    extends RawCoStreamView<Item, Meta>
+    implements RawCoValue
 {
-    push(
-        item: Item,
-        privacy: "private" | "trusting" = "private"
-    ): this {
-        this.core.makeTransaction([isCoValue(item) ? item.id : item], privacy);
-        return new CoStream(this.core) as this;
-    }
-
-    mutate(mutator: (mutable: MutableCoStream<Item, Meta>) => void): this {
-        const mutable = new MutableCoStream<Item, Meta>(this.core);
-        mutator(mutable);
-        return new CoStream(this.core) as this;
-    }
-
-    /** @deprecated Use `mutate` instead. */
-    edit(mutator: (mutable: MutableCoStream<Item, Meta>) => void): this {
-        return this.mutate(mutator);
-    }
-}
-
-export class MutableCoStream<
-        Item extends JsonValue,
-        Meta extends JsonObject | null = JsonObject | null
-    >
-    extends CoStreamView<Item, Meta>
-    implements CoValue
-{
-    push(
-        item: Item,
-        privacy: "private" | "trusting" = "private"
-    ) {
+    push(item: Item, privacy: "private" | "trusting" = "private"): void {
         this.core.makeTransaction([isCoValue(item) ? item.id : item], privacy);
         this.fillFromCoValue();
     }
@@ -286,14 +258,14 @@ export class MutableCoStream<
 
 const binary_U_prefixLength = 8; // "binary_U".length;
 
-export class BinaryCoStreamView<
+export class RawBinaryCoStreamView<
         Meta extends BinaryCoStreamMeta = { type: "binary" }
     >
-    extends CoStreamView<BinaryStreamItem, Meta>
-    implements CoValue
+    extends RawCoStreamView<BinaryStreamItem, Meta>
+    implements RawCoValue
 {
     getBinaryChunks(
-        allowUnfinished?: boolean,
+        allowUnfinished?: boolean
     ):
         | (BinaryStreamInfo & { chunks: Uint8Array[]; finished: boolean })
         | undefined {
@@ -358,35 +330,21 @@ export class BinaryCoStreamView<
     }
 }
 
-export class BinaryCoStream<
+export class RawBinaryCoStream<
         Meta extends BinaryCoStreamMeta = { type: "binary" }
     >
-    extends BinaryCoStreamView<Meta>
-    implements CoValue
+    extends RawBinaryCoStreamView<Meta>
+    implements RawCoValue
 {
     /** @internal */
-    push(
-        item: BinaryStreamItem,
-        privacy?: "private" | "trusting",
-    ): this
-    push(
-        item: BinaryStreamItem,
-        privacy: "private" | "trusting",
-        returnNewStream: true
-    ): this
-    push(
-        item: BinaryStreamItem,
-        privacy: "private" | "trusting",
-        returnNewStream: false
-    ): void
     push(
         item: BinaryStreamItem,
         privacy: "private" | "trusting" = "private",
-        returnNewStream: boolean = true
-    ): this | void {
+        updateView: boolean = true
+    ): void {
         this.core.makeTransaction([item], privacy);
-        if (returnNewStream) {
-            return new BinaryCoStream(this.core) as this;
+        if (updateView) {
+            this.fillFromCoValue();
         }
     }
 
@@ -394,7 +352,7 @@ export class BinaryCoStream<
         settings: BinaryStreamInfo,
         privacy: "private" | "trusting" = "private"
     ): void {
-        return this.push(
+        this.push(
             {
                 type: "start",
                 ...settings,
@@ -409,7 +367,7 @@ export class BinaryCoStream<
         privacy: "private" | "trusting" = "private"
     ): void {
         // const before = performance.now();
-        return this.push(
+        this.push(
             {
                 type: "chunk",
                 chunk: `binary_U${bytesToBase64url(chunk)}`,
@@ -424,77 +382,13 @@ export class BinaryCoStream<
         // );
     }
 
-    endBinaryStream(privacy: "private" | "trusting" = "private"): this {
-        return this.push(
-            {
-                type: "end",
-            } satisfies BinaryStreamEnd,
-            privacy,
-            true
-        );
-    }
-
-    mutate(mutator: (mutable: MutableBinaryCoStream<Meta>) => void): this {
-        const mutable = new MutableBinaryCoStream<Meta>(this.core);
-        mutator(mutable);
-        return new BinaryCoStream(this.core) as this;
-    }
-
-    /** @deprecated Use `mutate` instead. */
-    edit(mutator: (mutable: MutableBinaryCoStream<Meta>) => void): this {
-        return this.mutate(mutator);
-    }
-}
-
-export class MutableBinaryCoStream<
-        Meta extends BinaryCoStreamMeta = { type: "binary" }
-    >
-    extends BinaryCoStreamView<Meta>
-    implements CoValue
-{
-    /** @internal */
-    push(item: BinaryStreamItem, privacy: "private" | "trusting" = "private") {
-        MutableCoStream.prototype.push.call(this, item, privacy);
-    }
-
-    startBinaryStream(
-        settings: BinaryStreamInfo,
-        privacy: "private" | "trusting" = "private"
-    ) {
-        this.push(
-            {
-                type: "start",
-                ...settings,
-            } satisfies BinaryStreamStart,
-            privacy
-        );
-    }
-
-    pushBinaryStreamChunk(
-        chunk: Uint8Array,
-        privacy: "private" | "trusting" = "private"
-    ) {
-        // const before = performance.now();
-        this.push(
-            {
-                type: "chunk",
-                chunk: `binary_U${bytesToBase64url(chunk)}`,
-            } satisfies BinaryStreamChunk,
-            privacy
-        );
-        // const after = performance.now();
-        // console.log(
-        //     "pushBinaryStreamChunk bandwidth in MB/s",
-        //     (1000 * chunk.length) / (after - before) / (1024 * 1024)
-        // );
-    }
-
     endBinaryStream(privacy: "private" | "trusting" = "private") {
         this.push(
             {
                 type: "end",
             } satisfies BinaryStreamEnd,
-            privacy
+            privacy,
+            true
         );
     }
 }