cojson 0.3.6 → 0.4.0

package/src/coValueCore.ts

@@ -26,12 +26,17 @@ import {
     determineValidTransactions,
     isKeyForKeyField,
 } from "./permissions.js";
-import { Group, expectGroupContent } from "./group.js";
+import { Group, expectGroup } from "./coValues/group.js";
 import { LocalNode } from "./localNode.js";
 import { CoValueKnownState, NewContentMessage } from "./sync.js";
 import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
 import { CoList } from "./coValues/coList.js";
-import { AccountID, GeneralizedControlledAccount } from "./account.js";
+import {
+    Account,
+    AccountID,
+    GeneralizedControlledAccount,
+    isAccountID,
+} from "./coValues/account.js";
 import { Stringified, stableStringify } from "./jsonStringify.js";
 
 export const MAX_RECOMMENDED_TX_SIZE = 100 * 1024;
@@ -163,7 +168,15 @@ export class CoValueCore {
     }
 
     nextTransactionID(): TransactionID {
-        const sessionID = this.node.currentSessionID;
+        // This is an ugly hack to get a unique but stable session ID for editing the current account
+        const sessionID =
+            this.header.meta?.type === "account"
+                ? (this.node.currentSessionID.replace(
+                      this.node.account.id,
+                      this.node.account.currentAgentID()
+                  ) as SessionID)
+                : this.node.currentSessionID;
+
         return {
             sessionID,
             txIndex: this.sessions[sessionID]?.transactions.length || 0,
@@ -467,7 +480,14 @@ export class CoValueCore {
             };
         }
 
-        const sessionID = this.node.currentSessionID;
+        // This is an ugly hack to get a unique but stable session ID for editing the current account
+        const sessionID =
+            this.header.meta?.type === "account"
+                ? (this.node.currentSessionID.replace(
+                      this.node.account.id,
+                      this.node.account.currentAgentID()
+                  ) as SessionID)
+                : this.node.currentSessionID;
 
         const { expectedNewHash } = this.expectedNewHashAfter(sessionID, [
             transaction,
@@ -492,33 +512,51 @@ export class CoValueCore {
         return success;
     }
 
-    getCurrentContent(): CoValue {
-        if (this._cachedContent) {
+    getCurrentContent(options?: { ignorePrivateTransactions: true }): CoValue {
+        if (!options?.ignorePrivateTransactions && this._cachedContent) {
             return this._cachedContent;
         }
 
+        let newContent;
         if (this.header.type === "comap") {
-            this._cachedContent = new CoMap(this);
+            if (this.header.ruleset.type === "group") {
+                if (
+                    this.header.meta?.type === "account" &&
+                    !options?.ignorePrivateTransactions
+                ) {
+                    newContent = new Account(this);
+                } else {
+                    newContent = new Group(this, options);
+                }
+            } else {
+                newContent = new CoMap(this);
+            }
         } else if (this.header.type === "colist") {
-            this._cachedContent = new CoList(this);
+            newContent = new CoList(this);
         } else if (this.header.type === "costream") {
             if (this.header.meta && this.header.meta.type === "binary") {
-                this._cachedContent = new BinaryCoStream(this);
+                newContent = new BinaryCoStream(this);
             } else {
-                this._cachedContent = new CoStream(this);
+                newContent = new CoStream(this);
             }
         } else {
             throw new Error(`Unknown coValue type ${this.header.type}`);
         }
 
-        return this._cachedContent;
+        if (!options?.ignorePrivateTransactions) {
+            this._cachedContent = newContent;
+        }
+
+        return newContent;
     }
 
-    getValidSortedTransactions(): DecryptedTransaction[] {
+    getValidSortedTransactions(options?: {
+        ignorePrivateTransactions: true;
+    }): DecryptedTransaction[] {
         const validTransactions = determineValidTransactions(this);
 
         const allTransactions: DecryptedTransaction[] = validTransactions
-            .map(({ txID, tx }) => {
+            .flatMap(({ txID, tx }) => {
                 if (tx.privacy === "trusting") {
                     return {
                         txID,
@@ -526,6 +564,9 @@ export class CoValueCore {
                         changes: tx.changes,
                     };
                 } else {
+                    if (options?.ignorePrivateTransactions) {
+                        return undefined;
+                    }
                     const readKey = this.getReadKey(tx.keyUsed);
 
                     if (!readKey) {
@@ -574,7 +615,7 @@ export class CoValueCore {
 
     getCurrentReadKey(): { secret: KeySecret | undefined; id: KeyID } {
         if (this.header.ruleset.type === "group") {
-            const content = expectGroupContent(this.getCurrentContent());
+            const content = expectGroup(this.getCurrentContent());
 
             const currentKeyId = content.get("readKey");
 
@@ -600,16 +641,38 @@ export class CoValueCore {
     }
 
     getReadKey(keyID: KeyID): KeySecret | undefined {
-        if (readKeyCache.get(this)?.[keyID]) {
-            return readKeyCache.get(this)?.[keyID];
+        let key = readKeyCache.get(this)?.[keyID];
+        if (!key) {
+            key = this.getUncachedReadKey(keyID);
+            if (key) {
+                let cache = readKeyCache.get(this);
+                if (!cache) {
+                    cache = {};
+                    readKeyCache.set(this, cache);
+                }
+                cache[keyID] = key;
+            }
         }
+        return key;
+    }
+
+    getUncachedReadKey(keyID: KeyID): KeySecret | undefined {
         if (this.header.ruleset.type === "group") {
-            const content = expectGroupContent(this.getCurrentContent());
+            const content = expectGroup(
+                this.getCurrentContent({ ignorePrivateTransactions: true })
+            );
+
+            const keyForEveryone = content.get(`${keyID}_for_everyone`);
+            if (keyForEveryone) return keyForEveryone;
 
             // Try to find key revelation for us
+            const lookupAccountOrAgentID =
+                this.header.meta?.type === "account"
+                    ? this.node.account.currentAgentID()
+                    : this.node.account.id;
 
             const lastReadyKeyEdit = content.lastEditAt(
-                `${keyID}_for_${this.node.account.id}`
+                `${keyID}_for_${lookupAccountOrAgentID}`
             );
 
             if (lastReadyKeyEdit?.value) {
@@ -630,13 +693,6 @@ export class CoValueCore {
                 );
 
                 if (secret) {
-                    let cache = readKeyCache.get(this);
-                    if (!cache) {
-                        cache = {};
-                        readKeyCache.set(this, cache);
-                    }
-                    cache[keyID] = secret;
-
                     return secret as KeySecret;
                 }
             }
@@ -665,13 +721,6 @@ export class CoValueCore {
                     );
 
                     if (secret) {
-                        let cache = readKeyCache.get(this);
-                        if (!cache) {
-                            cache = {};
-                            readKeyCache.set(this, cache);
-                        }
-                        cache[keyID] = secret;
-
                         return secret as KeySecret;
                     } else {
                         console.error(
@@ -698,13 +747,10 @@ export class CoValueCore {
             throw new Error("Only values owned by groups have groups");
         }
 
-        return new Group(
-            expectGroupContent(
-                this.node
-                    .expectCoValueLoaded(this.header.ruleset.group)
-                    .getCurrentContent()
-            ),
+        return expectGroup(
             this.node
+                .expectCoValueLoaded(this.header.ruleset.group)
+                .getCurrentContent()
         );
     }
 
@@ -808,11 +854,25 @@ export class CoValueCore {
 
     getDependedOnCoValues(): RawCoID[] {
         return this.header.ruleset.type === "group"
-            ? expectGroupContent(this.getCurrentContent())
+            ? expectGroup(this.getCurrentContent())
                   .keys()
                   .filter((k): k is AccountID => k.startsWith("co_"))
             : this.header.ruleset.type === "ownedByGroup"
-            ? [this.header.ruleset.group]
+            ? [
+                  this.header.ruleset.group,
+                  ...new Set(
+                      Object.keys(this._sessions)
+                          .map((sessionID) =>
+                              accountOrAgentIDfromSessionID(
+                                  sessionID as SessionID
+                              )
+                          )
+                          .filter(
+                              (session): session is AccountID =>
+                                  isAccountID(session) && session !== this.id
+                          )
+                  ),
+              ]
             : [];
     }
 }

package/src/{account.ts → coValues/account.ts}

@@ -1,5 +1,5 @@
-import { CoValueHeader } from "./coValueCore.js";
-import { CoID } from "./coValue.js";
+import { CoValueCore, CoValueHeader } from "../coValueCore.js";
+import { CoID, CoValue } from "../coValue.js";
 import {
     AgentSecret,
     SealerID,
@@ -11,11 +11,10 @@ import {
     getAgentSealerSecret,
     getAgentSignerID,
     getAgentSignerSecret,
-} from "./crypto.js";
-import { AgentID } from "./ids.js";
-import { CoMap } from "./coValues/coMap.js";
-import { LocalNode } from "./localNode.js";
-import { Group, GroupContent } from "./group.js";
+} from "../crypto.js";
+import { AgentID } from "../ids.js";
+import { CoMap } from "./coMap.js";
+import { Group, InviteSecret } from "./group.js";
 
 export function accountHeaderForInitialAgentSecret(
     agentSecret: AgentSecret
@@ -32,15 +31,15 @@ export function accountHeaderForInitialAgentSecret(
     };
 }
 
-export class AccountGroup extends Group {
-    get id(): AccountID {
-        return this.underlyingMap.id as AccountID;
-    }
-
+export class Account<
+    P extends Profile = Profile,
+    R extends CoMap = CoMap,
+    Meta extends AccountMeta = AccountMeta
+> extends Group<P, R, Meta> {
     getCurrentAgentID(): AgentID {
-        const agents = this.underlyingMap
-            .keys()
-            .filter((k): k is AgentID => k.startsWith("sealer_"));
+        const agents = this.keys().filter((k): k is AgentID =>
+            k.startsWith("sealer_")
+        );
 
         if (agents.length !== 1) {
             throw new Error(
@@ -64,22 +63,37 @@ export interface GeneralizedControlledAccount {
 }
 
 /** @hidden */
-export class ControlledAccount
-    extends AccountGroup
+export class ControlledAccount<
+P extends Profile = Profile,
+R extends CoMap = CoMap,
+Meta extends AccountMeta = AccountMeta
+>
+    extends Account<P, R, Meta>
     implements GeneralizedControlledAccount
 {
     agentSecret: AgentSecret;
 
-    constructor(
-        agentSecret: AgentSecret,
-        groupMap: CoMap<AccountContent, AccountMeta>,
-        node: LocalNode
-    ) {
-        super(groupMap, node);
+    constructor(core: CoValueCore, agentSecret: AgentSecret) {
+        super(core);
 
         this.agentSecret = agentSecret;
     }
 
+    /**
+     * Creates a new group (with the current account as the group's first admin).
+     * @category 1. High-level
+     */
+    createGroup() {
+        return this.core.node.createGroup();
+    }
+
+    async acceptInvite<T extends CoValue>(
+        groupOrOwnedValueID: CoID<T>,
+        inviteSecret: InviteSecret
+    ): Promise<void> {
+        return this.core.node.acceptInvite(groupOrOwnedValueID, inviteSecret);
+    }
+
     currentAgentID(): AgentID {
         return getAgentID(this.agentSecret);
     }
@@ -136,17 +150,22 @@ export class AnonymousControlledAccount
     }
 }
 
-export type AccountContent = { profile: Profile } & GroupContent;
 export type AccountMeta = { type: "account" };
-export type Account = CoMap<AccountContent, AccountMeta>;
 export type AccountID = CoID<Account>;
 
 export function isAccountID(id: AccountID | AgentID): id is AccountID {
     return id.startsWith("co_");
 }
 
-export type ProfileContent = {
+export type ProfileShape = {
     name: string;
 };
 export type ProfileMeta = { type: "profile" };
-export type Profile = CoMap<ProfileContent, ProfileMeta>;
+
+export class Profile<Shape extends ProfileShape = ProfileShape, Meta extends ProfileMeta = ProfileMeta> extends CoMap<Shape, Meta> {
+
+}
+
+export type AccountMigration< P extends Profile = Profile,
+R extends CoMap = CoMap,
+Meta extends AccountMeta = AccountMeta> = (account: ControlledAccount<P, R, Meta>, profile: P) => void;

package/src/coValues/coList.ts

@@ -2,21 +2,21 @@ import { JsonObject, JsonValue } from "../jsonValue.js";
 import { CoID, CoValue, isCoValue } from "../coValue.js";
 import { CoValueCore, accountOrAgentIDfromSessionID } from "../coValueCore.js";
 import { AgentID, SessionID, TransactionID } from "../ids.js";
-import { Group } from "../group.js";
-import { AccountID } from "../account.js";
+import { AccountID } from "./account.js";
 import { parseJSON } from "../jsonStringify.js";
+import { Group } from "./group.js";
 
 type OpID = TransactionID & { changeIdx: number };
 
-type InsertionOpPayload<T extends JsonValue | CoValue> =
+type InsertionOpPayload<T extends JsonValue> =
     | {
           op: "pre";
-          value: T extends CoValue ? CoID<T> : Exclude<T, CoValue>;
+          value: T;
           before: OpID | "end";
       }
     | {
           op: "app";
-          value: T extends CoValue ? CoID<T> : Exclude<T, CoValue>;
+          value: T;
           after: OpID | "start";
       };
 
@@ -25,11 +25,11 @@ type DeletionOpPayload = {
     insertion: OpID;
 };
 
-export type ListOpPayload<T extends JsonValue | CoValue> =
+export type ListOpPayload<T extends JsonValue> =
     | InsertionOpPayload<T>
     | DeletionOpPayload;
 
-type InsertionEntry<T extends JsonValue | CoValue> = {
+type InsertionEntry<T extends JsonValue> = {
     madeAt: number;
     predecessors: OpID[];
     successors: OpID[];
@@ -41,7 +41,7 @@ type DeletionEntry = {
 } & DeletionOpPayload;
 
 export class CoListView<
-    Item extends JsonValue | CoValue,
+    Item extends JsonValue = JsonValue,
     Meta extends JsonObject | null = null
 > implements CoValue
 {
@@ -220,11 +220,7 @@ export class CoListView<
      *
      * @category 1. Reading
      */
-    get(
-        idx: number
-    ):
-        | (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)
-        | undefined {
+    get(idx: number): Item | undefined {
         const entry = this.entries()[idx];
         if (!entry) {
             return undefined;
@@ -237,18 +233,18 @@ export class CoListView<
      *
      * @category 1. Reading
      **/
-    asArray(): (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)[] {
+    asArray(): Item[] {
         return this.entries().map((entry) => entry.value);
     }
 
     /** @internal */
-     entries(): {
-        value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+    entries(): {
+        value: Item;
         madeAt: number;
         opID: OpID;
     }[] {
         const arr: {
-            value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+            value: Item;
             madeAt: number;
             opID: OpID;
         }[] = [];
@@ -265,7 +261,7 @@ export class CoListView<
     private fillArrayFromOpID(
         opID: OpID,
         arr: {
-            value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+            value: Item;
             madeAt: number;
             opID: OpID;
         }[]
@@ -299,7 +295,7 @@ export class CoListView<
      *
      * @category 1. Reading
      */
-    toJSON(): (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)[] {
+    toJSON(): Item[] {
         return this.asArray();
     }
 
@@ -309,7 +305,7 @@ export class CoListView<
               by: AccountID | AgentID;
               tx: TransactionID;
               at: Date;
-              value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+              value: Item;
           }
         | undefined {
         const entry = this.entries()[idx];
@@ -377,8 +373,8 @@ export class CoListView<
 }
 
 export class CoList<
-        Item extends JsonValue | CoValue,
-        Meta extends JsonObject | null = null
+        Item extends JsonValue = JsonValue,
+        Meta extends JsonObject | null = JsonObject | null
     >
     extends CoListView<Item, Meta>
     implements CoValue
@@ -392,7 +388,7 @@ export class CoList<
      * @category 2. Editing
      **/
     append(
-        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        item: Item,
         after?: number,
         privacy: "private" | "trusting" = "private"
     ): this {
@@ -440,7 +436,7 @@ export class CoList<
      * @category 2. Editing
      */
     prepend(
-        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        item: Item,
         before?: number,
         privacy: "private" | "trusting" = "private"
     ): this {
@@ -518,8 +514,8 @@ export class CoList<
 }
 
 export class MutableCoList<
-        Item extends JsonValue | CoValue,
-        Meta extends JsonObject | null = null
+        Item extends JsonValue = JsonValue,
+        Meta extends JsonObject | null = JsonObject | null
     >
     extends CoListView<Item, Meta>
     implements CoValue
@@ -533,7 +529,7 @@ export class MutableCoList<
      * @category 2. Mutating
      **/
     append(
-        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        item: Item,
         after?: number,
         privacy: "private" | "trusting" = "private"
     ): void {
@@ -558,7 +554,7 @@ export class MutableCoList<
      * * @category 2. Mutating
      **/
     prepend(
-        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        item: Item,
         before?: number,
         privacy: "private" | "trusting" = "private"
     ): void {