cojson 0.6.6 → 0.7.0-alpha.0

package/src/coValue.ts

@@ -1,17 +1,17 @@
 import { JsonObject, JsonValue } from "./jsonValue.js";
 import { RawCoID } from "./ids.js";
-import { CoMap } from "./coValues/coMap.js";
-import { BinaryCoStream, CoStream } from "./coValues/coStream.js";
-import { CoList } from "./coValues/coList.js";
+import { RawCoMap } from "./coValues/coMap.js";
+import { RawBinaryCoStream, RawCoStream } from "./coValues/coStream.js";
+import { RawCoList } from "./coValues/coList.js";
 import { CoValueCore } from "./coValueCore.js";
-import { Group } from "./coValues/group.js";
-import { Account, Profile } from "./index.js";
+import { RawGroup } from "./coValues/group.js";
+import { RawAccount, Profile } from "./index.js";
 
-export type CoID<T extends CoValue> = RawCoID & {
+export type CoID<T extends RawCoValue> = RawCoID & {
     readonly __type: T;
 };
 
-export interface CoValue {
+export interface RawCoValue {
     /** The `CoValue`'s (precisely typed) `CoID` */
     id: CoID<this>;
     core: CoValueCore;
@@ -20,7 +20,7 @@ export interface CoValue {
     /** The `CoValue`'s (precisely typed) static metadata */
     headerMeta: JsonObject | null;
     /** The `Group` this `CoValue` belongs to (determining permissions) */
-    group: Group;
+    group: RawGroup;
     /** Returns an immutable JSON presentation of this `CoValue` */
     toJSON(): JsonValue;
     atTime(time: number): this;
@@ -34,35 +34,35 @@ export interface CoValue {
     subscribe(listener: (coValue: this) => void): () => void;
 }
 
-export type AnyCoValue =
-    | CoMap
-    | Group
-    | Account
+export type AnyRawCoValue =
+    | RawCoMap
+    | RawGroup
+    | RawAccount
     | Profile
-    | CoList
-    | CoStream
-    | BinaryCoStream;
+    | RawCoList
+    | RawCoStream
+    | RawBinaryCoStream;
 
-export function expectMap(content: CoValue): CoMap {
+export function expectMap(content: RawCoValue): RawCoMap {
     if (content.type !== "comap") {
         throw new Error("Expected map");
     }
 
-    return content as CoMap;
+    return content as RawCoMap;
 }
 
-export function expectList(content: CoValue): CoList {
+export function expectList(content: RawCoValue): RawCoList {
     if (content.type !== "colist") {
         throw new Error("Expected list");
     }
 
-    return content as CoList;
+    return content as RawCoList;
 }
 
-export function expectStream(content: CoValue): CoStream {
+export function expectStream(content: RawCoValue): RawCoStream {
     if (content.type !== "costream") {
         throw new Error("Expected stream");
     }
 
-    return content as CoStream;
+    return content as RawCoStream;
 }

package/src/coValueCore.ts

@@ -1,4 +1,4 @@
-import { AnyCoValue, CoValue } from "./coValue.js";
+import { AnyRawCoValue, RawCoValue } from "./coValue.js";
 import {
     Encrypted,
     Hash,
@@ -23,7 +23,7 @@ import {
     determineValidTransactions,
     isKeyForKeyField,
 } from "./permissions.js";
-import { Group } from "./coValues/group.js";
+import { RawGroup } from "./coValues/group.js";
 import { LocalNode } from "./localNode.js";
 import { CoValueKnownState, NewContentMessage } from "./sync.js";
 import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
@@ -37,7 +37,7 @@ import { accountOrAgentIDfromSessionID } from "./typeUtils/accountOrAgentIDfromS
 export const MAX_RECOMMENDED_TX_SIZE = 100 * 1024;
 
 export type CoValueHeader = {
-    type: AnyCoValue["type"];
+    type: AnyRawCoValue["type"];
     ruleset: RulesetDef;
     meta: JsonObject | null;
     createdAt: `2${string}` | null;
@@ -95,8 +95,8 @@ export class CoValueCore {
     node: LocalNode;
     header: CoValueHeader;
     _sessionLogs: Map<SessionID, SessionLog>;
-    _cachedContent?: CoValue;
-    listeners: Set<(content?: CoValue) => void> = new Set();
+    _cachedContent?: RawCoValue;
+    listeners: Set<(content?: RawCoValue) => void> = new Set();
     _decryptionCache: {
         [key: Encrypted<JsonValue[], JsonValue>]: JsonValue[] | undefined;
     } = {};
@@ -409,7 +409,7 @@ export class CoValueCore {
         }
     }
 
-    subscribe(listener: (content?: CoValue) => void): () => void {
+    subscribe(listener: (content?: RawCoValue) => void): () => void {
         this.listeners.add(listener);
         listener(this.getCurrentContent());
 
@@ -533,7 +533,7 @@ export class CoValueCore {
         return success;
     }
 
-    getCurrentContent(options?: { ignorePrivateTransactions: true }): CoValue {
+    getCurrentContent(options?: { ignorePrivateTransactions: true }): RawCoValue {
         if (!options?.ignorePrivateTransactions && this._cachedContent) {
             return this._cachedContent;
         }
@@ -741,7 +741,7 @@ export class CoValueCore {
         }
     }
 
-    getGroup(): Group {
+    getGroup(): RawGroup {
         if (this.header.ruleset.type !== "ownedByGroup") {
             throw new Error("Only values owned by groups have groups");
         }

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;