cojson 0.6.7 → 0.7.0-alpha.0

package/src/coValues/account.ts

@@ -1,5 +1,5 @@
 import { CoValueCore, CoValueHeader } from "../coValueCore.js";
-import { CoID, CoValue } from "../coValue.js";
+import { CoID, RawCoValue } from "../coValue.js";
 import {
     AgentSecret,
     SealerID,
@@ -13,8 +13,8 @@ import {
     getAgentSignerSecret,
 } from "../crypto.js";
 import { AgentID } from "../ids.js";
-import { CoMap } from "./coMap.js";
-import { Group, InviteSecret } from "./group.js";
+import { RawCoMap } from "./coMap.js";
+import { RawGroup, InviteSecret } from "./group.js";
 import { LocalNode } from "../index.js";
 
 export function accountHeaderForInitialAgentSecret(
@@ -32,11 +32,9 @@ export function accountHeaderForInitialAgentSecret(
     };
 }
 
-export class Account<
-    P extends Profile = Profile,
-    R extends CoMap = CoMap,
+export class RawAccount<
     Meta extends AccountMeta = AccountMeta
-> extends Group<P, R, Meta> {
+> extends RawGroup<Meta> {
     currentAgentID(): AgentID {
         const agents = this.keys().filter((k): k is AgentID =>
             k.startsWith("sealer_")
@@ -64,12 +62,8 @@ export interface ControlledAccountOrAgent {
 }
 
 /** @hidden */
-export class ControlledAccount<
-        P extends Profile = Profile,
-        R extends CoMap = CoMap,
-        Meta extends AccountMeta = AccountMeta
-    >
-    extends Account<P, R, Meta>
+export class RawControlledAccount<Meta extends AccountMeta = AccountMeta>
+    extends RawAccount<Meta>
     implements ControlledAccountOrAgent
 {
     agentSecret: AgentSecret;
@@ -88,7 +82,7 @@ export class ControlledAccount<
         return this.core.node.createGroup();
     }
 
-    async acceptInvite<T extends CoValue>(
+    async acceptInvite<T extends RawCoValue>(
         groupOrOwnedValueID: CoID<T>,
         inviteSecret: InviteSecret
     ): Promise<void> {
@@ -117,9 +111,7 @@ export class ControlledAccount<
 }
 
 /** @hidden */
-export class ControlledAgent
-    implements ControlledAccountOrAgent
-{
+export class ControlledAgent implements ControlledAccountOrAgent {
     agentSecret: AgentSecret;
 
     constructor(agentSecret: AgentSecret) {
@@ -152,7 +144,7 @@ export class ControlledAgent
 }
 
 export type AccountMeta = { type: "account" };
-export type AccountID = CoID<Account>;
+export type AccountID = CoID<RawAccount>;
 
 export type ProfileShape = {
     name: string;
@@ -162,14 +154,10 @@ export type ProfileMeta = { type: "profile" };
 export class Profile<
     Shape extends ProfileShape = ProfileShape,
     Meta extends ProfileMeta = ProfileMeta
-> extends CoMap<Shape, Meta> {}
+> extends RawCoMap<Shape, Meta> {}
 
-export type AccountMigration<
-    P extends Profile = Profile,
-    R extends CoMap = CoMap,
-    Meta extends AccountMeta = AccountMeta
-> = (
-    account: ControlledAccount<P, R, Meta>,
-    profile: P,
+export type RawAccountMigration<Meta extends AccountMeta = AccountMeta> = (
+    account: RawControlledAccount<Meta>,
+    profile: RawCoMap,
     localNode: LocalNode
 ) => void | Promise<void>;

package/src/coValues/coList.ts

@@ -1,11 +1,11 @@
 import { JsonObject, JsonValue } from "../jsonValue.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 { AgentID, SessionID, TransactionID } from "../ids.js";
 import { AccountID } from "./account.js";
-import { Group } from "./group.js";
+import { RawGroup } from "./group.js";
 
 type OpID = TransactionID & { changeIdx: number };
 
@@ -41,10 +41,10 @@ type DeletionEntry = {
     deletionID: OpID;
 } & DeletionOpPayload;
 
-export class CoListView<
+export class RawCoListView<
     Item extends JsonValue = JsonValue,
-    Meta extends JsonObject | null = null
-> implements CoValue
+    Meta extends JsonObject | null = null,
+> implements RawCoValue
 {
     /** @category 6. Meta */
     id: CoID<this>;
@@ -209,7 +209,7 @@ export class CoListView<
     }
 
     /** @category 6. Meta */
-    get group(): Group {
+    get group(): RawGroup {
         return this.core.getGroup();
     }
 
@@ -306,7 +306,9 @@ export class CoListView<
                 opID,
             });
         }
-        for (const successor of entry.successors) {
+        // traverse successors in reverse for correct insertion behavior
+        for (let i = entry.successors.length - 1; i >= 0; i--) {
+            const successor = entry.successors[i]!;
             this.fillArrayFromOpID(successor, arr);
         }
     }
@@ -393,14 +395,14 @@ export class CoListView<
     }
 }
 
-export class CoList<
+export class RawCoList<
         Item extends JsonValue = JsonValue,
-        Meta extends JsonObject | null = JsonObject | null
+        Meta extends JsonObject | null = JsonObject | null,
     >
-    extends CoListView<Item, Meta>
-    implements CoValue
+    extends RawCoListView<Item, Meta>
+    implements RawCoValue
 {
-    /** Returns a new version of this CoList with `item` appended after the item currently at index `after`.
+    /** Appends `item` after the item currently at index `after`.
      *
      * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
      *
@@ -412,7 +414,7 @@ export class CoList<
         item: Item,
         after?: number,
         privacy: "private" | "trusting" = "private"
-    ): this {
+    ) {
         const entries = this.entries();
         after =
             after === undefined
@@ -444,11 +446,17 @@ export class CoList<
             privacy
         );
 
-        return new CoList(this.core) as this;
+        const listAfter = new RawCoList(this.core) as this;
+
+        this.afterStart = listAfter.afterStart;
+        this.beforeEnd = listAfter.beforeEnd;
+        this.insertions = listAfter.insertions;
+        this.deletionsByInsertion = listAfter.deletionsByInsertion;
+        this._cachedEntries = undefined;
     }
 
     /**
-     * Returns a new version of this CoList with `item` prepended before the item currently at index `before`.
+     * Prepends `item` before the item currently at index `before`.
      *
      * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
      *
@@ -460,7 +468,7 @@ export class CoList<
         item: Item,
         before?: number,
         privacy: "private" | "trusting" = "private"
-    ): this {
+    ) {
         const entries = this.entries();
         before = before === undefined ? 0 : before;
         let opIDAfter;
@@ -491,10 +499,16 @@ export class CoList<
             privacy
         );
 
-        return new CoList(this.core) as this;
+        const listAfter = new RawCoList(this.core) as this;
+
+        this.afterStart = listAfter.afterStart;
+        this.beforeEnd = listAfter.beforeEnd;
+        this.insertions = listAfter.insertions;
+        this.deletionsByInsertion = listAfter.deletionsByInsertion;
+        this._cachedEntries = undefined;
     }
 
-    /** Returns a new version of this CoList with the item at index `at` deleted from the list.
+    /** Deletes the item at index `at`.
      *
      * If `privacy` is `"private"` **(default)**, the fact of this deletion is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
      *
@@ -502,7 +516,7 @@ export class CoList<
      *
      * @category 2. Editing
      **/
-    delete(at: number, privacy: "private" | "trusting" = "private"): this {
+    delete(at: number, privacy: "private" | "trusting" = "private") {
         const entries = this.entries();
         const entry = entries[at];
         if (!entry) {
@@ -518,48 +532,8 @@ export class CoList<
             privacy
         );
 
-        return new CoList(this.core) as this;
-    }
-
-    /** @category 2. Editing */
-    mutate(mutator: (mutable: MutableCoList<Item, Meta>) => void): this {
-        const mutable = new MutableCoList<Item, Meta>(this.core);
-        mutator(mutable);
-        return new CoList(this.core) as this;
-    }
-
-    /** @deprecated Use `mutate` instead. */
-    edit(mutator: (mutable: MutableCoList<Item, Meta>) => void): this {
-        return this.mutate(mutator);
-    }
-}
+        const listAfter = new RawCoList(this.core) as this;
 
-export class MutableCoList<
-        Item extends JsonValue = JsonValue,
-        Meta extends JsonObject | null = JsonObject | null
-    >
-    extends CoListView<Item, Meta>
-    implements CoValue
-{
-    /** Appends `item` after the item currently at index `after`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Mutating
-     **/
-    append(
-        item: Item,
-        after?: number,
-        privacy: "private" | "trusting" = "private"
-    ): void {
-        const listAfter = CoList.prototype.append.call(
-            this,
-            item,
-            after,
-            privacy
-        ) as CoList<Item, Meta>;
         this.afterStart = listAfter.afterStart;
         this.beforeEnd = listAfter.beforeEnd;
         this.insertions = listAfter.insertions;
@@ -567,46 +541,33 @@ export class MutableCoList<
         this._cachedEntries = undefined;
     }
 
-    /** Prepends `item` before the item currently at index `before`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * * @category 2. Mutating
-     **/
-    prepend(
-        item: Item,
-        before?: number,
+    replace(
+        at: number,
+        newItem: Item,
         privacy: "private" | "trusting" = "private"
-    ): void {
-        const listAfter = CoList.prototype.prepend.call(
-            this,
-            item,
-            before,
-            privacy
-        ) as CoList<Item, Meta>;
-        this.afterStart = listAfter.afterStart;
-        this.beforeEnd = listAfter.beforeEnd;
-        this.insertions = listAfter.insertions;
-        this.deletionsByInsertion = listAfter.deletionsByInsertion;
-        this._cachedEntries = undefined;
-    }
+    ) {
+        const entries = this.entries();
+        const entry = entries[at];
+        if (!entry) {
+            throw new Error("Invalid index " + at);
+        }
 
-    /** Deletes the item at index `at` from the list.
-     *
-     * If `privacy` is `"private"` **(default)**, the fact of this deletion is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, the fact of this deletion is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * * @category 2. Mutating
-     **/
-    delete(at: number, privacy: "private" | "trusting" = "private"): void {
-        const listAfter = CoList.prototype.delete.call(
-            this,
-            at,
+        this.core.makeTransaction(
+            [
+                {
+                    op: "app",
+                    value: isCoValue(newItem) ? newItem.id : newItem,
+                    after: entry.opID,
+                },
+                {
+                    op: "del",
+                    insertion: entry.opID,
+                },
+            ],
             privacy
-        ) as CoList<Item, Meta>;
+        );
+        const listAfter = new RawCoList(this.core) as this;
+
         this.afterStart = listAfter.afterStart;
         this.beforeEnd = listAfter.beforeEnd;
         this.insertions = listAfter.insertions;

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;
     }
 }