Publish

- jazz-example-pets@0.0.14
 - jazz-example-todo@0.0.39
 - cojson@0.3.5
 - cojson-simple-sync@0.3.7
 - cojson-storage-indexeddb@0.3.5
 - cojson-storage-sqlite@0.3.7
 - jazz-browser@0.3.5
 - jazz-browser-auth-local@0.3.5
 - jazz-browser-media-images@0.3.5
 - jazz-react@0.3.5
 - jazz-react-auth-local@0.3.5
 - jazz-react-media-images@0.3.5

README.md

@@ -1,82 +1,116 @@
 # Jazz - instant sync
 
-Homepage: [jazz.tools](https://jazz.tools) — [Discord](https://discord.gg/utDMjHYg42)
+<sub>Homepage: [jazz.tools](https://jazz.tools) &mdash; Docs: [DOCS.md](./DOCS.md) &mdash; Community & support: [Discord](https://discord.gg/utDMjHYg42) &mdash; Updates: [Twitter](https://twitter.com/jazz_tools) & [Email](https://gcmp.io/news)</sub>
 
-Jazz is an open-source toolkit for *secure telepathic data.*
+ **Jazz is an open-source toolkit for building apps with *secure sync.***
 
-- Ship faster & simplify your frontend and backend
-- Get cross-device sync, real-time collaboration & offline support for free
+Quickly build and ship apps with:
 
-[Jazz Global Mesh](https://jazz.tools/mesh) is serverless sync & storage for Jazz apps. (currently free!)
+- **Cross-device sync**
+- **Collaborative features** (incl. real-time multiplayer)
+- **Instantly reacting UIs**
+- Local-first storage & offline support
+- File upload and real-time media streaming
+
+# What is *secure sync*?
+
+**Sync** means that, *instead of making API requests*, you:
+
+- **Read and write data as if it was local** &mdash; from anywhere in your app.
+- **Always have data synced to wherever it's needed, instantly:** to other devices of the same user, to other users, to your backend, to your local machine for debugging, etc.
+
+**Secure** means that, *instead of relying on your API or DB for access control*, you:
+
+- **Set fine-grained, role-based permissions in `Group`s** that are **synced along with your data**.
+- **Permissions *verifiably enforced* everywhere,** using encryption & signatures under the hood.
+- **Change roles dynamically** for evolving teams, expiring invite links and more.
+
+# What's special about Jazz?
+
+Compared to other libraries and frameworks for local-first, sync-based or real-time apps, these are some of the things that make Jazz unique:
+
+- **Jazz is a *batteries-included,* vertically integrated toolkit,** offering everything you need to build an app, including auth, permissions, data model, sync, conflict resolution, blob storage, file uploads, real-time media streaming and more.
+- **Jazz has a *small API surface* of only a few abstractions to learn,** which combine in powerful ways to implement a broad set of features.
+- **Jazz *granularly* loads and caches *only the data that is needed*,** combining *local-first* instant UI reactivity and offline support with the on-demand data efficiency of conventional APIs
+- **Jazz supports end-to-end encryption, but doesn't require it,** allowing you to either manage your user's secret keys for them (based on existing auth flows) or letting your users
+- **Jazz is based on CoJSON, a soon-to-be *open standard,*** which means that there will be a whole ecosystem of compatible libraries and frameworks in a variety of environments &mdash; and it will be easy to achieve (secure) interop between Jazz/CoJSON-based apps and services.
+
+# Jazz Global Mesh
+
+Jazz is open source and you can run your own sync & storage server, but to really provide you with everything you need, we're also running
+**[Jazz Global Mesh](https://jazz.tools/mesh)**, a globally distributed mesh of servers optimized for:
+
+ - **Ultra-low-latency sync** (with geo-aware edge caching and optimal routing)
+ - **Low-cost, reliable storage**
 
 
+**Jazz Global Mesh is free for small volumes of data** and it's the **default syncing peer,** so you can  **start building multi-user Jazz apps with persistent data in minutes,** using only frontend code!
 
-## What is Secure Telepathic Data?
+# Getting started
 
-**Telepathic** means:
+## Example App Walkthrough
 
-- **Read and write data as if it was local,** from anywhere in your app.
-- **Always have that data synced, instantly.** Across devices of the same user &mdash; or to other users (coming soon: to your backend, workers, etc.)
+**For now the best tutorial is the walkthrough of the [Todo List Example App](#todo-list).**
 
-**Secure** means:
+## General Scenarios
 
-- **Fine-grained, role-based permissions are *baked into* your data.**
-- **Permissions are enforced everywhere, locally.** (using cryptography instead of through an API)
-- Roles can be changed dynamically, supporting changing teams, invite links and more.
+### Building a new, entirely sync-based React app
 
-## How to build an app with Jazz?
+1. Define your data model with [cojson Collaborative Values (CoValues)](./DOCS.md/#covalue).
+2. Implement permission logic using [cojson Groups](./DOCS.md/#group).
+3. Build a user interface with [jazz-react](./DOCS.md/#jazz-react)'s reactive [synced queries](./DOCS.md/#usesyncedqueryid).
 
-### Building a new app, completely with Jazz
+### Gradually adding sync to an existing React app
 
-It's still a bit early, but these are the rough steps:
+Gradually migrate app features to use sync:
 
-1. Define your data model with [CoJSON Values](#cojson).
-2. Implement permission logic using [CoJSON Groups](#group).
-3. Hook up a user interface with [jazz-react](#jazz-react).
+1. Define data model for small aspect of your app with [cojson Collaborative Values (CoValues)](./DOCS.md/#covalue).
+    - Schema adapters/importers for Prisma/Drizzle/PostgreSQL introspection coming soon.
+2. Map existing permission logic with [cojson Groups](./DOCS.md/#group) & integrate existing auth.
+    - Auth integrations coming soon.
+3. Replace some of the React state and API requests in your UI with [jazz-react](./DOCS.md/#jazz-react)'s reactive [synced queries](./DOCS.md/#usesyncedqueryid).
 
-The best example is currently the [Todo List app](#example-app-todo-list).
+# Example Apps
 
-### Gradually adding Jazz to an existing app
+## Todo List
 
-Coming soon: Jazz will support gradual adoption by integrating with your existing UI, auth and database.
+**A simple collaborative todo list app.**
 
-## Example App: Todo List
+Live version: https://example-todo.jazz.tools
 
-The best example of Jazz is currently the Todo List app.
+Source code & walkthrough: [`./examples/todo`](./examples/todo)
 
-- Live version: https://example-todo.jazz.tools
-- Source code: [`./examples/todo`](./examples/todo). See the README there for a walk-through and running instructions.
+Demonstrates:
+  - Defining a data model with `CoMap`s and `CoList`s
+  - Creating data and setting permissions with `Group`s
+  - Fetching, rendering & editing data from nested `CoValue`s with reactive synced queries
 
-# Documentation
 
-Note: Since it's early days, this is the only source of documentation so far.
+## Rate-My-Pet
 
-If you want to build something with Jazz, [join the Jazz Discord](https://discord.gg/utDMjHYg42) for encouragement and help!
+**A simple social polling app.**
 
-## Overview: Main Packages
+Live version: https://example-pets.jazz.tools
 
-**`cojson`** → [DOCS](./DOCS.md#cojson)
+Source code (walkthrough coming soon): [`./examples/pets`](./examples/pets)
 
-A library implementing abstractions and protocols for "Collaborative JSON". This will soon be standardized and forms the basis of secure telepathic data.
+Demonstrates:
+  - Implementing per-account data streams (reactions) with `CoStream`s
+  - Implementing image upload and progressive image streaming using helpers from `jazz-react-media-images` (on top of CoJSON's `BinaryCoStreams` & `ImageDefinition` convention)
 
-**`jazz-react`** → [DOCS](./DOCS.md#jazz-react)
 
-Provides you with everything you need to build react apps around CoJSON, including reactive hooks for telepathic data, local IndexedDB persistence, support for different auth providers and helpers for simple invite links for CoJSON groups.
+# Documentation & API Reference
 
-### Supporting packages
-<small>
+For now, docs are hosted in a single well-structured markdown file: [`./DOCS.md`](./DOCS.md).
 
-**`cojson-simple-sync`**
+- [Package Overview](./DOCS.md/#overview)
+- [`jazz-react` API](./DOCS.md/#jazz-react)
+- [`cojson` API](./DOCS.md/#cojson)
+- [`jazz-react-media-images` API](./DOCS.md/#jazz-react-media-images)
 
-A generic CoJSON sync server you can run locally if you don't want to use Jazz Global Mesh (the default sync backend, at `wss://sync.jazz.tools`)
 
-**`jazz-browser`**  → [DOCS](./DOCS.md#jazz-browser)
+In the future we'll build a dedicated docs page on the Jazz homepage.
 
-framework-agnostic primitives that allow you to use CoJSON in the browser. Used to implement `jazz-react`, will be used to implement bindings for other frameworks in the future.
+----
 
-**`jazz-react-auth-local`** (and `jazz-browser-auth-local`): A simple auth provider that stores cryptographic keys on user devices using WebAuthentication/Passkeys. Lets you build Jazz apps completely without a backend, with end-to-end encryption by default.
-
-**`jazz-storage-indexeddb`**
-
-Provides local, offline-capable persistence. Included and enabled in `jazz-react` by default.
-</small>
+Copyright 2023 &mdash; Garden Computing, Inc.

examples/pets/index.html

@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="/src/0_main.tsx"></script>
+    <script type="module" src="/src/2_main.tsx"></script>
   </body>
 </html>

examples/pets/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jazz-example-pets",
   "private": true,
-  "version": "0.0.8",
+  "version": "0.0.14",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -16,13 +16,15 @@
     "@types/qrcode": "^1.5.1",
     "class-variance-authority": "^0.7.0",
     "clsx": "^2.0.0",
-    "jazz-react": "^0.2.4",
-    "jazz-react-auth-local": "^0.2.4",
-    "jazz-react-media-images": "^0.2.4",
+    "jazz-react": "^0.3.5",
+    "jazz-react-auth-local": "^0.3.5",
+    "jazz-react-media-images": "^0.3.5",
     "lucide-react": "^0.274.0",
     "qrcode": "^1.5.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "react-router": "^6.16.0",
+    "react-router-dom": "^6.16.0",
     "tailwind-merge": "^1.14.0",
     "tailwindcss-animate": "^1.0.7",
     "uniqolor": "^1.1.0"

examples/pets/src/0_main.tsx

@@ -1,38 +0,0 @@
-import React from "react";
-import ReactDOM from "react-dom/client";
-import "./index.css";
-
-import { WithJazz } from "jazz-react";
-import { LocalAuth } from "jazz-react-auth-local";
-
-import { ThemeProvider, TitleAndLogo } from "./basicComponents/index.ts";
-import { PrettyAuthUI } from "./components/Auth.tsx";
-import App from "./2_App.tsx";
-
-/** Walkthrough: The top-level provider `<WithJazz/>`
- *
- *  This shows how to use the top-level provider `<WithJazz/>`,
- *  which provides the rest of the app with a `LocalNode` (used through `useJazz` later),
- *  based on `LocalAuth` that uses PassKeys (aka WebAuthn) to store a user's account secret
- *  - no backend needed. */
-
-const appName = "Jazz Rate My Pet Example";
-
-const auth = LocalAuth({
-    appName,
-    Component: PrettyAuthUI,
-});
-
-ReactDOM.createRoot(document.getElementById("root")!).render(
-    <React.StrictMode>
-        <ThemeProvider>
-            <TitleAndLogo name={appName} />
-
-            <WithJazz auth={auth}>
-                <App />
-            </WithJazz>
-        </ThemeProvider>
-    </React.StrictMode>
-);
-
-/** Walkthrough: Continue with ./1_types.ts */

examples/pets/src/1_types.ts

@@ -1,4 +1,4 @@
-import { CoMap, CoID, CoStream, Media } from "cojson";
+import { CoMap, CoStream, Media } from "cojson";
 
 /** Walkthrough: Defining the data model with CoJSON
  *
@@ -9,8 +9,8 @@ import { CoMap, CoID, CoStream, Media } from "cojson";
 
 export type PetPost = CoMap<{
     name: string;
-    image: CoID<Media.ImageDefinition>;
-    reactions: CoID<PetReactions>;
+    image: Media.ImageDefinition;
+    reactions: PetReactions;
 }>;
 
 export const REACTION_TYPES = [

examples/pets/src/2_App.tsx

@@ -1,48 +0,0 @@
-import { useJazz } from "jazz-react";
-
-import { PetPost } from "./1_types";
-
-import { Button } from "./basicComponents";
-
-import { useSimpleHashRouterThatAcceptsInvites } from "./router";
-import { RatePetPostUI } from "./4_RatePetPostUI";
-import { CreatePetPostForm } from "./3_CreatePetPostForm";
-
-/** Walkthrough: Creating pet posts & routing in `<App/>`
- *
- *  <App> is the main app component, handling client-side routing based
- *  on the CoValue ID (CoID) of our PetPost, stored in the URL hash
- *  - which can also contain invite links.
- */
-
-export default function App() {
-    // A `LocalNode` represents a local view of loaded & created CoValues.
-    // It is associated with a current user account, which will determine
-    // access rights to CoValues. We get it from the top-level provider `<WithJazz/>`.
-    const { localNode, logOut } = useJazz();
-
-    // This sets up routing and accepting invites, skip for now
-    const [currentPetPostID, navigateToPetPostID] =
-        useSimpleHashRouterThatAcceptsInvites<PetPost>(localNode);
-
-    return (
-        <div className="flex flex-col h-full items-center justify-start gap-10 pt-10 pb-10 px-5">
-            {currentPetPostID ? (
-                <RatePetPostUI petPostID={currentPetPostID} />
-            ) : (
-                <CreatePetPostForm onCreate={navigateToPetPostID} />
-            )}
-            <Button
-                onClick={() => {
-                    navigateToPetPostID(undefined);
-                    logOut();
-                }}
-                variant="outline"
-            >
-                Log Out
-            </Button>
-        </div>
-    );
-}
-
-/** Walkthrough: continue with ./3_CreatePetPostForm.tsx */

examples/pets/src/2_main.tsx

@@ -0,0 +1,86 @@
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { RouterProvider, createHashRouter } from "react-router-dom";
+import "./index.css";
+
+import { WithJazz, useJazz, useAcceptInvite } from "jazz-react";
+import { LocalAuth } from "jazz-react-auth-local";
+
+import {
+    Button,
+    ThemeProvider,
+    TitleAndLogo,
+} from "./basicComponents/index.ts";
+import { PrettyAuthUI } from "./components/Auth.tsx";
+import { NewPetPostForm } from "./3_NewPetPostForm.tsx";
+import { RatePetPostUI } from "./4_RatePetPostUI.tsx";
+
+/** Walkthrough: The top-level provider `<WithJazz/>`
+ *
+ *  This shows how to use the top-level provider `<WithJazz/>`,
+ *  which provides the rest of the app with a `LocalNode` (used through `useJazz` later),
+ *  based on `LocalAuth` that uses PassKeys (aka WebAuthn) to store a user's account secret
+ *  - no backend needed. */
+
+const appName = "Jazz Rate My Pet Example";
+
+const auth = LocalAuth({
+    appName,
+    Component: PrettyAuthUI,
+});
+
+ReactDOM.createRoot(document.getElementById("root")!).render(
+    <React.StrictMode>
+        <WithJazz auth={auth}>
+            <App />
+        </WithJazz>
+    </React.StrictMode>
+);
+
+/** Walkthrough: Creating pet posts & routing in `<App/>`
+ *
+ *  <App> is the main app component, handling client-side routing based
+ *  on the CoValue ID (CoID) of our PetPost, stored in the URL hash
+ *  - which can also contain invite links.
+ */
+
+export default function App() {
+    const { logOut } = useJazz();
+
+    const router = createHashRouter([
+        {
+            path: "/",
+            element: <NewPetPostForm />,
+        },
+        {
+            path: "/pet/:petPostId",
+            element: <RatePetPostUI />,
+        },
+        {
+            path: "/invite/*",
+            element: <p>Accepting invite...</p>,
+        },
+    ]);
+
+    useAcceptInvite((petPostID) => router.navigate("/pet/" + petPostID));
+
+    return (
+        <ThemeProvider>
+            <TitleAndLogo name={appName} />
+            <div className="flex flex-col h-full items-center justify-start gap-10 pt-10 pb-10 px-5">
+                <RouterProvider router={router} />
+
+                <Button
+                    onClick={() => router.navigate("/").then(logOut)}
+                    variant="outline"
+                >
+                    Log Out
+                </Button>
+            </div>
+        </ThemeProvider>
+    );
+}
+
+/** Walkthrough: continue with ./3_CreatePetPostForm.tsx */
+
+/** Walkthrough: Continue with ./1_types.ts */

examples/pets/src/3_NewPetPostForm.tsx

@@ -1,10 +1,11 @@
 import { ChangeEvent, useCallback, useState } from "react";
+import { useNavigate } from "react-router";
 
-import { CoID } from "cojson";
-import { useJazz, useTelepathicState } from "jazz-react";
+import { CoID, CoMap, Media } from "cojson";
+import { useJazz, useSyncedQuery } from "jazz-react";
 import { createImage } from "jazz-browser-media-images";
 
-import { PetPost, PetReactions } from "./1_types";
+import { PetReactions } from "./1_types";
 
 import { Input, Button } from "./basicComponents";
 import { useLoadImage } from "jazz-react-media-images";
@@ -12,37 +13,35 @@ import { useLoadImage } from "jazz-react-media-images";
 /** Walkthrough: TODO
  */
 
-export function CreatePetPostForm({
-    onCreate,
-}: {
-    onCreate: (id: CoID<PetPost>) => void;
-}) {
+type PartialPetPost = CoMap<{
+    name: string;
+    image?: Media.ImageDefinition;
+    reactions: PetReactions;
+}>;
+
+export function NewPetPostForm() {
     const { localNode } = useJazz();
+    const navigate = useNavigate();
 
-    const [newPostId, setNewPostId] = useState<CoID<PetPost> | undefined>(
-        undefined
-    );
+    const [newPostId, setNewPostId] = useState<
+        CoID<PartialPetPost> | undefined
+    >(undefined);
 
-    const newPetPost = useTelepathicState(newPostId);
+    const newPetPost = useSyncedQuery(newPostId);
 
     const onChangeName = useCallback(
         (name: string) => {
-            let petPost = newPetPost;
-            if (!petPost) {
+            if (newPetPost) {
+                newPetPost.set({ name });
+            } else {
                 const petPostGroup = localNode.createGroup();
-                petPost = petPostGroup.createMap<PetPost>();
-                const petReactions = petPostGroup.createStream<PetReactions>();
-
-                petPost = petPost.edit((petPost) => {
-                    petPost.set("reactions", petReactions.id);
+                const petPost = petPostGroup.createMap<PartialPetPost>({
+                    name,
+                    reactions: petPostGroup.createStream<PetReactions>(),
                 });
 
                 setNewPostId(petPost.id);
             }
-
-            petPost.edit((petPost) => {
-                petPost.set("name", name);
-            });
         },
         [localNode, newPetPost]
     );
@@ -51,19 +50,17 @@ export function CreatePetPostForm({
         async (event: ChangeEvent<HTMLInputElement>) => {
             if (!newPetPost || !event.target.files) return;
 
-            const imageDefinition = await createImage(
+            const image = await createImage(
                 event.target.files[0],
                 newPetPost.group
             );
 
-            newPetPost.edit((petPost) => {
-                petPost.set("image", imageDefinition.id);
-            });
+            newPetPost.set({ image });
         },
         [newPetPost]
     );
 
-    const petImage = useLoadImage(newPetPost?.get("image"));
+    const petImage = useLoadImage(newPetPost?.image?.id);
 
     return (
         <div className="flex flex-col gap-10">
@@ -73,7 +70,7 @@ export function CreatePetPostForm({
                 placeholder="Pet Name"
                 className="text-3xl py-6"
                 onChange={(event) => onChangeName(event.target.value)}
-                value={newPetPost?.get("name") || ""}
+                value={newPetPost?.name || ""}
             />
 
             {petImage ? (
@@ -84,15 +81,15 @@ export function CreatePetPostForm({
             ) : (
                 <Input
                     type="file"
-                    disabled={!newPetPost?.get("name")}
+                    disabled={!newPetPost?.name}
                     onChange={onImageSelected}
                 />
             )}
 
-            {newPetPost?.get("name") && newPetPost?.get("image") && (
+            {newPetPost?.name && newPetPost?.image && (
                 <Button
                     onClick={() => {
-                        onCreate(newPetPost.id);
+                        navigate("/pet/" + newPetPost.id);
                     }}
                 >
                     Submit Post

examples/pets/src/4_RatePetPostUI.tsx

@@ -1,12 +1,13 @@
-import { AccountID, CoID } from "cojson";
-import { useTelepathicState } from "jazz-react";
+import { useParams } from "react-router";
+import { CoID, Queried } from "cojson";
+import { useSyncedQuery } from "jazz-react";
 
-import { PetPost, PetReactions, ReactionType, REACTION_TYPES } from "./1_types";
+import { PetPost, ReactionType, REACTION_TYPES, PetReactions } from "./1_types";
 
 import { ShareButton } from "./components/ShareButton";
-import { NameBadge } from "./components/NameBadge";
-import { Button } from "./basicComponents";
+import { Button, Skeleton } from "./basicComponents";
 import { useLoadImage } from "jazz-react-media-images";
+import uniqolor from "uniqolor";
 
 /** Walkthrough: TODO
  */
@@ -20,15 +21,16 @@ const reactionEmojiMap: { [reaction in ReactionType]: string } = {
     chonkers: "🐘",
 };
 
-export function RatePetPostUI({ petPostID }: { petPostID: CoID<PetPost> }) {
-    const petPost = useTelepathicState(petPostID);
-    const petReactions = useTelepathicState(petPost?.get("reactions"));
-    const petImage = useLoadImage(petPost?.get("image"));
+export function RatePetPostUI() {
+    const petPostID = useParams<{ petPostId: CoID<PetPost> }>().petPostId;
+
+    const petPost = useSyncedQuery(petPostID);
+    const petImage = useLoadImage(petPost?.image);
 
     return (
         <div className="flex flex-col gap-8">
             <div className="flex justify-between">
-                <h1 className="text-3xl font-bold">{petPost?.get("name")}</h1>
+                <h1 className="text-3xl font-bold">{petPost?.name}</h1>
                 <ShareButton petPost={petPost} />
             </div>
 
@@ -44,14 +46,12 @@ export function RatePetPostUI({ petPostID }: { petPostID: CoID<PetPost> }) {
                     <Button
                         key={reactionType}
                         variant={
-                            petReactions?.getLastItemFromMe() === reactionType
+                            petPost?.reactions?.me?.last === reactionType
                                 ? "default"
                                 : "outline"
                         }
                         onClick={() => {
-                            petReactions?.edit((reactions) => {
-                                reactions.push(reactionType);
-                            });
+                            petPost?.reactions?.push(reactionType);
                         }}
                         title={`React with ${reactionType}`}
                         className="text-2xl px-2"
@@ -61,26 +61,28 @@ export function RatePetPostUI({ petPostID }: { petPostID: CoID<PetPost> }) {
                 ))}
             </div>
 
-            {petPost?.group.myRole() === "admin" && petReactions && (
-                <ReactionOverview petReactions={petReactions} />
+            {petPost?.group.myRole() === "admin" && petPost.reactions && (
+                <ReactionOverview petReactions={petPost.reactions} />
             )}
         </div>
     );
 }
 
-function ReactionOverview({ petReactions }: { petReactions: PetReactions }) {
+function ReactionOverview({
+    petReactions,
+}: {
+    petReactions: Queried<PetReactions>;
+}) {
     return (
         <div>
             <h2>Reactions</h2>
             <div className="flex flex-col gap-1">
                 {REACTION_TYPES.map((reactionType) => {
-                    const accountsWithThisReaction = Object.entries(
-                        petReactions.getLastItemsPerAccount()
-                    ).flatMap(([accountID, reaction]) =>
-                        reaction === reactionType ? [accountID] : []
-                    );
+                    const reactionsOfThisType = Object.values(
+                        petReactions.perAccount
+                    ).filter(({ last }) => last === reactionType);
 
-                    if (accountsWithThisReaction.length === 0) return null;
+                    if (reactionsOfThisType.length === 0) return null;
 
                     return (
                         <div
@@ -88,12 +90,22 @@ function ReactionOverview({ petReactions }: { petReactions: PetReactions }) {
                             key={reactionType}
                         >
                             {reactionEmojiMap[reactionType]}{" "}
-                            {accountsWithThisReaction.map((accountID) => (
-                                <NameBadge
-                                    key={accountID}
-                                    accountID={accountID as AccountID}
-                                />
-                            ))}
+                            {reactionsOfThisType.map((reaction, idx) =>
+                                reaction.by?.profile?.name ? (
+                                    <span
+                                        className="rounded-full py-0.5 px-2 text-xs"
+                                        style={uniqueColoring(reaction.by.id)}
+                                        key={reaction.by.id}
+                                    >
+                                        {reaction.by.profile.name}
+                                    </span>
+                                ) : (
+                                    <Skeleton
+                                        className="mt-1 w-[50px] h-[1em] rounded-full"
+                                        key={idx}
+                                    />
+                                )
+                            )}
                         </div>
                     );
                 })}
@@ -101,3 +113,12 @@ function ReactionOverview({ petReactions }: { petReactions: PetReactions }) {
         </div>
     );
 }
+
+function uniqueColoring(seed: string) {
+    const darkMode = window.matchMedia("(prefers-color-scheme: dark)").matches;
+
+    return {
+        color: uniqolor(seed, { lightness: darkMode ? 80 : 20 }).color,
+        background: uniqolor(seed, { lightness: darkMode ? 20 : 80 }).color,
+    };
+}

examples/pets/src/components/NameBadge.tsx

@@ -1,46 +0,0 @@
-import { AccountID } from "cojson";
-import { useProfile } from "jazz-react";
-
-import { Skeleton } from "@/basicComponents";
-import uniqolor from "uniqolor";
-
-/** Walkthrough: Getting user profiles in `<NameBadge/>`
- *
- *  `<NameBadge/>` uses `useProfile(accountID)`, which is a shorthand for
- *  useTelepathicState on an account's profile.
- *
- *  Profiles are always a `CoMap<{name: string}>`, but they might have app-specific
- *  additional properties).
- *
- *  In our case, we just display the profile name (which is set by the LocalAuth
- *  provider when we first create an account).
- */
-
-export function NameBadge({ accountID }: { accountID?: AccountID }) {
-    const profile = useProfile(accountID);
-
-    return accountID && profile?.get("name") ? (
-        <span
-            className="rounded-full py-0.5 px-2 text-xs"
-            style={randomUserColor(accountID)}
-        >
-            {profile.get("name")}
-        </span>
-    ) : (
-        <Skeleton className="mt-1 w-[50px] h-[1em] rounded-full" />
-    );
-}
-
-function randomUserColor(accountID: AccountID) {
-    const theme = window.matchMedia("(prefers-color-scheme: dark)").matches
-        ? "dark"
-        : "light";
-
-    const brightColor = uniqolor(accountID || "", { lightness: 80 }).color;
-    const darkColor = uniqolor(accountID || "", { lightness: 20 }).color;
-
-    return {
-        color: theme == "light" ? darkColor : brightColor,
-        background: theme == "light" ? brightColor : darkColor,
-    };
-}

examples/pets/src/components/ShareButton.tsx

@@ -6,8 +6,9 @@ import { createInviteLink } from "jazz-react";
 import QRCode from "qrcode";
 
 import { useToast, Button } from "../basicComponents";
+import { Queried } from "cojson";
 
-export function ShareButton({ petPost }: { petPost?: PetPost }) {
+export function ShareButton({ petPost }: { petPost?: Queried<PetPost> }) {
     const [existingInviteLink, setExistingInviteLink] = useState<string>();
     const { toast } = useToast();
 

examples/pets/src/router.ts

@@ -1,37 +0,0 @@
-import { useCallback, useEffect, useState } from "react";
-import { CoID, LocalNode, CoValueImpl } from "cojson";
-import { consumeInviteLinkFromWindowLocation } from "jazz-react";
-
-export function useSimpleHashRouterThatAcceptsInvites<C extends CoValueImpl>(
-    localNode: LocalNode
-) {
-    const [currentValueId, setCurrentValueId] = useState<CoID<C>>();
-
-    useEffect(() => {
-        const listener = async () => {
-            const acceptedInvitation = await consumeInviteLinkFromWindowLocation<C>(localNode);
-
-            if (acceptedInvitation) {
-                setCurrentValueId(acceptedInvitation.valueID);
-                window.location.hash = acceptedInvitation.valueID;
-                return;
-            }
-
-            setCurrentValueId(
-                (window.location.hash.slice(1) as CoID<C>) || undefined
-            );
-        };
-        window.addEventListener("hashchange", listener);
-        listener();
-
-        return () => {
-            window.removeEventListener("hashchange", listener);
-        };
-    }, [localNode]);
-
-    const navigateToValue = useCallback((id: CoID<C> | undefined) => {
-        window.location.hash = id || "";
-    }, []);
-
-    return [currentValueId, navigateToValue] as const;
-}

examples/todo/README.md

@@ -27,29 +27,28 @@ npm run dev
 
 ## Structure
 
-- [`src/basicComponents`](./src/basicComponents) contains simple components to build the UI, unrelated to Jazz (powered by [shadcn/ui](https://ui.shadcn.com))
-- [`src/components`](./src/components/) contains helper components that do contain Jazz-specific logic, but are not super relevant to understand the basics of Jazz and CoJSON
-- [`src/0_main.tsx`](./src/0_main.tsx), [`src/1_types.ts`](./src/1_types.ts), [`src/2_App.tsx`](./src/2_App.tsx), [`src/3_TodoTable.tsx`](./src/3_TodoTable.tsx), [`src/router.ts`](./src/router.ts) - the main files for this example, see the walkthrough below
+- [`src/basicComponents`](./src/basicComponents): simple components to build the UI, unrelated to Jazz (uses [shadcn/ui](https://ui.shadcn.com))
+- [`src/components`](./src/components/): helper components that do contain Jazz-specific logic, but aren't very relevant to understand the basics of Jazz and CoJSON
+- [`src/1_types.ts`](./src/1_types.ts),
+[`src/2_main.tsx`](./src/2_main.tsx),
+[`src/3_NewProjectForm.tsx`](./src/3_NewProjectForm.tsx),
+[`src/4_ProjectTodoTable.tsx`](./src/4_ProjectTodoTable.tsx): the main files for this example, see the walkthrough below
 
 ## Walkthrough
 
 ### Main parts
 
-- The top-level provider `<WithJazz/>`: [`src/0_main.tsx`](./src/0_main.tsx)
+1. Defining the data model with CoJSON: [`src/1_types.ts`](./src/1_types.ts)
 
-- Defining the data model with CoJSON: [`src/1_types.ts`](./src/1_types.ts)
+2. The top-level provider `<WithJazz/>` and routing: [`src/2_main.tsx`](./src/2_main.tsx)
 
-- Creating todo projects & routing in `<App/>`: [`src/2_App.tsx`](./src/2_App.tsx)
+3. Creating a new todo project: [`src/3_NewProjectForm.tsx`](./src/3_NewProjectForm.tsx)
 
-- Reactively rendering a todo project as a table, adding and editing tasks: [`src/3_TodoTable.tsx`](./src/3_TodoTable.tsx)
+4. Reactively rendering a todo project as a table, adding and editing tasks: [`src/4_ProjectTodoTable.tsx`](./src/4_ProjectTodoTable.tsx)
 
 ### Helpers
 
-- Getting user profiles in `<NameBadge/>`: [`src/components/NameBadge.tsx`](./src/components/NameBadge.tsx)
-
-- (not yet commented) Creating invite links/QR codes with `<InviteButton/>`: [`src/components/InviteButton.tsx`](./src/components/InviteButton.tsx)
-
-- (not yet commented) `location.hash`-based routing and accepting invite links with `useSimpleHashRouterThatAcceptsInvites()` in [`src/router.ts`](./src/router.ts)
+- (not yet explained) Creating invite links/QR codes with `<InviteButton/>`: [`src/components/InviteButton.tsx`](./src/components/InviteButton.tsx)
 
 This is the whole Todo List app!
 
@@ -62,4 +61,4 @@ If you have feedback, let us know on [Discord](https://discord.gg/utDMjHYg42) or
 
 By default, the example app uses [Jazz Global Mesh](https://jazz.tools/mesh) (`wss://sync.jazz.tools`) - so cross-device use, invites and collaboration should just work.
 
-You can also run a local sync server by running `npx cojson-simple-sync` and adding the query param `?sync=ws://localhost:4200` to the URL of the example app (for example: `http://localhost:5173/?sync=ws://localhost:4200`), or by setting the `sync` parameter of the `<WithJazz>` provider component in [./src/0_main.tsx](./src/0_main.tsx).
+You can also run a local sync server by running `npx cojson-simple-sync` and adding the query param `?sync=ws://localhost:4200` to the URL of the example app (for example: `http://localhost:5173/?sync=ws://localhost:4200`), or by setting the `sync` parameter of the `<WithJazz>` provider component in [./src/2_main.tsx](./src/2_main.tsx).

examples/todo/index.html

@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="/src/0_main.tsx"></script>
+    <script type="module" src="/src/2_main.tsx"></script>
   </body>
 </html>

examples/todo/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jazz-example-todo",
   "private": true,
-  "version": "0.0.33",
+  "version": "0.0.39",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -16,12 +16,14 @@
     "@types/qrcode": "^1.5.1",
     "class-variance-authority": "^0.7.0",
     "clsx": "^2.0.0",
-    "jazz-react": "^0.2.4",
-    "jazz-react-auth-local": "^0.2.4",
+    "jazz-react": "^0.3.5",
+    "jazz-react-auth-local": "^0.3.5",
     "lucide-react": "^0.274.0",
     "qrcode": "^1.5.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "react-router": "^6.16.0",
+    "react-router-dom": "^6.16.0",
     "tailwind-merge": "^1.14.0",
     "tailwindcss-animate": "^1.0.7",
     "uniqolor": "^1.1.0"

examples/todo/src/0_main.tsx

@@ -1,38 +0,0 @@
-import React from "react";
-import ReactDOM from "react-dom/client";
-import "./index.css";
-
-import { WithJazz } from "jazz-react";
-import { LocalAuth } from "jazz-react-auth-local";
-
-import { ThemeProvider, TitleAndLogo } from "./basicComponents/index.ts";
-import { PrettyAuthUI } from "./components/Auth.tsx";
-import App from "./2_App.tsx";
-
-/** Walkthrough: The top-level provider `<WithJazz/>`
- *
- *  This shows how to use the top-level provider `<WithJazz/>`,
- *  which provides the rest of the app with a `LocalNode` (used through `useJazz` later),
- *  based on `LocalAuth` that uses PassKeys (aka WebAuthn) to store a user's account secret
- *  - no backend needed. */
-
-const appName = "Jazz Todo List Example";
-
-const auth = LocalAuth({
-    appName,
-    Component: PrettyAuthUI,
-});
-
-ReactDOM.createRoot(document.getElementById("root")!).render(
-    <React.StrictMode>
-        <ThemeProvider>
-            <TitleAndLogo name={appName} />
-
-            <WithJazz auth={auth}>
-                <App />
-            </WithJazz>
-        </ThemeProvider>
-    </React.StrictMode>
-);
-
-/** Walkthrough: Continue with ./1_types.ts */

examples/todo/src/1_types.ts

@@ -1,28 +1,23 @@
-import { CoMap, CoList, CoID } from "cojson";
+import { CoMap, CoList } from "cojson";
 
 /** Walkthrough: Defining the data model with CoJSON
  *
  *  Here, we define our main data model of tasks, lists of tasks and projects
  *  using CoJSON's collaborative map and list types, CoMap & CoList.
  *
- *  CoMap values and CoLists items can be:
+ *  CoMap values and CoLists items can contain:
  *  - arbitrary immutable JSON
- *  - references to other CoValues by their CoID
- *    - CoIDs are strings that look like `co_zXPuWmH1D1cKdMpDW6CMzWb3LpY`
- *    - In TypeScript, CoIDs take a generic parameter for the type of the
- *      referenced CoValue, e.g. `CoID<Task>` - to make the references precise
+ *  - references to other CoValues (internally stored by their CoID)
  **/
 
 /** An individual task which collaborators can tick or rename */
 export type Task = CoMap<{ done: boolean; text: string; }>;
 
-/** A collaborative, ordered list of task references */
-export type ListOfTasks = CoList<CoID<Task>>;
-
 /** Our top level object: a project with a title, referencing a list of tasks */
 export type TodoProject = CoMap<{
     title: string;
-    tasks: CoID<ListOfTasks>;
+    /** A collaborative, ordered list of tasks */
+    tasks: CoList<Task>;
 }>;
 
-/** Walkthrough: Continue with ./2_App.tsx */
+/** Walkthrough: Continue with ./2_main.tsx */

examples/todo/src/2_App.tsx

@@ -1,78 +0,0 @@
-import { useCallback } from "react";
-
-import { useJazz } from "jazz-react";
-
-import { TodoProject, ListOfTasks } from "./1_types";
-
-import { SubmittableInput, Button } from "./basicComponents";
-
-import { useSimpleHashRouterThatAcceptsInvites } from "./router";
-import { TodoTable } from "./3_TodoTable";
-
-/** Walkthrough: Creating todo projects & routing in `<App/>`
- *
- *  <App> is the main app component, handling client-side routing based
- *  on the CoValue ID (CoID) of our TodoProject, stored in the URL hash
- *  - which can also contain invite links.
- */
-
-export default function App() {
-    // A `LocalNode` represents a local view of loaded & created CoValues.
-    // It is associated with a current user account, which will determine
-    // access rights to CoValues. We get it from the top-level provider `<WithJazz/>`.
-    const { localNode, logOut } = useJazz();
-
-    // This sets up routing and accepting invites, skip for now
-    const [currentProjectId, navigateToProjectId] =
-        useSimpleHashRouterThatAcceptsInvites<TodoProject>(localNode);
-
-    const createProject = useCallback(
-        (title: string) => {
-            if (!title) return;
-
-            // To create a new todo project, we first create a `Group`,
-            // which is a scope for defining access rights (reader/writer/admin)
-            // of its members, which will apply to all CoValues owned by that group.
-            const projectGroup = localNode.createGroup();
-
-            // Then we create an empty todo project and list of tasks within that group.
-            const project = projectGroup.createMap<TodoProject>();
-            const tasks = projectGroup.createList<ListOfTasks>();
-
-            // We edit the todo project to initialise it.
-            // Inside the `.edit` callback we can mutate a CoValue
-            project.edit((project) => {
-                project.set("title", title);
-                project.set("tasks", tasks.id);
-            });
-
-            navigateToProjectId(project.id);
-        },
-        [localNode, navigateToProjectId]
-    );
-
-    return (
-        <div className="flex flex-col h-full items-center justify-start gap-10 pt-10 pb-10 px-5">
-            {currentProjectId ? (
-                <TodoTable projectId={currentProjectId} />
-            ) : (
-                <SubmittableInput
-                    onSubmit={createProject}
-                    label="Create New Project"
-                    placeholder="New project title"
-                />
-            )}
-            <Button
-                onClick={() => {
-                    navigateToProjectId(undefined);
-                    logOut();
-                }}
-                variant="outline"
-            >
-                Log Out
-            </Button>
-        </div>
-    );
-}
-
-/** Walkthrough: continue with ./3_TodoTable.tsx */

examples/todo/src/2_main.tsx

@@ -0,0 +1,91 @@
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { RouterProvider, createHashRouter } from "react-router-dom";
+import "./index.css";
+
+import { WithJazz, useJazz, useAcceptInvite } from "jazz-react";
+import { LocalAuth } from "jazz-react-auth-local";
+
+import {
+    Button,
+    ThemeProvider,
+    TitleAndLogo,
+} from "./basicComponents/index.ts";
+import { PrettyAuthUI } from "./components/Auth.tsx";
+import { NewProjectForm } from "./3_NewProjectForm.tsx";
+import { ProjectTodoTable } from "./4_ProjectTodoTable.tsx";
+
+/**
+ * Walkthrough: The top-level provider `<WithJazz/>`
+ *
+ * This shows how to use the top-level provider `<WithJazz/>`,
+ * which provides the rest of the app with a `LocalNode` (used through `useJazz` later),
+ * based on `LocalAuth` that uses Passkeys (aka WebAuthn) to store a user's account secret
+ * - no backend needed.
+ */
+
+const appName = "Jazz Todo List Example";
+
+const auth = LocalAuth({
+    appName,
+    Component: PrettyAuthUI,
+});
+
+ReactDOM.createRoot(document.getElementById("root")!).render(
+    <React.StrictMode>
+        <WithJazz auth={auth}>
+            <App />
+        </WithJazz>
+    </React.StrictMode>
+);
+
+/**
+ * Routing in `<App/>`
+ *
+ * <App> is the main app component, handling client-side routing based
+ * on the CoValue ID (CoID) of our TodoProject, stored in the URL hash
+ * - which can also contain invite links.
+ */
+
+function App() {
+    // logOut logs out the AuthProvider passed to `<WithJazz/>` above.
+    const { logOut } = useJazz();
+
+    const router = createHashRouter([
+        {
+            path: "/",
+            element: <NewProjectForm />,
+        },
+        {
+            path: "/project/:projectId",
+            element: <ProjectTodoTable />,
+        },
+        {
+            path: "/invite/*",
+            element: <p>Accepting invite...</p>
+        }
+    ]);
+
+    // `useAcceptInvite()` is a hook that accepts an invite link from the URL hash,
+    // and on success calls our callback where we navigate to the project that we were just invited to.
+    useAcceptInvite((projectID) => router.navigate("/project/" + projectID));
+
+    return (
+        <ThemeProvider>
+            <TitleAndLogo name={appName} />
+            <div className="flex flex-col h-full items-center justify-start gap-10 pt-10 pb-10 px-5">
+
+                <RouterProvider router={router} />
+
+                <Button
+                    onClick={() => router.navigate("/").then(logOut)}
+                    variant="outline"
+                >
+                    Log Out
+                </Button>
+            </div>
+        </ThemeProvider>
+    );
+}
+
+/** Walkthrough: Continue with ./3_NewProjectForm.tsx */

examples/todo/src/3_NewProjectForm.tsx

@@ -0,0 +1,48 @@
+import { useCallback } from "react";
+
+import { useJazz } from "jazz-react";
+
+import { Task, TodoProject } from "./1_types";
+
+import { SubmittableInput } from "./basicComponents";
+
+import { CoList } from "cojson";
+import { useNavigate } from "react-router";
+
+export function NewProjectForm() {
+    // A `LocalNode` represents a local view of loaded & created CoValues.
+    // It is associated with a current user account, which will determine
+    // access rights to CoValues. We get it from the top-level provider `<WithJazz/>`.
+    const { localNode } = useJazz();
+    const navigate = useNavigate();
+
+    const createProject = useCallback(
+        (title: string) => {
+            if (!title) return;
+
+            // To create a new todo project, we first create a `Group`,
+            // which is a scope for defining access rights (reader/writer/admin)
+            // of its members, which will apply to all CoValues owned by that group.
+            const projectGroup = localNode.createGroup();
+
+            // Then we create an empty todo project within that group
+            const project = projectGroup.createMap<TodoProject>({
+                title,
+                tasks: projectGroup.createList<CoList<Task>>(),
+            });
+
+            navigate("/project/" + project.id);
+        },
+        [localNode, navigate]
+    );
+
+    return (
+        <SubmittableInput
+            onSubmit={createProject}
+            label="Create New Project"
+            placeholder="New project title"
+        />
+    );
+}
+
+/** Walkthrough: continue with ./4_ProjectTodoTable.tsx */

examples/todo/src/3_TodoTable.tsx

@@ -1,162 +0,0 @@
-import { useCallback } from "react";
-
-import { CoID } from "cojson";
-import { useTelepathicState } from "jazz-react";
-
-import { TodoProject, Task } from "./1_types";
-
-import {
-    Checkbox,
-    SubmittableInput,
-    Skeleton,
-    Table,
-    TableBody,
-    TableCell,
-    TableHead,
-    TableHeader,
-    TableRow,
-} from "./basicComponents";
-
-import { InviteButton } from "./components/InviteButton";
-import { NameBadge } from "./components/NameBadge";
-
-/** Walkthrough: Reactively rendering a todo project as a table,
- *               adding and editing tasks
- *
- *  Here in `<TodoTable/>`, we use `useTelepathicData()` for the first time,
- *  in this case to load the CoValue for our `TodoProject` as well as
- *  the `ListOfTasks` referenced in it.
- */
-
-export function TodoTable({ projectId }: { projectId: CoID<TodoProject> }) {
-    // `useTelepathicData()` reactively subscribes to updates to a CoValue's
-    // content - whether we create edits locally, load persisted data, or receive
-    // sync updates from other devices or participants!
-    const project = useTelepathicState(projectId);
-    const projectTasks = useTelepathicState(project?.get("tasks"));
-
-    // `createTask` is similar to `createProject` we saw earlier, creating a new CoMap
-    // for a new task (in the same group as the list of tasks/the project), and then
-    // adding it as an item to the project's list of tasks.
-    const createTask = useCallback(
-        (text: string) => {
-            if (!projectTasks || !text) return;
-            const task = projectTasks.group.createMap<Task>();
-
-            task.edit((task) => {
-                task.set("text", text);
-                task.set("done", false);
-            });
-
-            projectTasks.edit((projectTasks) => {
-                projectTasks.push(task.id);
-            });
-        },
-        [projectTasks]
-    );
-
-    return (
-        <div className="max-w-full w-4xl">
-            <div className="flex justify-between items-center gap-4 mb-4">
-                <h1>
-                    {
-                        // This is how we can access properties from the project,
-                        // accounting for the fact that it might not be loaded yet
-                        project?.get("title") ? (
-                            <>
-                                {project.get("title")}{" "}
-                                <span className="text-sm">({project.id})</span>
-                            </>
-                        ) : (
-                            <Skeleton className="mt-1 w-[200px] h-[1em] rounded-full" />
-                        )
-                    }
-                </h1>
-                <InviteButton list={project} />
-            </div>
-            <Table>
-                <TableHeader>
-                    <TableRow>
-                        <TableHead className="w-[40px]">Done</TableHead>
-                        <TableHead>Task</TableHead>
-                    </TableRow>
-                </TableHeader>
-                <TableBody>
-                    {
-                        // Here, we iterate over the items of our `ListOfTasks`
-                        // and render a `<TaskRow>` for each.
-
-                        projectTasks?.map((taskId: CoID<Task>) => (
-                            <TaskRow key={taskId} taskId={taskId} />
-                        ))
-                    }
-                    <NewTaskInputRow
-                        createTask={createTask}
-                        disabled={!project}
-                    />
-                </TableBody>
-            </Table>
-        </div>
-    );
-}
-
-export function TaskRow({ taskId }: { taskId: CoID<Task> }) {
-    // `<TaskRow/>` uses `useTelepathicState()` as well, to granularly load and
-    // subscribe to changes for that particular task.
-    const task = useTelepathicState(taskId);
-
-    return (
-        <TableRow>
-            <TableCell>
-                <Checkbox
-                    className="mt-1"
-                    checked={task?.get("done")}
-                    onCheckedChange={(checked) => {
-                        // (the only thing we let the user change is the "done" status)
-                        task?.edit((task) => {
-                            task.set("done", !!checked);
-                        });
-                    }}
-                />
-            </TableCell>
-            <TableCell>
-                <div className="flex flex-row justify-between items-center gap-2">
-                    <span className={task?.get("done") ? "line-through" : ""}>
-                        {task?.get("text") || (
-                            <Skeleton className="mt-1 w-[200px] h-[1em] rounded-full" />
-                        )}
-                    </span>
-                    {/* We also use a `<NameBadge/>` helper component to render the name
-                        of the author of the task. We get the author by using the collaboration
-                        feature `whoEdited(key)` on our `Task` CoMap, which returns the accountID
-                        of the last account that changed a given key in the CoMap. */}
-                    <NameBadge accountID={task?.whoEdited("text")} />
-                </div>
-            </TableCell>
-        </TableRow>
-    );
-}
-
-function NewTaskInputRow({
-    createTask,
-    disabled,
-}: {
-    createTask: (text: string) => void;
-    disabled: boolean;
-}) {
-    return (
-        <TableRow>
-            <TableCell>
-                <Checkbox className="mt-1" disabled />
-            </TableCell>
-            <TableCell>
-                <SubmittableInput
-                    onSubmit={(taskText) => createTask(taskText)}
-                    label="Add"
-                    placeholder="New task"
-                    disabled={disabled}
-                />
-            </TableCell>
-        </TableRow>
-    );
-}

examples/todo/src/4_ProjectTodoTable.tsx

@@ -0,0 +1,177 @@
+import { useCallback } from "react";
+
+import { CoID, Queried } from "cojson";
+import { useSyncedQuery } from "jazz-react";
+
+import { TodoProject, Task } from "./1_types";
+
+import {
+    Checkbox,
+    SubmittableInput,
+    Skeleton,
+    Table,
+    TableBody,
+    TableCell,
+    TableHead,
+    TableHeader,
+    TableRow,
+} from "./basicComponents";
+
+import { InviteButton } from "./components/InviteButton";
+import uniqolor from "uniqolor";
+import { useParams } from "react-router";
+
+/** Walkthrough: Reactively rendering a todo project as a table,
+ *               adding and editing tasks
+ *
+ *  Here in `<TodoTable/>`, we use `useSyncedQuery()` for the first time,
+ *  in this case to load the CoValue for our `TodoProject` as well as
+ *  the `ListOfTasks` referenced in it.
+ */
+
+export function ProjectTodoTable() {
+    const projectId = useParams<{ projectId: CoID<TodoProject> }>().projectId;
+
+    // `useSyncedQuery()` reactively subscribes to updates to a CoValue's
+    // content - whether we create edits locally, load persisted data, or receive
+    // sync updates from other devices or participants!
+    // It also recursively resolves and subsribes to all referenced CoValues.
+    const project = useSyncedQuery(projectId);
+
+    // `createTask` is similar to `createProject` we saw earlier, creating a new CoMap
+    // for a new task (in the same group as the project), and then
+    // adding that as an item to the project's list of tasks.
+    const createTask = useCallback(
+        (text: string) => {
+            if (!project?.tasks || !text) return;
+            const task = project.group.createMap<Task>({
+                done: false,
+                text,
+            });
+
+            // project.tasks is immutable, but `append` will create an edit
+            // that will cause useSyncedQuery to rerender this component
+            // - here and on other devices!
+            project.tasks.append(task);
+        },
+        [project?.tasks, project?.group]
+    );
+
+    return (
+        <div className="max-w-full w-4xl">
+            <div className="flex justify-between items-center gap-4 mb-4">
+                <h1>
+                    {
+                        // This is how we can access properties from the project query,
+                        // accounting for the fact that note everything might be loaded yet
+                        project?.title ? (
+                            <>
+                                {project.title}{" "}
+                                <span className="text-sm">({project.id})</span>
+                            </>
+                        ) : (
+                            <Skeleton className="mt-1 w-[200px] h-[1em] rounded-full" />
+                        )
+                    }
+                </h1>
+                <InviteButton value={project} />
+            </div>
+            <Table>
+                <TableHeader>
+                    <TableRow>
+                        <TableHead className="w-[40px]">Done</TableHead>
+                        <TableHead>Task</TableHead>
+                    </TableRow>
+                </TableHeader>
+                <TableBody>
+                    {project?.tasks?.map(
+                        (task) => task && <TaskRow key={task.id} task={task} />
+                    )}
+                    <NewTaskInputRow
+                        createTask={createTask}
+                        disabled={!project}
+                    />
+                </TableBody>
+            </Table>
+        </div>
+    );
+}
+
+export function TaskRow({ task }: { task: Queried<Task> | undefined }) {
+    return (
+        <TableRow>
+            <TableCell>
+                <Checkbox
+                    className="mt-1"
+                    checked={task?.done}
+                    onCheckedChange={(checked) => {
+                        // Tick or untick the task
+                        // Task is also immutable, but this will update all queries
+                        // that include this task as a reference
+                        task?.set({ done: !!checked });
+                    }}
+                />
+            </TableCell>
+            <TableCell>
+                <div className="flex flex-row justify-between items-center gap-2">
+                    {task?.text ? (
+                        <span className={task?.done ? "line-through" : ""}>
+                            {task.text}
+                        </span>
+                    ) : (
+                        <Skeleton className="mt-1 w-[200px] h-[1em] rounded-full" />
+                    )}
+                    {
+                        // Here we see for the first time how we can access edit history
+                        // for a CoValue, and use it to display who created the task.
+                        task?.edits.text?.by?.profile?.name ? (
+                            <span
+                                className="rounded-full py-0.5 px-2 text-xs"
+                                style={uniqueColoring(task.edits.text.by.id)}
+                            >
+                                {task.edits.text.by.profile.name}
+                            </span>
+                        ) : (
+                            <Skeleton className="mt-1 w-[50px] h-[1em] rounded-full" />
+                        )
+                    }
+                </div>
+            </TableCell>
+        </TableRow>
+    );
+}
+
+/** Walkthrough: This is the end of the walkthrough so far! */
+
+function NewTaskInputRow({
+    createTask,
+    disabled,
+}: {
+    createTask: (text: string) => void;
+    disabled: boolean;
+}) {
+    return (
+        <TableRow>
+            <TableCell>
+                <Checkbox className="mt-1" disabled />
+            </TableCell>
+            <TableCell>
+                <SubmittableInput
+                    onSubmit={(taskText) => createTask(taskText)}
+                    label="Add"
+                    placeholder="New task"
+                    disabled={disabled}
+                />
+            </TableCell>
+        </TableRow>
+    );
+}
+
+function uniqueColoring(seed: string) {
+    const darkMode = window.matchMedia("(prefers-color-scheme: dark)").matches;
+
+    return {
+        color: uniqolor(seed, { lightness: darkMode ? 80 : 20 }).color,
+        background: uniqolor(seed, { lightness: darkMode ? 20 : 80 }).color,
+    };
+}

examples/todo/src/components/InviteButton.tsx

@@ -1,27 +1,26 @@
 import { useState } from "react";
 
-import { TodoProject } from "../1_types";
-
 import { createInviteLink } from "jazz-react";
 import QRCode from "qrcode";
 
 import { useToast, Button } from "../basicComponents";
+import { CoValue, Queried } from "cojson";
 
-export function InviteButton({ list }: { list?: TodoProject }) {
+export function InviteButton<T extends CoValue>({ value }: { value: T | Queried<T> | undefined }) {
     const [existingInviteLink, setExistingInviteLink] = useState<string>();
     const { toast } = useToast();
 
     return (
-        list?.group.myRole() === "admin" && (
+        value?.group?.myRole() === "admin" && (
             <Button
                 size="sm"
                 className="py-0"
-                disabled={!list}
+                disabled={!value.group || !value.id}
                 variant="outline"
                 onClick={async () => {
                     let inviteLink = existingInviteLink;
-                    if (list && !inviteLink) {
-                        inviteLink = createInviteLink(list, "writer");
+                    if (value.group && value.id && !inviteLink) {
+                        inviteLink = createInviteLink(value, "writer");
                         setExistingInviteLink(inviteLink);
                     }
                     if (inviteLink) {

examples/todo/src/components/NameBadge.tsx

@@ -1,46 +0,0 @@
-import { AccountID } from "cojson";
-import { useProfile } from "jazz-react";
-
-import { Skeleton } from "@/basicComponents";
-import uniqolor from "uniqolor";
-
-/** Walkthrough: Getting user profiles in `<NameBadge/>`
- *
- *  `<NameBadge/>` uses `useProfile(accountID)`, which is a shorthand for
- *  useTelepathicState on an account's profile.
- *
- *  Profiles are always a `CoMap<{name: string}>`, but they might have app-specific
- *  additional properties).
- *
- *  In our case, we just display the profile name (which is set by the LocalAuth
- *  provider when we first create an account).
- */
-
-export function NameBadge({ accountID }: { accountID?: AccountID }) {
-    const profile = useProfile(accountID);
-
-    return accountID && profile?.get("name") ? (
-        <span
-            className="rounded-full py-0.5 px-2 text-xs"
-            style={randomUserColor(accountID)}
-        >
-            {profile.get("name")}
-        </span>
-    ) : (
-        <Skeleton className="mt-1 w-[50px] h-[1em] rounded-full" />
-    );
-}
-
-function randomUserColor(accountID: AccountID) {
-    const theme = window.matchMedia("(prefers-color-scheme: dark)").matches
-        ? "dark"
-        : "light";
-
-    const brightColor = uniqolor(accountID || "", { lightness: 80 }).color;
-    const darkColor = uniqolor(accountID || "", { lightness: 20 }).color;
-
-    return {
-        color: theme == "light" ? darkColor : brightColor,
-        background: theme == "light" ? brightColor : darkColor,
-    };
-}

examples/todo/src/router.ts

@@ -1,37 +0,0 @@
-import { useCallback, useEffect, useState } from "react";
-import { CoID, LocalNode, CoValueImpl } from "cojson";
-import { consumeInviteLinkFromWindowLocation } from "jazz-react";
-
-export function useSimpleHashRouterThatAcceptsInvites<C extends CoValueImpl>(
-    localNode: LocalNode
-) {
-    const [currentValueId, setCurrentValueId] = useState<CoID<C>>();
-
-    useEffect(() => {
-        const listener = async () => {
-            const acceptedInvitation = await consumeInviteLinkFromWindowLocation<C>(localNode);
-
-            if (acceptedInvitation) {
-                setCurrentValueId(acceptedInvitation.valueID);
-                window.location.hash = acceptedInvitation.valueID;
-                return;
-            }
-
-            setCurrentValueId(
-                (window.location.hash.slice(1) as CoID<C>) || undefined
-            );
-        };
-        window.addEventListener("hashchange", listener);
-        listener();
-
-        return () => {
-            window.removeEventListener("hashchange", listener);
-        };
-    }, [localNode]);
-
-    const navigateToValue = useCallback((id: CoID<C> | undefined) => {
-        window.location.hash = id || "";
-    }, []);
-
-    return [currentValueId, navigateToValue] as const;
-}

generateDocs.ts

@@ -1,5 +1,5 @@
 import { readFile, writeFile } from "fs/promises";
-import { Application, JSONOutput } from "typedoc";
+import { Application, JSONOutput, ReflectionKind } from "typedoc";
 
 const manuallyIgnore = new Set(["CojsonInternalTypes"]);
 
@@ -8,14 +8,18 @@ async function main() {
     // Also accepts an array of option readers if you want to disable
     // TypeDoc's tsconfig.json/package.json/typedoc.json option readers
     const packageDocs = Object.entries({
-        cojson: "index.ts",
         "jazz-react": "index.tsx",
+        cojson: "index.ts",
+        "jazz-react-media-images": "index.tsx",
         "jazz-browser": "index.ts",
+        "jazz-browser-media-images": "index.ts",
     }).map(async ([packageName, entryPoint]) => {
         const app = await Application.bootstrapWithPlugins({
             entryPoints: [`packages/${packageName}/src/${entryPoint}`],
             tsconfig: `packages/${packageName}/tsconfig.json`,
             sort: ["required-first"],
+            groupOrder: ["Functions", "Classes", "TypeAliases", "Namespaces"],
+            categorizeByGroup: false
         });
 
         const project = await app.convert();
@@ -35,33 +39,67 @@ async function main() {
             docs
                 .groups!.map((group) => {
                     return group.children
-                        ?.map((childId) => {
+                        ?.flatMap((childId) => {
                             const child = docs.children!.find(
                                 (child) => child.id === childId
                             )!;
 
-                            if (manuallyIgnore.has(child.name)) {
-                                return "";
+                            if (
+                                manuallyIgnore.has(child.name) ||
+                                child.comment?.blockTags?.some(
+                                    (tag) =>
+                                        tag.tag === "@deprecated" ||
+                                        tag.tag === "@internal" ||
+                                        tag.tag === "@ignore"
+                                ) ||
+                                child.signatures?.every((signature) =>
+                                    signature.comment?.blockTags?.some(
+                                        (tag) =>
+                                            tag.tag === "@deprecated" ||
+                                            tag.tag === "@internal" ||
+                                            tag.tag === "@ignore"
+                                    )
+                                )
+                            ) {
+                                return [];
                             }
 
                             return (
-                                `## \`${renderChildName(child)}\` (${group.title
+                                `## \`${renderChildName(
+                                    child
+                                )}\`\n\n<sup>(${group.title
                                     .toLowerCase()
+                                    .replace("bles", "ble")
                                     .replace("ces", "ce")
                                     .replace(/es$/, "")
                                     .replace(
                                         "ns",
                                         "n"
-                                    )} in \`${packageName}\`)\n\n` +
+                                    )} in \`${packageName}\`)</sup>\n\n` +
                                 renderChildType(child) +
-                                renderComment(child.comment) +
-                                (child.kind === 128 || child.kind === 256
-                                    ? child.groups
-                                          ?.map((group) =>
-                                              renderChildGroup(child, group)
+                                (child.kind === ReflectionKind.Class ||
+                                child.kind === ReflectionKind.Interface ||
+                                child.kind === ReflectionKind.Namespace
+                                    ? renderSummary(child.comment) +
+                                      renderExamples(child.comment) +
+                                      (child.categories || child.groups)
+                                          ?.map((category) =>
+                                              renderChildCategory(child, category)
                                           )
-                                          .join("\n\n")
-                                    : "TODO: doc generator not implemented yet")
+                                          .join("<br/>\n\n")
+                                    : child.kind === ReflectionKind.Function
+                                    ? renderSummary(
+                                          child.signatures?.[0].comment
+                                      ) +
+                                      renderParamComments(
+                                          child.signatures?.[0].parameters || []
+                                      ) +
+                                      renderExamples(
+                                          child.signatures?.[0].comment
+                                      ) +
+                                      "\n\n"
+                                    : "TODO: doc generator not implemented yet " +
+                                      child.kind)
                             );
                         })
                         .join("\n\n----\n\n");
@@ -69,7 +107,7 @@ async function main() {
                 .join("\n\n----\n\n")
         );
 
-        function renderComment(comment?: JSONOutput.Comment): string {
+        function renderSummary(comment?: JSONOutput.Comment): string {
             if (comment) {
                 return (
                     comment.summary
@@ -80,11 +118,50 @@ async function main() {
                         )
                         .join("") +
                     "\n\n" +
-                    (comment.blockTags || [])
-                        .map((blockTag) =>
-                            blockTag.tag === "@example"
-                                ? "##### Example:\n\n" +
-                                  blockTag.content
+                    "\n\n"
+                );
+            } else {
+                return "TODO: document\n\n";
+            }
+        }
+
+        function renderExamples(comment?: JSONOutput.Comment): string {
+            return (comment?.blockTags || [])
+                .map((blockTag) =>
+                    blockTag.tag === "@example"
+                        ? "##### Example:\n\n" +
+                          blockTag.content
+                              .map((token) =>
+                                  token.kind === "text" || token.kind === "code"
+                                      ? token.text
+                                      : ""
+                              )
+                              .join("") +
+                          "\n\n"
+                        : ""
+                )
+                .join("");
+        }
+
+        function renderParamComments(params: JSONOutput.ParameterReflection[]) {
+            const paramDocs = params.flatMap((param) => {
+                if (param.type?.type === "reflection") {
+                    return param.type.declaration.children?.flatMap((child) => {
+                        if (
+                            child.name === "children" &&
+                            child.type?.type === "reference" &&
+                            child.type?.name === "ReactNode"
+                        ) {
+                            return [];
+                        }
+                        return (
+                            `| \`${param.name}.${child.name}${
+                                child.flags.isOptional || child.defaultValue
+                                    ? "?"
+                                    : ""
+                            }\` | ` +
+                            (child.comment
+                                ? child.comment.summary
                                       .map((token) =>
                                           token.kind === "text" ||
                                           token.kind === "code"
@@ -92,13 +169,37 @@ async function main() {
                                               : ""
                                       )
                                       .join("")
+                                : "TODO: document") +
+                            " |"
+                        );
+                    });
+                } else {
+                    const comment = param.comment;
+                    return [
+                        `| \`${param.name}${
+                            param.flags.isOptional || param.defaultValue
+                                ? "?"
                                 : ""
-                        )
-                        .join("\n\n") +
-                    "\n\n"
-                );
-            } else {
-                return "TODO: document\n\n";
+                        }\` | ` +
+                            (comment
+                                ? comment.summary
+                                      .map((token) =>
+                                          token.kind === "text" ||
+                                          token.kind === "code"
+                                              ? token.text
+                                              : ""
+                                      )
+                                      .join("")
+                                : "TODO: document ") +
+                            " |",
+                    ];
+                }
+            });
+
+            if (paramDocs.length) {
+                return `### Parameters:\n\n| name | description |\n| ----: | ---- |\n${paramDocs.join(
+                    "\n"
+                )}\n\n`;
             }
         }
 
@@ -126,26 +227,30 @@ async function main() {
         function renderChildType(
             child: JSONOutput.DeclarationReflection
         ): string {
-            const isClass = child.kind === 128;
-            const isTypeDef = child.kind === 2097152;
-            const isInterface = child.kind === 256;
+            const isClass = child.kind === ReflectionKind.Class;
+            const isTypeAlias = child.kind === ReflectionKind.TypeAlias;
+            const isInterface = child.kind === ReflectionKind.Interface;
+            const isNamespace = child.kind === ReflectionKind.Namespace;
             const isFunction = !!child.signatures;
+
+            const kind = isClass
+                ? "class"
+                : isTypeAlias
+                ? "type"
+                : isFunction
+                ? "function"
+                : isInterface
+                ? "interface"
+                : isNamespace
+                ? "namespace"
+                : "";
+
             return (
                 "```typescript\n" +
-                `export ${
-                    isClass
-                        ? "class"
-                        : isTypeDef
-                        ? "type"
-                        : isFunction
-                        ? "function"
-                        : isInterface
-                        ? "interface"
-                        : ""
-                } ${child.name}` +
-                (child.typeParameters
+                `export ${kind} ${child.name}` +
+                ((child.typeParameters || child.signatures?.[0].typeParameter)
                     ? "<" +
-                      child.typeParameters.map(renderTypeParam).join(", ") +
+                      (child.typeParameters || child.signatures?.[0].typeParameter || []).map(renderTypeParam).join(", ") +
                       ">"
                     : "") +
                 (child.extendedTypes
@@ -156,9 +261,9 @@ async function main() {
                     ? " implements " +
                       child.implementedTypes.map(renderType).join(", ")
                     : "") +
-                (isClass || isInterface
+                (isClass || isInterface || isNamespace
                     ? " {...}"
-                    : isTypeDef
+                    : isTypeAlias
                     ? ` = ${renderType(child.type)}`
                     : child.signatures
                     ? `(${(child.signatures[0].parameters || [])
@@ -171,33 +276,69 @@ async function main() {
             );
         }
 
-        function renderChildGroup(
+        function renderChildCategory(
             child: JSONOutput.DeclarationReflection,
-            group: JSONOutput.ReflectionGroup
+            category: JSONOutput.ReflectionGroup
         ): string {
             return (
-                `### ${group.title}\n\n` +
-                group.children
+                `### \`${child.name}\`: ${category.title.replace(/[^d]+\./, "")}\n\n` +
+                category.children
                     ?.map((memberId) => {
                         const member = child.children!.find(
                             (member) => member.id === memberId
                         )!;
 
                         if (member.kind === 2048 || member.kind === 512) {
-                            if (member.signatures?.every(sig => sig.comment?.modifierTags?.includes("@internal"))) {
-                                return ""
+                            if (
+                                member.signatures?.every(
+                                    (sig) =>
+                                        sig.comment?.modifierTags?.includes(
+                                            "@internal"
+                                        ) ||
+                                        sig.comment?.modifierTags?.includes(
+                                            "@deprecated"
+                                        )
+                                )
+                            ) {
+                                return "";
                             } else {
-                                return documentConstructorOrMethod(member, child);
+                                return documentConstructorOrMethod(
+                                    member,
+                                    child
+                                );
                             }
                         } else if (
                             member.kind === 1024 ||
                             member.kind === 262144
                         ) {
-                            if (member.comment?.modifierTags?.includes("@internal")) {
-                                return ""
+                            if (
+                                member.comment?.modifierTags?.includes(
+                                    "@internal"
+                                ) ||
+                                member.comment?.modifierTags?.includes(
+                                    "@deprecated"
+                                )
+                            ) {
+                                return "";
                             } else {
                                 return documentProperty(member, child);
                             }
+                        } else if (member.kind === 2097152) {
+                            if (
+                                member.comment?.modifierTags?.includes(
+                                    "@internal"
+                                ) ||
+                                member.comment?.modifierTags?.includes(
+                                    "@deprecated"
+                                )
+                            ) {
+                                return "";
+                            } else {
+                                return documentProperty(
+                                    { ...member, flags: { isStatic: true } },
+                                    child
+                                );
+                            }
                         } else {
                             return "Unknown member kind " + member.kind;
                         }
@@ -220,9 +361,39 @@ async function main() {
             } else if (t.type === "literal") {
                 return JSON.stringify(t.value);
             } else if (t.type === "union") {
-                return [...new Set(t.types.map(renderType))].join(" | ");
+                const seen = new Set<string>();
+                return t.types
+                    .flatMap((t) => {
+                        const rendered =
+                            t.type === "intersection" || t.type === "union"
+                                ? `(${renderType(t)})`
+                                : renderType(t);
+
+                        if (seen.has(rendered)) {
+                            return [];
+                        } else {
+                            seen.add(rendered);
+                            return [rendered];
+                        }
+                    })
+                    .join(" | ");
             } else if (t.type === "intersection") {
-                return [...new Set(t.types.map(renderType))].join(" & ");
+                const seen = new Set<string>();
+                return t.types
+                    .flatMap((t) => {
+                        const rendered =
+                            t.type === "intersection" || t.type === "union"
+                                ? `(${renderType(t)})`
+                                : renderType(t);
+
+                        if (seen.has(rendered)) {
+                            return [];
+                        } else {
+                            seen.add(rendered);
+                            return [rendered];
+                        }
+                    })
+                    .join(" & ");
             } else if (t.type === "indexedAccess") {
                 return (
                     renderType(t.objectType) +
@@ -233,40 +404,84 @@ async function main() {
             } else if (t.type === "reflection") {
                 if (t.declaration.indexSignature) {
                     return (
-                        "{ [" +
+                        `{${
+                            t.declaration.children
+                                ? t.declaration.children
+                                      .map(
+                                          (child) =>
+                                              `  ${child.name}${
+                                                  child.flags.isOptional
+                                                      ? "?"
+                                                      : ""
+                                              }: ${indentEnd(
+                                                  renderType(child.type)
+                                              )},`
+                                      )
+                                      .join("\n")
+                                : ""
+                        }\n  [` +
                         t.declaration.indexSignature?.parameters?.[0].name +
                         ": " +
                         renderType(
                             t.declaration.indexSignature?.parameters?.[0].type
                         ) +
                         "]: " +
-                        renderType(t.declaration.indexSignature?.type) +
+                        indentEnd(
+                            renderType(t.declaration.indexSignature?.type)
+                        ) +
                         " }"
                     );
                 } else if (t.declaration.children) {
-                    return `{${t.declaration.children
-                        .map(
-                            (child) =>
-                                `${child.name}${
-                                    child.flags.isOptional ? "?" : ""
-                                }: ${renderType(child.type)}`
+                    return `{\n${t.declaration.children
+                        .map((child) =>
+                            child.signatures
+                                ? child.signatures
+                                      .map(
+                                          (signature) =>
+                                              `  ${child.name}(${
+                                                  signature.parameters
+                                                      ? "\n  " +
+                                                        indent(
+                                                            signature.parameters
+                                                                .map((p) =>
+                                                                    indentEnd(
+                                                                        renderParam(
+                                                                            p
+                                                                        )
+                                                                    )
+                                                                )
+                                                                .join(",\n  ")
+                                                        ) +
+                                                        "\n  )"
+                                                      : "()"
+                                              }: ${indentEnd(
+                                                  renderType(signature.type)
+                                              )}`
+                                      )
+                                      .join("\n") + ",\n"
+                                : `  ${child.name}${
+                                      child.flags.isOptional ? "?" : ""
+                                  }: ${indentEnd(renderType(child.type))},\n`
                         )
-                        .join(", ")}}`;
+                        .join("")}}`;
                 } else if (t.declaration.signatures) {
-                    if (t.declaration.signatures.length > 1) {
-                        return "COMPLEX_TYPE_MULTIPLE_INLINE_SIGNATURES";
-                    } else {
-                        return `(${(
-                            t.declaration.signatures[0].parameters || []
-                        ).map(renderParam)}) => ${renderType(
-                            t.declaration.signatures[0].type
-                        )}`;
-                    }
+                    return t.declaration.signatures
+                        .map(
+                            (signature) =>
+                                `(${(signature.parameters || [])
+                                    .map(renderParam)
+                                    .join(", ")}) => ${renderType(
+                                    signature.type
+                                )}`
+                        )
+                        .join("\n");
                 } else {
                     return "COMPLEX_TYPE_REFLECTION";
                 }
             } else if (t.type === "array") {
                 return renderType(t.elementType) + "[]";
+            } else if (t.type === "tuple") {
+                return `[${t.elements?.map(renderType).join(", ")}]`;
             } else if (t.type === "templateLiteral") {
                 const matchingNamedType = docs.children?.find(
                     (child) =>
@@ -296,9 +511,55 @@ async function main() {
                             return "AgentID";
                         }
                     } else {
-                        return "TEMPLATE_LITERAL";
+                        return (
+                            "`" +
+                            t.head +
+                            t.tail
+                                .map(
+                                    (bit) =>
+                                        "${" + renderType(bit[0]) + "}" + bit[1]
+                                )
+                                .join("") +
+                            "`"
+                        );
                     }
                 }
+            } else if (t.type === "conditional") {
+                const trueRendered = renderType(t.trueType);
+                const falseRendered = renderType(t.falseType);
+
+                if (
+                    trueRendered.includes("\n") ||
+                    falseRendered.includes("\n")
+                ) {
+                    return (
+                        renderType(t.checkType) +
+                        " extends " +
+                        renderType(t.extendsType) +
+                        "\n  ? " +
+                        indentEnd(renderType(t.trueType)) +
+                        "\n  : " +
+                        indentEnd(renderType(t.falseType))
+                    );
+                } else {
+                    return (
+                        renderType(t.checkType) +
+                        " extends " +
+                        renderType(t.extendsType) +
+                        " ? " +
+                        renderType(t.trueType) +
+                        " : " +
+                        renderType(t.falseType)
+                    );
+                }
+            } else if (t.type === "inferred") {
+                return "infer " + t.name;
+            } else if (t.type === "typeOperator") {
+                return t.operator + " " + renderType(t.target);
+            } else if (t.type === "mapped") {
+                return `{\n  [${t.parameter} in ${renderType(
+                    t.parameterType
+                )}]: ${indentEnd(renderType(t.templateType))}\n}`;
             } else {
                 return "COMPLEX_TYPE_" + t.type;
             }
@@ -341,101 +602,186 @@ async function main() {
                           (child) =>
                               child.name + (child.flags.isOptional ? "?" : "")
                       )
-                      .join(", ")}}${param.defaultValue ? "?" : ""}`
-                : param.name + (param.defaultValue ? "?" : "");
+                      .join(", ")}}${
+                      param.flags.isOptional || param.defaultValue ? "?" : ""
+                  }`
+                : param.name +
+                      (param.flags.isOptional || param.defaultValue ? "?" : "");
         }
 
         function documentConstructorOrMethod(
             member: JSONOutput.DeclarationReflection,
             child: JSONOutput.DeclarationReflection
         ) {
+            const isInClass = child.kind === 128;
+            const isInTypeDef = child.kind === 2097152;
+            const isInInterface = child.kind === 256;
+            const isInNamespace = child.kind === 4;
+            const isInFunction = !!child.signatures;
+
+            const inKind = isInClass
+                ? "class"
+                : isInTypeDef
+                ? "type"
+                : isInFunction
+                ? "function"
+                : isInInterface
+                ? "interface"
+                : isInNamespace
+                ? "namespace"
+                : "";
+
             const stem =
                 member.name === "constructor"
-                    ? "new " + child.name
-                    : (member.flags.isStatic
-                          ? child.name
-                          : child.name[0].toLowerCase() + child.name.slice(1)) +
+                    ? "new " + child.name + "</code></b>"
+                    : (member.flags.isStatic ? child.name : "") +
                       "." +
-                      member.name;
+                      member.name +
+                      "";
 
-            return (
-                `<details>\n<summary><code>${stem}(${(
-                    member.signatures?.[0]?.parameters?.map(
-                        renderParamSimple
-                    ) || []
-                ).join(", ")})</code> ${
-                    member.inheritedFrom
-                        ? "(from <code>" +
-                          member.inheritedFrom.name.split(".")[0] +
-                          "</code>) "
-                        : ""
-                } ${
-                    member.signatures?.[0]?.comment ? "" : "(undocumented)"
-                }</summary>\n\n` +
-                member.signatures?.map((signature) => {
+            return member.signatures
+                ?.map((signature) => {
                     return (
-                        "```typescript\n" +
-                        `${stem}${
-                            signature.typeParameter
-                                ? `<${signature.typeParameter
-                                      .map(renderTypeParam)
-                                      .join(", ")}>`
+                        `<details>\n<summary><b><code>${stem}(${(
+                            signature?.parameters?.map(renderParamSimple) || []
+                        ).join(", ")})</code></b> ${
+                            member.inheritedFrom
+                                ? "<sub><sup>from <code>" +
+                                  member.inheritedFrom.name.split(".")[0] +
+                                  "</code></sup></sub> "
                                 : ""
-                        }(${
-                            (
-                                signature.parameters?.map(
-                                    (param) =>
-                                        `\n  ${param.name}${
-                                            param.defaultValue ? "?" : ""
-                                        }: ${renderType(param.type)}${
-                                            param.defaultValue
-                                                ? ` = ${param.defaultValue}`
-                                                : ""
-                                        }`
-                                ) || []
-                            ).join(",") +
-                            (signature.parameters?.length ? "\n" : "")
-                        }): ${renderType(signature.type)}\n` +
-                        "```\n" +
-                        renderComment(signature.comment)
+                        } ${
+                            signature?.comment
+                                ? ""
+                                : "<sub><sup>(undocumented)</sup></sub>"
+                        }</summary>\n\n` +
+                        ("```typescript\n" +
+                            `${inKind} ${child.name}${
+                                child.typeParameters
+                                    ? `<${child.typeParameters
+                                          .map((t) => t.name)
+                                          .join(", ")}>`
+                                    : ""
+                            } {\n\n${indent(
+                                `${member.name}${
+                                    signature.typeParameter
+                                        ? `<${signature.typeParameter
+                                              .map(renderTypeParam)
+                                              .join(", ")}>`
+                                        : ""
+                                }(${
+                                    (
+                                        signature.parameters?.map(
+                                            (param) =>
+                                                `\n  ${param.name}${
+                                                    param.flags.isOptional ||
+                                                    param.defaultValue
+                                                        ? "?"
+                                                        : ""
+                                                }: ${indentEnd(
+                                                    renderType(param.type)
+                                                )}${
+                                                    param.defaultValue
+                                                        ? ` = ${param.defaultValue}`
+                                                        : ""
+                                                }`
+                                        ) || []
+                                    ).join(",") +
+                                    (signature.parameters?.length ? "\n" : "")
+                                }): ${renderType(signature.type)} {...}`
+                            )}\n\n}\n` +
+                            "```\n" +
+                            renderSummary(signature.comment)) +
+                        renderParamComments(signature.parameters || []) +
+                        renderExamples(signature.comment) +
+                        "</details>\n\n"
                     );
-                }) +
-                "</details>\n\n"
-            );
+                })
+                .join("\n\n");
         }
 
         function documentProperty(
             member: JSONOutput.DeclarationReflection,
             child: JSONOutput.DeclarationReflection
         ) {
-            const stem = member.flags.isStatic
-                ? child.name
-                : child.name[0].toLowerCase() + child.name.slice(1);
+            const isInClass = child.kind === 128;
+            const isInTypeDef = child.kind === 2097152;
+            const isInInterface = child.kind === 256;
+            const isInNamespace = child.kind === 4;
+            const isInFunction = !!child.signatures;
+
+            const inKind = isInClass
+                ? "class"
+                : isInTypeDef
+                ? "type"
+                : isInFunction
+                ? "function"
+                : isInInterface
+                ? "interface"
+                : isInNamespace
+                ? "namespace"
+                : "";
+
+            const stem = member.flags.isStatic ? child.name : "";
             return (
-                `<details>\n<summary><code>${stem}.${member.name}</code> ${
+                `<details>\n<summary><b><code>${stem}.${
+                    member.name
+                }</code></b> ${
                     member.inheritedFrom
-                        ? "(from <code>" +
+                        ? "<sub><sup>from <code>" +
                           member.inheritedFrom.name.split(".")[0] +
-                          "</code>) "
+                          "</code></sup></sub> "
                         : ""
                 } ${
-                    member.comment ? "" : "(undocumented)"
+                    member.comment ? "" : "<sub><sup>(undocumented)</sup></sub>"
                 }</summary>\n\n` +
                 "```typescript\n" +
-                `${member.getSignature ? "get " : ""}${stem}.${member.name}${
-                    member.getSignature ? "()" : ""
-                }: ${renderType(member.type || member.getSignature?.type)}\n` +
-                "```\n" +
-                renderComment(member.comment) +
+                `${inKind} ${child.name}${
+                    child.typeParameters
+                        ? `<${child.typeParameters
+                              .map((t) => t.name)
+                              .join(", ")}>`
+                        : ""
+                } {\n\n${indent(
+                    `${member.getSignature ? "get " : ""}${member.name}${
+                        member.getSignature ? "()" : ""
+                    }: ${renderType(member.type || member.getSignature?.type)}${
+                        member.getSignature ? " {...}" : ""
+                    }`
+                )}` +
+                "\n\n}\n```\n" +
+                renderSummary(member.comment) +
+                renderExamples(member.comment) +
                 "</details>\n\n"
             );
         }
     });
 
+    const docsContent = await readFile("./DOCS.md", "utf8");
+
     await writeFile(
         "./DOCS.md",
-        (await Promise.all(packageDocs)).join("\n\n\n")
+        docsContent.slice(
+            0,
+            docsContent.indexOf("<!-- AUTOGENERATED DOCS AFTER THIS POINT -->")
+        ) +
+            "<!-- AUTOGENERATED DOCS AFTER THIS POINT -->\n" +
+            (await Promise.all(packageDocs)).join("\n\n\n")
     );
 }
 
+function indent(text: string): string {
+    return text
+        .split("\n")
+        .map((line) => "  " + line)
+        .join("\n");
+}
+
+function indentEnd(text: string): string {
+    return text
+        .split("\n")
+        .map((line, i) => (i === 0 ? line : "  " + line))
+        .join("\n");
+}
+
 main().catch(console.error);

packages/cojson-simple-sync/package.json

@@ -4,7 +4,7 @@
     "types": "src/index.ts",
     "type": "module",
     "license": "MIT",
-    "version": "0.2.5",
+    "version": "0.3.7",
     "devDependencies": {
         "@types/jest": "^29.5.3",
         "@types/ws": "^8.5.5",
@@ -16,8 +16,8 @@
         "typescript": "5.0.2"
     },
     "dependencies": {
-        "cojson": "^0.2.2",
-        "cojson-storage-sqlite": "^0.2.5",
+        "cojson": "^0.3.5",
+        "cojson-storage-sqlite": "^0.3.7",
         "ws": "^8.13.0"
     },
     "scripts": {

packages/cojson-simple-sync/src/index.ts

@@ -16,7 +16,7 @@ const localNode = new LocalNode(
 );
 
 SQLiteStorage.asPeer({ filename: "./sync.db" })
-    .then((storage) => localNode.sync.addPeer(storage))
+    .then((storage) => localNode.syncManager.addPeer(storage))
     .catch((e) => console.error(e));
 
 wss.on("connection", function connection(ws, req) {
@@ -34,8 +34,6 @@ wss.on("connection", function connection(ws, req) {
         clearInterval(pinging);
     });
 
-
-
     const clientAddress =
         (req.headers["x-forwarded-for"] as string | undefined)
             ?.split(",")[0]
@@ -43,7 +41,7 @@ wss.on("connection", function connection(ws, req) {
 
     const clientId = clientAddress + "@" + new Date().toISOString();
 
-    localNode.sync.addPeer({
+    localNode.syncManager.addPeer({
         id: clientId,
         role: "client",
         incoming: websocketReadableStream(ws),

packages/cojson-storage-indexeddb/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "jazz-storage-indexeddb",
-  "version": "0.2.4",
+  "name": "cojson-storage-indexeddb",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "cojson": "^0.2.2",
+    "cojson": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "devDependencies": {

packages/cojson-storage-indexeddb/src/index.test.ts

@@ -12,7 +12,7 @@ test.skip("Should be able to initialize and load from empty DB", async () => {
         )
     );
 
-    node.sync.addPeer(await IDBStorage.asPeer({ trace: true }));
+    node.syncManager.addPeer(await IDBStorage.asPeer({ trace: true }));
 
     console.log("yay!");
 
@@ -20,7 +20,7 @@ test.skip("Should be able to initialize and load from empty DB", async () => {
 
     await new Promise((resolve) => setTimeout(resolve, 200));
 
-    expect(node.sync.peers["storage"]).toBeDefined();
+    expect(node.syncManager.peers["storage"]).toBeDefined();
 });
 
 test("Should be able to sync data to database and then load that from a new node", async () => {
@@ -33,7 +33,7 @@ test("Should be able to sync data to database and then load that from a new node
         )
     );
 
-    node1.sync.addPeer(
+    node1.syncManager.addPeer(
         await IDBStorage.asPeer({ trace: true, localNodeName: "node1" })
     );
 
@@ -56,7 +56,7 @@ test("Should be able to sync data to database and then load that from a new node
         )
     );
 
-    node2.sync.addPeer(
+    node2.syncManager.addPeer(
         await IDBStorage.asPeer({ trace: true, localNodeName: "node2" })
     );
 

packages/cojson-storage-sqlite/package.json

@@ -1,13 +1,13 @@
 {
   "name": "cojson-storage-sqlite",
   "type": "module",
-  "version": "0.2.5",
+  "version": "0.3.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
     "better-sqlite3": "^8.5.2",
-    "cojson": "^0.2.2",
+    "cojson": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "scripts": {

packages/cojson-storage-sqlite/src/index.ts

@@ -237,19 +237,31 @@ export class SQLiteStorage {
             sessions: {},
         };
 
-        const parsedHeader = (coValueRow?.header &&
-            JSON.parse(coValueRow.header)) as
-            | CojsonInternalTypes.CoValueHeader
-            | undefined;
+        let parsedHeader;
 
-            const newContentPieces: CojsonInternalTypes.NewContentMessage[] = [
-                {
-                    action: "content",
-                    id: theirKnown.id,
-                    header: theirKnown.header ? undefined : parsedHeader,
-                    new: {},
-                },
-            ];
+        try {
+            parsedHeader = (coValueRow?.header &&
+                JSON.parse(coValueRow.header)) as
+                | CojsonInternalTypes.CoValueHeader
+                | undefined;
+        } catch (e) {
+            console.warn(
+                theirKnown.id,
+                "Invalid JSON in header",
+                e,
+                coValueRow?.header
+            );
+            return;
+        }
+
+        const newContentPieces: CojsonInternalTypes.NewContentMessage[] = [
+            {
+                action: "content",
+                id: theirKnown.id,
+                header: theirKnown.header ? undefined : parsedHeader,
+                new: {},
+            },
+        ];
 
         for (const sessionRow of allOurSessions) {
             ourKnown.sessions[sessionRow.sessionID] = sessionRow.lastIdx;
@@ -265,7 +277,10 @@ export class SQLiteStorage {
                     .prepare<[number, number]>(
                         `SELECT * FROM signatureAfter WHERE ses = ? AND idx >= ?`
                     )
-                    .all(sessionRow.rowID, firstNewTxIdx) as SignatureAfterRow[];
+                    .all(
+                        sessionRow.rowID,
+                        firstNewTxIdx
+                    ) as SignatureAfterRow[];
 
                 // console.log(
                 //     theirKnown.id,
@@ -295,7 +310,8 @@ export class SQLiteStorage {
                     if (!sessionEntry) {
                         sessionEntry = {
                             after: idx,
-                            lastSignature: "WILL_BE_REPLACED" as CojsonInternalTypes.Signature,
+                            lastSignature:
+                                "WILL_BE_REPLACED" as CojsonInternalTypes.Signature,
                             newTransactions: [],
                         };
                         newContentPieces[newContentPieces.length - 1]!.new[
@@ -303,7 +319,21 @@ export class SQLiteStorage {
                         ] = sessionEntry;
                     }
 
-                    sessionEntry.newTransactions.push(JSON.parse(tx.tx));
+                    let parsedTx;
+
+                    try {
+                        parsedTx = JSON.parse(tx.tx);
+                    } catch (e) {
+                        console.warn(
+                            theirKnown.id,
+                            "Invalid JSON in transaction",
+                            e,
+                            tx.tx
+                        );
+                        break;
+                    }
+
+                    sessionEntry.newTransactions.push(parsedTx);
 
                     if (
                         signaturesAndIdxs[0] &&
@@ -331,28 +361,46 @@ export class SQLiteStorage {
         const dependedOnCoValues =
             parsedHeader?.ruleset.type === "group"
                 ? newContentPieces
-                .flatMap((piece) => Object.values(piece.new)).flatMap((sessionEntry) =>
-                      sessionEntry.newTransactions.flatMap((tx) => {
-                          if (tx.privacy !== "trusting") return [];
-                          // TODO: avoid parsing here?
-                          return cojsonInternals
-                              .parseJSON(tx.changes)
-                              .map(
-                                  (change) =>
-                                      change &&
-                                      typeof change === "object" &&
-                                      "op" in change &&
-                                      change.op === "set" &&
-                                      "key" in change &&
-                                      change.key
-                              )
-                              .filter(
-                                  (key): key is CojsonInternalTypes.RawCoID =>
-                                      typeof key === "string" &&
-                                      key.startsWith("co_")
-                              );
-                      })
-                  )
+                      .flatMap((piece) => Object.values(piece.new))
+                      .flatMap((sessionEntry) =>
+                          sessionEntry.newTransactions.flatMap((tx) => {
+                              if (tx.privacy !== "trusting") return [];
+                              // TODO: avoid parsing here?
+                              let parsedChanges;
+
+                              try {
+                                  parsedChanges = cojsonInternals.parseJSON(
+                                      tx.changes
+                                  );
+                              } catch (e) {
+                                  console.warn(
+                                      theirKnown.id,
+                                      "Invalid JSON in transaction",
+                                      e,
+                                      tx.changes
+                                  );
+                                  return [];
+                              }
+
+                              return parsedChanges
+                                  .map(
+                                      (change) =>
+                                          change &&
+                                          typeof change === "object" &&
+                                          "op" in change &&
+                                          change.op === "set" &&
+                                          "key" in change &&
+                                          change.key
+                                  )
+                                  .filter(
+                                      (
+                                          key
+                                      ): key is CojsonInternalTypes.RawCoID =>
+                                          typeof key === "string" &&
+                                          key.startsWith("co_")
+                                  );
+                          })
+                      )
                 : parsedHeader?.ruleset.type === "ownedByGroup"
                 ? [parsedHeader?.ruleset.group]
                 : [];
@@ -499,7 +547,7 @@ export class SQLiteStorage {
                             sessionUpdate.sessionID,
                             sessionUpdate.lastIdx,
                             sessionUpdate.lastSignature,
-                            sessionUpdate.bytesSinceLastSignature,
+                            sessionUpdate.bytesSinceLastSignature
                         ) as { rowID: number };
 
                     const sessionRowID = upsertedSession.rowID;

packages/cojson/.eslintrc.cjs

@@ -9,6 +9,7 @@ module.exports = {
     parserOptions: {
         project: "./tsconfig.json",
     },
+    ignorePatterns: [".eslint.cjs", "**/tests/*"],
     root: true,
     rules: {
         "no-unused-vars": "off",

packages/cojson/package.json

@@ -5,7 +5,7 @@
     "types": "dist/index.d.ts",
     "type": "module",
     "license": "MIT",
-    "version": "0.2.2",
+    "version": "0.3.5",
     "devDependencies": {
         "@types/jest": "^29.5.3",
         "@typescript-eslint/eslint-plugin": "^6.2.1",

packages/cojson/src/account.ts

@@ -14,7 +14,7 @@ import {
 } from "./crypto.js";
 import { AgentID } from "./ids.js";
 import { CoMap } from "./coValues/coMap.js";
-import { LocalNode } from "./node.js";
+import { LocalNode } from "./localNode.js";
 import { Group, GroupContent } from "./group.js";
 
 export function accountHeaderForInitialAgentSecret(
@@ -32,7 +32,7 @@ export function accountHeaderForInitialAgentSecret(
     };
 }
 
-export class Account extends Group {
+export class AccountGroup extends Group {
     get id(): AccountID {
         return this.underlyingMap.id as AccountID;
     }
@@ -65,7 +65,7 @@ export interface GeneralizedControlledAccount {
 
 /** @hidden */
 export class ControlledAccount
-    extends Account
+    extends AccountGroup
     implements GeneralizedControlledAccount
 {
     agentSecret: AgentSecret;
@@ -136,10 +136,10 @@ export class AnonymousControlledAccount
     }
 }
 
-export type AccountContent = GroupContent & { profile: CoID<Profile> };
+export type AccountContent = { profile: Profile } & GroupContent;
 export type AccountMeta = { type: "account" };
-export type AccountMap = CoMap<AccountContent, AccountMeta>;
-export type AccountID = CoID<AccountMap>;
+export type Account = CoMap<AccountContent, AccountMeta>;
+export type AccountID = CoID<Account>;
 
 export function isAccountID(id: AccountID | AgentID): id is AccountID {
     return id.startsWith("co_");

packages/cojson/src/coValue.ts

@@ -1,17 +1,32 @@
 import { JsonObject, JsonValue } from "./jsonValue.js";
 import { RawCoID } from "./ids.js";
 import { CoMap } from "./coValues/coMap.js";
-import { BinaryCoStream, BinaryCoStreamMeta, CoStream } from "./coValues/coStream.js";
-import { Static } from "./coValues/static.js";
+import {
+    BinaryCoStream,
+    BinaryCoStreamMeta,
+    CoStream,
+} from "./coValues/coStream.js";
 import { CoList } from "./coValues/coList.js";
 import { CoValueCore } from "./coValueCore.js";
 import { Group } from "./group.js";
 
-export type CoID<T extends CoValueImpl> = RawCoID & {
+export type CoID<T extends CoValue> = RawCoID & {
     readonly __type: T;
 };
 
-export interface ReadableCoValue extends CoValue {
+export interface CoValue {
+    /** The `CoValue`'s (precisely typed) `CoID` */
+    id: CoID<this>;
+    core: CoValueCore;
+    /** Specifies which kind of `CoValue` this is */
+    type: string;
+    /** The `CoValue`'s (precisely typed) static metadata */
+    meta: JsonObject | null;
+    /** The `Group` this `CoValue` belongs to (determining permissions) */
+    group: Group;
+    /** Returns an immutable JSON presentation of this `CoValue` */
+    toJSON(): JsonValue;
+    atTime(time: number): this;
     /** Lets you subscribe to future updates to this CoValue (whether made locally or by other users).
      *
      * Takes a listener function that will be called with the current state for each update.
@@ -19,46 +34,62 @@ export interface ReadableCoValue extends CoValue {
      * Returns an unsubscribe function.
      *
      * Used internally by `useTelepathicData()` for reactive updates on changes to a `CoValue`. */
-    subscribe(listener: (coValue: CoValueImpl) => void): () => void;
-    /** Lets you apply edits to a `CoValue`, inside the changer callback, which receives a `WriteableCoValue`.
-     *
-     *  A `WritableCoValue` has all the same methods as a `CoValue`, but all edits made to it (with its additional mutator methods)
-     *  are reflected in it immediately - so it behaves mutably, whereas a `CoValue` is always immutable
-     *  (you need to use `subscribe` to receive new versions of it). */
-    edit?:
-        | ((changer: (editable: WriteableCoValue) => void) => CoValueImpl)
-        | undefined;
+    subscribe(listener: (coValue: this) => void): () => void;
 }
 
-export interface CoValue {
-    /** The `CoValue`'s (precisely typed) `CoID` */
-    id: CoID<CoValueImpl>;
-    core: CoValueCore;
-    /** Specifies which kind of `CoValue` this is */
-    type: CoValueImpl["type"];
-    /** The `CoValue`'s (precisely typed) static metadata */
-    meta: JsonObject | null;
-    /** The `Group` this `CoValue` belongs to (determining permissions) */
-    group: Group;
-    /** Returns an immutable JSON presentation of this `CoValue` */
-    toJSON(): JsonValue;
-}
+export type AnyCoMap = CoMap<
+    { [key: string]: JsonValue | CoValue | undefined },
+    JsonObject | null
+>;
 
-export interface WriteableCoValue extends CoValue {}
+export type AnyCoList = CoList<JsonValue | CoValue, JsonObject | null>;
 
-export type CoValueImpl =
-    | CoMap<{ [key: string]: JsonValue | undefined; }, JsonObject | null>
-    | CoList<JsonValue, JsonObject | null>
-    | CoStream<JsonValue, JsonObject | null>
-    | BinaryCoStream<BinaryCoStreamMeta>
-    | Static<JsonObject>;
+export type AnyCoStream = CoStream<JsonValue | CoValue, JsonObject | null>;
+
+export type AnyBinaryCoStream = BinaryCoStream<BinaryCoStreamMeta>;
+
+
+export type AnyCoValue =
+    | AnyCoMap
+    | AnyCoList
+    | AnyCoStream
+    | AnyBinaryCoStream
 
 export function expectMap(
-    content: CoValueImpl
-): CoMap<{ [key: string]: string }, JsonObject | null> {
+    content: CoValue
+): AnyCoMap {
     if (content.type !== "comap") {
         throw new Error("Expected map");
     }
 
-    return content as CoMap<{ [key: string]: string }, JsonObject | null>;
+    return content as AnyCoMap;
+}
+
+export function expectList(
+    content: CoValue
+): AnyCoList {
+    if (content.type !== "colist") {
+        throw new Error("Expected list");
+    }
+
+    return content as AnyCoList;
+}
+
+export function expectStream(
+    content: CoValue
+): AnyCoStream {
+    if (content.type !== "costream") {
+        throw new Error("Expected stream");
+    }
+
+    return content as AnyCoStream;
+}
+
+export function isCoValue(value: JsonValue | CoValue | undefined) : value is CoValue {
+    return (
+        value instanceof CoMap ||
+        value instanceof CoList ||
+        value instanceof CoStream ||
+        value instanceof BinaryCoStream
+    );
 }

packages/cojson/src/coValueCore.ts

@@ -1,6 +1,5 @@
 import { randomBytes } from "@noble/hashes/utils";
-import { CoValueImpl } from "./coValue.js";
-import { Static } from "./coValues/static.js";
+import { AnyCoValue, CoValue } from "./coValue.js";
 import { BinaryCoStream, CoStream } from "./coValues/coStream.js";
 import { CoMap } from "./coValues/coMap.js";
 import {
@@ -28,7 +27,7 @@ import {
     isKeyForKeyField,
 } from "./permissions.js";
 import { Group, expectGroupContent } from "./group.js";
-import { LocalNode } from "./node.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";
@@ -38,7 +37,7 @@ import { Stringified, stableStringify } from "./jsonStringify.js";
 export const MAX_RECOMMENDED_TX_SIZE = 100 * 1024;
 
 export type CoValueHeader = {
-    type: CoValueImpl["type"];
+    type: AnyCoValue["type"];
     ruleset: RulesetDef;
     meta: JsonObject | null;
     createdAt: `2${string}` | null;
@@ -99,8 +98,8 @@ export class CoValueCore {
     node: LocalNode;
     header: CoValueHeader;
     _sessions: { [key: SessionID]: SessionLog };
-    _cachedContent?: CoValueImpl;
-    listeners: Set<(content?: CoValueImpl) => void> = new Set();
+    _cachedContent?: CoValue;
+    listeners: Set<(content?: CoValue) => void> = new Set();
     _decryptionCache: {
         [key: Encrypted<JsonValue[], JsonValue>]:
             | Stringified<JsonValue[]>
@@ -376,7 +375,7 @@ export class CoValueCore {
         }
     }
 
-    subscribe(listener: (content?: CoValueImpl) => void): () => void {
+    subscribe(listener: (content?: CoValue) => void): () => void {
         this.listeners.add(listener);
         listener(this.getCurrentContent());
 
@@ -487,13 +486,13 @@ export class CoValueCore {
         );
 
         if (success) {
-            void this.node.sync.syncCoValue(this);
+            void this.node.syncManager.syncCoValue(this);
         }
 
         return success;
     }
 
-    getCurrentContent(): CoValueImpl {
+    getCurrentContent(): CoValue {
         if (this._cachedContent) {
             return this._cachedContent;
         }
@@ -508,8 +507,6 @@ export class CoValueCore {
             } else {
                 this._cachedContent = new CoStream(this);
             }
-        } else if (this.header.type === "static") {
-            this._cachedContent = new Static(this);
         } else {
             throw new Error(`Unknown coValue type ${this.header.type}`);
         }
@@ -611,26 +608,24 @@ export class CoValueCore {
 
             // Try to find key revelation for us
 
-            const readKeyEntry = content.getLastEntry(
+            const lastReadyKeyEdit = content.lastEditAt(
                 `${keyID}_for_${this.node.account.id}`
             );
 
-            if (readKeyEntry) {
-                const revealer = accountOrAgentIDfromSessionID(
-                    readKeyEntry.txID.sessionID
-                );
+            if (lastReadyKeyEdit?.value) {
+                const revealer = lastReadyKeyEdit.by;
                 const revealerAgent = this.node.resolveAccountAgent(
                     revealer,
                     "Expected to know revealer"
                 );
 
                 const secret = unseal(
-                    readKeyEntry.value,
+                    lastReadyKeyEdit.value,
                     this.node.account.currentSealerSecret(),
                     getAgentSealerID(revealerAgent),
                     {
                         in: this.id,
-                        tx: readKeyEntry.txID,
+                        tx: lastReadyKeyEdit.tx,
                     }
                 );
 
@@ -784,15 +779,16 @@ export class CoValueCore {
                     sessionEntry = {
                         after: sentState[sessionID] ?? 0,
                         newTransactions: [],
-                        lastSignature: "WILL_BE_REPLACED" as Signature
+                        lastSignature: "WILL_BE_REPLACED" as Signature,
                     };
                     currentPiece.new[sessionID] = sessionEntry;
                 }
 
                 sessionEntry.newTransactions.push(...txsToAdd);
-                sessionEntry.lastSignature = nextKnownSignatureIdx === undefined
-                ? log.lastSignature!
-                : log.signatureAfter[nextKnownSignatureIdx]!
+                sessionEntry.lastSignature =
+                    nextKnownSignatureIdx === undefined
+                        ? log.lastSignature!
+                        : log.signatureAfter[nextKnownSignatureIdx]!;
 
                 sentState[sessionID] =
                     (sentState[sessionID] || 0) + txsToAdd.length;

packages/cojson/src/coValues/coList.ts

@@ -1,22 +1,22 @@
 import { JsonObject, JsonValue } from "../jsonValue.js";
-import { CoID, ReadableCoValue, WriteableCoValue } from "../coValue.js";
+import { CoID, CoValue, isCoValue } from "../coValue.js";
 import { CoValueCore, accountOrAgentIDfromSessionID } from "../coValueCore.js";
-import { SessionID, TransactionID } from "../ids.js";
+import { AgentID, SessionID, TransactionID } from "../ids.js";
 import { Group } from "../group.js";
-import { AccountID, isAccountID } from "../account.js";
+import { AccountID } from "../account.js";
 import { parseJSON } from "../jsonStringify.js";
 
 type OpID = TransactionID & { changeIdx: number };
 
-type InsertionOpPayload<T extends JsonValue> =
+type InsertionOpPayload<T extends JsonValue | CoValue> =
     | {
           op: "pre";
-          value: T;
+          value: T extends CoValue ? CoID<T> : Exclude<T, CoValue>;
           before: OpID | "end";
       }
     | {
           op: "app";
-          value: T;
+          value: T extends CoValue ? CoID<T> : Exclude<T, CoValue>;
           after: OpID | "start";
       };
 
@@ -25,11 +25,11 @@ type DeletionOpPayload = {
     insertion: OpID;
 };
 
-export type ListOpPayload<T extends JsonValue> =
+export type ListOpPayload<T extends JsonValue | CoValue> =
     | InsertionOpPayload<T>
     | DeletionOpPayload;
 
-type InsertionEntry<T extends JsonValue> = {
+type InsertionEntry<T extends JsonValue | CoValue> = {
     madeAt: number;
     predecessors: OpID[];
     successors: OpID[];
@@ -40,11 +40,16 @@ type DeletionEntry = {
     deletionID: OpID;
 } & DeletionOpPayload;
 
-export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
-    implements ReadableCoValue
+export class CoListView<
+    Item extends JsonValue | CoValue,
+    Meta extends JsonObject | null = null
+> implements CoValue
 {
-    id: CoID<CoList<T, Meta>>;
+    /** @category 6. Meta */
+    id: CoID<this>;
+    /** @category 6. Meta */
     type = "colist" as const;
+    /** @category 6. Meta */
     core: CoValueCore;
     /** @internal */
     afterStart: OpID[];
@@ -54,7 +59,7 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
     insertions: {
         [sessionID: SessionID]: {
             [txIdx: number]: {
-                [changeIdx: number]: InsertionEntry<T>;
+                [changeIdx: number]: InsertionEntry<Item>;
             };
         };
     };
@@ -66,29 +71,18 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
             };
         };
     };
+    /** @category 6. Meta */
+    readonly _item!: Item;
 
     /** @internal */
     constructor(core: CoValueCore) {
-        this.id = core.id as CoID<CoList<T, Meta>>;
+        this.id = core.id as CoID<this>;
         this.core = core;
         this.afterStart = [];
         this.beforeEnd = [];
         this.insertions = {};
         this.deletionsByInsertion = {};
 
-        this.fillOpsFromCoValue();
-    }
-
-    get meta(): Meta {
-        return this.core.header.meta as Meta;
-    }
-
-    get group(): Group {
-        return this.core.getGroup();
-    }
-
-    /** @internal */
-    protected fillOpsFromCoValue() {
         this.insertions = {};
         this.deletionsByInsertion = {};
         this.afterStart = [];
@@ -99,8 +93,10 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
             changes,
             madeAt,
         } of this.core.getValidSortedTransactions()) {
-            for (const [changeIdx, changeUntyped] of parseJSON(changes).entries()) {
-                const change = changeUntyped as ListOpPayload<T>;
+            for (const [changeIdx, changeUntyped] of parseJSON(
+                changes
+            ).entries()) {
+                const change = changeUntyped as ListOpPayload<Item>;
 
                 if (change.op === "pre" || change.op === "app") {
                     let sessionEntry = this.insertions[txID.sessionID];
@@ -200,8 +196,35 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
         }
     }
 
-    /** Get the item currently at `idx`. */
-    get(idx: number): T | undefined {
+    /** @category 6. Meta */
+    get meta(): Meta {
+        return this.core.header.meta as Meta;
+    }
+
+    /** @category 6. Meta */
+    get group(): Group {
+        return this.core.getGroup();
+    }
+
+    /**
+     * Not yet implemented
+     *
+     * @category 4. Time travel
+     */
+    atTime(_time: number): this {
+        throw new Error("Not yet implemented");
+    }
+
+    /**
+     * Get the item currently at `idx`.
+     *
+     * @category 1. Reading
+     */
+    get(
+        idx: number
+    ):
+        | (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)
+        | undefined {
         const entry = this.entries()[idx];
         if (!entry) {
             return undefined;
@@ -209,13 +232,26 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
         return entry.value;
     }
 
-    /** Returns the current items in the CoList as an array. */
-    asArray(): T[] {
+    /**
+     * Returns the current items in the CoList as an array.
+     *
+     * @category 1. Reading
+     **/
+    asArray(): (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)[] {
         return this.entries().map((entry) => entry.value);
     }
 
-    entries(): { value: T; madeAt: number; opID: OpID }[] {
-        const arr: { value: T; madeAt: number; opID: OpID }[] = [];
+    /** @internal */
+     entries(): {
+        value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+        madeAt: number;
+        opID: OpID;
+    }[] {
+        const arr: {
+            value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+            madeAt: number;
+            opID: OpID;
+        }[] = [];
         for (const opID of this.afterStart) {
             this.fillArrayFromOpID(opID, arr);
         }
@@ -228,7 +264,11 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
     /** @internal */
     private fillArrayFromOpID(
         opID: OpID,
-        arr: { value: T; madeAt: number; opID: OpID }[]
+        arr: {
+            value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+            madeAt: number;
+            opID: OpID;
+        }[]
     ) {
         const entry =
             this.insertions[opID.sessionID]?.[opID.txIndex]?.[opID.changeIdx];
@@ -254,86 +294,115 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
         }
     }
 
-    /** Returns the accountID of the account that inserted value at the given index. */
-    whoInserted(idx: number): AccountID | undefined {
+    /**
+     * Returns the current items in the CoList as an array. (alias of `asArray`)
+     *
+     * @category 1. Reading
+     */
+    toJSON(): (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)[] {
+        return this.asArray();
+    }
+
+    /** @category 5. Edit history */
+    editAt(idx: number):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+          }
+        | undefined {
         const entry = this.entries()[idx];
         if (!entry) {
             return undefined;
         }
-        const accountID = accountOrAgentIDfromSessionID(entry.opID.sessionID);
-        if (isAccountID(accountID)) {
-            return accountID;
-        } else {
-            return undefined;
+        const madeAt = new Date(entry.madeAt);
+        const by = accountOrAgentIDfromSessionID(entry.opID.sessionID);
+        const value = entry.value;
+        return {
+            by,
+            tx: {
+                sessionID: entry.opID.sessionID,
+                txIndex: entry.opID.txIndex,
+            },
+            at: madeAt,
+            value,
+        };
+    }
+
+    /** @category 5. Edit history */
+    deletionEdits(): {
+        by: AccountID | AgentID;
+        tx: TransactionID;
+        at: Date;
+        // TODO: add indices that are now before and after the deleted item
+    }[] {
+        const edits: {
+            by: AccountID | AgentID;
+            tx: TransactionID;
+            at: Date;
+        }[] = [];
+
+        for (const sessionID in this.deletionsByInsertion) {
+            const sessionEntry =
+                this.deletionsByInsertion[sessionID as SessionID];
+            for (const txIdx in sessionEntry) {
+                const txEntry = sessionEntry[Number(txIdx)];
+                for (const changeIdx in txEntry) {
+                    const changeEntry = txEntry[Number(changeIdx)];
+                    for (const deletion of changeEntry || []) {
+                        const madeAt = new Date(deletion.madeAt);
+                        const by = accountOrAgentIDfromSessionID(
+                            deletion.deletionID.sessionID
+                        );
+                        edits.push({
+                            by,
+                            tx: deletion.deletionID,
+                            at: madeAt,
+                        });
+                    }
+                }
+            }
         }
+
+        return edits;
     }
 
-    /** Returns the current items in the CoList as an array. (alias of `asArray`) */
-    toJSON(): T[] {
-        return this.asArray();
-    }
-
-    map<U>(mapper: (value: T, idx: number) => U): U[] {
-        return this.entries().map((entry, idx) => mapper(entry.value, idx));
-    }
-
-    filter<U extends T>(predicate: (value: T, idx: number) => value is U): U[];
-    filter(predicate: (value: T, idx: number) => boolean): T[] {
-        return this.entries()
-            .filter((entry, idx) => predicate(entry.value, idx))
-            .map((entry) => entry.value);
-    }
-
-    reduce<U>(
-        reducer: (accumulator: U, value: T, idx: number) => U,
-        initialValue: U
-    ): U {
-        return this.entries().reduce(
-            (accumulator, entry, idx) => reducer(accumulator, entry.value, idx),
-            initialValue
-        );
-    }
-
-    subscribe(listener: (coMap: CoList<T, Meta>) => void): () => void {
+    /** @category 3. Subscription */
+    subscribe(listener: (coList: this) => void): () => void {
         return this.core.subscribe((content) => {
-            listener(content as CoList<T, Meta>);
+            listener(content as this);
         });
     }
-
-    edit(
-        changer: (editable: WriteableCoList<T, Meta>) => void
-    ): CoList<T, Meta> {
-        const editable = new WriteableCoList<T, Meta>(this.core);
-        changer(editable);
-        return new CoList(this.core);
-    }
 }
 
-export class WriteableCoList<
-        T extends JsonValue,
+export class CoList<
+        Item extends JsonValue | CoValue,
         Meta extends JsonObject | null = null
     >
-    extends CoList<T, Meta>
-    implements WriteableCoValue
+    extends CoListView<Item, Meta>
+    implements CoValue
 {
-    /** @internal */
-    edit(
-        _changer: (editable: WriteableCoList<T, Meta>) => void
-    ): CoList<T, Meta> {
-        throw new Error("Already editing.");
-    }
-
-    /** Appends a new item after index `after`.
+    /** Returns a new version of this CoList with `item` appended after the item currently at index `after`.
      *
-     * If `privacy` is `"private"` **(default)**, both `value` 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 `"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"`, both `value` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers. */
+     * 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. Editing
+     **/
     append(
-        after: number,
-        value: T,
+        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        after?: number,
         privacy: "private" | "trusting" = "private"
-    ): void {
+    ): this {
         const entries = this.entries();
+        after =
+            after === undefined
+                ? entries.length > 0
+                    ? entries.length - 1
+                    : 0
+                : 0;
         let opIDBefore;
         if (entries.length > 0) {
             const entryBefore = entries[after];
@@ -351,44 +420,32 @@ export class WriteableCoList<
             [
                 {
                     op: "app",
-                    value,
+                    value: isCoValue(item) ? item.id : item,
                     after: opIDBefore,
                 },
             ],
             privacy
         );
 
-        this.fillOpsFromCoValue();
-    }
-
-    /** Pushes a new item to the end of the list.
-     *
-     * If `privacy` is `"private"` **(default)**, both `value` 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"`, both `value` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers. */
-    push(value: T, privacy: "private" | "trusting" = "private"): void {
-        // TODO: optimize
-        const entries = this.entries();
-        this.append(
-            entries.length > 0 ? entries.length - 1 : 0,
-            value,
-            privacy
-        );
+        return new CoList(this.core) as this;
     }
 
     /**
-     * Prepends a new item before index `before`.
+     * Returns a new version of this CoList with `item` prepended before the item currently at index `before`.
      *
-     * If `privacy` is `"private"` **(default)**, both `value` 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 `"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"`, both `value` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
+     * 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. Editing
      */
     prepend(
-        before: number,
-        value: T,
+        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        before?: number,
         privacy: "private" | "trusting" = "private"
-    ): void {
+    ): this {
         const entries = this.entries();
+        before = before === undefined ? 0 : before;
         let opIDAfter;
         if (entries.length > 0) {
             const entryAfter = entries[before];
@@ -410,22 +467,25 @@ export class WriteableCoList<
             [
                 {
                     op: "pre",
-                    value,
+                    value: isCoValue(item) ? item.id : item,
                     before: opIDAfter,
                 },
             ],
             privacy
         );
 
-        this.fillOpsFromCoValue();
+        return new CoList(this.core) as this;
     }
 
-    /** Deletes the item at index `at` from the list.
+    /** Returns a new version of this CoList with the item at index `at` deleted 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. */
-    delete(at: number, privacy: "private" | "trusting" = "private"): void {
+     * 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. Editing
+     **/
+    delete(at: number, privacy: "private" | "trusting" = "private"): this {
         const entries = this.entries();
         const entry = entries[at];
         if (!entry) {
@@ -441,6 +501,96 @@ export class WriteableCoList<
             privacy
         );
 
-        this.fillOpsFromCoValue();
+        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);
+    }
+}
+
+export class MutableCoList<
+        Item extends JsonValue | CoValue,
+        Meta extends JsonObject | null = 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 extends CoValue ? Item | CoID<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;
+        this.deletionsByInsertion = listAfter.deletionsByInsertion;
+    }
+
+    /** 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 extends CoValue ? Item | CoID<Item> : Item,
+        before?: number,
+        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;
+    }
+
+    /** 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,
+            privacy
+        ) as CoList<Item, Meta>;
+        this.afterStart = listAfter.afterStart;
+        this.beforeEnd = listAfter.beforeEnd;
+        this.insertions = listAfter.insertions;
+        this.deletionsByInsertion = listAfter.deletionsByInsertion;
     }
 }

packages/cojson/src/coValues/coMap.ts

@@ -1,71 +1,70 @@
-import { JsonObject, JsonValue } from '../jsonValue.js';
-import { TransactionID } from '../ids.js';
-import { CoID, ReadableCoValue, WriteableCoValue } from '../coValue.js';
-import { CoValueCore, accountOrAgentIDfromSessionID } from '../coValueCore.js';
-import { AccountID, isAccountID } from '../account.js';
-import { Group } from '../group.js';
-import { parseJSON } from '../jsonStringify.js';
+import { JsonObject, JsonValue } from "../jsonValue.js";
+import { AgentID, TransactionID } from "../ids.js";
+import { CoID, CoValue, isCoValue } from "../coValue.js";
+import { CoValueCore, accountOrAgentIDfromSessionID } from "../coValueCore.js";
+import { AccountID } from "../account.js";
+import { Group } from "../group.js";
+import { parseJSON } from "../jsonStringify.js";
 
-type MapOp<K extends string, V extends JsonValue | undefined> = {
+type MapOp<K extends string, V extends JsonValue | CoValue | undefined> = {
     txID: TransactionID;
     madeAt: number;
     changeIdx: number;
 } & MapOpPayload<K, V>;
 // TODO: add after TransactionID[] for conflicts/ordering
 
-export type MapOpPayload<K extends string, V extends JsonValue | undefined> = {
-    op: "set";
-    key: K;
-    value: V;
-} |
+export type MapOpPayload<
+    K extends string,
+    V extends JsonValue | CoValue | undefined
+> =
+    | {
+          op: "set";
+          key: K;
+          value: V extends CoValue ? CoID<V> : Exclude<V, CoValue>;
+      }
+    | {
+          op: "del";
+          key: K;
+      };
+
+export class CoMapView<
+    Shape extends { [key: string]: JsonValue | CoValue | undefined },
+    Meta extends JsonObject | null = null
+> implements CoValue
 {
-    op: "del";
-    key: K;
-};
-
-export type MapK<M extends { [key: string]: JsonValue | undefined; }> = keyof M & string;
-export type MapV<M extends { [key: string]: JsonValue | undefined; }> = M[MapK<M>];
-
-
-/** A collaborative map with precise shape `M` and optional static metadata `Meta` */
-export class CoMap<
-    M extends { [key: string]: JsonValue | undefined; },
-    Meta extends JsonObject | null = null,
-> implements ReadableCoValue {
-    id: CoID<CoMap<M, Meta>>;
+    /** @category 6. Meta */
+    id: CoID<this>;
+    /** @category 6. Meta */
     type = "comap" as const;
+    /** @category 6. Meta */
     core: CoValueCore;
     /** @internal */
     ops: {
-        [KK in MapK<M>]?: MapOp<KK, M[KK]>[];
+        [Key in keyof Shape & string]?: MapOp<Key, Shape[Key]>[];
     };
+    /** @internal */
+    atTimeFilter?: number = undefined;
+    /** @category 6. Meta */
+    readonly _shape!: Shape;
 
     /** @internal */
     constructor(core: CoValueCore) {
-        this.id = core.id as CoID<CoMap<M, Meta>>;
+        this.id = core.id as CoID<this>;
         this.core = core;
         this.ops = {};
 
-        this.fillOpsFromCoValue();
-    }
-
-    get meta(): Meta {
-        return this.core.header.meta as Meta;
-    }
-
-    get group(): Group {
-        return this.core.getGroup();
-    }
-
-    /** @internal */
-    protected fillOpsFromCoValue() {
-        this.ops = {};
-
-        for (const { txID, changes, madeAt } of this.core.getValidSortedTransactions()) {
-            for (const [changeIdx, changeUntyped] of (
-                parseJSON(changes)
+        for (const {
+            txID,
+            changes,
+            madeAt,
+        } of core.getValidSortedTransactions()) {
+            for (const [changeIdx, changeUntyped] of parseJSON(
+                changes
             ).entries()) {
-                const change = changeUntyped as MapOpPayload<MapK<M>, MapV<M>>;
+                const change = changeUntyped as MapOpPayload<
+                    keyof Shape & string,
+                    Shape[keyof Shape & string]
+                >;
                 let entries = this.ops[change.key];
                 if (!entries) {
                     entries = [];
@@ -75,175 +74,373 @@ export class CoMap<
                     txID,
                     madeAt,
                     changeIdx,
-                    ...(change as MapOpPayload<MapK<M>, MapV<M>>),
+                    ...(change as MapOpPayload<
+                        keyof Shape & string,
+                        Shape[keyof Shape & string]
+                    >),
                 });
             }
         }
     }
 
-    keys(): MapK<M>[] {
-        return Object.keys(this.ops) as MapK<M>[];
+    /** @category 6. Meta */
+    get meta(): Meta {
+        return this.core.header.meta as Meta;
     }
 
-    /** Returns the current value for the given key. */
-    get<K extends MapK<M>>(key: K): M[K] | undefined {
-        const ops = this.ops[key];
+    /** @category 6. Meta */
+    get group(): Group {
+        return this.core.getGroup();
+    }
+
+    /** @category 4. Time travel */
+    atTime(time: number): this {
+        const clone = Object.create(this) as this;
+        clone.id = this.id;
+        clone.type = this.type;
+        clone.core = this.core;
+        clone.ops = this.ops;
+        clone.atTimeFilter = time;
+        return clone;
+    }
+
+    /** @internal */
+    timeFilteredOps<K extends keyof Shape & string>(
+        key: K
+    ): MapOp<K, Shape[K]>[] | undefined {
+        if (this.atTimeFilter) {
+            return this.ops[key]?.filter(
+                (op) => op.madeAt <= this.atTimeFilter!
+            );
+        } else {
+            return this.ops[key];
+        }
+    }
+
+    /**
+     * Get all keys currently in the map.
+     *
+     * @category 1. Reading */
+    keys(): (keyof Shape & string)[] {
+        const keys = Object.keys(this.ops) as (keyof Shape & string)[];
+
+        if (this.atTimeFilter) {
+            return keys.filter((key) => {
+                this.timeFilteredOps(key)?.length;
+            });
+        } else {
+            return keys;
+        }
+    }
+
+    /**
+     * Returns the current value for the given key.
+     *
+     * @category 1. Reading
+     **/
+    get<K extends keyof Shape & string>(
+        key: K
+    ):
+        | (Shape[K] extends CoValue
+              ? CoID<Shape[K]>
+              : Exclude<Shape[K], CoValue>)
+        | undefined {
+        const ops = this.timeFilteredOps(key);
         if (!ops) {
             return undefined;
         }
 
-        const lastEntry = ops[ops.length - 1]!;
+        const includeUntil = this.atTimeFilter;
+        const lastEntry = includeUntil
+            ? ops.findLast((entry) => entry.madeAt <= includeUntil)
+            : ops[ops.length - 1]!;
 
-        if (lastEntry.op === "del") {
+        if (lastEntry?.op === "del") {
             return undefined;
         } else {
-            return lastEntry.value;
+            return lastEntry?.value;
         }
     }
 
-    getAtTime<K extends MapK<M>>(key: K, time: number): M[K] | undefined {
-        const ops = this.ops[key];
-        if (!ops) {
-            return undefined;
-        }
-
-        const lastOpBeforeOrAtTime = ops.findLast((op) => op.madeAt <= time);
-
-        if (!lastOpBeforeOrAtTime) {
-            return undefined;
-        }
-
-        if (lastOpBeforeOrAtTime.op === "del") {
-            return undefined;
-        } else {
-            return lastOpBeforeOrAtTime.value;
-        }
-    }
-
-    /** Returns the accountID of the last account to modify the value for the given key. */
-    whoEdited<K extends MapK<M>>(key: K): AccountID | undefined {
-        const tx  = this.getLastTxID(key);
-        if (!tx) {
-            return undefined;
-        }
-        const accountID = accountOrAgentIDfromSessionID(tx.sessionID);
-        if (isAccountID(accountID)) {
-            return accountID;
-        } else {
-            return undefined;
-        }
-    }
-
-    getLastTxID<K extends MapK<M>>(key: K): TransactionID | undefined {
-        const ops = this.ops[key];
-        if (!ops) {
-            return undefined;
-        }
-
-        const lastEntry = ops[ops.length - 1]!;
-
-        return lastEntry.txID;
-    }
-
-    getLastEntry<K extends MapK<M>>(key: K): { at: number; txID: TransactionID; value: M[K]; } | undefined {
-        const ops = this.ops[key];
-        if (!ops) {
-            return undefined;
-        }
-
-        const lastEntry = ops[ops.length - 1]!;
-
-        if (lastEntry.op === "del") {
-            return undefined;
-        } else {
-            return { at: lastEntry.madeAt, txID: lastEntry.txID, value: lastEntry.value };
-        }
-    }
-
-    getHistory<K extends MapK<M>>(key: K): { at: number; txID: TransactionID; value: M[K] | undefined; }[] {
-        const ops = this.ops[key];
-        if (!ops) {
-            return [];
-        }
-
-        const history: { at: number; txID: TransactionID; value: M[K] | undefined; }[] = [];
-
-        for (const op of ops) {
-            if (op.op === "del") {
-                history.push({ at: op.madeAt, txID: op.txID, value: undefined });
-            } else {
-                history.push({ at: op.madeAt, txID: op.txID, value: op.value });
-            }
-        }
-
-        return history;
-    }
-
-    toJSON(): JsonObject {
-        const json: JsonObject = {};
+    /** @category 1. Reading */
+    asObject(): {
+        [K in keyof Shape & string]: Shape[K] extends CoValue
+            ? CoID<Shape[K]>
+            : Exclude<Shape[K], CoValue>;
+    } {
+        const object: Partial<{
+            [K in keyof Shape & string]: Shape[K] extends CoValue
+                ? CoID<Shape[K]>
+                : Exclude<Shape[K], CoValue>;
+        }> = {};
 
         for (const key of this.keys()) {
             const value = this.get(key);
             if (value !== undefined) {
-                json[key] = value;
+                object[key] = value;
             }
         }
 
-        return json;
+        return object as {
+            [K in keyof Shape & string]: Shape[K] extends CoValue
+                ? CoID<Shape[K]>
+                : Exclude<Shape[K], CoValue>;
+        };
     }
 
-    subscribe(listener: (coMap: CoMap<M, Meta>) => void): () => void {
+    /** @category 1. Reading */
+    toJSON(): {
+        [K in keyof Shape & string]: Shape[K] extends CoValue
+            ? CoID<Shape[K]>
+            : Exclude<Shape[K], CoValue>;
+    } {
+        return this.asObject();
+    }
+
+    /** @category 5. Edit history */
+    nthEditAt<K extends keyof Shape & string>(
+        key: K,
+        n: number
+    ):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value?: Shape[K] extends CoValue
+                  ? CoID<Shape[K]>
+                  : Exclude<Shape[K], CoValue>;
+          }
+        | undefined {
+        const ops = this.timeFilteredOps(key);
+        if (!ops || ops.length <= n) {
+            return undefined;
+        }
+
+        const entry = ops[n]!;
+
+        if (this.atTimeFilter && entry.madeAt > this.atTimeFilter) {
+            return undefined;
+        }
+
+        return {
+            by: accountOrAgentIDfromSessionID(entry.txID.sessionID),
+            tx: entry.txID,
+            at: new Date(entry.madeAt),
+            value: entry.op === "del" ? undefined : entry.value,
+        };
+    }
+
+    /** @category 5. Edit history */
+    lastEditAt<K extends keyof Shape & string>(
+        key: K
+    ):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value?: Shape[K] extends CoValue
+                  ? CoID<Shape[K]>
+                  : Exclude<Shape[K], CoValue>;
+          }
+        | undefined {
+        const ops = this.timeFilteredOps(key);
+        if (!ops || ops.length === 0) {
+            return undefined;
+        }
+        return this.nthEditAt(key, ops.length - 1);
+    }
+
+    /** @category 5. Edit history */
+    *editsAt<K extends keyof Shape & string>(key: K) {
+        const ops = this.timeFilteredOps(key);
+        if (!ops) {
+            return;
+        }
+
+        for (let i = 0; i < ops.length; i++) {
+            yield this.nthEditAt(key, i)!;
+        }
+    }
+
+    /** @category 3. Subscription */
+    subscribe(listener: (coMap: this) => void): () => void {
         return this.core.subscribe((content) => {
-            listener(content as CoMap<M, Meta>);
+            listener(content as this);
         });
     }
-
-    edit(changer: (editable: WriteableCoMap<M, Meta>) => void): CoMap<M, Meta> {
-        const editable = new WriteableCoMap<M, Meta>(this.core);
-        changer(editable);
-        return new CoMap(this.core);
-    }
 }
 
-export class WriteableCoMap<
-    M extends { [key: string]: JsonValue | undefined; },
-    Meta extends JsonObject | null = null,
-> extends CoMap<M, Meta> implements WriteableCoValue {
-    /** @internal */
-    edit(_changer: (editable: WriteableCoMap<M, Meta>) => void): CoMap<M, Meta> {
-        throw new Error("Already editing.");
+/** A collaborative map with precise shape `Shape` and optional static metadata `Meta` */
+export class CoMap<
+        Shape extends { [key: string]: JsonValue | CoValue | undefined },
+        Meta extends JsonObject | null = null
+    >
+    extends CoMapView<Shape, Meta>
+    implements CoValue
+{
+
+
+    /** Returns a new version of this CoMap with 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. Editing
+     **/
+    set<K extends keyof Shape & string>(
+        key: K,
+        value: Shape[K] extends CoValue ? Shape[K] | CoID<Shape[K]> : Shape[K],
+        privacy?: "private" | "trusting"
+    ): this;
+    set(
+        kv: {
+            [K in keyof Shape & string]?: Shape[K] extends CoValue
+                ? Shape[K] | CoID<Shape[K]>
+                : Shape[K];
+        },
+        privacy?: "private" | "trusting"
+    ): this;
+    set<K extends keyof Shape & string>(
+        ...args:
+            | [
+                  {
+                      [K in keyof Shape & string]?: Shape[K] extends CoValue
+                          ? Shape[K] | CoID<Shape[K]>
+                          : Shape[K];
+                  },
+                  ("private" | "trusting")?
+              ]
+            | [
+                  K,
+                  Shape[K] extends CoValue
+                      ? Shape[K] | CoID<Shape[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 [
+                {
+                    [K in keyof Shape & string]: Shape[K] extends CoValue
+                        ? Shape[K] | CoID<Shape[K]>
+                        : Shape[K];
+                },
+                "private" | "trusting" | undefined
+            ];
+
+            for (const [key, value] of Object.entries(kv)) {
+                this.core.makeTransaction(
+                    [
+                        {
+                            op: "set",
+                            key,
+                            value: isCoValue(value) ? value.id : value,
+                        },
+                    ],
+                    privacy
+                );
+            }
+        }
+
+        return new CoMap(this.core) as this;
     }
 
+    /** Returns a new version of this CoMap with the given key deleted (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. Editing
+     **/
+    delete(
+        key: keyof Shape & string,
+        privacy: "private" | "trusting" = "private"
+    ): this {
+        this.core.makeTransaction(
+            [
+                {
+                    op: "del",
+                    key,
+                },
+            ],
+            privacy
+        );
+
+        return new CoMap(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 CoMap(this.core) as this;
+    }
+
+    /** @deprecated Use `mutate` instead. */
+    edit(mutator: (mutable: MutableCoMap<Shape, Meta>) => void): this {
+        return this.mutate(mutator);
+    }
+}
+
+export class MutableCoMap<
+        Shape extends { [key: string]: JsonValue | CoValue | undefined },
+        Meta extends JsonObject | null = 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. */
-    set<K extends MapK<M>>(key: K, value: M[K], privacy: "private" | "trusting" = "private"): void {
-        this.core.makeTransaction([
-            {
-                op: "set",
-                key,
-                value,
-            },
-        ], privacy);
-
-        this.fillOpsFromCoValue();
+     * 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] extends CoValue ? Shape[K] | CoID<Shape[K]> : 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. */
-    delete(key: MapK<M>, privacy: "private" | "trusting" = "private"): void {
-        this.core.makeTransaction([
-            {
-                op: "del",
-                key,
-            },
-        ], privacy);
-
-        this.fillOpsFromCoValue();
+     * 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;
     }
 }

packages/cojson/src/coValues/coStream.ts

@@ -1,14 +1,13 @@
 import { JsonObject, JsonValue } from "../jsonValue.js";
-import { CoID, ReadableCoValue, WriteableCoValue } from "../coValue.js";
+import { CoValue, CoID, isCoValue } from "../coValue.js";
 import { CoValueCore, accountOrAgentIDfromSessionID } from "../coValueCore.js";
 import { Group } from "../group.js";
-import { SessionID } from "../ids.js";
+import { AgentID, SessionID, TransactionID } from "../ids.js";
 import { base64URLtoBytes, bytesToBase64url } from "../base64url.js";
-import { AccountID } from "../index.js";
-import { isAccountID } from "../account.js";
+import { AccountID } from "../account.js";
 import { parseJSON } from "../jsonStringify.js";
 
-export type BinaryChunkInfo = {
+export type BinaryStreamInfo = {
     mimeType: string;
     fileName?: string;
     totalSizeBytes?: number;
@@ -16,7 +15,7 @@ export type BinaryChunkInfo = {
 
 export type BinaryStreamStart = {
     type: "start";
-} & BinaryChunkInfo;
+} & BinaryStreamInfo;
 
 export type BinaryStreamChunk = {
     type: "chunk";
@@ -34,20 +33,27 @@ export type BinaryStreamItem =
     | BinaryStreamChunk
     | BinaryStreamEnd;
 
-export class CoStream<
-    T extends JsonValue,
+export type CoStreamItem<Item extends JsonValue | CoValue> = {
+    value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+    tx: TransactionID;
+    madeAt: number;
+};
+
+export class CoStreamView<
+    Item extends JsonValue | CoValue,
     Meta extends JsonObject | null = null
-> implements ReadableCoValue
+> implements CoValue
 {
-    id: CoID<CoStream<T, Meta>>;
+    id: CoID<this>;
     type = "costream" as const;
     core: CoValueCore;
     items: {
-        [key: SessionID]: {item: T, madeAt: number}[];
+        [key: SessionID]: CoStreamItem<Item>[];
     };
+    readonly _item!: Item;
 
     constructor(core: CoValueCore) {
-        this.id = core.id as CoID<CoStream<T, Meta>>;
+        this.id = core.id as CoID<this>;
         this.core = core;
         this.items = {};
         this.fillFromCoValue();
@@ -61,6 +67,11 @@ export class CoStream<
         return this.core.getGroup();
     }
 
+    /** Not yet implemented */
+    atTime(_time: number): this {
+        throw new Error("Not yet implemented");
+    }
+
     /** @internal */
     protected fillFromCoValue() {
         this.items = {};
@@ -71,18 +82,22 @@ export class CoStream<
             changes,
         } of this.core.getValidSortedTransactions()) {
             for (const changeUntyped of parseJSON(changes)) {
-                const change = changeUntyped as T;
+                const change = changeUntyped as Item extends CoValue
+                    ? CoID<Item>
+                    : Exclude<Item, CoValue>;
                 let entries = this.items[txID.sessionID];
                 if (!entries) {
                     entries = [];
                     this.items[txID.sessionID] = entries;
                 }
-                entries.push({item: change, madeAt});
+                entries.push({ value: change, madeAt, tx: txID });
             }
         }
     }
 
-    getSingleStream(): T[] | undefined {
+    getSingleStream():
+        | (Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>)[]
+        | undefined {
         if (Object.keys(this.items).length === 0) {
             return undefined;
         } else if (Object.keys(this.items).length !== 1) {
@@ -91,86 +106,202 @@ export class CoStream<
             );
         }
 
-        return Object.values(this.items)[0]?.map(item => item.item);
+        return Object.values(this.items)[0]?.map((item) => item.value);
     }
 
-    getLastItemsPerAccount(): {[account: AccountID]: T | undefined} {
-        const result: {[account: AccountID]: {item: T, madeAt: number} | undefined} = {};
+    sessions(): SessionID[] {
+        return Object.keys(this.items) as SessionID[];
+    }
 
-        for (const [sessionID, items] of Object.entries(this.items)) {
-            const account = accountOrAgentIDfromSessionID(sessionID as SessionID);
-            if (!isAccountID(account)) continue;
-            if (items.length > 0) {
-                const lastItemOfSession = items[items.length - 1]!;
-                if (!result[account] || lastItemOfSession.madeAt > result[account]!.madeAt) {
-                    result[account] = lastItemOfSession;
-                }
-            }
+    accounts(): Set<AccountID | AgentID> {
+        return new Set(this.sessions().map(accountOrAgentIDfromSessionID));
+    }
+
+    nthItemIn(
+        sessionID: SessionID,
+        n: number
+    ):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+          }
+        | undefined {
+        const items = this.items[sessionID];
+        if (!items) return;
+
+        const item = items[n];
+        if (!item) return;
+
+        return {
+            by: accountOrAgentIDfromSessionID(sessionID),
+            tx: item.tx,
+            at: new Date(item.madeAt),
+            value: item.value,
+        };
+    }
+
+    lastItemIn(sessionID: SessionID):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+          }
+        | undefined {
+        const items = this.items[sessionID];
+        if (!items) return;
+        return this.nthItemIn(sessionID, items.length - 1);
+    }
+
+    *itemsIn(sessionID: SessionID) {
+        const items = this.items[sessionID];
+        if (!items) return;
+        for (const item of items) {
+            yield {
+                by: accountOrAgentIDfromSessionID(sessionID),
+                tx: item.tx,
+                at: new Date(item.madeAt),
+                value: item.value,
+            };
         }
-
-        return Object.fromEntries(Object.entries(result).map(([account, item]) =>
-            [account, item?.item]
-        ));
     }
 
-    getLastItemFrom(account: AccountID): T | undefined {
-        let lastItem: {item: T, madeAt: number} | undefined;
+    lastItemBy(account: AccountID | AgentID):
+        | {
+              by: AccountID | AgentID;
+              tx: TransactionID;
+              at: Date;
+              value: Item extends CoValue ? CoID<Item> : Exclude<Item, CoValue>;
+          }
+        | undefined {
+        let latestItem:
+            | {
+                  by: AccountID | AgentID;
+                  tx: TransactionID;
+                  at: Date;
+                  value: Item extends CoValue
+                      ? CoID<Item>
+                      : Exclude<Item, CoValue>;
+              }
+            | undefined;
 
-        for (const [sessionID, items] of Object.entries(this.items)) {
+        for (const sessionID of Object.keys(this.items)) {
             if (sessionID.startsWith(account)) {
-                if (items.length > 0) {
-                    const lastItemOfSession = items[items.length - 1]!;
-                    if (!lastItem || lastItemOfSession.madeAt > lastItem.madeAt) {
-                        lastItem = lastItemOfSession;
-                    }
+                const item = this.lastItemIn(sessionID as SessionID);
+                if (!item) continue;
+                if (!latestItem || item.at > latestItem.at) {
+                    latestItem = {
+                        by: item.by,
+                        tx: item.tx,
+                        at: item.at,
+                        value: item.value,
+                    };
                 }
             }
         }
 
-        return lastItem?.item;
+        return latestItem;
     }
 
-    getLastItemFromMe(): T | undefined {
-        const myAccountID = this.core.node.account.id;
-        if (!isAccountID(myAccountID)) return undefined;
-        return this.getLastItemFrom(myAccountID);
+    *itemsBy(account: AccountID | AgentID) {
+        // TODO: this can be made more lazy without a huge collect and sort
+        const items = [
+            ...Object.keys(this.items).flatMap((sessionID) =>
+                sessionID.startsWith(account)
+                    ? [...this.itemsIn(sessionID as SessionID)].map((item) => ({
+                          in: sessionID as SessionID,
+                          ...item,
+                      }))
+                    : []
+            ),
+        ];
+
+        items.sort((a, b) => a.at.getTime() - b.at.getTime());
+
+        for (const item of items) {
+            yield item;
+        }
     }
 
     toJSON(): {
-        [key: SessionID]: T[];
+        [key: SessionID]: (Item extends CoValue
+            ? CoID<Item>
+            : Exclude<Item, CoValue>)[];
     } {
-        return Object.fromEntries(Object.entries(this.items).map(([sessionID, items]) =>
-            [sessionID, items.map(item => item.item)]
-        ));
+        return Object.fromEntries(
+            Object.entries(this.items).map(([sessionID, items]) => [
+                sessionID,
+                items.map((item) => item.value),
+            ])
+        );
     }
 
-    subscribe(listener: (coMap: CoStream<T, Meta>) => void): () => void {
+    subscribe(listener: (coStream: this) => void): () => void {
         return this.core.subscribe((content) => {
-            listener(content as CoStream<T, Meta>);
+            listener(content as this);
         });
     }
+}
 
-    edit(
-        changer: (editable: WriteableCoStream<T, Meta>) => void
-    ): CoStream<T, Meta> {
-        const editable = new WriteableCoStream<T, Meta>(this.core);
-        changer(editable);
-        return new CoStream(this.core);
+export class CoStream<
+        Item extends JsonValue | CoValue,
+        Meta extends JsonObject | null = null
+    >
+    extends CoStreamView<Item, Meta>
+    implements CoValue
+{
+    push(
+        item: Item extends CoValue ? Item | CoID<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 | CoValue,
+        Meta extends JsonObject | null = null
+    >
+    extends CoStreamView<Item, Meta>
+    implements CoValue
+{
+    push(
+        item: Item extends CoValue ? Item | CoID<Item> : Item,
+        privacy: "private" | "trusting" = "private"
+    ) {
+        this.core.makeTransaction([isCoValue(item) ? item.id : item], privacy);
+        this.fillFromCoValue();
     }
 }
 
 const binary_U_prefixLength = 8; // "binary_U".length;
 
-export class BinaryCoStream<
+export class BinaryCoStreamView<
         Meta extends BinaryCoStreamMeta = { type: "binary" }
     >
-    extends CoStream<BinaryStreamItem, Meta>
-    implements ReadableCoValue
+    extends CoStreamView<BinaryStreamItem, Meta>
+    implements CoValue
 {
-    id!: CoID<BinaryCoStream<Meta>>;
+    id!: CoID<this>;
 
-    getBinaryChunks(allowUnfinished?: boolean):
-        | (BinaryChunkInfo & { chunks: Uint8Array[]; finished: boolean })
+    getBinaryChunks(
+        allowUnfinished?: boolean
+    ):
+        | (BinaryStreamInfo & { chunks: Uint8Array[]; finished: boolean })
         | undefined {
         // const before = performance.now();
         const items = this.getSingleStream();
@@ -225,56 +356,89 @@ export class BinaryCoStream<
             finished,
         };
     }
-
-    edit(
-        changer: (editable: WriteableBinaryCoStream<Meta>) => void
-    ): BinaryCoStream<Meta> {
-        const editable = new WriteableBinaryCoStream<Meta>(this.core);
-        changer(editable);
-        return new BinaryCoStream(this.core);
-    }
 }
 
-export class WriteableCoStream<
-        T extends JsonValue,
-        Meta extends JsonObject | null = null
-    >
-    extends CoStream<T, Meta>
-    implements WriteableCoValue
-{
-    /** @internal */
-    edit(
-        _changer: (editable: WriteableCoStream<T, Meta>) => void
-    ): CoStream<T, Meta> {
-        throw new Error("Already editing.");
-    }
-
-    push(item: T, privacy: "private" | "trusting" = "private") {
-        this.core.makeTransaction([item], privacy);
-        this.fillFromCoValue();
-    }
-}
-
-export class WriteableBinaryCoStream<
+export class BinaryCoStream<
         Meta extends BinaryCoStreamMeta = { type: "binary" }
     >
-    extends BinaryCoStream<Meta>
-    implements WriteableCoValue
+    extends BinaryCoStreamView<Meta>
+    implements CoValue
 {
     /** @internal */
-    edit(
-        _changer: (editable: WriteableBinaryCoStream<Meta>) => void
-    ): BinaryCoStream<Meta> {
-        throw new Error("Already editing.");
-    }
-
-    /** @internal */
-    push(item: BinaryStreamItem, privacy: "private" | "trusting" = "private") {
-        WriteableCoStream.prototype.push.call(this, item, privacy);
+    push(
+        item: BinaryStreamItem,
+        privacy: "private" | "trusting" = "private"
+    ): this {
+        this.core.makeTransaction([item], privacy);
+        return new BinaryCoStream(this.core) as this;
     }
 
     startBinaryStream(
-        settings: BinaryChunkInfo,
+        settings: BinaryStreamInfo,
+        privacy: "private" | "trusting" = "private"
+    ): this {
+        return this.push(
+            {
+                type: "start",
+                ...settings,
+            } satisfies BinaryStreamStart,
+            privacy
+        );
+    }
+
+    pushBinaryStreamChunk(
+        chunk: Uint8Array,
+        privacy: "private" | "trusting" = "private"
+    ): this {
+        // const before = performance.now();
+        return 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 {
+        return this.push(
+            {
+                type: "end",
+            } satisfies BinaryStreamEnd,
+            privacy
+        );
+    }
+
+    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(

packages/cojson/src/coValues/static.ts

@@ -1,31 +0,0 @@
-import { JsonObject } from '../jsonValue.js';
-import { CoID, ReadableCoValue } from '../coValue.js';
-import { CoValueCore } from '../coValueCore.js';
-import { Group } from '../index.js';
-
-export class Static<T extends JsonObject> implements ReadableCoValue{
-    id: CoID<Static<T>>;
-    type = "static" as const;
-    core: CoValueCore;
-
-    constructor(core: CoValueCore) {
-        this.id = core.id as CoID<Static<T>>;
-        this.core = core;
-    }
-
-    get meta(): T {
-        return this.core.header.meta as T;
-    }
-
-    get group(): Group {
-        return this.core.getGroup();
-    }
-
-    toJSON(): JsonObject {
-        throw new Error("Method not implemented.");
-    }
-
-    subscribe(_listener: (coMap: Static<T>) => void): () => void {
-        throw new Error("Method not implemented.");
-    }
-}

packages/cojson/src/crypto.ts

@@ -6,33 +6,43 @@ import { randomBytes } from "@noble/ciphers/webcrypto/utils";
 import { AgentID, RawCoID, TransactionID } from "./ids.js";
 import { base64URLtoBytes, bytesToBase64url } from "./base64url.js";
 
-import { createBLAKE3 } from 'hash-wasm';
+import { createBLAKE3 } from "hash-wasm";
 import { Stringified, parseJSON, stableStringify } from "./jsonStringify.js";
 
 let blake3Instance: Awaited<ReturnType<typeof createBLAKE3>>;
 let blake3HashOnce: (data: Uint8Array) => Uint8Array;
-let blake3HashOnceWithContext: (data: Uint8Array, {context}: {context: Uint8Array}) => Uint8Array;
-let blake3incrementalUpdateSLOW_WITH_DEVTOOLS: (state: Uint8Array, data: Uint8Array) => Uint8Array;
+let blake3HashOnceWithContext: (
+    data: Uint8Array,
+    { context }: { context: Uint8Array }
+) => Uint8Array;
+let blake3incrementalUpdateSLOW_WITH_DEVTOOLS: (
+    state: Uint8Array,
+    data: Uint8Array
+) => Uint8Array;
 let blake3digestForState: (state: Uint8Array) => Uint8Array;
 
 export const cryptoReady = new Promise<void>((resolve) => {
-    createBLAKE3().then(bl3 => {
-        blake3Instance = bl3;
-        blake3HashOnce = (data) => {
-            return bl3.init().update(data).digest('binary');
-        }
-        blake3HashOnceWithContext = (data, {context}) => {
-            return bl3.init().update(context).update(data).digest('binary');
-        }
-        blake3incrementalUpdateSLOW_WITH_DEVTOOLS = (state, data) => {
-            bl3.load(state).update(data);
-            return bl3.save();
-        }
-        blake3digestForState = (state) => {
-            return bl3.load(state).digest('binary');
-        }
-        resolve();
-    })
+    createBLAKE3()
+        .then((bl3) => {
+            blake3Instance = bl3;
+            blake3HashOnce = (data) => {
+                return bl3.init().update(data).digest("binary");
+            };
+            blake3HashOnceWithContext = (data, { context }) => {
+                return bl3.init().update(context).update(data).digest("binary");
+            };
+            blake3incrementalUpdateSLOW_WITH_DEVTOOLS = (state, data) => {
+                bl3.load(state).update(data);
+                return bl3.save();
+            };
+            blake3digestForState = (state) => {
+                return bl3.load(state).digest("binary");
+            };
+            resolve();
+        })
+        .catch((e) =>
+            console.error("Failed to load cryptography dependencies", e)
+        );
 });
 
 export type SignerSecret = `signerSecret_z${string}`;
@@ -149,12 +159,17 @@ export function getAgentSealerSecret(agentSecret: AgentSecret): SealerSecret {
     return agentSecret.split("/")[0] as SealerSecret;
 }
 
-export function seal<T extends JsonValue>(
-    message: T,
-    from: SealerSecret,
-    to: SealerID,
-    nOnceMaterial: { in: RawCoID; tx: TransactionID }
-): Sealed<T> {
+export function seal<T extends JsonValue>({
+    message,
+    from,
+    to,
+    nOnceMaterial,
+}: {
+    message: T;
+    from: SealerSecret;
+    to: SealerID;
+    nOnceMaterial: { in: RawCoID; tx: TransactionID };
+}): Sealed<T> {
     const nOnce = blake3HashOnce(
         textEncoder.encode(stableStringify(nOnceMaterial))
     ).slice(0, 24);
@@ -220,9 +235,12 @@ export class StreamingHash {
     }
 
     update(value: JsonValue) {
-        const encoded = textEncoder.encode(stableStringify(value))
+        const encoded = textEncoder.encode(stableStringify(value));
         // const before = performance.now();
-        this.state = blake3incrementalUpdateSLOW_WITH_DEVTOOLS(this.state, encoded);
+        this.state = blake3incrementalUpdateSLOW_WITH_DEVTOOLS(
+            this.state,
+            encoded
+        );
         // const after = performance.now();
         // console.log(`Hashing throughput in MB/s`, 1000 * (encoded.length / (after - before)) / (1024 * 1024));
     }
@@ -333,8 +351,7 @@ function decryptRaw<T extends JsonValue, N extends JsonValue>(
     );
     const plaintext = xsalsa20(keySecretBytes, nOnce, ciphertext);
 
-        return textDecoder.decode(plaintext) as Stringified<T>;
-
+    return textDecoder.decode(plaintext) as Stringified<T>;
 }
 
 function decrypt<T extends JsonValue, N extends JsonValue>(
@@ -345,7 +362,7 @@ function decrypt<T extends JsonValue, N extends JsonValue>(
     try {
         return parseJSON(decryptRaw(encrypted, keySecret, nOnceMaterial));
     } catch (e) {
-        console.error("Decryption error", e)
+        console.error("Decryption error", e);
         return undefined;
     }
 }

packages/cojson/src/group.ts

@@ -1,4 +1,4 @@
-import { CoID, CoValueImpl } from "./coValue.js";
+import { CoID, CoValue, AnyCoValue, AnyCoMap, AnyCoList } from "./coValue.js";
 import { CoMap } from "./coValues/coMap.js";
 import { JsonObject, JsonValue } from "./jsonValue.js";
 import {
@@ -15,18 +15,21 @@ import {
     agentSecretFromSecretSeed,
     getAgentID,
 } from "./crypto.js";
-import { LocalNode } from "./node.js";
+import { LocalNode } from "./localNode.js";
 import { AgentID, SessionID, isAgentID } from "./ids.js";
 import { AccountID, GeneralizedControlledAccount, Profile } from "./account.js";
 import { Role } from "./permissions.js";
 import { base58 } from "@scure/base";
-import { CoList } from "./coValues/coList.js";
-import { BinaryCoStream, BinaryCoStreamMeta, CoStream } from "./coValues/coStream.js";
+import {
+    BinaryCoStream,
+    BinaryCoStreamMeta,
+    CoStream,
+} from "./coValues/coStream.js";
 
 export type GroupContent = {
-    profile: CoID<Profile> | null;
+    profile?: CoID<Profile> | null;
     [key: AccountID | AgentID]: Role;
-    readKey: KeyID;
+    readKey?: KeyID;
     [revelationFor: `${KeyID}_for_${AccountID | AgentID}`]: Sealed<KeySecret>;
     [oldKeyForNewKey: `${KeyID}_for_${KeyID}`]: Encrypted<
         KeySecret,
@@ -35,7 +38,7 @@ export type GroupContent = {
 };
 
 export function expectGroupContent(
-    content: CoValueImpl
+    content: CoValue
 ): CoMap<GroupContent, JsonObject | null> {
     if (content.type !== "comap") {
         throw new Error("Expected map");
@@ -66,6 +69,7 @@ export function expectGroupContent(
  *  ```
  * */
 export class Group {
+    /** @category 4. Underlying CoMap */
     underlyingMap: CoMap<GroupContent, JsonObject | null>;
     /** @internal */
     node: LocalNode;
@@ -79,12 +83,20 @@ export class Group {
         this.node = node;
     }
 
-    /** Returns the `CoID` of the `Group`. */
+    /**
+     * Returns the `CoID` of the `Group`.
+     *
+     * @category 4. Underlying CoMap
+     */
     get id(): CoID<CoMap<GroupContent, JsonObject | null>> {
         return this.underlyingMap.id;
     }
 
-    /** Returns the current role of a given account. */
+    /**
+     * Returns the current role of a given account.
+     *
+     * @category 1. Role reading
+     */
     roleOf(accountID: AccountID): Role | undefined {
         return this.roleOfInternal(accountID);
     }
@@ -94,20 +106,28 @@ export class Group {
         return this.underlyingMap.get(accountID);
     }
 
-    /** Returns the role of the current account in the group. */
+    /**
+     * Returns the role of the current account in the group.
+     *
+     * @category 1. Role reading
+     */
     myRole(): Role | undefined {
         return this.roleOfInternal(this.node.account.id);
     }
 
-    /** Directly grants a new member a role in the group. The current account must be an
-     * admin to be able to do so. Throws otherwise. */
+    /**
+     * Directly grants a new member a role in the group. The current account must be an
+     * admin to be able to do so. Throws otherwise.
+     *
+     * @category 2. Role changing
+     */
     addMember(accountID: AccountID, role: Role) {
         this.addMemberInternal(accountID, role);
     }
 
     /** @internal */
     addMemberInternal(accountID: AccountID | AgentID, role: Role) {
-        this.underlyingMap = this.underlyingMap.edit((map) => {
+        this.underlyingMap = this.underlyingMap.mutate((map) => {
             const currentReadKey = this.underlyingMap.core.getCurrentReadKey();
 
             if (!currentReadKey.secret) {
@@ -127,15 +147,15 @@ export class Group {
 
             map.set(
                 `${currentReadKey.id}_for_${accountID}`,
-                seal(
-                    currentReadKey.secret,
-                    this.underlyingMap.core.node.account.currentSealerSecret(),
-                    getAgentSealerID(agent),
-                    {
+                seal({
+                    message: currentReadKey.secret,
+                    from: this.underlyingMap.core.node.account.currentSealerSecret(),
+                    to: getAgentSealerID(agent),
+                    nOnceMaterial: {
                         in: this.underlyingMap.core.id,
                         tx: this.underlyingMap.core.nextTransactionID(),
-                    }
-                ),
+                    },
+                }),
                 "trusting"
             );
         });
@@ -173,7 +193,7 @@ export class Group {
 
         const newReadKey = newRandomKeySecret();
 
-        this.underlyingMap = this.underlyingMap.edit((map) => {
+        this.underlyingMap = this.underlyingMap.mutate((map) => {
             for (const readerID of currentlyPermittedReaders) {
                 const reader = this.node.resolveAccountAgent(
                     readerID,
@@ -182,15 +202,15 @@ export class Group {
 
                 map.set(
                     `${newReadKey.id}_for_${readerID}`,
-                    seal(
-                        newReadKey.secret,
-                        this.underlyingMap.core.node.account.currentSealerSecret(),
-                        getAgentSealerID(reader),
-                        {
+                    seal({
+                        message: newReadKey.secret,
+                        from: this.underlyingMap.core.node.account.currentSealerSecret(),
+                        to: getAgentSealerID(reader),
+                        nOnceMaterial: {
                             in: this.underlyingMap.core.id,
                             tx: this.underlyingMap.core.nextTransactionID(),
-                        }
-                    ),
+                        },
+                    }),
                     "trusting"
                 );
             }
@@ -208,23 +228,33 @@ export class Group {
         });
     }
 
-    /** Strips the specified member of all roles (preventing future writes in
+    /**
+     * Strips the specified member of all roles (preventing future writes in
      *  the group and owned values) and rotates the read encryption key for that group
-     * (preventing reads of new content in the group and owned values) */
+     * (preventing reads of new content in the group and owned values)
+     *
+     * @category 2. Role changing
+     */
     removeMember(accountID: AccountID) {
         this.removeMemberInternal(accountID);
     }
 
     /** @internal */
     removeMemberInternal(accountID: AccountID | AgentID) {
-        this.underlyingMap = this.underlyingMap.edit((map) => {
+        this.underlyingMap = this.underlyingMap.mutate((map) => {
             map.set(accountID, "revoked", "trusting");
         });
 
         this.rotateReadKey();
     }
 
-    /** Creates an invite for new members to indirectly join the group, allowing them to grant themselves the specified role with the InviteSecret (a string starting with "inviteSecret_") - use `LocalNode.acceptInvite()` for this purpose. */
+    /**
+     * Creates an invite for new members to indirectly join the group,
+     * allowing them to grant themselves the specified role with the InviteSecret
+     * (a string starting with "inviteSecret_") - use `LocalNode.acceptInvite()` for this purpose.
+     *
+     * @category 2. Role changing
+     */
     createInvite(role: "reader" | "writer" | "admin"): InviteSecret {
         const secretSeed = newRandomSecretSeed();
 
@@ -236,12 +266,22 @@ export class Group {
         return inviteSecretFromSecretSeed(secretSeed);
     }
 
-    /** Creates a new `CoMap` within this group, with the specified specialized
-     *  `CoMap` type `M` and optional static metadata. */
-    createMap<M extends CoMap<{ [key: string]: JsonValue | undefined; }, JsonObject | null>>(
-        meta?: M["meta"]
+    /**
+     * Creates a new `CoMap` within this group, with the specified specialized
+     * `CoMap` type `M` and optional static metadata.
+     *
+     * @category 3. Value creation
+     */
+    createMap<M extends AnyCoMap>(
+        init?: {
+            [K in keyof M["_shape"]]: M["_shape"][K] extends AnyCoValue
+                ? M["_shape"][K] | CoID<M["_shape"][K]>
+                : M["_shape"][K];
+        },
+        meta?: M["meta"],
+        initPrivacy: "trusting" | "private" = "trusting"
     ): M {
-        return this.node
+        let map = this.node
             .createCoValue({
                 type: "comap",
                 ruleset: {
@@ -252,14 +292,30 @@ export class Group {
                 ...createdNowUnique(),
             })
             .getCurrentContent() as M;
+
+        if (init) {
+            for (const [key, value] of Object.entries(init)) {
+                map = map.set(key, value, initPrivacy);
+            }
+        }
+
+        return map;
     }
 
-    /** Creates a new `CoList` within this group, with the specified specialized
-     * `CoList` type `L` and optional static metadata. */
-    createList<L extends CoList<JsonValue, JsonObject | null>>(
-        meta?: L["meta"]
+    /**
+     * Creates a new `CoList` within this group, with the specified specialized
+     * `CoList` type `L` and optional static metadata.
+     *
+     * @category 3. Value creation
+     */
+    createList<L extends AnyCoList>(
+        init?: (L["_item"] extends CoValue
+            ? CoID<L["_item"]> | L["_item"]
+            : L["_item"])[],
+        meta?: L["meta"],
+        initPrivacy: "trusting" | "private" = "trusting"
     ): L {
-        return this.node
+        let list = this.node
             .createCoValue({
                 type: "colist",
                 ruleset: {
@@ -270,9 +326,18 @@ export class Group {
                 ...createdNowUnique(),
             })
             .getCurrentContent() as L;
+
+        if (init) {
+            for (const item of init) {
+                list = list.append(item, undefined, initPrivacy);
+            }
+        }
+
+        return list;
     }
 
-    createStream<C extends CoStream<JsonValue, JsonObject | null>>(
+    /** @category 3. Value creation */
+    createStream<C extends CoStream<JsonValue | CoValue, JsonObject | null>>(
         meta?: C["meta"]
     ): C {
         return this.node
@@ -288,9 +353,10 @@ export class Group {
             .getCurrentContent() as C;
     }
 
-    createBinaryStream<
-        C extends BinaryCoStream<BinaryCoStreamMeta>
-    >(meta: C["meta"] = { type: "binary" }): C {
+    /** @category 3. Value creation */
+    createBinaryStream<C extends BinaryCoStream<BinaryCoStreamMeta>>(
+        meta: C["meta"] = { type: "binary" }
+    ): C {
         return this.node
             .createCoValue({
                 type: "costream",

packages/cojson/src/index.ts

@@ -1,13 +1,17 @@
-import { CoValueCore, newRandomSessionID, MAX_RECOMMENDED_TX_SIZE } from "./coValueCore.js";
-import { LocalNode } from "./node.js";
-import type { CoValue, ReadableCoValue } from "./coValue.js";
-import { CoMap, WriteableCoMap } from "./coValues/coMap.js";
-import { CoList, WriteableCoList } from "./coValues/coList.js";
+import {
+    CoValueCore,
+    newRandomSessionID,
+    MAX_RECOMMENDED_TX_SIZE,
+} from "./coValueCore.js";
+import { LocalNode } from "./localNode.js";
+import type { CoValue } from "./coValue.js";
+import { CoMap, MutableCoMap } from "./coValues/coMap.js";
+import { CoList, MutableCoList } from "./coValues/coList.js";
 import {
     CoStream,
-    WriteableCoStream,
+    MutableCoStream,
     BinaryCoStream,
-    WriteableBinaryCoStream,
+    MutableBinaryCoStream,
 } from "./coValues/coStream.js";
 import {
     agentSecretFromBytes,
@@ -18,7 +22,7 @@ import {
     agentSecretFromSecretSeed,
     secretSeedLength,
     shortHashLength,
-    cryptoReady
+    cryptoReady,
 } from "./crypto.js";
 import { connectedPeers } from "./streamUtils.js";
 import { AnonymousControlledAccount, ControlledAccount } from "./account.js";
@@ -28,16 +32,23 @@ import { base64URLtoBytes, bytesToBase64url } from "./base64url.js";
 import { parseJSON } from "./jsonStringify.js";
 
 import type { SessionID, AgentID } from "./ids.js";
-import type { CoID, CoValueImpl } from "./coValue.js";
-import type { BinaryChunkInfo, BinaryCoStreamMeta } from "./coValues/coStream.js";
+import type { CoID, AnyCoValue } from "./coValue.js";
+import type { Queried } from "./queries.js";
+import type { QueriedCoStream } from "./queriedCoValues/queriedCoStream.js";
+import type { QueriedCoList } from "./queriedCoValues/queriedCoList.js";
+import type { QueriedCoMap } from "./queriedCoValues/queriedCoMap.js";
+import type {
+    BinaryStreamInfo,
+    BinaryCoStreamMeta,
+} from "./coValues/coStream.js";
 import type { JsonValue } from "./jsonValue.js";
 import type { SyncMessage, Peer } from "./sync.js";
 import type { AgentSecret } from "./crypto.js";
-import type { AccountID, Profile } from "./account.js";
+import type { AccountID, Account, Profile } from "./account.js";
 import type { InviteSecret } from "./group.js";
 import type * as Media from "./media.js";
 
-type Value = JsonValue | CoValueImpl;
+type Value = JsonValue | AnyCoValue;
 
 /** @hidden */
 export const cojsonInternals = {
@@ -56,45 +67,46 @@ export const cojsonInternals = {
     expectGroupContent,
     base64URLtoBytes,
     bytesToBase64url,
-    parseJSON
+    parseJSON,
 };
 
 export {
     LocalNode,
     Group,
     CoMap,
-    WriteableCoMap,
+    MutableCoMap,
     CoList,
-    WriteableCoList,
+    MutableCoList,
     CoStream,
-    WriteableCoStream,
+    MutableCoStream,
     BinaryCoStream,
-    WriteableBinaryCoStream,
+    MutableBinaryCoStream,
+    CoValue,
+    CoID,
+    AnyCoValue,
+    Queried,
+    QueriedCoMap,
+    QueriedCoList,
+    QueriedCoStream,
+    AccountID,
+    Account,
+    Profile,
+    SessionID,
+    Media,
     CoValueCore,
     AnonymousControlledAccount,
     ControlledAccount,
     cryptoReady as cojsonReady,
-    MAX_RECOMMENDED_TX_SIZE
-};
-
-export type {
+    MAX_RECOMMENDED_TX_SIZE,
     Value,
     JsonValue,
-    CoValue,
-    ReadableCoValue,
-    CoValueImpl,
-    CoID,
-    AccountID,
-    Profile,
-    SessionID,
     Peer,
-    BinaryChunkInfo,
+    BinaryStreamInfo,
     BinaryCoStreamMeta,
     AgentID,
     AgentSecret,
     InviteSecret,
     SyncMessage,
-    Media
 };
 
 // eslint-disable-next-line @typescript-eslint/no-namespace

packages/cojson/src/localNode.ts

@@ -9,7 +9,11 @@ import {
     newRandomKeySecret,
     seal,
 } from "./crypto.js";
-import { CoValueCore, CoValueHeader, newRandomSessionID } from "./coValueCore.js";
+import {
+    CoValueCore,
+    CoValueHeader,
+    newRandomSessionID,
+} from "./coValueCore.js";
 import {
     InviteSecret,
     Group,
@@ -19,9 +23,10 @@ import {
 } from "./group.js";
 import { Peer, SyncManager } from "./sync.js";
 import { AgentID, RawCoID, SessionID, isAgentID } from "./ids.js";
-import { CoID, CoValueImpl } from "./coValue.js";
+import { CoID } from "./coValue.js";
+import { Queried, query } from "./queries.js";
 import {
-    Account,
+    AccountGroup,
     AccountMeta,
     accountHeaderForInitialAgentSecret,
     GeneralizedControlledAccount,
@@ -30,9 +35,9 @@ import {
     AccountID,
     Profile,
     AccountContent,
-    AccountMap,
 } from "./account.js";
 import { CoMap } from "./coValues/coMap.js";
+import { CoValue } from "./index.js";
 
 /** A `LocalNode` represents a local view of a set of loaded `CoValue`s, from the perspective of a particular account (or primitive cryptographic agent).
 
@@ -48,11 +53,14 @@ const { localNode } = useJazz();
 export class LocalNode {
     /** @internal */
     coValues: { [key: RawCoID]: CoValueState } = {};
-    /** @internal */
+    /** @category 3. Low-level */
     account: GeneralizedControlledAccount;
+    /** @category 3. Low-level */
     currentSessionID: SessionID;
-    sync = new SyncManager(this);
+    /** @category 3. Low-level */
+    syncManager = new SyncManager(this);
 
+    /** @category 3. Low-level */
     constructor(
         account: GeneralizedControlledAccount,
         currentSessionID: SessionID
@@ -61,6 +69,7 @@ export class LocalNode {
         this.currentSessionID = currentSessionID;
     }
 
+    /** @category 2. Node Creation */
     static withNewlyCreatedAccount(
         name: string,
         initialAgentSecret = newRandomAgentSecret()
@@ -91,6 +100,7 @@ export class LocalNode {
         };
     }
 
+    /** @category 2. Node Creation */
     static async withLoadedAccount(
         accountID: AccountID,
         accountSecret: AgentSecret,
@@ -105,7 +115,7 @@ export class LocalNode {
         const accountPromise = loadingNode.load(accountID);
 
         for (const peer of peersToLoadFrom) {
-            loadingNode.sync.addPeer(peer);
+            loadingNode.syncManager.addPeer(peer);
         }
 
         const account = await accountPromise;
@@ -115,8 +125,8 @@ export class LocalNode {
             new ControlledAccount(accountSecret, account, loadingNode),
             sessionID
         );
-        node.sync = loadingNode.sync;
-        node.sync.local = node;
+        node.syncManager = loadingNode.syncManager;
+        node.syncManager.local = node;
 
         return node;
     }
@@ -126,7 +136,7 @@ export class LocalNode {
         const coValue = new CoValueCore(header, this);
         this.coValues[coValue.id] = { state: "loaded", coValue: coValue };
 
-        void this.sync.syncCoValue(coValue);
+        void this.syncManager.syncCoValue(coValue);
 
         return coValue;
     }
@@ -139,7 +149,7 @@ export class LocalNode {
 
             this.coValues[id] = entry;
 
-            this.sync.loadFromPeers(id);
+            this.syncManager.loadFromPeers(id);
         }
         if (entry.state === "loaded") {
             return Promise.resolve(entry.coValue);
@@ -151,28 +161,51 @@ export class LocalNode {
      * Loads a CoValue's content, syncing from peers as necessary and resolving the returned
      * promise once a first version has been loaded. See `coValue.subscribe()` and `node.useTelepathicData()`
      * for listening to subsequent updates to the CoValue.
+     *
+     * @category 3. Low-level
      */
-    async load<T extends CoValueImpl>(id: CoID<T>): Promise<T> {
+    async load<T extends CoValue>(id: CoID<T>): Promise<T> {
         return (await this.loadCoValue(id)).getCurrentContent() as T;
     }
 
-    /**
-     * Loads a profile associated with an account. `Profile` is at least a `CoMap<{string: name}>`,
-     * but might contain other, app-specific properties.
-     */
-    async loadProfile(id: AccountID): Promise<Profile> {
-        const account = await this.load<AccountMap>(id);
-        const profileID = account.get("profile");
+    /** @category 3. Low-level */
+    subscribe<T extends CoValue>(
+        id: CoID<T>,
+        callback: (update: T) => void
+    ): () => void {
+        let stopped = false;
+        let unsubscribe!: () => void;
 
-        if (!profileID) {
-            throw new Error(`Account ${id} has no profile`);
-        }
-        return (
-            await this.loadCoValue(profileID)
-        ).getCurrentContent() as Profile;
+        console.log("Subscribing to " + id);
+
+        this.load(id)
+            .then((coValue) => {
+                if (stopped) {
+                    return;
+                }
+                unsubscribe = coValue.subscribe(callback);
+            })
+            .catch((e) => {
+                console.error("Error subscribing to ", id, e);
+            });
+
+        return () => {
+            console.log("Unsubscribing from " + id);
+            stopped = true;
+            unsubscribe?.();
+        };
     }
 
-    async acceptInvite<T extends CoValueImpl>(
+    /** @category 1. High-level */
+    query<T extends CoValue>(
+        id: CoID<T>,
+        callback: (update: Queried<T> | undefined) => void
+    ): () => void {
+        return query(id, this, callback);
+    }
+
+    /** @category 1. High-level */
+    async acceptInvite<T extends CoValue>(
         groupOrOwnedValueID: CoID<T>,
         inviteSecret: InviteSecret
     ): Promise<void> {
@@ -204,10 +237,7 @@ export class LocalNode {
                 }
             });
             setTimeout(
-                () =>
-                    reject(
-                        new Error("Couldn't find invite before timeout")
-                    ),
+                () => reject(new Error("Couldn't find invite before timeout")),
                 2000
             );
         });
@@ -224,7 +254,9 @@ export class LocalNode {
             (existingRole === "writer" && inviteRole === "reader") ||
             (existingRole === "reader" && inviteRole === "readerInvite")
         ) {
-            console.debug("Not accepting invite that would replace or downgrade role");
+            console.debug(
+                "Not accepting invite that would replace or downgrade role"
+            );
             return;
         }
 
@@ -242,7 +274,8 @@ export class LocalNode {
                 : "reader"
         );
 
-        group.underlyingMap.core._sessions = groupAsInvite.underlyingMap.core.sessions;
+        group.underlyingMap.core._sessions =
+            groupAsInvite.underlyingMap.core.sessions;
         group.underlyingMap.core._cachedContent = undefined;
 
         for (const groupListener of group.underlyingMap.core.listeners) {
@@ -292,11 +325,12 @@ export class LocalNode {
         name: string,
         agentSecret = newRandomAgentSecret()
     ): ControlledAccount {
+        const accountAgentID = getAgentID(agentSecret);
         const account = this.createCoValue(
             accountHeaderForInitialAgentSecret(agentSecret)
         ).testWithDifferentAccount(
             new AnonymousControlledAccount(agentSecret),
-            newRandomSessionID(getAgentID(agentSecret))
+            newRandomSessionID(accountAgentID)
         );
 
         const accountAsGroup = new Group(
@@ -304,22 +338,22 @@ export class LocalNode {
             account.node
         );
 
-        accountAsGroup.underlyingMap.edit((editable) => {
-            editable.set(getAgentID(agentSecret), "admin", "trusting");
+        accountAsGroup.underlyingMap.mutate((editable) => {
+            editable.set(accountAgentID, "admin", "trusting");
 
             const readKey = newRandomKeySecret();
 
             editable.set(
-                `${readKey.id}_for_${getAgentID(agentSecret)}`,
-                seal(
-                    readKey.secret,
-                    getAgentSealerSecret(agentSecret),
-                    getAgentSealerID(getAgentID(agentSecret)),
-                    {
+                `${readKey.id}_for_${accountAgentID}`,
+                seal({
+                    message: readKey.secret,
+                    from: getAgentSealerSecret(agentSecret),
+                    to: getAgentSealerID(accountAgentID),
+                    nOnceMaterial: {
                         in: account.id,
                         tx: account.nextTransactionID(),
-                    }
-                ),
+                    },
+                }),
                 "trusting"
             );
 
@@ -332,28 +366,38 @@ export class LocalNode {
             account.node
         );
 
-        const profile = accountAsGroup.createMap<Profile>({
-            type: "profile",
-        });
+        const profile = accountAsGroup.createMap<Profile>(
+            { name },
+            {
+                type: "profile",
+            },
+            "trusting"
+        );
 
-        profile.edit((editable) => {
-            editable.set("name", name, "trusting");
-        });
-
-        accountAsGroup.underlyingMap.edit((editable) => {
-            editable.set("profile", profile.id, "trusting");
-        });
+        accountAsGroup.underlyingMap.set("profile", profile.id, "trusting");
 
         const accountOnThisNode = this.expectCoValueLoaded(account.id);
 
-        accountOnThisNode._sessions = {...accountAsGroup.underlyingMap.core.sessions};
+        accountOnThisNode._sessions = {
+            ...accountAsGroup.underlyingMap.core.sessions,
+        };
         accountOnThisNode._cachedContent = undefined;
 
+        const profileOnThisNode = this.createCoValue(profile.core.header);
+
+        profileOnThisNode._sessions = {
+            ...profile.core.sessions,
+        };
+        profileOnThisNode._cachedContent = undefined;
+
         return controlledAccount;
     }
 
     /** @internal */
-    resolveAccountAgent(id: AccountID | AgentID, expectation?: string): AgentID {
+    resolveAccountAgent(
+        id: AccountID | AgentID,
+        expectation?: string
+    ): AgentID {
         if (isAgentID(id)) {
             return id;
         }
@@ -374,13 +418,16 @@ export class LocalNode {
             );
         }
 
-        return new Account(
+        return new AccountGroup(
             coValue.getCurrentContent() as CoMap<GroupContent, AccountMeta>,
             this
         ).getCurrentAgentID();
     }
 
-    /** Creates a new group (with the current account as the group's first admin). */
+    /**
+     * Creates a new group (with the current account as the group's first admin).
+     * @category 1. High-level
+     */
     createGroup(): Group {
         const groupCoValue = this.createCoValue({
             type: "comap",
@@ -391,22 +438,22 @@ export class LocalNode {
 
         let groupContent = expectGroupContent(groupCoValue.getCurrentContent());
 
-        groupContent = groupContent.edit((editable) => {
+        groupContent = groupContent.mutate((editable) => {
             editable.set(this.account.id, "admin", "trusting");
 
             const readKey = newRandomKeySecret();
 
             editable.set(
                 `${readKey.id}_for_${this.account.id}`,
-                seal(
-                    readKey.secret,
-                    this.account.currentSealerSecret(),
-                    this.account.currentSealerID(),
-                    {
+                seal({
+                    message: readKey.secret,
+                    from: this.account.currentSealerSecret(),
+                    to: this.account.currentSealerID(),
+                    nOnceMaterial: {
                         in: groupCoValue.id,
                         tx: groupCoValue.nextTransactionID(),
-                    }
-                ),
+                    },
+                }),
                 "trusting"
             );
 
@@ -443,7 +490,11 @@ export class LocalNode {
                     continue;
                 }
 
-                const newCoValue = new CoValueCore(entry.coValue.header, newNode, {...entry.coValue.sessions});
+                const newCoValue = new CoValueCore(
+                    entry.coValue.header,
+                    newNode,
+                    { ...entry.coValue.sessions }
+                );
 
                 newNode.coValues[coValueID as RawCoID] = {
                     state: "loaded",

packages/cojson/src/media.ts

@@ -1,9 +1,8 @@
 import { CoMap } from './coValues/coMap.js'
-import { CoID } from './coValue.js'
 import { BinaryCoStream } from './coValues/coStream.js'
 
 export type ImageDefinition = CoMap<{
     originalSize: [number, number];
     placeholderDataURL?: string;
-    [res: `${number}x${number}`]: CoID<BinaryCoStream>;
+    [res: `${number}x${number}`]: BinaryCoStream;
 }>;

packages/cojson/src/permissions.ts

@@ -1,9 +1,7 @@
 import { CoID } from "./coValue.js";
 import { MapOpPayload } from "./coValues/coMap.js";
 import { JsonValue } from "./jsonValue.js";
-import {
-    KeyID,
-} from "./crypto.js";
+import { KeyID } from "./crypto.js";
 import {
     CoValueCore,
     Transaction,
@@ -11,11 +9,9 @@ import {
     accountOrAgentIDfromSessionID,
 } from "./coValueCore.js";
 import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
-import {
-    AccountID,
-    Profile,
-} from "./account.js";
+import { AccountID, Profile } from "./account.js";
 import { parseJSON } from "./jsonStringify.js";
+import { expectGroupContent } from "./group.js";
 
 export type PermissionsDef =
     | { type: "group"; initialAdmin: AccountID | AgentID }
@@ -77,7 +73,24 @@ export function determineValidTransactions(
             // console.log("before", { memberState, validTransactions });
             const transactor = accountOrAgentIDfromSessionID(sessionID);
 
-            const changes = parseJSON(tx.changes)
+            let changes;
+
+            try {
+                changes = parseJSON(tx.changes);
+            } catch (e) {
+                console.warn(
+                    coValue.id,
+                    "Invalid JSON in transaction",
+                    e,
+                    tx,
+                    JSON.stringify(tx.changes, (k, v) =>
+                        k === "changes" || k === "encryptedChanges"
+                            ? v.slice(0, 20) + "..."
+                            : v
+                    )
+                );
+                continue;
+            }
 
             const change = changes[0] as
                 | MapOpPayload<AccountID | AgentID, Role>
@@ -193,12 +206,14 @@ export function determineValidTransactions(
 
         return validTransactions;
     } else if (coValue.header.ruleset.type === "ownedByGroup") {
-        const groupContent = coValue.node
-            .expectCoValueLoaded(
-                coValue.header.ruleset.group,
-                "Determining valid transaction in owned object but its group wasn't loaded"
-            )
-            .getCurrentContent();
+        const groupContent = expectGroupContent(
+            coValue.node
+                .expectCoValueLoaded(
+                    coValue.header.ruleset.group,
+                    "Determining valid transaction in owned object but its group wasn't loaded"
+                )
+                .getCurrentContent()
+        );
 
         if (groupContent.type !== "comap") {
             throw new Error("Group must be a map");
@@ -211,10 +226,9 @@ export function determineValidTransactions(
                 );
                 return sessionLog.transactions
                     .filter((tx) => {
-                        const transactorRoleAtTxTime = groupContent.getAtTime(
-                            transactor,
-                            tx.madeAt
-                        );
+                        const transactorRoleAtTxTime = groupContent
+                            .atTime(tx.madeAt)
+                            .get(transactor);
 
                         return (
                             transactorRoleAtTxTime === "admin" ||
@@ -238,7 +252,7 @@ export function determineValidTransactions(
         );
     } else {
         throw new Error(
-            "Unknown ruleset type " + (coValue.header.ruleset as any).type
+            "Unknown ruleset type " + (coValue.header.ruleset as {type: string}).type
         );
     }
 }

packages/cojson/src/queriedCoValues/queriedCoList.ts

@@ -0,0 +1,248 @@
+import { CoList, MutableCoList } from "../coValues/coList.js";
+import { CoValueCore } from "../coValueCore.js";
+import { Group } from "../group.js";
+import { isAccountID } from "../account.js";
+import { AnyCoList, CoID, CoValue } from "../coValue.js";
+import { TransactionID } from "../ids.js";
+import { QueriedAccountAndProfile } from "./queriedCoMap.js";
+import { ValueOrSubQueried, QueryContext } from "../queries.js";
+
+export class QueriedCoList<L extends AnyCoList> extends Array<
+    ValueOrSubQueried<L["_item"]>
+> {
+    coList!: L;
+    id!: CoID<L>;
+    type!: "colist";
+
+    /** @internal */
+    constructor(coList: L, queryContext: QueryContext) {
+        if (!(coList instanceof CoList)) {
+            // this might be called from an intrinsic, like map, trying to create an empty array
+            // passing `0` as the only parameter
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            return new Array(coList) as any;
+        }
+        super(
+            ...coList
+                .asArray()
+                .map(
+                    (item) =>
+                        queryContext.resolveValue(item) as ValueOrSubQueried<
+                            L["_item"]
+                        >
+                )
+        );
+
+        Object.defineProperties(this, {
+            coList: { value: coList },
+            id: { value: coList.id },
+            type: { value: "colist" },
+            edits: {
+                value: [...this.keys()].map((i) => {
+                    const edit = coList.editAt(i)!;
+                    return {
+                        by:
+                            edit.by && isAccountID(edit.by)
+                                ? queryContext.resolveAccount(edit.by)
+                                : undefined,
+                        tx: edit.tx,
+                        at: new Date(edit.at),
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        value: queryContext.resolveValue(edit.value) as any,
+                    };
+                }),
+            },
+            deletions: {
+                value: coList.deletionEdits().map((deletion) => ({
+                    by:
+                        deletion.by && isAccountID(deletion.by)
+                            ? queryContext.resolveAccount(deletion.by)
+                            : undefined,
+                    tx: deletion.tx,
+                    at: new Date(deletion.at),
+                })),
+            },
+        });
+    }
+
+    get meta(): L["meta"] {
+        return this.coList.meta;
+    }
+
+    get group(): Group {
+        return this.coList.group;
+    }
+
+    get core(): CoValueCore {
+        return this.coList.core;
+    }
+
+    append(
+        item: L["_item"] extends CoValue
+            ? L["_item"] | CoID<L["_item"]>
+            : L["_item"],
+        after?: number,
+        privacy?: "private" | "trusting"
+    ): L {
+        return this.coList.append(item, after, privacy);
+    }
+
+    prepend(
+        item: L["_item"] extends CoValue
+            ? L["_item"] | CoID<L["_item"]>
+            : L["_item"],
+        before?: number,
+        privacy?: "private" | "trusting"
+    ): L {
+        return this.coList.prepend(item, before, privacy);
+    }
+
+    delete(at: number, privacy: "private" | "trusting"): L {
+        return this.coList.delete(at, privacy);
+    }
+
+    mutate(
+        mutator: (mutable: MutableCoList<L["_item"], L["meta"]>) => void
+    ): L {
+        return this.coList.mutate(mutator);
+    }
+
+    edits!: {
+        by?: QueriedAccountAndProfile;
+        tx: TransactionID;
+        at: Date;
+        value: L["_item"] extends CoValue
+            ? CoID<L["_item"]>
+            : Exclude<L["_item"], CoValue>;
+    }[];
+
+    deletions!: {
+        by?: QueriedAccountAndProfile;
+        tx: TransactionID;
+        at: Date;
+    }[];
+
+    /** @internal */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isArray(arg: any): arg is any[] {
+        return Array.isArray(arg);
+    }
+
+    /** @internal */
+    static from<T>(arrayLike: ArrayLike<T>): T[];
+    /** @internal */
+    static from<T, U>(
+        arrayLike: ArrayLike<T>,
+        mapfn: (v: T, k: number) => U,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        thisArg?: any
+    ): U[];
+    /** @internal */
+    static from<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
+    /** @internal */
+    static from<T, U>(
+        iterable: Iterable<T> | ArrayLike<T>,
+        mapfn: (v: T, k: number) => U,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        thisArg?: any
+    ): U[];
+    /** @internal */
+    static from<T, U>(
+        _iterable: unknown,
+        _mapfn?: unknown,
+        _thisArg?: unknown
+    ): T[] | U[] | T[] | U[] {
+        throw new Error("Array method 'from' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    static of<T>(..._items: T[]): T[] {
+        throw new Error("Array method 'of' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    pop(): ValueOrSubQueried<L["_item"]> | undefined {
+        throw new Error("Array method 'pop' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    push(..._items: ValueOrSubQueried<L["_item"]>[]): number {
+        throw new Error("Array method 'push' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    concat(
+        ..._items: ConcatArray<ValueOrSubQueried<L["_item"]>>[]
+    ): ValueOrSubQueried<L["_item"]>[];
+    /** @internal */
+    concat(
+        ..._items: (
+            | ValueOrSubQueried<L["_item"]>
+            | ConcatArray<ValueOrSubQueried<L["_item"]>>
+        )[]
+    ): ValueOrSubQueried<L["_item"]>[];
+    /** @internal */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    concat(..._items: any[]): ValueOrSubQueried<L["_item"]>[] {
+        throw new Error("Array method 'concat' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    reverse(): ValueOrSubQueried<L["_item"]>[] {
+        throw new Error(
+            "Array method 'reverse' not supported on QueriedCoList"
+        );
+    }
+
+    /** @internal */
+    shift(): ValueOrSubQueried<L["_item"]> | undefined {
+        throw new Error("Array method 'shift' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    sort(
+        _compareFn?:
+            | ((
+                  a: ValueOrSubQueried<L["_item"]>,
+                  b: ValueOrSubQueried<L["_item"]>
+              ) => number)
+            | undefined
+    ): this {
+        throw new Error("Array method 'sort' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    splice(
+        _start: number,
+        _deleteCount?: number | undefined
+    ): ValueOrSubQueried<L["_item"]>[] {
+        throw new Error("Array method 'splice' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    unshift(..._items: ValueOrSubQueried<L["_item"]>[]): number {
+        throw new Error(
+            "Array method 'unshift' not supported on QueriedCoList"
+        );
+    }
+
+    /** @internal */
+    fill(
+        _value: ValueOrSubQueried<L["_item"]>,
+        _start?: number | undefined,
+        _end?: number | undefined
+    ): this {
+        throw new Error("Array method 'fill' not supported on QueriedCoList");
+    }
+
+    /** @internal */
+    copyWithin(
+        _target: number,
+        _start: number,
+        _end?: number | undefined
+    ): this {
+        throw new Error(
+            "Array method 'copyWithin' not supported on QueriedCoList"
+        );
+    }
+}

packages/cojson/src/queriedCoValues/queriedCoMap.ts

@@ -0,0 +1,180 @@
+import { MutableCoMap } from "../coValues/coMap.js";
+import { CoValueCore } from "../coValueCore.js";
+import { Group } from "../group.js";
+import { Account, AccountID, Profile, isAccountID } from "../account.js";
+import { AnyCoMap, CoID, CoValue } from "../coValue.js";
+import { TransactionID } from "../ids.js";
+import { ValueOrSubQueried, QueryContext } from "../queries.js";
+
+export type QueriedCoMap<M extends AnyCoMap> = {
+    [K in keyof M["_shape"] & string]: ValueOrSubQueried<M["_shape"][K]>;
+} & QueriedCoMapBase<M>;
+
+export type QueriedCoMapEdit<
+    M extends AnyCoMap,
+    K extends keyof M["_shape"]
+> = {
+    by?: QueriedAccountAndProfile;
+    tx: TransactionID;
+    at: Date;
+    value: M["_shape"][K] extends CoValue
+        ? CoID<M["_shape"][K]>
+        : Exclude<M["_shape"][K], CoValue>;
+};
+
+export class QueriedCoMapBase<M extends AnyCoMap> {
+    coMap!: M;
+    id!: CoID<M>;
+    type!: "comap";
+
+    /** @internal */
+    static newWithKVPairs<M extends AnyCoMap>(
+        coMap: M,
+        queryContext: QueryContext
+    ): QueriedCoMap<M> {
+        const kv = {} as {
+            [K in keyof M["_shape"] & string]: ValueOrSubQueried<
+                M["_shape"][K]
+            >;
+        };
+
+        if (coMap.meta?.type === "account") {
+            const profileID = coMap.get("profile");
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            (kv as any).profile =
+                profileID && queryContext.resolveValue(profileID);
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            (kv as any).isMe =
+                (coMap as unknown as Account).id ===
+                queryContext.node.account.id;
+        } else {
+            for (const key of coMap.keys()) {
+                const value = coMap.get(key);
+
+                if (value === undefined) continue;
+
+                kv[key as keyof typeof kv] = queryContext.resolveValue(
+                    value
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                ) as any;
+            }
+        }
+
+        return Object.assign(new QueriedCoMapBase(coMap, queryContext), kv);
+    }
+
+    /** @internal */
+    constructor(coMap: M, queryContext: QueryContext) {
+        Object.defineProperties(this, {
+            coMap: { value: coMap, enumerable: false },
+            id: { value: coMap.id, enumerable: false },
+            type: { value: "comap", enumerable: false },
+            edits: {
+                value: Object.fromEntries(
+                    coMap.keys().flatMap((key) => {
+                        const edits = [...coMap.editsAt(key)].map((edit) => ({
+                            by:
+                                edit.by && isAccountID(edit.by)
+                                    ? queryContext.resolveAccount(edit.by)
+                                    : undefined,
+                            tx: edit.tx,
+                            at: new Date(edit.at),
+                            value:
+                                edit.value &&
+                                queryContext.resolveValue(edit.value),
+                        }));
+                        const lastEdit = edits[edits.length - 1];
+                        if (!lastEdit) return [];
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        const editsAtKey = {
+                            by: lastEdit.by,
+                            tx: lastEdit.tx,
+                            at: lastEdit.at,
+                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                            value: lastEdit.value as any,
+                            all: edits,
+                        };
+
+                        return [[key, editsAtKey]];
+                    })
+                ),
+                enumerable: false,
+            },
+        });
+    }
+
+    edits!: {
+        [K in keyof M["_shape"] & string]:
+            | (QueriedCoMapEdit<M, K> & {
+                  all: QueriedCoMapEdit<M, K>[];
+              })
+            | undefined;
+    };
+
+    get meta(): M["meta"] {
+        return this.coMap.meta;
+    }
+
+    get group(): Group {
+        return this.coMap.group;
+    }
+
+    get core(): CoValueCore {
+        return this.coMap.core;
+    }
+
+    set<K extends keyof M["_shape"] & string>(
+        key: K,
+        value: M["_shape"][K] extends CoValue
+            ? M["_shape"][K] | CoID<M["_shape"][K]>
+            : M["_shape"][K],
+        privacy?: "private" | "trusting"
+    ): M;
+    set(
+        kv: {
+            [K in keyof M["_shape"] & string]?: M["_shape"][K] extends CoValue
+                ? M["_shape"][K] | CoID<M["_shape"][K]>
+                : M["_shape"][K];
+        },
+        privacy?: "private" | "trusting"
+    ): M;
+    set<K extends keyof M["_shape"] & string>(
+        ...args:
+            | [
+                  {
+                      [K in keyof M["_shape"] &
+                          string]?: M["_shape"][K] extends CoValue
+                          ? M["_shape"][K] | CoID<M["_shape"][K]>
+                          : M["_shape"][K];
+                  },
+                  ("private" | "trusting")?
+              ]
+            | [
+                  K,
+                  M["_shape"][K] extends CoValue
+                      ? M["_shape"][K] | CoID<M["_shape"][K]>
+                      : M["_shape"][K],
+                  ("private" | "trusting")?
+              ]
+    ): M {
+        // eslint-disable-next-line @typescript-eslint/ban-types
+        return (this.coMap.set as Function)(...args);
+    }
+    delete(
+        key: keyof M["_shape"] & string,
+        privacy?: "private" | "trusting"
+    ): M {
+        return this.coMap.delete(key, privacy);
+    }
+    mutate(
+        mutator: (mutable: MutableCoMap<M["_shape"], M["meta"]>) => void
+    ): M {
+        return this.coMap.mutate(mutator);
+    }
+}
+
+export type QueriedAccountAndProfile = {
+    profile?: { name?: string; id: CoID<Profile> };
+    isMe?: boolean;
+    id: AccountID;
+};

packages/cojson/src/queriedCoValues/queriedCoStream.ts

@@ -0,0 +1,125 @@
+import { JsonValue } from "../jsonValue.js";
+import { MutableCoStream } from "../coValues/coStream.js";
+import { CoValueCore } from "../coValueCore.js";
+import { Group } from "../group.js";
+import { AccountID, isAccountID } from "../account.js";
+import { AnyCoStream, CoID, CoValue } from "../coValue.js";
+import { SessionID, TransactionID } from "../ids.js";
+import { QueriedAccountAndProfile } from "./queriedCoMap.js";
+import { ValueOrSubQueried, QueryContext } from "../queries.js";
+
+
+export type QueriedCoStreamItems<Item extends JsonValue | CoValue> = {
+    last?: ValueOrSubQueried<Item>;
+    by?: QueriedAccountAndProfile;
+    tx?: TransactionID;
+    at?: Date;
+    all: {
+        value: ValueOrSubQueried<Item>;
+        by?: QueriedAccountAndProfile;
+        tx: TransactionID;
+        at: Date;
+    }[];
+};
+
+export class QueriedCoStream<S extends AnyCoStream> {
+    coStream: S;
+    id: CoID<S>;
+    type = "costream" as const;
+
+    /** @internal */
+    constructor(coStream: S, queryContext: QueryContext) {
+        this.coStream = coStream;
+        this.id = coStream.id;
+
+        this.perSession = Object.fromEntries(
+            coStream.sessions().map((sessionID) => {
+                const items = [...coStream.itemsIn(sessionID)].map((item) => ({
+                    by: item.by && isAccountID(item.by)
+                        ? queryContext.resolveAccount(item.by)
+                        : undefined,
+                    tx: item.tx,
+                    at: new Date(item.at),
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    value: queryContext.resolveValue(item.value) as any,
+                }));
+
+                const lastItem = items[items.length - 1];
+
+                return [
+                    sessionID,
+                    {
+                        last: lastItem?.value,
+                        by: lastItem?.by,
+                        tx: lastItem?.tx,
+                        at: lastItem?.at,
+                        all: items,
+                    } satisfies QueriedCoStreamItems<S["_item"]>,
+                ];
+            })
+        );
+
+        this.perAccount = Object.fromEntries(
+            [...coStream.accounts()].map((accountID) => {
+                const items = [...coStream.itemsBy(accountID)].map((item) => ({
+                    by: item.by && isAccountID(item.by)
+                        ? queryContext.resolveAccount(item.by)
+                        : undefined,
+                    tx: item.tx,
+                    at: new Date(item.at),
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    value: queryContext.resolveValue(item.value) as any,
+                }));
+
+                const lastItem = items[items.length - 1];
+
+                return [
+                    accountID,
+                    {
+                        last: lastItem?.value,
+                        by: lastItem?.by,
+                        tx: lastItem?.tx,
+                        at: lastItem?.at,
+                        all: items,
+                    } satisfies QueriedCoStreamItems<S["_item"]>,
+                ];
+            })
+        );
+
+        this.me = isAccountID(queryContext.node.account.id)
+            ? this.perAccount[queryContext.node.account.id]
+            : undefined;
+    }
+
+    get meta(): S["meta"] {
+        return this.coStream.meta;
+    }
+
+    get group(): Group {
+        return this.coStream.group;
+    }
+
+    get core(): CoValueCore {
+        return this.coStream.core;
+    }
+
+    me?: QueriedCoStreamItems<S["_item"]>;
+    perAccount: {
+        [account: AccountID]: QueriedCoStreamItems<S["_item"]>;
+    };
+    perSession: {
+        [session: SessionID]: QueriedCoStreamItems<S["_item"]>;
+    };
+
+    push(
+        item: S["_item"] extends CoValue ? S["_item"] | CoID<S["_item"]> : S["_item"],
+        privacy?: "private" | "trusting"
+    ): S {
+        return this.coStream.push(item, privacy);
+    }
+    mutate(
+        mutator: (mutable: MutableCoStream<S["_item"], S["meta"]>) => void
+    ): S {
+        return this.coStream.mutate(mutator);
+    }
+}

packages/cojson/src/queries.ts

@@ -0,0 +1,142 @@
+import { JsonValue } from "./jsonValue.js";
+import { CoMap } from "./coValues/coMap.js";
+import { CoStream } from "./coValues/coStream.js";
+import { CoList } from "./coValues/coList.js";
+import { AccountID } from "./account.js";
+import { AnyCoList, AnyCoMap, AnyCoStream, CoID, CoValue } from "./coValue.js";
+import { LocalNode } from "./localNode.js";
+import {
+    QueriedAccountAndProfile,
+    QueriedCoMap,
+    QueriedCoMapBase,
+} from "./queriedCoValues/queriedCoMap.js";
+import { QueriedCoList } from "./queriedCoValues/queriedCoList.js";
+import { QueriedCoStream } from "./queriedCoValues/queriedCoStream.js";
+
+export type Queried<T extends CoValue> = T extends AnyCoMap
+    ? QueriedCoMap<T>
+    : T extends AnyCoList
+    ? QueriedCoList<T>
+    : T extends AnyCoStream
+    ? T["meta"] extends { type: "binary" }
+        ? never
+        : QueriedCoStream<T>
+    : never;
+
+export type ValueOrSubQueried<
+    V extends JsonValue | CoValue | CoID<CoValue> | undefined
+> = V extends CoID<infer C>
+    ? Queried<C> | undefined
+    : V extends CoValue
+    ? Queried<V> | undefined
+    : V;
+
+export interface CleanupCallbackAndUsable {
+    (): void;
+    [Symbol.dispose]: () => void;
+}
+
+export class QueryContext {
+    values: {
+        [id: CoID<CoValue>]: {
+            lastQueried: Queried<CoValue> | undefined;
+            unsubscribe: () => void;
+        };
+    } = {};
+    node: LocalNode;
+    onUpdate: () => void;
+
+    constructor(node: LocalNode, onUpdate: () => void) {
+        this.node = node;
+        this.onUpdate = onUpdate;
+    }
+
+    getChildLastQueriedOrSubscribe<T extends CoValue>(valueID: CoID<T>) {
+        let value = this.values[valueID];
+        if (!value) {
+            value = {
+                lastQueried: undefined,
+                unsubscribe: query(valueID, this.node, (childQueried) => {
+                    value!.lastQueried = childQueried as Queried<CoValue>;
+                    this.onUpdate();
+                }),
+            };
+            this.values[valueID] = value;
+        }
+        return value.lastQueried as Queried<T> | undefined;
+    }
+
+    resolveAccount(accountID: AccountID) {
+        return this.getChildLastQueriedOrSubscribe(
+            accountID
+        ) as QueriedAccountAndProfile;
+    }
+
+    resolveValue<T extends JsonValue>(
+        value: T
+    ): T extends CoID<infer C> ? Queried<C> | undefined : T {
+        return (
+            typeof value === "string" && value.startsWith("co_")
+                ? this.getChildLastQueriedOrSubscribe(value as CoID<CoValue>)
+                : value
+        ) as T extends CoID<infer C> ? Queried<C> | undefined : T;
+    }
+
+    cleanup() {
+        for (const child of Object.values(this.values)) {
+            child.unsubscribe();
+        }
+    }
+}
+
+export function query<T extends CoValue>(
+    id: CoID<T>,
+    node: LocalNode,
+    callback: (queried: Queried<T> | undefined) => void,
+    parentContext?: QueryContext
+): CleanupCallbackAndUsable {
+    console.log("querying", id);
+
+    const context = parentContext || new QueryContext(node, onUpdate);
+
+    const unsubscribe = node.subscribe(id, (update) => {
+        lastRootValue = update;
+        onUpdate();
+    });
+
+    let lastRootValue: T | undefined;
+
+    function onUpdate() {
+        const rootValue = lastRootValue;
+
+        if (rootValue === undefined) {
+            return undefined;
+        }
+
+        if (rootValue instanceof CoMap) {
+            callback(
+                QueriedCoMapBase.newWithKVPairs(
+                    rootValue,
+                    context
+                ) as Queried<T>
+            );
+        } else if (rootValue instanceof CoList) {
+            callback(new QueriedCoList(rootValue, context) as Queried<T>);
+        } else if (rootValue instanceof CoStream) {
+            if (rootValue.meta?.type === "binary") {
+                // Querying binary string not yet implemented
+                return {};
+            } else {
+                callback(new QueriedCoStream(rootValue, context) as Queried<T>);
+            }
+        }
+    }
+
+    const cleanup = function cleanup() {
+        context.cleanup();
+        unsubscribe();
+    } as CleanupCallbackAndUsable;
+    cleanup[Symbol.dispose] = cleanup;
+
+    return cleanup;
+}

packages/cojson/src/sync.ts

@@ -1,15 +1,14 @@
 import { Signature } from "./crypto.js";
 import { CoValueHeader, Transaction } from "./coValueCore.js";
 import { CoValueCore } from "./coValueCore.js";
-import { LocalNode } from "./node.js";
-import { newLoadingState } from "./node.js";
+import { LocalNode } from "./localNode.js";
+import { newLoadingState } from "./localNode.js";
 import {
     ReadableStream,
     WritableStream,
     WritableStreamDefaultWriter,
 } from "isomorphic-streams";
 import { RawCoID, SessionID } from "./ids.js";
-import { stableStringify } from "./jsonStringify.js";
 
 export type CoValueKnownState = {
     id: RawCoID;
@@ -224,7 +223,7 @@ export class SyncManager {
                 peer.optimisticKnownStates[id] || emptyKnownState(id);
 
             const sendPieces = async () => {
-                for (const [i, piece] of newContentPieces.entries()) {
+                for (const [_i, piece] of newContentPieces.entries()) {
                     // console.log(
                     //     `${id} -> ${peer.id}: Sending content piece ${i + 1}/${newContentPieces.length} header: ${!!piece.header}`,
                     //     // Object.values(piece.new).map((s) => s.newTransactions)
@@ -505,7 +504,11 @@ export class SyncManager {
                 console.error(
                     "Failed to add transactions",
                     msg.id,
-                    newTransactions
+                    JSON.stringify(newTransactions, (k, v) =>
+                        k === "changes" || k === "encryptedChanges"
+                            ? v.slice(0, 20) + "..."
+                            : v
+                    )
                 );
                 continue;
             }

packages/cojson/src/tests/account.test.ts

@@ -1,7 +1,7 @@
-import { newRandomSessionID } from "./coValueCore.js";
-import { cojsonReady } from "./index.js";
-import { LocalNode } from "./node.js";
-import { connectedPeers } from "./streamUtils.js";
+import { newRandomSessionID } from "../coValueCore.js";
+import { cojsonReady } from "../index.js";
+import { LocalNode } from "../localNode.js";
+import { connectedPeers } from "../streamUtils.js";
 
 beforeEach(async () => {
     await cojsonReady;
@@ -19,9 +19,6 @@ test("Can create a node while creating a new account with profile", async () =>
     expect(node.expectProfileLoaded(accountID).get("name")).toEqual(
         "Hermes Puggington"
     );
-    expect((await node.loadProfile(accountID)).get("name")).toEqual(
-        "Hermes Puggington"
-    );
 });
 
 test("A node with an account can create groups and and objects within them", async () => {
@@ -39,7 +36,7 @@ test("A node with an account can create groups and and objects within them", asy
 
     expect(map.get("foo")).toEqual("bar");
 
-    expect(map.whoEdited("foo")).toEqual(accountID);
+    expect(map.lastEditAt("foo")?.by).toEqual(accountID);
 });
 
 test("Can create account with one node, and then load it on another", async () => {
@@ -57,7 +54,7 @@ test("Can create account with one node, and then load it on another", async () =
 
     const [node1asPeer, node2asPeer] = connectedPeers("node1", "node2", {trace: true, peer1role: "server", peer2role: "client"});
 
-    node.sync.addPeer(node2asPeer);
+    node.syncManager.addPeer(node2asPeer);
 
     const node2 = await LocalNode.withLoadedAccount(
         accountID,

packages/cojson/src/tests/coValue.test.ts

@@ -1,8 +1,9 @@
-import { accountOrAgentIDfromSessionID } from "./coValueCore.js";
-import { BinaryCoStream } from "./coValues/coStream.js";
-import { createdNowUnique } from "./crypto.js";
-import { MAX_RECOMMENDED_TX_SIZE, cojsonReady } from "./index.js";
-import { LocalNode } from "./node.js";
+import { expectList, expectMap, expectStream } from "../coValue.js";
+import { accountOrAgentIDfromSessionID } from "../coValueCore.js";
+import { BinaryCoStream } from "../coValues/coStream.js";
+import { createdNowUnique } from "../crypto.js";
+import { MAX_RECOMMENDED_TX_SIZE, cojsonReady } from "../index.js";
+import { LocalNode } from "../localNode.js";
 import { randomAnonymousAccountAndSessionID } from "./testUtils.js";
 
 beforeEach(async () => {
@@ -19,11 +20,7 @@ test("Empty CoMap works", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "comap") {
-        throw new Error("Expected map");
-    }
+    const content = expectMap(coValue.getCurrentContent());
 
     expect(content.type).toEqual("comap");
     expect([...content.keys()]).toEqual([]);
@@ -40,11 +37,7 @@ test("Can insert and delete CoMap entries in edit()", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "comap") {
-        throw new Error("Expected map");
-    }
+    const content = expectMap(coValue.getCurrentContent());
 
     expect(content.type).toEqual("comap");
 
@@ -69,11 +62,7 @@ test("Can get CoMap entry values at different points in time", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "comap") {
-        throw new Error("Expected map");
-    }
+    const content = expectMap(coValue.getCurrentContent());
 
     expect(content.type).toEqual("comap");
 
@@ -88,10 +77,10 @@ test("Can get CoMap entry values at different points in time", () => {
         while (Date.now() < beforeC + 10) {}
         editable.set("hello", "C", "trusting");
         expect(editable.get("hello")).toEqual("C");
-        expect(editable.getAtTime("hello", Date.now())).toEqual("C");
-        expect(editable.getAtTime("hello", beforeA)).toEqual(undefined);
-        expect(editable.getAtTime("hello", beforeB)).toEqual("A");
-        expect(editable.getAtTime("hello", beforeC)).toEqual("B");
+        expect(editable.atTime(Date.now()).get("hello")).toEqual("C");
+        expect(editable.atTime(beforeA).get("hello")).toEqual(undefined);
+        expect(editable.atTime(beforeB).get("hello")).toEqual("A");
+        expect(editable.atTime(beforeC).get("hello")).toEqual("B");
     });
 });
 
@@ -105,43 +94,43 @@ test("Can get all historic values of key in CoMap", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "comap") {
-        throw new Error("Expected map");
-    }
+    const content = expectMap(coValue.getCurrentContent());
 
     expect(content.type).toEqual("comap");
 
     content.edit((editable) => {
         editable.set("hello", "A", "trusting");
-        const txA = editable.getLastTxID("hello");
+        const editA = editable.lastEditAt("hello");
         editable.set("hello", "B", "trusting");
-        const txB = editable.getLastTxID("hello");
+        const editB = editable.lastEditAt("hello");
         editable.delete("hello", "trusting");
-        const txDel = editable.getLastTxID("hello");
+        const editDel = editable.lastEditAt("hello");
         editable.set("hello", "C", "trusting");
-        const txC = editable.getLastTxID("hello");
-        expect(editable.getHistory("hello")).toEqual([
+        const editC = editable.lastEditAt("hello");
+        expect([...editable.editsAt("hello")]).toEqual([
             {
-                txID: txA,
+                tx: editA!.tx,
+                by: node.account.id,
                 value: "A",
-                at: txA && coValue.getTx(txA)?.madeAt,
+                at: editA?.at,
             },
             {
-                txID: txB,
+                tx: editB!.tx,
+                by: node.account.id,
                 value: "B",
-                at: txB && coValue.getTx(txB)?.madeAt,
+                at: editB?.at,
             },
             {
-                txID: txDel,
+                tx: editDel!.tx,
+                by: node.account.id,
                 value: undefined,
-                at: txDel && coValue.getTx(txDel)?.madeAt,
+                at: editDel?.at,
             },
             {
-                txID: txC,
+                tx: editC!.tx,
+                by: node.account.id,
                 value: "C",
-                at: txC && coValue.getTx(txC)?.madeAt,
+                at: editC?.at,
             },
         ]);
     });
@@ -157,26 +146,22 @@ test("Can get last tx ID for a key in CoMap", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "comap") {
-        throw new Error("Expected map");
-    }
+    const content = expectMap(coValue.getCurrentContent());
 
     expect(content.type).toEqual("comap");
 
     content.edit((editable) => {
-        expect(editable.getLastTxID("hello")).toEqual(undefined);
+        expect(editable.lastEditAt("hello")).toEqual(undefined);
         editable.set("hello", "A", "trusting");
-        const sessionID = editable.getLastTxID("hello")?.sessionID;
+        const sessionID = editable.lastEditAt("hello")?.tx.sessionID;
         expect(sessionID && accountOrAgentIDfromSessionID(sessionID)).toEqual(
             node.account.id
         );
-        expect(editable.getLastTxID("hello")?.txIndex).toEqual(0);
+        expect(editable.lastEditAt("hello")?.tx.txIndex).toEqual(0);
         editable.set("hello", "B", "trusting");
-        expect(editable.getLastTxID("hello")?.txIndex).toEqual(1);
+        expect(editable.lastEditAt("hello")?.tx.txIndex).toEqual(1);
         editable.set("hello", "C", "trusting");
-        expect(editable.getLastTxID("hello")?.txIndex).toEqual(2);
+        expect(editable.lastEditAt("hello")?.tx.txIndex).toEqual(2);
     });
 });
 
@@ -190,11 +175,7 @@ test("Empty CoList works", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "colist") {
-        throw new Error("Expected list");
-    }
+    const content = expectList(coValue.getCurrentContent());
 
     expect(content.type).toEqual("colist");
     expect(content.toJSON()).toEqual([]);
@@ -210,22 +191,16 @@ test("Can append, prepend and delete items to CoList", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "colist") {
-        throw new Error("Expected list");
-    }
-
-    expect(content.type).toEqual("colist");
+    const content = expectList(coValue.getCurrentContent());
 
     content.edit((editable) => {
-        editable.append(0, "hello", "trusting");
+        editable.append("hello", 0, "trusting");
         expect(editable.toJSON()).toEqual(["hello"]);
-        editable.append(0, "world", "trusting");
+        editable.append("world", 0, "trusting");
         expect(editable.toJSON()).toEqual(["hello", "world"]);
-        editable.prepend(1, "beautiful", "trusting");
+        editable.prepend("beautiful", 1, "trusting");
         expect(editable.toJSON()).toEqual(["hello", "beautiful", "world"]);
-        editable.prepend(3, "hooray", "trusting");
+        editable.prepend("hooray", 3, "trusting");
         expect(editable.toJSON()).toEqual([
             "hello",
             "beautiful",
@@ -247,20 +222,16 @@ test("Push is equivalent to append after last item", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "colist") {
-        throw new Error("Expected list");
-    }
+    const content = expectList(coValue.getCurrentContent());
 
     expect(content.type).toEqual("colist");
 
     content.edit((editable) => {
-        editable.append(0, "hello", "trusting");
+        editable.append("hello", 0, "trusting");
         expect(editable.toJSON()).toEqual(["hello"]);
-        editable.push("world", "trusting");
+        editable.append("world", undefined, "trusting");
         expect(editable.toJSON()).toEqual(["hello", "world"]);
-        editable.push("hooray", "trusting");
+        editable.append("hooray", undefined, "trusting");
         expect(editable.toJSON()).toEqual(["hello", "world", "hooray"]);
     });
 });
@@ -275,16 +246,12 @@ test("Can push into empty list", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "colist") {
-        throw new Error("Expected list");
-    }
+    const content = expectList(coValue.getCurrentContent());
 
     expect(content.type).toEqual("colist");
 
     content.edit((editable) => {
-        editable.push("hello", "trusting");
+        editable.append("hello", undefined, "trusting");
         expect(editable.toJSON()).toEqual(["hello"]);
     });
 });
@@ -299,11 +266,7 @@ test("Empty CoStream works", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "costream") {
-        throw new Error("Expected stream");
-    }
+    const content = expectStream(coValue.getCurrentContent());
 
     expect(content.type).toEqual("costream");
     expect(content.toJSON()).toEqual({});
@@ -320,11 +283,7 @@ test("Can push into CoStream", () => {
         ...createdNowUnique(),
     });
 
-    const content = coValue.getCurrentContent();
-
-    if (content.type !== "costream") {
-        throw new Error("Expected stream");
-    }
+    const content = expectStream(coValue.getCurrentContent());
 
     content.edit((editable) => {
         editable.push({ hello: "world" }, "trusting");
@@ -354,7 +313,11 @@ test("Empty BinaryCoStream works", () => {
 
     const content = coValue.getCurrentContent();
 
-    if (content.type !== "costream" || content.meta?.type !== "binary" || !(content instanceof BinaryCoStream)) {
+    if (
+        content.type !== "costream" ||
+        content.meta?.type !== "binary" ||
+        !(content instanceof BinaryCoStream)
+    ) {
         throw new Error("Expected binary stream");
     }
 
@@ -376,12 +339,19 @@ test("Can push into BinaryCoStream", () => {
 
     const content = coValue.getCurrentContent();
 
-    if (content.type !== "costream" || content.meta?.type !== "binary" || !(content instanceof BinaryCoStream)) {
+    if (
+        content.type !== "costream" ||
+        content.meta?.type !== "binary" ||
+        !(content instanceof BinaryCoStream)
+    ) {
         throw new Error("Expected binary stream");
     }
 
     content.edit((editable) => {
-        editable.startBinaryStream({mimeType: "text/plain", fileName: "test.txt"}, "trusting");
+        editable.startBinaryStream(
+            { mimeType: "text/plain", fileName: "test.txt" },
+            "trusting"
+        );
         expect(editable.getBinaryChunks(true)).toEqual({
             mimeType: "text/plain",
             fileName: "test.txt",
@@ -426,16 +396,23 @@ test("When adding large transactions (small fraction of MAX_RECOMMENDED_TX_SIZE)
 
     const content = coValue.getCurrentContent();
 
-    if (content.type !== "costream" || content.meta?.type !== "binary" || !(content instanceof BinaryCoStream)) {
+    if (
+        content.type !== "costream" ||
+        content.meta?.type !== "binary" ||
+        !(content instanceof BinaryCoStream)
+    ) {
         throw new Error("Expected binary stream");
     }
 
     content.edit((editable) => {
-        editable.startBinaryStream({mimeType: "text/plain", fileName: "test.txt"}, "trusting");
+        editable.startBinaryStream(
+            { mimeType: "text/plain", fileName: "test.txt" },
+            "trusting"
+        );
     });
 
     for (let i = 0; i < 10; i++) {
-        const chunk = new Uint8Array(MAX_RECOMMENDED_TX_SIZE/3 + 100);
+        const chunk = new Uint8Array(MAX_RECOMMENDED_TX_SIZE / 3 + 100);
 
         content.edit((editable) => {
             editable.pushBinaryStreamChunk(chunk, "trusting");
@@ -461,14 +438,26 @@ test("When adding large transactions (small fraction of MAX_RECOMMENDED_TX_SIZE)
     expect(sessionEntry.signatureAfter[10]).not.toBeDefined();
     expect(sessionEntry.signatureAfter[11]).not.toBeDefined();
 
-    const newContent = coValue.newContentSince({id: coValue.id, header: false, sessions: {}})!;
+    const newContent = coValue.newContentSince({
+        id: coValue.id,
+        header: false,
+        sessions: {},
+    })!;
 
-    expect(newContent.length).toEqual(5)
+    expect(newContent.length).toEqual(5);
     expect(newContent[0]!.header).toBeDefined();
-    expect(newContent[1]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[3]);
-    expect(newContent[2]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[6]);
-    expect(newContent[3]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[9]);
-    expect(newContent[4]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.lastSignature);
+    expect(newContent[1]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[3]
+    );
+    expect(newContent[2]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[6]
+    );
+    expect(newContent[3]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[9]
+    );
+    expect(newContent[4]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.lastSignature
+    );
 });
 
 test("When adding large transactions (bigger than MAX_RECOMMENDED_TX_SIZE), we store an inbetween signature after every large transaction and split up newContentSince accordingly", () => {
@@ -483,12 +472,19 @@ test("When adding large transactions (bigger than MAX_RECOMMENDED_TX_SIZE), we s
 
     const content = coValue.getCurrentContent();
 
-    if (content.type !== "costream" || content.meta?.type !== "binary" || !(content instanceof BinaryCoStream)) {
+    if (
+        content.type !== "costream" ||
+        content.meta?.type !== "binary" ||
+        !(content instanceof BinaryCoStream)
+    ) {
         throw new Error("Expected binary stream");
     }
 
     content.edit((editable) => {
-        editable.startBinaryStream({mimeType: "text/plain", fileName: "test.txt"}, "trusting");
+        editable.startBinaryStream(
+            { mimeType: "text/plain", fileName: "test.txt" },
+            "trusting"
+        );
     });
 
     const chunk = new Uint8Array(MAX_RECOMMENDED_TX_SIZE + 100);
@@ -511,14 +507,24 @@ test("When adding large transactions (bigger than MAX_RECOMMENDED_TX_SIZE), we s
     expect(sessionEntry.signatureAfter[3]).toBeDefined();
     expect(sessionEntry.signatureAfter[4]).not.toBeDefined();
 
-    const newContent = coValue.newContentSince({id: coValue.id, header: false, sessions: {}})!;
+    const newContent = coValue.newContentSince({
+        id: coValue.id,
+        header: false,
+        sessions: {},
+    })!;
 
-    expect(newContent.length).toEqual(5)
+    expect(newContent.length).toEqual(5);
     expect(newContent[0]!.header).toBeDefined();
-    expect(newContent[1]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[1]);
-    expect(newContent[2]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[2]);
-    expect(newContent[3]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.signatureAfter[3]);
-    expect(newContent[4]!.new[node.currentSessionID]!.lastSignature).toEqual(sessionEntry.lastSignature);
+    expect(newContent[1]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[1]
+    );
+    expect(newContent[2]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[2]
+    );
+    expect(newContent[3]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.signatureAfter[3]
+    );
+    expect(newContent[4]!.new[node.currentSessionID]!.lastSignature).toEqual(
+        sessionEntry.lastSignature
+    );
 });
-
-

packages/cojson/src/tests/coValueCore.test.ts

@@ -1,11 +1,11 @@
-import { Transaction } from "./coValueCore.js";
-import { LocalNode } from "./node.js";
-import { createdNowUnique, getAgentSignerSecret, newRandomAgentSecret, sign } from "./crypto.js";
+import { Transaction } from "../coValueCore.js";
+import { LocalNode } from "../localNode.js";
+import { createdNowUnique, getAgentSignerSecret, newRandomAgentSecret, sign } from "../crypto.js";
 import { randomAnonymousAccountAndSessionID } from "./testUtils.js";
-import { MapOpPayload } from "./coValues/coMap.js";
-import { Role } from "./permissions.js";
-import { cojsonReady } from "./index.js";
-import { stableStringify } from "./jsonStringify.js";
+import { MapOpPayload } from "../coValues/coMap.js";
+import { Role } from "../permissions.js";
+import { cojsonReady } from "../index.js";
+import { stableStringify } from "../jsonStringify.js";
 
 beforeEach(async () => {
     await cojsonReady;

packages/cojson/src/tests/crypto.test.ts

@@ -14,14 +14,14 @@ import {
     decryptForTransaction,
     encryptKeySecret,
     decryptKeySecret,
-} from './crypto.js';
+} from "../crypto.js";
 import { base58, base64url } from "@scure/base";
 import { x25519 } from "@noble/curves/ed25519";
 import { xsalsa20_poly1305 } from "@noble/ciphers/salsa";
 import { blake3 } from "@noble/hashes/blake3";
 import stableStringify from "fast-json-stable-stringify";
-import { SessionID } from './ids.js';
-import { cojsonReady } from './index.js';
+import { SessionID } from "../ids.js";
+import { cojsonReady } from "../index.js";
 
 beforeEach(async () => {
     await cojsonReady;
@@ -58,18 +58,18 @@ test("encrypting round-trips, but invalid receiver can't unseal", () => {
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 0 },
     } as const;
 
-    const sealed = seal(
-        data,
-        sender,
-        getSealerID(sealer),
-        nOnceMaterial
-    );
+    const sealed = seal({
+        message: data,
+        from: sender,
+        to: getSealerID(sealer),
+        nOnceMaterial,
+    });
 
-    expect(
-        unseal(sealed, sealer, getSealerID(sender), nOnceMaterial)
-    ).toEqual(data);
-    expect(
-        () => unseal(sealed, wrongSealer, getSealerID(sender), nOnceMaterial)
+    expect(unseal(sealed, sealer, getSealerID(sender), nOnceMaterial)).toEqual(
+        data
+    );
+    expect(() =>
+        unseal(sealed, wrongSealer, getSealerID(sender), nOnceMaterial)
     ).toThrow(/Wrong tag/);
 
     // trying with wrong sealer secret, by hand
@@ -82,9 +82,7 @@ test("encrypting round-trips, but invalid receiver can't unseal", () => {
     const senderPub = base58.decode(
         getSealerID(sender).substring("sealer_z".length)
     );
-    const sealedBytes = base64url.decode(
-        sealed.substring("sealed_U".length)
-    );
+    const sealedBytes = base64url.decode(sealed.substring("sealed_U".length));
     const sharedSecret = x25519.getSharedSecret(sealer3priv, senderPub);
 
     expect(() => {
@@ -105,7 +103,7 @@ test("Hashing is deterministic", () => {
 test("Encryption for transactions round-trips", () => {
     const { secret } = newRandomKeySecret();
 
-    const encrypted1 =  encryptForTransaction({ a: "hello" }, secret, {
+    const encrypted1 = encryptForTransaction({ a: "hello" }, secret, {
         in: "co_zTEST",
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 0 },
     });
@@ -120,7 +118,7 @@ test("Encryption for transactions round-trips", () => {
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 0 },
     });
 
-    const decrypted2 =  decryptForTransaction(encrypted2, secret, {
+    const decrypted2 = decryptForTransaction(encrypted2, secret, {
         in: "co_zTEST",
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 1 },
     });
@@ -132,7 +130,7 @@ test("Encryption for transactions doesn't decrypt with a wrong key", () => {
     const { secret } = newRandomKeySecret();
     const { secret: secret2 } = newRandomKeySecret();
 
-    const encrypted1 =  encryptForTransaction({ a: "hello" }, secret, {
+    const encrypted1 = encryptForTransaction({ a: "hello" }, secret, {
         in: "co_zTEST",
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 0 },
     });
@@ -147,7 +145,7 @@ test("Encryption for transactions doesn't decrypt with a wrong key", () => {
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 0 },
     });
 
-    const decrypted2 =  decryptForTransaction(encrypted2, secret2, {
+    const decrypted2 = decryptForTransaction(encrypted2, secret2, {
         in: "co_zTEST",
         tx: { sessionID: "co_zTEST_session_zTEST" as SessionID, txIndex: 1 },
     });

packages/cojson/src/tests/group.test.ts

@@ -1,5 +1,5 @@
-import { LocalNode, CoMap, CoList, CoStream, BinaryCoStream, cojsonReady } from "./index";
-import { randomAnonymousAccountAndSessionID } from "./testUtils";
+import { LocalNode, CoMap, CoList, CoStream, BinaryCoStream, cojsonReady } from "../index";
+import { randomAnonymousAccountAndSessionID } from "./testUtils.js";
 
 beforeEach(async () => {
     await cojsonReady;

packages/cojson/src/tests/permissions.test.ts

@@ -1,6 +1,6 @@
-import { newRandomSessionID } from "./coValueCore.js";
-import { expectMap } from "./coValue.js";
-import { Group, expectGroupContent } from "./group.js";
+import { newRandomSessionID } from "../coValueCore.js";
+import { expectMap } from "../coValue.js";
+import { Group, expectGroupContent } from "../group.js";
 import {
     createdNowUnique,
     newRandomKeySecret,
@@ -10,14 +10,14 @@ import {
     getAgentID,
     getAgentSealerSecret,
     getAgentSealerID,
-} from "./crypto.js";
+} from "../crypto.js";
 import {
     newGroup,
     newGroupHighLevel,
     groupWithTwoAdmins,
     groupWithTwoAdminsHighLevel,
 } from "./testUtils.js";
-import { AnonymousControlledAccount, cojsonReady } from "./index.js";
+import { AnonymousControlledAccount, cojsonReady } from "../index.js";
 
 beforeEach(async () => {
     await cojsonReady;
@@ -39,7 +39,9 @@ test("Added admin can add a third admin to a group", () => {
         newRandomSessionID(otherAdmin.id)
     );
 
-    let otherContent = expectGroupContent(groupAsOtherAdmin.getCurrentContent());
+    let otherContent = expectGroupContent(
+        groupAsOtherAdmin.getCurrentContent()
+    );
 
     expect(otherContent.get(otherAdmin.id)).toEqual("admin");
 
@@ -112,9 +114,9 @@ test("Admins can't demote other admins in a group (high level)", () => {
         newRandomSessionID(otherAdmin.id)
     );
 
-    expect(() => groupAsOtherAdmin.addMemberInternal(admin.id, "writer")).toThrow(
-        "Failed to set role"
-    );
+    expect(() =>
+        groupAsOtherAdmin.addMemberInternal(admin.id, "writer")
+    ).toThrow("Failed to set role");
 
     expect(groupAsOtherAdmin.underlyingMap.get(admin.id)).toEqual("admin");
 });
@@ -157,7 +159,9 @@ test("Admins an add writers to a group, who can't add admins, writers, or reader
         expect(editable.get(otherAgent.id)).toBeUndefined();
     });
 
-    groupContentAsWriter = expectGroupContent(groupAsWriter.getCurrentContent());
+    groupContentAsWriter = expectGroupContent(
+        groupAsWriter.getCurrentContent()
+    );
 
     expect(groupContentAsWriter.get(otherAgent.id)).toBeUndefined();
 });
@@ -230,7 +234,9 @@ test("Admins can add readers to a group, who can't add admins, writers, or reade
         expect(editable.get(otherAgent.id)).toBeUndefined();
     });
 
-    groupContentAsReader = expectGroupContent(groupAsReader.getCurrentContent());
+    groupContentAsReader = expectGroupContent(
+        groupAsReader.getCurrentContent()
+    );
 
     expect(groupContentAsReader.get(otherAgent.id)).toBeUndefined();
 });
@@ -425,15 +431,15 @@ test("Admins can set group read key and then use it to create and read private t
 
     groupContent.edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
 
@@ -492,27 +498,27 @@ test("Admins can set group read key and then writers can use it to create and re
         editable.set(writer.id, "writer", "trusting");
         expect(editable.get(writer.id)).toEqual("writer");
 
-        const revelation1 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation1 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation1, "trusting");
 
-        const revelation2 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            writer.currentSealerID(),
-            {
+        const revelation2 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: writer.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${writer.id}`, revelation2, "trusting");
 
@@ -583,27 +589,27 @@ test("Admins can set group read key and then use it to create private transactio
         editable.set(reader.id, "reader", "trusting");
         expect(editable.get(reader.id)).toEqual("reader");
 
-        const revelation1 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation1 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation1, "trusting");
 
-        const revelation2 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            reader.currentSealerID(),
-            {
+        const revelation2 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: reader.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${reader.id}`, revelation2, "trusting");
 
@@ -674,27 +680,27 @@ test("Admins can set group read key and then use it to create private transactio
         editable.set(reader1.id, "reader", "trusting");
         expect(editable.get(reader1.id)).toEqual("reader");
 
-        const revelation1 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation1 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation1, "trusting");
 
-        const revelation2 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            reader1.currentSealerID(),
-            {
+        const revelation2 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: reader1.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${reader1.id}`, revelation2, "trusting");
 
@@ -727,15 +733,15 @@ test("Admins can set group read key and then use it to create private transactio
     expect(childContentAsReader1.get("foo")).toEqual("bar");
 
     groupContent.edit((editable) => {
-        const revelation3 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            reader2.currentSealerID(),
-            {
+        const revelation3 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: reader2.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${reader2.id}`, revelation3, "trusting");
     });
@@ -796,15 +802,15 @@ test("Admins can set group read key, make a private transaction in an owned obje
 
     groupContent.edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
 
@@ -833,15 +839,15 @@ test("Admins can set group read key, make a private transaction in an owned obje
     groupContent.edit((editable) => {
         const { secret: readKey2, id: readKeyID2 } = newRandomKeySecret();
 
-        const revelation = seal(
-            readKey2,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey2,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID2}_for_${admin.id}`, revelation, "trusting");
 
@@ -903,15 +909,15 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const { secret: readKey, id: readKeyID } = newRandomKeySecret();
 
     groupContent.edit((editable) => {
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
 
@@ -935,27 +941,27 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const { secret: readKey2, id: readKeyID2 } = newRandomKeySecret();
 
     groupContent.edit((editable) => {
-        const revelation2 = seal(
-            readKey2,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation2 = seal({
+            message: readKey2,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID2}_for_${admin.id}`, revelation2, "trusting");
 
-        const revelation3 = seal(
-            readKey2,
-            admin.currentSealerSecret(),
-            reader.currentSealerID(),
-            {
+        const revelation3 = seal({
+            message: readKey2,
+            from: admin.currentSealerSecret(),
+            to: reader.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID2}_for_${reader.id}`, revelation3, "trusting");
 
@@ -1051,39 +1057,39 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const reader2 = node.createAccount("reader2");
 
     groupContent.edit((editable) => {
-        const revelation1 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation1 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation1, "trusting");
 
-        const revelation2 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            reader.currentSealerID(),
-            {
+        const revelation2 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: reader.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${reader.id}`, revelation2, "trusting");
 
-        const revelation3 = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            reader2.currentSealerID(),
-            {
+        const revelation3 = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: reader2.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${reader2.id}`, revelation3, "trusting");
 
@@ -1128,15 +1134,15 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const { secret: readKey2, id: readKeyID2 } = newRandomKeySecret();
 
     groupContent.edit((editable) => {
-        const newRevelation1 = seal(
-            readKey2,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const newRevelation1 = seal({
+            message: readKey2,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID2}_for_${admin.id}`,
@@ -1144,15 +1150,15 @@ test("Admins can set group read rey, make a private transaction in an owned obje
             "trusting"
         );
 
-        const newRevelation2 = seal(
-            readKey2,
-            admin.currentSealerSecret(),
-            reader2.currentSealerID(),
-            {
+        const newRevelation2 = seal({
+            message: readKey2,
+            from: admin.currentSealerSecret(),
+            to: reader2.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID2}_for_${reader2.id}`,
@@ -1281,15 +1287,15 @@ test("Admins can create an adminInvite, which can add an admin", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1298,15 +1304,15 @@ test("Admins can create an adminInvite, which can add an admin", () => {
 
         expect(editable.get(inviteID)).toEqual("adminInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,
@@ -1332,15 +1338,15 @@ test("Admins can create an adminInvite, which can add an admin", () => {
 
         expect(readKey.secret).toBeDefined();
 
-        const revelation = seal(
-            readKey.secret!,
-            getAgentSealerSecret(invitedAdminSecret),
-            getAgentSealerID(invitedAdminID),
-            {
+        const revelation = seal({
+            message: readKey.secret!,
+            from: getAgentSealerSecret(invitedAdminSecret),
+            to: getAgentSealerID(invitedAdminID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKey.id}_for_${invitedAdminID}`,
@@ -1377,14 +1383,18 @@ test("Admins can create an adminInvite, which can add an admin (high-level)", as
         nodeAsInvitedAdmin
     );
 
-    expect(groupAsInvitedAdmin.underlyingMap.get(invitedAdminID)).toEqual("admin");
+    expect(groupAsInvitedAdmin.underlyingMap.get(invitedAdminID)).toEqual(
+        "admin"
+    );
     expect(
         groupAsInvitedAdmin.underlyingMap.core.getCurrentReadKey().secret
     ).toBeDefined();
 
     groupAsInvitedAdmin.addMemberInternal(thirdAdminID, "admin");
 
-    expect(groupAsInvitedAdmin.underlyingMap.get(thirdAdminID)).toEqual("admin");
+    expect(groupAsInvitedAdmin.underlyingMap.get(thirdAdminID)).toEqual(
+        "admin"
+    );
 });
 
 test("Admins can create a writerInvite, which can add a writer", () => {
@@ -1395,15 +1405,15 @@ test("Admins can create a writerInvite, which can add a writer", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1412,15 +1422,15 @@ test("Admins can create a writerInvite, which can add a writer", () => {
 
         expect(editable.get(inviteID)).toEqual("writerInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,
@@ -1446,15 +1456,15 @@ test("Admins can create a writerInvite, which can add a writer", () => {
 
         expect(readKey.secret).toBeDefined();
 
-        const revelation = seal(
-            readKey.secret!,
-            getAgentSealerSecret(invitedWriterSecret),
-            getAgentSealerID(invitedWriterID),
-            {
+        const revelation = seal({
+            message: readKey.secret!,
+            from: getAgentSealerSecret(invitedWriterSecret),
+            to: getAgentSealerID(invitedWriterID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKey.id}_for_${invitedWriterID}`,
@@ -1488,13 +1498,14 @@ test("Admins can create a writerInvite, which can add a writer (high-level)", as
         nodeAsInvitedWriter
     );
 
-    expect(groupAsInvitedWriter.underlyingMap.get(invitedWriterID)).toEqual("writer");
+    expect(groupAsInvitedWriter.underlyingMap.get(invitedWriterID)).toEqual(
+        "writer"
+    );
     expect(
         groupAsInvitedWriter.underlyingMap.core.getCurrentReadKey().secret
     ).toBeDefined();
 });
 
-
 test("Admins can create a readerInvite, which can add a reader", () => {
     const { node, group, admin } = newGroup();
 
@@ -1503,15 +1514,15 @@ test("Admins can create a readerInvite, which can add a reader", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1520,15 +1531,15 @@ test("Admins can create a readerInvite, which can add a reader", () => {
 
         expect(editable.get(inviteID)).toEqual("readerInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,
@@ -1554,15 +1565,15 @@ test("Admins can create a readerInvite, which can add a reader", () => {
 
         expect(readKey.secret).toBeDefined();
 
-        const revelation = seal(
-            readKey.secret!,
-            getAgentSealerSecret(invitedReaderSecret),
-            getAgentSealerID(invitedReaderID),
-            {
+        const revelation = seal({
+            message: readKey.secret!,
+            from: getAgentSealerSecret(invitedReaderSecret),
+            to: getAgentSealerID(invitedReaderID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKey.id}_for_${invitedReaderID}`,
@@ -1596,7 +1607,9 @@ test("Admins can create a readerInvite, which can add a reader (high-level)", as
         nodeAsInvitedReader
     );
 
-    expect(groupAsInvitedReader.underlyingMap.get(invitedReaderID)).toEqual("reader");
+    expect(groupAsInvitedReader.underlyingMap.get(invitedReaderID)).toEqual(
+        "reader"
+    );
     expect(
         groupAsInvitedReader.underlyingMap.core.getCurrentReadKey().secret
     ).toBeDefined();
@@ -1610,15 +1623,15 @@ test("WriterInvites can not invite admins", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1627,15 +1640,15 @@ test("WriterInvites can not invite admins", () => {
 
         expect(editable.get(inviteID)).toEqual("writerInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,
@@ -1666,15 +1679,15 @@ test("ReaderInvites can not invite admins", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1683,15 +1696,15 @@ test("ReaderInvites can not invite admins", () => {
 
         expect(editable.get(inviteID)).toEqual("readerInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,
@@ -1722,15 +1735,15 @@ test("ReaderInvites can not invite writers", () => {
 
     expectGroupContent(group.getCurrentContent()).edit((editable) => {
         const { secret: readKey, id: readKeyID } = newRandomKeySecret();
-        const revelation = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            admin.currentSealerID(),
-            {
+        const revelation = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: admin.currentSealerID(),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(`${readKeyID}_for_${admin.id}`, revelation, "trusting");
         editable.set("readKey", readKeyID, "trusting");
@@ -1739,15 +1752,15 @@ test("ReaderInvites can not invite writers", () => {
 
         expect(editable.get(inviteID)).toEqual("readerInvite");
 
-        const revelationForInvite = seal(
-            readKey,
-            admin.currentSealerSecret(),
-            getAgentSealerID(inviteID),
-            {
+        const revelationForInvite = seal({
+            message: readKey,
+            from: admin.currentSealerSecret(),
+            to: getAgentSealerID(inviteID),
+            nOnceMaterial: {
                 in: group.id,
                 tx: group.nextTransactionID(),
-            }
-        );
+            },
+        });
 
         editable.set(
             `${readKeyID}_for_${inviteID}`,

packages/cojson/src/tests/queries.test.ts

@@ -0,0 +1,318 @@
+import { BinaryCoStream, CoList, CoMap, CoStream, Group, LocalNode, cojsonReady } from "..";
+
+beforeEach(async () => {
+    await cojsonReady;
+});
+
+test("Queries with maps work", async () => {
+    const { node, accountID } =
+        LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let map = group.createMap<
+        CoMap<{
+            hello: "world";
+            subMap: CoMap<{
+                hello: "world" | "moon" | "sun";
+                id: string;
+            }>;
+        }>
+    >();
+
+    const done = new Promise<void>((resolve) => {
+        const unsubQuery = node.query(map.id, (queriedMap) => {
+            // console.log("update", update);
+            if (queriedMap) {
+                expect(queriedMap.type).toBe("comap");
+                expect(queriedMap.id).toEqual(map.id);
+                expect(queriedMap.core).toEqual(map.core);
+                expect(queriedMap.group).toBeInstanceOf(Group);
+                expect(queriedMap.group.id).toBe(group.id);
+                expect(queriedMap.meta).toBe(null);
+                expect(queriedMap.hello).toBe("world");
+                expect(Object.keys(queriedMap)).toEqual(["hello", "subMap"]);
+                if (queriedMap.edits.hello?.by?.profile?.name) {
+                    expect(queriedMap.edits.hello).toMatchObject({
+                        by: {
+                            id: accountID,
+                            profile: {
+                                id: node.expectProfileLoaded(accountID).id,
+                                name: "Hermes Puggington",
+                            },
+                            isMe: true,
+                        },
+                        tx: map.lastEditAt("hello")!.tx,
+                        at: new Date(map.lastEditAt("hello")!.at),
+                    });
+                    if (queriedMap.subMap) {
+                        expect(queriedMap.subMap.type).toBe("comap");
+                        expect(queriedMap.subMap.id).toEqual("foreignID");
+                        expect(queriedMap.subMap.core).toEqual(subMap.core);
+                        expect(queriedMap.subMap.group).toBeInstanceOf(Group);
+                        expect(queriedMap.subMap.group.id).toBe(group.id);
+                        expect(queriedMap.subMap.meta).toBe(null);
+                        if (queriedMap.subMap.hello === "moon") {
+                            // console.log("got to 'moon'");
+                            queriedMap.subMap.set("hello", "sun");
+                        } else if (
+                            queriedMap.subMap.hello === "sun" &&
+                            queriedMap.subMap.edits.hello?.by?.profile?.name ===
+                                "Hermes Puggington"
+                        ) {
+                            // console.log("final update", queriedMap);
+                            resolve();
+                            unsubQuery();
+                        }
+                    }
+                }
+            }
+        });
+    });
+
+    map = map.set("hello", "world");
+
+    let subMap = group.createMap<
+        CoMap<{
+            hello: "world" | "moon" | "sun";
+            id: string;
+        }>
+    >();
+
+    map = map.set("subMap", subMap);
+
+    subMap = subMap.mutate((subMap) => {
+        subMap.set("hello", "world");
+        subMap.set("id", "foreignID");
+    });
+
+    subMap = subMap.set("hello", "moon");
+
+    await done;
+});
+
+test("Queries with lists work", () => {
+    const { node, accountID } =
+        LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let list = group.createList<CoList<string>>();
+
+    const done = new Promise<void>((resolve) => {
+        const unsubQuery = node.query(list.id, (queriedList) => {
+            if (queriedList) {
+                // console.log("update", queriedList, queriedList.edits);
+                expect(queriedList.type).toBe("colist");
+                expect(queriedList.id).toEqual(list.id);
+                expect(queriedList.core).toEqual(list.core);
+                expect(queriedList.group).toBeInstanceOf(Group);
+                expect(queriedList.group.id).toBe(group.id);
+                expect(queriedList.meta).toBe(null);
+                expect(queriedList[0]).toBe("hello");
+                expect(queriedList[1]).toBe("world");
+                expect(queriedList[2]).toBe("moon");
+                if (queriedList.edits[2]?.by?.profile?.name) {
+                    expect(queriedList.edits[2]).toMatchObject({
+                        by: {
+                            id: accountID,
+                            profile: {
+                                id: node.expectProfileLoaded(accountID).id,
+                                name: "Hermes Puggington",
+                            },
+                            isMe: true,
+                        },
+                        at: expect.any(Date),
+                    });
+                    if (queriedList.length === 3) {
+                        queriedList.append("sun");
+
+                    } else if (
+                        queriedList.length === 4 &&
+                        queriedList.edits[3]?.by?.profile?.name ===
+                            "Hermes Puggington"
+                    ) {
+                        expect(queriedList[3]).toBe("sun");
+                        // console.log("final update", queriedList);
+                        resolve();
+                        unsubQuery();
+                    }
+                }
+            }
+        });
+    });
+
+    list = list.mutate((list) => {
+        list.append("hello");
+        list.append("world");
+        list.append("moon");
+    });
+
+    return done;
+});
+
+test("List of nested maps works", () => {
+    const { node } = LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let list = group.createList<CoList<CoMap<{ hello: "world" }>>>();
+
+    const done = new Promise<void>((resolve) => {
+        const unsubQuery = node.query(list.id, (queriedList) => {
+            if (queriedList && queriedList[0]) {
+                // console.log("update", queriedList);
+                expect(queriedList[0]).toMatchObject({
+                    hello: "world",
+                    id: list.get(0)!,
+                });
+                // console.log("final update", queriedList);
+                resolve();
+                unsubQuery();
+            }
+        });
+    });
+
+    list = list.append(
+        group.createMap<CoMap<{ hello: "world" }>>({
+            hello: "world",
+        })
+    );
+
+    return done;
+});
+
+test("Can call .map on a quieried coList", async () => {
+    const { node } = LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let list = group.createList<CoList<string>>();
+
+    const done = new Promise<void>((resolve) => {
+
+        const unsubQuery = node.query(list.id, (queriedList) => {
+
+            if (queriedList && queriedList[0]) {
+                // console.log("update", queriedList);
+                expect(queriedList.map((item) => item + "!!!")).toEqual([
+                    "hello!!!",
+                    "world!!!",
+                ]);
+                // console.log("final update", queriedList);
+                resolve();
+                unsubQuery();
+            }
+        });
+    });
+
+    list = list.mutate((list) => {
+        list.append("hello");
+        list.append("world");
+    });
+
+    await done;
+});
+
+test("Queries with streams work", () => {
+    const { node, accountID } =
+        LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let stream = group.createStream<CoStream<string>>();
+
+    const done = new Promise<void>((resolve) => {
+        const unsubQuery = node.query(stream.id, (queriedStream) => {
+            if (queriedStream) {
+                // console.log("update", queriedStream);
+                if (queriedStream.me?.by?.profile?.name) {
+                    expect(queriedStream.type).toBe("costream");
+                    expect(queriedStream.id).toEqual(stream.id);
+                    expect(queriedStream.core).toEqual(stream.core);
+                    expect(queriedStream.group).toBeInstanceOf(Group);
+                    expect(queriedStream.group.id).toBe(group.id);
+                    expect(queriedStream.meta).toBe(null);
+                    const expectedEntry = {
+                        last: "world",
+                        by: {
+                            id: accountID,
+                            isMe: true,
+                            profile: {
+                                id: node.expectProfileLoaded(accountID).id,
+                                name: "Hermes Puggington",
+                            },
+                        },
+                        at: new Date(
+                            stream.items[node.currentSessionID][1].madeAt
+                        ),
+                        all: [
+                            {
+                                value: "hello",
+                                at: new Date(
+                                    stream.items[
+                                        node.currentSessionID
+                                    ][0].madeAt
+                                ),
+                            },
+                            {
+                                value: "world",
+                                at: new Date(
+                                    stream.items[
+                                        node.currentSessionID
+                                    ][1].madeAt
+                                ),
+                            },
+                        ],
+                    };
+                    expect(queriedStream.perSession).toMatchObject({
+                        [node.currentSessionID]: expectedEntry,
+                    });
+                    expect(queriedStream.perAccount).toMatchObject({
+                        [accountID]: expectedEntry,
+                    });
+                    expect(queriedStream.me).toMatchObject(expectedEntry);
+                    // console.log("final update", queriedStream);
+                    resolve();
+                    unsubQuery();
+                }
+            }
+        });
+    });
+
+    stream = stream.push("hello");
+    stream = stream.push("world");
+
+    return done;
+});
+
+test("Streams of nested maps work", () => {
+    const { node } = LocalNode.withNewlyCreatedAccount("Hermes Puggington");
+
+    const group = node.createGroup();
+
+    let stream = group.createStream<CoStream<CoMap<{ hello: "world" }>>>();
+
+    const done = new Promise<void>((resolve) => {
+        const unsubQuery = node.query(stream.id, (queriedStream) => {
+            if (queriedStream && queriedStream.me?.last) {
+                // console.log("update", queriedList);
+                expect(queriedStream.me.last).toMatchObject({
+                    hello: "world",
+                    id: map.id,
+                });
+                // console.log("final update", queriedList);
+                resolve();
+                unsubQuery();
+            }
+        });
+    });
+
+    const map = group.createMap<CoMap<{ hello: "world" }>>({
+        hello: "world",
+    });
+
+    stream = stream.push(map);
+
+    return done;
+});

packages/cojson/src/tests/sync.test.ts

@@ -1,17 +1,17 @@
-import { newRandomSessionID } from "./coValueCore.js";
-import { LocalNode } from "./node.js";
-import { SyncMessage } from "./sync.js";
-import { expectMap } from "./coValue.js";
-import { MapOpPayload } from "./coValues/coMap.js";
-import { Group } from "./group.js";
+import { newRandomSessionID } from "../coValueCore.js";
+import { LocalNode } from "../localNode.js";
+import { SyncMessage } from "../sync.js";
+import { expectMap } from "../coValue.js";
+import { MapOpPayload } from "../coValues/coMap.js";
+import { Group } from "../group.js";
 import {
     randomAnonymousAccountAndSessionID,
     shouldNotResolve,
 } from "./testUtils.js";
-import { connectedPeers, newStreamPair } from "./streamUtils.js";
-import { AccountID } from "./account.js";
-import { cojsonReady } from "./index.js";
-import { stableStringify } from "./jsonStringify.js";
+import { connectedPeers, newStreamPair } from "../streamUtils.js";
+import { AccountID } from "../account.js";
+import { cojsonReady } from "../index.js";
+import { stableStringify } from "../jsonStringify.js";
 
 beforeEach(async () => {
     await cojsonReady;
@@ -32,7 +32,7 @@ test("Node replies with initial tx and header to empty subscribe", async () => {
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -114,7 +114,7 @@ test("Node replies with only new tx to subscribe with some known state", async (
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -191,7 +191,7 @@ test("After subscribing, node sends own known state and new txs to peer", async
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -312,7 +312,7 @@ test("Client replies with known new content to tellKnownState from server", asyn
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -387,7 +387,7 @@ test("No matter the optimistic known state, node respects invalid known state me
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -491,7 +491,7 @@ test("If we add a peer, but it never subscribes to a coValue, it won't get any m
     const [inRx, _inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -520,7 +520,7 @@ test("If we add a server peer, all updates to all coValues are sent to it, even
     const [inRx, _inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -592,7 +592,7 @@ test("If we add a server peer, newly created coValues are auto-subscribed to", a
     const [inRx, _inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -646,7 +646,7 @@ test("When we connect a new server peer, we try to sync all existing coValues to
     const [inRx, _inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -682,7 +682,7 @@ test("When receiving a subscribe with a known state that is ahead of our own, pe
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -723,7 +723,7 @@ test.skip("When replaying creation and transactions of a coValue as new content,
     const [inRx1, inTx1] = newStreamPair<SyncMessage>();
     const [outRx1, outTx1] = newStreamPair<SyncMessage>();
 
-    node1.sync.addPeer({
+    node1.syncManager.addPeer({
         id: "test2",
         incoming: inRx1,
         outgoing: outTx1,
@@ -738,7 +738,7 @@ test.skip("When replaying creation and transactions of a coValue as new content,
     const [inRx2, inTx2] = newStreamPair<SyncMessage>();
     const [outRx2, outTx2] = newStreamPair<SyncMessage>();
 
-    node2.sync.addPeer({
+    node2.syncManager.addPeer({
         id: "test1",
         incoming: inRx2,
         outgoing: outTx2,
@@ -769,7 +769,7 @@ test.skip("When replaying creation and transactions of a coValue as new content,
     expect(groupTellKnownStateMsg.value).toMatchObject(groupStateEx(group));
 
     expect(
-        node2.sync.peers["test1"]!.optimisticKnownStates[
+        node2.syncManager.peers["test1"]!.optimisticKnownStates[
             group.underlyingMap.core.id
         ]
     ).toBeDefined();
@@ -850,8 +850,8 @@ test.skip("When loading a coValue on one node, the server node it is requested f
 
     const [node1asPeer, node2asPeer] = connectedPeers("peer1", "peer2");
 
-    node1.sync.addPeer(node2asPeer);
-    node2.sync.addPeer(node1asPeer);
+    node1.syncManager.addPeer(node2asPeer);
+    node2.syncManager.addPeer(node1asPeer);
 
     await node2.loadCoValue(map.core.id);
 
@@ -883,8 +883,8 @@ test("Can sync a coValue through a server to another client", async () => {
         peer2role: "client",
     });
 
-    client1.sync.addPeer(serverAsPeer);
-    server.sync.addPeer(client1AsPeer);
+    client1.syncManager.addPeer(serverAsPeer);
+    server.syncManager.addPeer(client1AsPeer);
 
     const client2 = new LocalNode(admin, newRandomSessionID(admin.id));
 
@@ -894,8 +894,8 @@ test("Can sync a coValue through a server to another client", async () => {
         { peer1role: "server", peer2role: "client" }
     );
 
-    client2.sync.addPeer(serverAsOtherPeer);
-    server.sync.addPeer(client2AsPeer);
+    client2.syncManager.addPeer(serverAsOtherPeer);
+    server.syncManager.addPeer(client2AsPeer);
 
     const mapOnClient2 = await client2.loadCoValue(map.core.id);
 
@@ -926,8 +926,8 @@ test("Can sync a coValue with private transactions through a server to another c
         peer2role: "client",
     });
 
-    client1.sync.addPeer(serverAsPeer);
-    server.sync.addPeer(client1AsPeer);
+    client1.syncManager.addPeer(serverAsPeer);
+    server.syncManager.addPeer(client1AsPeer);
 
     const client2 = new LocalNode(admin, newRandomSessionID(admin.id));
 
@@ -937,8 +937,8 @@ test("Can sync a coValue with private transactions through a server to another c
         { trace: true, peer1role: "server", peer2role: "client" }
     );
 
-    client2.sync.addPeer(serverAsOtherPeer);
-    server.sync.addPeer(client2AsPeer);
+    client2.syncManager.addPeer(serverAsOtherPeer);
+    server.syncManager.addPeer(client2AsPeer);
 
     const mapOnClient2 = await client2.loadCoValue(map.core.id);
 
@@ -956,7 +956,7 @@ test("When a peer's incoming/readable stream closes, we remove the peer", async
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -998,7 +998,7 @@ test("When a peer's incoming/readable stream closes, we remove the peer", async
 
     await new Promise((resolve) => setTimeout(resolve, 100));
 
-    expect(node.sync.peers["test"]).toBeUndefined();
+    expect(node.syncManager.peers["test"]).toBeUndefined();
 });
 
 test("When a peer's outgoing/writable stream closes, we remove the peer", async () => {
@@ -1010,7 +1010,7 @@ test("When a peer's outgoing/writable stream closes, we remove the peer", async
     const [inRx, inTx] = newStreamPair<SyncMessage>();
     const [outRx, outTx] = newStreamPair<SyncMessage>();
 
-    node.sync.addPeer({
+    node.syncManager.addPeer({
         id: "test",
         incoming: inRx,
         outgoing: outTx,
@@ -1057,7 +1057,7 @@ test("When a peer's outgoing/writable stream closes, we remove the peer", async
 
     await new Promise((resolve) => setTimeout(resolve, 100));
 
-    expect(node.sync.peers["test"]).toBeUndefined();
+    expect(node.syncManager.peers["test"]).toBeUndefined();
 });
 
 test("If we start loading a coValue before connecting to a peer that has it, it will load it once we connect", async () => {
@@ -1080,13 +1080,13 @@ test("If we start loading a coValue before connecting to a peer that has it, it
         trace: true,
     });
 
-    node1.sync.addPeer(node2asPeer);
+    node1.syncManager.addPeer(node2asPeer);
 
     const mapOnNode2Promise = node2.loadCoValue(map.core.id);
 
     expect(node2.coValues[map.core.id]?.state).toEqual("loading");
 
-    node2.sync.addPeer(node1asPeer);
+    node2.syncManager.addPeer(node1asPeer);
 
     const mapOnNode2 = await mapOnNode2Promise;
 

packages/cojson/src/tests/testUtils.ts

@@ -1,9 +1,11 @@
-import { AgentSecret, createdNowUnique, getAgentID, newRandomAgentSecret  } from "./crypto.js";
-import { newRandomSessionID } from "./coValueCore.js";
-import { LocalNode } from "./node.js";
-import { expectGroupContent } from "./group.js";
-import { AnonymousControlledAccount } from "./account.js";
-import { SessionID } from "./ids.js";
+import { AgentSecret, createdNowUnique, getAgentID, newRandomAgentSecret  } from "../crypto.js";
+import { newRandomSessionID } from "../coValueCore.js";
+import { LocalNode } from "../localNode.js";
+import { expectGroupContent } from "../group.js";
+import { AnonymousControlledAccount } from "../account.js";
+import { SessionID } from "../ids.js";
+// @ts-ignore
+import { expect } from "bun:test";
 
 export function randomAnonymousAccountAndSessionID(): [AnonymousControlledAccount, SessionID] {
     const agentSecret = newRandomAgentSecret();
@@ -27,7 +29,7 @@ export function newGroup() {
 
     const groupContent = expectGroupContent(group.getCurrentContent());
 
-    groupContent.edit((editable) => {
+    groupContent.mutate((editable) => {
         editable.set(admin.id, "admin", "trusting");
         expect(editable.get(admin.id)).toEqual("admin");
     });
@@ -42,7 +44,7 @@ export function groupWithTwoAdmins() {
 
     let content = expectGroupContent(group.getCurrentContent());
 
-    content.edit((editable) => {
+    content.mutate((editable) => {
         editable.set(otherAdmin.id, "admin", "trusting");
         expect(editable.get(otherAdmin.id)).toEqual("admin");
     });

packages/jazz-browser-auth-local/package.json

@@ -1,11 +1,11 @@
 {
     "name": "jazz-browser-auth-local",
-    "version": "0.2.4",
+    "version": "0.3.5",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "license": "MIT",
     "dependencies": {
-        "jazz-browser": "^0.2.4",
+        "jazz-browser": "^0.3.5",
         "typescript": "^5.1.6"
     },
     "scripts": {

packages/jazz-browser-auth-local/src/index.ts

@@ -72,7 +72,7 @@ export class BrowserLocalAuth implements AuthProvider {
                                 this.appHostname
                             );
                             for (const peer of initialPeers) {
-                                node.sync.addPeer(peer);
+                                node.syncManager.addPeer(peer);
                             }
                             doneSigningUpOrLoggingIn(node);
                             this.driver.onSignedIn({ logOut });

packages/jazz-browser-media-images/package.json

@@ -1,13 +1,13 @@
 {
   "name": "jazz-browser-media-images",
-  "version": "0.2.4",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "cojson": "^0.2.2",
+    "cojson": "^0.3.5",
     "image-blob-reduce": "^4.1.0",
-    "jazz-browser": "^0.2.4",
+    "jazz-browser": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "scripts": {

packages/jazz-browser-media-images/src/index.ts

@@ -10,7 +10,7 @@ import {
 const pica = new Pica();
 
 export async function createImage(
-    image: Blob | File,
+    imageBlobOrFile: Blob | File,
     inGroup: Group
 ): Promise<Media.ImageDefinition> {
     let originalWidth!: number;
@@ -29,7 +29,7 @@ export async function createImage(
     });
 
     const placeholderDataURL = (
-        await Reducer.toCanvas(image, { max: 8 })
+        await Reducer.toCanvas(imageBlobOrFile, { max: 8 })
     ).toDataURL("image/png");
 
     let imageDefinition = inGroup.createMap<Media.ImageDefinition>();
@@ -40,7 +40,7 @@ export async function createImage(
     });
 
     setTimeout(async () => {
-        const max256 = await Reducer.toBlob(image, { max: 256 });
+        const max256 = await Reducer.toBlob(imageBlobOrFile, { max: 256 });
 
         if (originalWidth > 256 || originalHeight > 256) {
             const width =
@@ -63,7 +63,7 @@ export async function createImage(
 
         await new Promise((resolve) => setTimeout(resolve, 0));
 
-        const max1024 = await Reducer.toBlob(image, { max: 1024 });
+        const max1024 = await Reducer.toBlob(imageBlobOrFile, { max: 1024 });
 
         if (originalWidth > 1024 || originalHeight > 1024) {
             const width =
@@ -86,7 +86,7 @@ export async function createImage(
 
         await new Promise((resolve) => setTimeout(resolve, 0));
 
-        const max2048 = await Reducer.toBlob(image, { max: 2048 });
+        const max2048 = await Reducer.toBlob(imageBlobOrFile, { max: 2048 });
 
         if (originalWidth > 2048 || originalHeight > 2048) {
             const width =
@@ -110,7 +110,7 @@ export async function createImage(
         await new Promise((resolve) => setTimeout(resolve, 0));
 
         const originalBinaryStreamId = (
-            await createBinaryStreamFromBlob(image, inGroup)
+            await createBinaryStreamFromBlob(imageBlobOrFile, inGroup)
         ).id;
 
         imageDefinition.edit((imageDefinition) => {
@@ -131,7 +131,7 @@ export type LoadingImageInfo = {
 };
 
 export function loadImage(
-    imageID: CoID<Media.ImageDefinition>,
+    imageDef: CoID<Media.ImageDefinition> | Media.ImageDefinition | {id: CoID<Media.ImageDefinition>},
     localNode: LocalNode,
     progressiveCallback: (update: LoadingImageInfo) => void
 ): () => void {
@@ -153,15 +153,16 @@ export function loadImage(
         stopped = true;
         for (const [res, entry] of Object.entries(resState)) {
             if (entry?.state === "loaded") {
-                URL.revokeObjectURL(entry.blobURL);
                 resState[res as `${number}x${number}`] = { state: "revoked" };
+                // prevent flashing from immediate revocation
+                setTimeout(() => {URL.revokeObjectURL(entry.blobURL)}, 3000);
             }
         }
         unsubscribe?.();
     };
 
     localNode
-        .load(imageID)
+        .load(typeof imageDef === "string" ? imageDef : imageDef.id)
         .then((imageDefinition) => {
             if (stopped) return;
             unsubscribe = imageDefinition.subscribe(async (imageDefinition) => {
@@ -220,7 +221,7 @@ export function loadImage(
                             resState[res] = { state: "failed" };
                             console.error(
                                 "Loading image res failed",
-                                imageID,
+                                imageDef,
                                 res,
                                 binaryStreamId
                             );
@@ -319,13 +320,13 @@ export function loadImage(
                 }
 
                 startLoading().catch((err) => {
-                    console.error("Error loading image", imageID, err);
+                    console.error("Error loading image", imageDef, err);
                     cleanUp();
                 });
             });
         })
         .catch((err) => {
-            console.error("Error loading image", imageID, err);
+            console.error("Error loading image", imageDef, err);
             cleanUp();
         });
 

packages/jazz-browser/package.json

@@ -1,12 +1,12 @@
 {
   "name": "jazz-browser",
-  "version": "0.2.4",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "cojson": "^0.2.2",
-    "jazz-storage-indexeddb": "^0.2.4",
+    "cojson": "^0.3.5",
+    "cojson-storage-indexeddb": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "scripts": {

packages/jazz-browser/src/index.ts

@@ -1,4 +1,4 @@
-import { BinaryCoStream, InviteSecret } from "cojson";
+import { BinaryCoStream, CoValue, CoValueCore, InviteSecret } from "cojson";
 import { BinaryCoStreamMeta } from "cojson";
 import { MAX_RECOMMENDED_TX_SIZE } from "cojson";
 import { cojsonReady } from "cojson";
@@ -10,12 +10,11 @@ import {
     SessionID,
     SyncMessage,
     Peer,
-    CoValueImpl,
     Group,
     CoID,
 } from "cojson";
 import { ReadableStream, WritableStream } from "isomorphic-streams";
-import { IDBStorage } from "jazz-storage-indexeddb";
+import { IDBStorage } from "cojson-storage-indexeddb";
 
 export type BrowserNodeHandle = {
     node: LocalNode;
@@ -26,7 +25,7 @@ export type BrowserNodeHandle = {
 export async function createBrowserNode({
     auth,
     syncAddress = "wss://sync.jazz.tools",
-    reconnectionTimeout = 300,
+    reconnectionTimeout: initialReconnectionTimeout = 500,
 }: {
     auth: AuthProvider;
     syncAddress?: string;
@@ -38,6 +37,15 @@ export async function createBrowserNode({
     const firstWsPeer = createWebSocketPeer(syncAddress);
     let shouldTryToReconnect = true;
 
+    let currentReconnectionTimeout = initialReconnectionTimeout;
+
+    function onOnline() {
+        console.log("Online, resetting reconnection timeout");
+        currentReconnectionTimeout = initialReconnectionTimeout;
+    }
+
+    window.addEventListener("online", onOnline);
+
     const node = await auth.createNode(
         (accountID) => {
             const sessionHandle = getSessionHandleFor(accountID);
@@ -50,19 +58,37 @@ export async function createBrowserNode({
     async function websocketReconnectLoop() {
         while (shouldTryToReconnect) {
             if (
-                Object.keys(node.sync.peers).some((peerId) =>
+                Object.keys(node.syncManager.peers).some((peerId) =>
                     peerId.includes(syncAddress)
                 )
             ) {
-                await new Promise((resolve) =>
-                    setTimeout(resolve, reconnectionTimeout)
-                );
+                // TODO: this might drain battery, use listeners instead
+                await new Promise((resolve) => setTimeout(resolve, 100));
             } else {
-                console.log("Websocket disconnected, trying to reconnect");
-                node.sync.addPeer(createWebSocketPeer(syncAddress));
-                await new Promise((resolve) =>
-                    setTimeout(resolve, reconnectionTimeout)
+                console.log(
+                    "Websocket disconnected, trying to reconnect in " +
+                        currentReconnectionTimeout +
+                        "ms"
                 );
+                currentReconnectionTimeout = Math.min(
+                    currentReconnectionTimeout * 2,
+                    30000
+                );
+                await new Promise<void>((resolve) => {
+                    setTimeout(resolve, currentReconnectionTimeout);
+                    window.addEventListener(
+                        "online",
+                        () => {
+                            console.log(
+                                "Online, trying to reconnect immediately"
+                            );
+                            resolve();
+                        },
+                        { once: true }
+                    );
+                });
+
+                node.syncManager.addPeer(createWebSocketPeer(syncAddress));
             }
         }
     }
@@ -73,9 +99,12 @@ export async function createBrowserNode({
         node,
         done: () => {
             shouldTryToReconnect = false;
-            console.log("Cleaning up node")
-            for (const peer of Object.values(node.sync.peers)) {
-                peer.outgoing.close().catch(e => console.error("Error while closing peer", e));
+            window.removeEventListener("online", onOnline);
+            console.log("Cleaning up node");
+            for (const peer of Object.values(node.syncManager.peers)) {
+                peer.outgoing
+                    .close()
+                    .catch((e) => console.error("Error while closing peer", e));
             }
             sessionDone?.();
         },
@@ -290,13 +319,14 @@ function websocketWritableStream<T>(ws: WebSocket) {
     }
 }
 
-export function createInviteLink(
-    value: CoValueImpl,
+export function createInviteLink<T extends CoValue>(
+    value: T | { id: CoID<T>; core: CoValueCore },
     role: "reader" | "writer" | "admin",
     // default to same address as window.location, but without hash
     {
         baseURL = window.location.href.replace(/#.*$/, ""),
-    }: { baseURL?: string } = {}
+        valueHint,
+    }: { baseURL?: string; valueHint?: string } = {}
 ): string {
     const coValueCore = value.core;
     const node = coValueCore.node;
@@ -317,29 +347,45 @@ export function createInviteLink(
 
     const inviteSecret = group.createInvite(role);
 
-    return `${baseURL}#invitedTo=${value.id}&${inviteSecret}`;
+    return `${baseURL}#/invite/${valueHint ? valueHint + "/" : ""}${
+        value.id
+    }/${inviteSecret}`;
 }
 
-export function parseInviteLink<C extends CoValueImpl>(
+export function parseInviteLink<C extends CoValue>(
     inviteURL: string
 ):
     | {
           valueID: CoID<C>;
+          valueHint?: string;
           inviteSecret: InviteSecret;
       }
     | undefined {
     const url = new URL(inviteURL);
-    const valueID = url.hash
-        .split("&")[0]
-        ?.replace(/^#invitedTo=/, "") as CoID<C>;
-    const inviteSecret = url.hash.split("&")[1] as InviteSecret;
-    if (!valueID || !inviteSecret) {
-        return undefined;
+    const parts = url.hash.split("/");
+
+    let valueHint: string | undefined;
+    let valueID: CoID<C> | undefined;
+    let inviteSecret: InviteSecret | undefined;
+
+    if (parts[0] === "#" && parts[1] === "invite") {
+        if (parts.length === 5) {
+            valueHint = parts[2];
+            valueID = parts[3] as CoID<C>;
+            inviteSecret = parts[4] as InviteSecret;
+        } else if (parts.length === 4) {
+            valueID = parts[2] as CoID<C>;
+            inviteSecret = parts[3] as InviteSecret;
+        }
+
+        if (!valueID || !inviteSecret) {
+            return undefined;
+        }
+        return { valueID, inviteSecret, valueHint };
     }
-    return { valueID, inviteSecret };
 }
 
-export function consumeInviteLinkFromWindowLocation<C extends CoValueImpl>(
+export function consumeInviteLinkFromWindowLocation<C extends CoValue>(
     node: LocalNode
 ): Promise<
     | {
@@ -387,17 +433,17 @@ export async function createBinaryStreamFromBlob<
                     totalSizeBytes: blob.size,
                     fileName: blob instanceof File ? blob.name : undefined,
                 });
-            }) as C;// TODO: fix this
-                const chunkSize = MAX_RECOMMENDED_TX_SIZE;
+            }) as C; // TODO: fix this
+            const chunkSize = MAX_RECOMMENDED_TX_SIZE;
 
-                for (let idx = 0; idx < data.length; idx += chunkSize) {
-                    stream = stream.edit((stream) => {
-                        stream.pushBinaryStreamChunk(
-                            data.slice(idx, idx + chunkSize)
-                        );
-                    }) as C; // TODO: fix this
-                    await new Promise((resolve) => setTimeout(resolve, 0));
-                }
+            for (let idx = 0; idx < data.length; idx += chunkSize) {
+                stream = stream.edit((stream) => {
+                    stream.pushBinaryStreamChunk(
+                        data.slice(idx, idx + chunkSize)
+                    );
+                }) as C; // TODO: fix this
+                await new Promise((resolve) => setTimeout(resolve, 0));
+            }
             stream = stream.edit((stream) => {
                 stream.endBinaryStream();
             }) as C; // TODO: fix this

packages/jazz-react-auth-local/package.json

@@ -1,12 +1,12 @@
 {
     "name": "jazz-react-auth-local",
-    "version": "0.2.4",
+    "version": "0.3.5",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "license": "MIT",
     "dependencies": {
-        "jazz-browser-auth-local": "^0.2.4",
-        "jazz-react": "^0.2.4",
+        "jazz-browser-auth-local": "^0.3.5",
+        "jazz-react": "^0.3.5",
         "typescript": "^5.1.6"
     },
     "devDependencies": {

packages/jazz-react-media-images/package.json

@@ -1,14 +1,14 @@
 {
   "name": "jazz-react-media-images",
-  "version": "0.2.4",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "cojson": "^0.2.2",
-    "jazz-browser": "^0.2.4",
-    "jazz-browser-media-images": "^0.2.4",
-    "jazz-react": "^0.2.4",
+    "cojson": "^0.3.5",
+    "jazz-browser": "^0.3.5",
+    "jazz-browser-media-images": "^0.3.5",
+    "jazz-react": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "devDependencies": {

packages/jazz-react-media-images/src/index.tsx

@@ -2,10 +2,10 @@ import { CoID, Media } from "cojson";
 import { loadImage, LoadingImageInfo } from "jazz-browser-media-images";
 import { useJazz } from "jazz-react";
 import { useEffect, useState } from "react";
-export { createImage } from "jazz-browser-media-images";
+export { createImage, LoadingImageInfo } from "jazz-browser-media-images";
 
 export function useLoadImage(
-    imageID?: CoID<Media.ImageDefinition>
+    imageID?: CoID<Media.ImageDefinition> | Media.ImageDefinition | {id: CoID<Media.ImageDefinition>},
 ): LoadingImageInfo | undefined {
     const { localNode } = useJazz();
 

packages/jazz-react/package.json

@@ -1,12 +1,12 @@
 {
   "name": "jazz-react",
-  "version": "0.2.4",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "cojson": "^0.2.2",
-    "jazz-browser": "^0.2.4",
+    "cojson": "^0.3.5",
+    "jazz-browser": "^0.3.5",
     "typescript": "^5.1.6"
   },
   "devDependencies": {

packages/jazz-react/src/index.tsx

@@ -1,30 +1,25 @@
 import {
     LocalNode,
-    CoValueImpl,
     CoID,
-    CoMap,
-    AccountID,
-    JsonValue,
-    CojsonInternalTypes,
-    BinaryCoStream,
-    BinaryCoStreamMeta,
+    Queried,
+    CoValue,
 } from "cojson";
 import React, { useEffect, useState } from "react";
-import { AuthProvider, createBrowserNode } from "jazz-browser";
-import { readBlobFromBinaryStream } from "jazz-browser";
-
-export {
-    createInviteLink,
-    parseInviteLink,
+import {
+    AuthProvider,
     consumeInviteLinkFromWindowLocation,
+    createBrowserNode,
 } from "jazz-browser";
+import { readBlobFromBinaryStream } from "jazz-browser";
+import { AnyBinaryCoStream } from "cojson/dist/coValue";
 
-type JazzContext = {
-    localNode: LocalNode;
-    logOut: () => void;
-};
-
-const JazzContext = React.createContext<JazzContext | undefined>(undefined);
+const JazzContext = React.createContext<
+    | {
+          localNode: LocalNode;
+          logOut: () => void;
+      }
+    | undefined
+>(undefined);
 
 export type ReactAuthHook = () => {
     auth: AuthProvider;
@@ -32,15 +27,35 @@ export type ReactAuthHook = () => {
     logOut?: () => void;
 };
 
-export function WithJazz({
-    children,
-    auth: authHook,
-    syncAddress,
-}: {
-    children: React.ReactNode;
+/**
+ * Top-level component that provides Jazz context to your whole app, so you can use Jazz hooks in your components.
+ *
+ * @param props.auth An auth provider (renders login/sign-up UI if not logged in) - see available providers in the [Documentation](../../../DOCS.md#auth-providers)
+ *
+ * @param props.syncAddress The address of the upstream syncing peer. Defaults to `wss://sync.jazz.tool` (Jazz Global Mesh). If not set explicitly, it can also be temporarily overwritten by setting the `sync` query parameter in the URL, like `https://your-app.example.net?sync=ws://localhost:4200`.
+ *
+ * @example How to use `WithJazz` with the `jazz-react-auth-local` auth provider:
+ *
+ * ```typescript
+ * import { WithJazz } from "jazz-react";
+ * import { LocalAuth } from "jazz-react-auth-local";
+ *
+ * ReactDOM.createRoot(document.getElementById("root")!).render(
+ *    <React.StrictMode>
+ *       <WithJazz auth={LocalAuth({ appName: "My App" })}>
+ *          <App />
+ *      </WithJazz>
+ *   </React.StrictMode>
+ * );
+ * ```
+ * */
+export function WithJazz(props: {
     auth: ReactAuthHook;
     syncAddress?: string;
+    children: React.ReactNode;
 }) {
+    const { auth: authHook, syncAddress, children } = props;
+
     const [node, setNode] = useState<LocalNode | undefined>();
 
     const { auth, AuthUI, logOut } = authHook();
@@ -89,6 +104,12 @@ export function WithJazz({
     );
 }
 
+/**
+ * Hook that exposes the Jazz context provided by `<WithJazz/>`, most importantly the `LocalNode`
+ * for the logged in user (which you can use to create `Group`s, and `CoValue`s in those).
+ *
+ * Also provides a `logOut` function, which invokes the log-out logic of the Auth Provider passed to `<WithJazz/>`.
+ */
 export function useJazz() {
     const context = React.useContext(JazzContext);
 
@@ -99,7 +120,37 @@ export function useJazz() {
     return context;
 }
 
-export function useTelepathicState<T extends CoValueImpl>(id?: CoID<T>) {
+/**
+ * Hook that subscribes to all updates of a given `CoValue` (identified by its `CoID`) and that automatically resolves references to nested `CoValue`s, loading and subscribing to them as well.
+ *
+ * See `Queried<T>` in `cojson` to see which fields and methods are available on the returned object.
+ *
+ * @param id The `CoID` of the `CoValue` to subscribe to. Can be undefined (in which case the hook returns undefined).
+ */
+export function useSyncedQuery<T extends CoValue>(
+    id?: CoID<T>
+): Queried<T> | undefined {
+    const { localNode } = useJazz();
+
+    const [result, setResult] = useState<Queried<T> | undefined>();
+
+    useEffect(() => {
+        if (!id) return;
+        const unsubscribe = localNode.query(id, setResult);
+        return unsubscribe;
+    }, [id, localNode]);
+
+    return result;
+}
+
+/**
+ * Lower-level hook that loads and subscribes to updates of a single `CoValue` (identified by its `CoID`).
+ *
+ * References to nested `CoValue`s are not automatically resolved, they are returned as `CoID`s.
+ *
+ * @param id The `CoID` of the `CoValue` to subscribe to. Can be undefined (in which case the hook returns undefined).
+ */
+export function useSyncedValue<T extends CoValue>(id?: CoID<T>) {
     const [state, setState] = useState<T>();
 
     const { localNode } = useJazz();
@@ -136,36 +187,18 @@ export function useTelepathicState<T extends CoValueImpl>(id?: CoID<T>) {
     return state;
 }
 
-export function useProfile<
-    P extends {
-        [key: string]: JsonValue;
-    } & CojsonInternalTypes.ProfileContent = CojsonInternalTypes.ProfileContent
->(
-    accountID?: AccountID
-): CoMap<P, CojsonInternalTypes.ProfileMeta> | undefined {
-    const [profileID, setProfileID] =
-        useState<CoID<CoMap<P, CojsonInternalTypes.ProfileMeta>>>();
-
-    const { localNode } = useJazz();
-
-    useEffect(() => {
-        accountID &&
-            localNode
-                .loadProfile(accountID)
-                .then((profile) => setProfileID(profile.id as typeof profileID))
-                .catch((e) => console.log("Failed to load profile", e));
-    }, [localNode, accountID]);
-
-    return useTelepathicState(profileID);
+/** @deprecated Use the higher-level `useSyncedQuery` or the equivalent `useSyncedValue` instead */
+export function useTelepathicState<T extends CoValue>(id?: CoID<T>) {
+    return useSyncedValue(id);
 }
 
-export function useBinaryStream<C extends BinaryCoStream<BinaryCoStreamMeta>>(
+export function useBinaryStream<C extends AnyBinaryCoStream>(
     streamID?: CoID<C>,
     allowUnfinished?: boolean
 ): { blob: Blob; blobURL: string } | undefined {
     const { localNode } = useJazz();
 
-    const stream = useTelepathicState(streamID);
+    const stream = useSyncedValue(streamID);
 
     const [blob, setBlob] = useState<
         { blob: Blob; blobURL: string } | undefined
@@ -193,3 +226,29 @@ export function useBinaryStream<C extends BinaryCoStream<BinaryCoStreamMeta>>(
 
     return blob;
 }
+
+export function useAcceptInvite<C extends CoValue = CoValue>(
+    onInvite: (valueID: CoID<C>, valueHint?: string) => void
+) {
+    const { localNode } = useJazz();
+
+    useEffect(() => {
+        const listener = async () => {
+            const acceptedInvitation =
+                await consumeInviteLinkFromWindowLocation<C>(localNode);
+
+            if (acceptedInvitation) {
+                onInvite(acceptedInvitation.valueID);
+            }
+        };
+        window.addEventListener("hashchange", listener);
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        listener();
+
+        return () => {
+            window.removeEventListener("hashchange", listener);
+        };
+    }, [localNode]);
+}
+
+export { createInviteLink, parseInviteLink } from "jazz-browser";

yarn.lock

@@ -1332,6 +1332,11 @@
     "@babel/runtime" "^7.13.10"
     "@radix-ui/react-primitive" "1.0.3"
 
+"@remix-run/router@1.9.0":
+  version "1.9.0"
+  resolved "https://registry.yarnpkg.com/@remix-run/router/-/router-1.9.0.tgz#9033238b41c4cbe1e961eccb3f79e2c588328cf6"
+  integrity sha512-bV63itrKBC0zdT27qYm6SDZHlkXwFL1xMBuhkn+X7l0+IIhNaH5wuuvZKp6eKhCD4KFhujhfhCT1YxXW6esUIA==
+
 "@rollup/pluginutils@^3.1.0":
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-3.1.0.tgz#706b4524ee6dc8b103b3c995533e5ad680c02b9b"
@@ -6964,6 +6969,21 @@ react-is@^18.0.0:
   resolved "https://registry.yarnpkg.com/react-is/-/react-is-18.2.0.tgz#199431eeaaa2e09f86427efbb4f1473edb47609b"
   integrity sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w==
 
+react-router-dom@^6.16.0:
+  version "6.16.0"
+  resolved "https://registry.yarnpkg.com/react-router-dom/-/react-router-dom-6.16.0.tgz#86f24658da35eb66727e75ecbb1a029e33ee39d9"
+  integrity sha512-aTfBLv3mk/gaKLxgRDUPbPw+s4Y/O+ma3rEN1u8EgEpLpPe6gNjIsWt9rxushMHHMb7mSwxRGdGlGdvmFsyPIg==
+  dependencies:
+    "@remix-run/router" "1.9.0"
+    react-router "6.16.0"
+
+react-router@6.16.0, react-router@^6.16.0:
+  version "6.16.0"
+  resolved "https://registry.yarnpkg.com/react-router/-/react-router-6.16.0.tgz#abbf3d5bdc9c108c9b822a18be10ee004096fb81"
+  integrity sha512-VT4Mmc4jj5YyjpOi5jOf0I+TYzGpvzERy4ckNSvSh2RArv8LLoCxlsZ2D+tc7zgjxcY34oTz2hZaeX5RVprKqA==
+  dependencies:
+    "@remix-run/router" "1.9.0"
+
 react@^18.2.0:
   version "18.2.0"
   resolved "https://registry.yarnpkg.com/react/-/react-18.2.0.tgz#555bd98592883255fa00de14f1151a917b5d77d5"