cojson 0.7.35 → 0.8.0

package/src/coValueCore.ts

@@ -10,7 +10,6 @@ import {
     SignerID,
 } from "./crypto/crypto.js";
 import { JsonObject, JsonValue } from "./jsonValue.js";
-import { base58 } from "@scure/base";
 import {
     PermissionsDef as RulesetDef,
     determineValidTransactions,
@@ -19,8 +18,8 @@ import {
 import { RawGroup } from "./coValues/group.js";
 import { LocalNode, ResolveAccountAgentError } from "./localNode.js";
 import { CoValueKnownState, NewContentMessage } from "./sync.js";
-import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
-import { AccountID, ControlledAccountOrAgent } from "./coValues/account.js";
+import { RawCoID, SessionID, TransactionID } from "./ids.js";
+import { RawAccountID, ControlledAccountOrAgent } from "./coValues/account.js";
 import { Stringified, parseJSON, stableStringify } from "./jsonStringify.js";
 import { coreToCoValue } from "./coreToCoValue.js";
 import { expectGroup } from "./typeUtils/expectGroup.js";
@@ -42,9 +41,9 @@ export type CoValueHeader = {
     type: AnyRawCoValue["type"];
     ruleset: RulesetDef;
     meta: JsonObject | null;
-    createdAt: `2${string}` | null;
-    uniqueness: `z${string}` | null;
-};
+} & CoValueUniqueness;
+
+export type CoValueUniqueness = {uniqueness: JsonValue, createdAt?: `2${string}` | null}
 
 export function idforHeader(
     header: CoValueHeader,
@@ -54,13 +53,6 @@ export function idforHeader(
     return `co_z${hash.slice("shortHash_z".length)}`;
 }
 
-export function newRandomSessionID(accountID: AccountID | AgentID): SessionID {
-    return `${accountID}_session_z${base58.encode(
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (globalThis as any).crypto.getRandomValues(new Uint8Array(8)),
-    )}`;
-}
-
 type SessionLog = {
     transactions: Transaction[];
     lastHash?: Hash;
@@ -993,7 +985,7 @@ export class CoValueCore {
         return this.header.ruleset.type === "group"
             ? expectGroup(this.getCurrentContent())
                   .keys()
-                  .filter((k): k is AccountID => k.startsWith("co_"))
+                  .filter((k): k is RawAccountID => k.startsWith("co_"))
             : this.header.ruleset.type === "ownedByGroup"
               ? [
                     this.header.ruleset.group,
@@ -1005,7 +997,7 @@ export class CoValueCore {
                                 ),
                             )
                             .filter(
-                                (session): session is AccountID =>
+                                (session): session is RawAccountID =>
                                     isAccountID(session) && session !== this.id,
                             ),
                     ),

package/src/coValues/account.ts

@@ -1,4 +1,4 @@
-import { CoValueCore, CoValueHeader } from "../coValueCore.js";
+import { CoValueCore, CoValueHeader, CoValueUniqueness } from "../coValueCore.js";
 import { CoID, RawCoValue } from "../coValue.js";
 import {
     AgentSecret,
@@ -63,7 +63,7 @@ export class RawAccount<
 }
 
 export interface ControlledAccountOrAgent {
-    id: AccountID | AgentID;
+    id: RawAccountID | AgentID;
     agentSecret: AgentSecret;
 
     currentAgentID: () => Result<AgentID, InvalidAccountAgentIDError>;
@@ -92,8 +92,8 @@ export class RawControlledAccount<Meta extends AccountMeta = AccountMeta>
      * Creates a new group (with the current account as the group's first admin).
      * @category 1. High-level
      */
-    createGroup() {
-        return this.core.node.createGroup();
+    createGroup(uniqueness: CoValueUniqueness = this.core.crypto.createdNowUnique()) {
+        return this.core.node.createGroup(uniqueness);
     }
 
     async acceptInvite<T extends RawCoValue>(
@@ -133,7 +133,6 @@ export class RawControlledAccount<Meta extends AccountMeta = AccountMeta>
     }
 }
 
-/** @hidden */
 export class ControlledAgent implements ControlledAccountOrAgent {
     constructor(
         public agentSecret: AgentSecret,
@@ -170,7 +169,7 @@ export class ControlledAgent implements ControlledAccountOrAgent {
 }
 
 export type AccountMeta = { type: "account" };
-export type AccountID = CoID<RawAccount>;
+export type RawAccountID = CoID<RawAccount>;
 
 export type ProfileShape = {
     name: string;

package/src/coValues/coList.ts

@@ -4,7 +4,7 @@ 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 { RawAccountID } from "./account.js";
 import { RawGroup } from "./group.js";
 
 type OpID = TransactionID & { changeIdx: number };
@@ -325,7 +325,7 @@ export class RawCoListView<
     /** @category 5. Edit history */
     editAt(idx: number):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value: Item;
@@ -351,13 +351,13 @@ export class RawCoListView<
 
     /** @category 5. Edit history */
     deletionEdits(): {
-        by: AccountID | AgentID;
+        by: RawAccountID | AgentID;
         tx: TransactionID;
         at: Date;
         // TODO: add indices that are now before and after the deleted item
     }[] {
         const edits: {
-            by: AccountID | AgentID;
+            by: RawAccountID | AgentID;
             tx: TransactionID;
             at: Date;
         }[] = [];

package/src/coValues/coMap.ts

@@ -4,7 +4,7 @@ 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 { RawAccountID } from "./account.js";
 import type { RawGroup } from "./group.js";
 
 type MapOp<K extends string, V extends JsonValue | undefined> = {
@@ -196,7 +196,7 @@ export class RawCoMapView<
         n: number,
     ):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value?: Shape[K];
@@ -226,7 +226,7 @@ export class RawCoMapView<
         key: K,
     ):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value?: Shape[K];

package/src/coValues/coStream.ts

@@ -7,7 +7,7 @@ import { accountOrAgentIDfromSessionID } from "../typeUtils/accountOrAgentIDfrom
 import { RawGroup } from "./group.js";
 import { AgentID, SessionID, TransactionID } from "../ids.js";
 import { base64URLtoBytes, bytesToBase64url } from "../base64url.js";
-import { AccountID } from "./account.js";
+import { RawAccountID } from "./account.js";
 
 export type BinaryStreamInfo = {
     mimeType: string;
@@ -116,7 +116,7 @@ export class RawCoStreamView<
         return Object.keys(this.items) as SessionID[];
     }
 
-    accounts(): Set<AccountID> {
+    accounts(): Set<RawAccountID> {
         return new Set(
             this.sessions()
                 .map(accountOrAgentIDfromSessionID)
@@ -129,7 +129,7 @@ export class RawCoStreamView<
         n: number,
     ):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value: Item;
@@ -151,7 +151,7 @@ export class RawCoStreamView<
 
     lastItemIn(sessionID: SessionID):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value: Item;
@@ -175,9 +175,9 @@ export class RawCoStreamView<
         }
     }
 
-    lastItemBy(account: AccountID | AgentID):
+    lastItemBy(account: RawAccountID | AgentID):
         | {
-              by: AccountID | AgentID;
+              by: RawAccountID | AgentID;
               tx: TransactionID;
               at: Date;
               value: Item;
@@ -185,7 +185,7 @@ export class RawCoStreamView<
         | undefined {
         let latestItem:
             | {
-                  by: AccountID | AgentID;
+                  by: RawAccountID | AgentID;
                   tx: TransactionID;
                   at: Date;
                   value: Item;
@@ -210,7 +210,7 @@ export class RawCoStreamView<
         return latestItem;
     }
 
-    *itemsBy(account: AccountID | AgentID) {
+    *itemsBy(account: RawAccountID | AgentID) {
         // TODO: this can be made more lazy without a huge collect and sort
         const items = [
             ...Object.keys(this.items).flatMap((sessionID) =>

package/src/coValues/group.ts

@@ -5,9 +5,10 @@ import { JsonObject } from "../jsonValue.js";
 import { RawBinaryCoStream, RawCoStream } from "./coStream.js";
 import { Encrypted, KeyID, KeySecret, Sealed } from "../crypto/crypto.js";
 import { AgentID, isAgentID } from "../ids.js";
-import { RawAccount, AccountID, ControlledAccountOrAgent } from "./account.js";
+import { RawAccount, RawAccountID, ControlledAccountOrAgent } from "./account.js";
 import { Role } from "../permissions.js";
 import { base58 } from "@scure/base";
+import { CoValueUniqueness } from "../coValueCore.js";
 
 export const EVERYONE = "everyone" as const;
 export type Everyone = "everyone";
@@ -15,10 +16,10 @@ export type Everyone = "everyone";
 export type GroupShape = {
     profile: CoID<RawCoMap> | null;
     root: CoID<RawCoMap> | null;
-    [key: AccountID | AgentID]: Role;
+    [key: RawAccountID | AgentID]: Role;
     [EVERYONE]?: Role;
     readKey?: KeyID;
-    [revelationFor: `${KeyID}_for_${AccountID | AgentID}`]: Sealed<KeySecret>;
+    [revelationFor: `${KeyID}_for_${RawAccountID | AgentID}`]: Sealed<KeySecret>;
     [revelationFor: `${KeyID}_for_${Everyone}`]: KeySecret;
     [oldKeyForNewKey: `${KeyID}_for_${KeyID}`]: Encrypted<
         KeySecret,
@@ -55,12 +56,12 @@ export class RawGroup<
      *
      * @category 1. Role reading
      */
-    roleOf(accountID: AccountID): Role | undefined {
+    roleOf(accountID: RawAccountID): Role | undefined {
         return this.roleOfInternal(accountID);
     }
 
     /** @internal */
-    roleOfInternal(accountID: AccountID | AgentID): Role | undefined {
+    roleOfInternal(accountID: RawAccountID | AgentID): Role | undefined {
         return this.get(accountID);
     }
 
@@ -156,7 +157,7 @@ export class RawGroup<
             } else {
                 return false;
             }
-        }) as (AccountID | AgentID)[];
+        }) as (RawAccountID | AgentID)[];
 
         const maybeCurrentReadKey = this.core.getCurrentReadKey();
 
@@ -255,6 +256,7 @@ export class RawGroup<
         init?: M["_shape"],
         meta?: M["headerMeta"],
         initPrivacy: "trusting" | "private" = "private",
+        uniqueness: CoValueUniqueness = this.core.crypto.createdNowUnique()
     ): M {
         const map = this.core.node
             .createCoValue({
@@ -264,7 +266,7 @@ export class RawGroup<
                     group: this.id,
                 },
                 meta: meta || null,
-                ...this.core.crypto.createdNowUnique(),
+                ...uniqueness
             })
             .getCurrentContent() as M;
 
@@ -287,6 +289,7 @@ export class RawGroup<
         init?: L["_item"][],
         meta?: L["headerMeta"],
         initPrivacy: "trusting" | "private" = "private",
+        uniqueness: CoValueUniqueness = this.core.crypto.createdNowUnique()
     ): L {
         const list = this.core.node
             .createCoValue({
@@ -296,7 +299,7 @@ export class RawGroup<
                     group: this.id,
                 },
                 meta: meta || null,
-                ...this.core.crypto.createdNowUnique(),
+                ...uniqueness
             })
             .getCurrentContent() as L;
 
@@ -310,7 +313,7 @@ export class RawGroup<
     }
 
     /** @category 3. Value creation */
-    createStream<C extends RawCoStream>(meta?: C["headerMeta"]): C {
+    createStream<C extends RawCoStream>(meta?: C["headerMeta"], uniqueness: CoValueUniqueness = this.core.crypto.createdNowUnique()): C {
         return this.core.node
             .createCoValue({
                 type: "costream",
@@ -319,7 +322,7 @@ export class RawGroup<
                     group: this.id,
                 },
                 meta: meta || null,
-                ...this.core.crypto.createdNowUnique(),
+                ...uniqueness
             })
             .getCurrentContent() as C;
     }
@@ -327,6 +330,7 @@ export class RawGroup<
     /** @category 3. Value creation */
     createBinaryStream<C extends RawBinaryCoStream>(
         meta: C["headerMeta"] = { type: "binary" },
+        uniqueness: CoValueUniqueness = this.core.crypto.createdNowUnique()
     ): C {
         return this.core.node
             .createCoValue({
@@ -336,7 +340,7 @@ export class RawGroup<
                     group: this.id,
                 },
                 meta: meta,
-                ...this.core.crypto.createdNowUnique(),
+                ...uniqueness
             })
             .getCurrentContent() as C;
     }

package/src/crypto/crypto.ts

@@ -2,6 +2,7 @@ import { JsonValue } from "../jsonValue.js";
 import { base58 } from "@scure/base";
 import { AgentID, RawCoID, TransactionID } from "../ids.js";
 import { Stringified, parseJSON, stableStringify } from "../jsonStringify.js";
+import { RawAccountID, SessionID } from "../index.js";
 
 export type SignerSecret = `signerSecret_z${string}`;
 export type SignerID = `signer_z${string}`;
@@ -290,6 +291,10 @@ export abstract class CryptoProvider<Blake3State = any> {
             }),
         )}`;
     }
+
+    newRandomSessionID(accountID: RawAccountID | AgentID): SessionID {
+        return `${accountID}_session_z${base58.encode(this.randomBytes(8))}`;
+    }
 }
 
 export type Hash = `hash_z${string}`;

package/src/ids.ts

@@ -1,4 +1,4 @@
-import { AccountID } from "./coValues/account.js";
+import { RawAccountID } from "./coValues/account.js";
 import { base58 } from "@scure/base";
 import { shortHashLength } from "./crypto/crypto.js";
 
@@ -28,4 +28,4 @@ export function isAgentID(id: string): id is AgentID {
     );
 }
 
-export type SessionID = `${AccountID | AgentID}_session_z${string}`;
+export type SessionID = `${RawAccountID | AgentID}_session_z${string}`;

package/src/index.ts

@@ -1,6 +1,6 @@
 import {
     CoValueCore,
-    newRandomSessionID,
+    type CoValueUniqueness,
     MAX_RECOMMENDED_TX_SIZE,
     idforHeader,
 } from "./coValueCore.js";
@@ -50,7 +50,7 @@ import type {
 import { DisconnectedError, PingTimeoutError } from "./sync.js";
 import type { AgentSecret } from "./crypto/crypto.js";
 import type {
-    AccountID,
+    RawAccountID,
     AccountMeta,
     RawAccountMigration,
 } from "./coValues/account.js";
@@ -65,7 +65,6 @@ import { getPriorityFromHeader } from "./priority.js";
 
 /** @hidden */
 export const cojsonInternals = {
-    newRandomSessionID,
     connectedPeers,
     rawCoIDtoBytes,
     rawCoIDfromBytes,
@@ -98,7 +97,7 @@ export {
     CoID,
     AnyRawCoValue,
     RawAccount,
-    AccountID,
+    RawAccountID,
     AccountMeta,
     RawAccountMigration,
     RawProfile as Profile,
@@ -132,6 +131,7 @@ export type {
     OutgoingSyncQueue,
     DisconnectedError,
     PingTimeoutError,
+    CoValueUniqueness
 };
 
 // eslint-disable-next-line @typescript-eslint/no-namespace

package/src/localNode.ts

@@ -2,7 +2,7 @@ import { AgentSecret, CryptoProvider } from "./crypto/crypto.js";
 import {
     CoValueCore,
     CoValueHeader,
-    newRandomSessionID,
+    CoValueUniqueness,
 } from "./coValueCore.js";
 import {
     InviteSecret,
@@ -19,7 +19,7 @@ import {
     ControlledAccountOrAgent,
     RawControlledAccount,
     ControlledAgent,
-    AccountID,
+    RawAccountID,
     RawProfile,
     RawAccountMigration,
     InvalidAccountAgentIDError,
@@ -81,14 +81,14 @@ export class LocalNode {
         initialAgentSecret?: AgentSecret;
     }): Promise<{
         node: LocalNode;
-        accountID: AccountID;
+        accountID: RawAccountID;
         accountSecret: AgentSecret;
         sessionID: SessionID;
     }> {
         const throwawayAgent = crypto.newRandomAgentSecret();
         const setupNode = new LocalNode(
             new ControlledAgent(throwawayAgent, crypto),
-            newRandomSessionID(crypto.getAgentID(throwawayAgent)),
+            crypto.newRandomSessionID(crypto.getAgentID(throwawayAgent)),
             crypto,
         );
 
@@ -96,7 +96,7 @@ export class LocalNode {
 
         const nodeWithAccount = account.core.node.testWithDifferentAccount(
             account,
-            newRandomSessionID(account.id),
+            crypto.newRandomSessionID(account.id),
         );
 
         const accountOnNodeWithAccount =
@@ -173,7 +173,7 @@ export class LocalNode {
         crypto,
         migration,
     }: {
-        accountID: AccountID;
+        accountID: RawAccountID;
         accountSecret: AgentSecret;
         sessionID: SessionID | undefined;
         peersToLoadFrom: Peer[];
@@ -182,7 +182,7 @@ export class LocalNode {
     }): Promise<LocalNode> {
         const loadingNode = new LocalNode(
             new ControlledAgent(accountSecret, crypto),
-            newRandomSessionID(accountID),
+            crypto.newRandomSessionID(accountID),
             crypto,
         );
 
@@ -206,7 +206,7 @@ export class LocalNode {
         // since this is all synchronous, we can just swap out nodes for the SyncManager
         const node = loadingNode.testWithDifferentAccount(
             controlledAccount,
-            sessionID || newRandomSessionID(accountID),
+            sessionID || crypto.newRandomSessionID(accountID),
         );
         node.syncManager = loadingNode.syncManager;
         node.syncManager.local = node;
@@ -429,7 +429,7 @@ export class LocalNode {
             group.core
                 .testWithDifferentAccount(
                     new ControlledAgent(inviteAgentSecret, this.crypto),
-                    newRandomSessionID(inviteAgentID),
+                    this.crypto.newRandomSessionID(inviteAgentID),
                 )
                 .getCurrentContent(),
         );
@@ -470,7 +470,7 @@ export class LocalNode {
     }
 
     /** @internal */
-    expectProfileLoaded(id: AccountID, expectation?: string): RawProfile {
+    expectProfileLoaded(id: RawAccountID, expectation?: string): RawProfile {
         const account = this.expectCoValueLoaded(id, expectation);
         const profileID = expectGroup(account.getCurrentContent()).get(
             "profile",
@@ -499,7 +499,7 @@ export class LocalNode {
             )
                 .testWithDifferentAccount(
                     new ControlledAgent(agentSecret, this.crypto),
-                    newRandomSessionID(accountAgentID),
+                    this.crypto.newRandomSessionID(accountAgentID),
                 )
                 .getCurrentContent(),
         );
@@ -533,7 +533,7 @@ export class LocalNode {
 
     /** @internal */
     resolveAccountAgent(
-        id: AccountID | AgentID,
+        id: RawAccountID | AgentID,
         expectation?: string,
     ): Result<AgentID, ResolveAccountAgentError> {
         if (isAgentID(id)) {
@@ -560,7 +560,7 @@ export class LocalNode {
     }
 
     resolveAccountAgentAsync(
-        id: AccountID | AgentID,
+        id: RawAccountID | AgentID,
         expectation?: string,
     ): ResultAsync<AgentID, ResolveAccountAgentError> {
         if (isAgentID(id)) {
@@ -606,12 +606,12 @@ export class LocalNode {
     /**
      * @deprecated use Account.createGroup() instead
      */
-    createGroup(): RawGroup {
+    createGroup(uniqueness: CoValueUniqueness = this.crypto.createdNowUnique()): RawGroup {
         const groupCoValue = this.createCoValue({
             type: "comap",
             ruleset: { type: "group", initialAdmin: this.account.id },
             meta: null,
-            ...this.crypto.createdNowUnique(),
+            ...uniqueness
         });
 
         const group = expectGroup(groupCoValue.getCurrentContent());
@@ -731,19 +731,19 @@ export type LoadCoValueCoreError = {
     type: "ErrorLoadingCoValueCore";
     error: unknown;
     expectation?: string;
-    id: AccountID;
+    id: RawAccountID;
 };
 
 export type AccountUnavailableFromAllPeersError = {
     type: "AccountUnavailableFromAllPeers";
     expectation?: string;
-    id: AccountID;
+    id: RawAccountID;
 };
 
 export type UnexpectedlyNotAccountError = {
     type: "UnexpectedlyNotAccount";
     expectation?: string;
-    id: AccountID;
+    id: RawAccountID;
 };
 
 export type ResolveAccountAgentError =

package/src/permissions.ts

@@ -5,13 +5,13 @@ import { KeyID } from "./crypto/crypto.js";
 import { CoValueCore, Transaction } from "./coValueCore.js";
 import { accountOrAgentIDfromSessionID } from "./typeUtils/accountOrAgentIDfromSessionID.js";
 import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
-import { RawAccount, AccountID, RawProfile } from "./coValues/account.js";
+import { RawAccount, RawAccountID, RawProfile } from "./coValues/account.js";
 import { parseJSON } from "./jsonStringify.js";
 import { EVERYONE, Everyone } from "./coValues/group.js";
 import { expectGroup } from "./typeUtils/expectGroup.js";
 
 export type PermissionsDef =
-    | { type: "group"; initialAdmin: AccountID | AgentID }
+    | { type: "group"; initialAdmin: RawAccountID | AgentID }
     | { type: "ownedByGroup"; group: RawCoID }
     | { type: "unsafeAllowAll" };
 
@@ -53,7 +53,7 @@ export function determineValidTransactions(
         }
 
         const memberState: {
-            [agent: AccountID | AgentID]: Role;
+            [agent: RawAccountID | AgentID]: Role;
             [EVERYONE]?: Role;
         } = {};
 
@@ -99,7 +99,7 @@ export function determineValidTransactions(
             }
 
             const change = changes[0] as
-                | MapOpPayload<AccountID | AgentID | Everyone, Role>
+                | MapOpPayload<RawAccountID | AgentID | Everyone, Role>
                 | MapOpPayload<"readKey", JsonValue>
                 | MapOpPayload<"profile", CoID<RawProfile>>;
             if (changes.length !== 1) {
@@ -303,7 +303,7 @@ export function isKeyForKeyField(co: string): co is `${KeyID}_for_${KeyID}` {
 
 export function isKeyForAccountField(
     co: string,
-): co is `${KeyID}_for_${AccountID | AgentID}` {
+): co is `${KeyID}_for_${RawAccountID | AgentID}` {
     return (
         (co.startsWith("key_") &&
             (co.includes("_for_sealer") || co.includes("_for_co"))) ||

package/src/tests/account.test.ts

@@ -1,5 +1,4 @@
 import { expect, test } from "vitest";
-import { newRandomSessionID } from "../coValueCore.js";
 import { LocalNode } from "../localNode.js";
 import { connectedPeers } from "../streamUtils.js";
 import { WasmCrypto } from "../crypto/WasmCrypto.js";
@@ -65,7 +64,7 @@ test("Can create account with one node, and then load it on another", async () =
     const node2 = await LocalNode.withLoadedAccount({
         accountID,
         accountSecret,
-        sessionID: newRandomSessionID(accountID),
+        sessionID: Crypto.newRandomSessionID(accountID),
         peersToLoadFrom: [node1asPeer],
         crypto: Crypto,
     });