jazz-tools 0.7.0-alpha.3 → 0.7.0-alpha.31

package/src/tests/coStream.test.ts

@@ -1,10 +1,10 @@
-import { expect, describe, test, beforeEach, Test } from "vitest";
+import { expect, describe, test, beforeEach } from "vitest";
 
 import { webcrypto } from "node:crypto";
 import { connectedPeers } from "cojson/src/streamUtils.js";
 import { newRandomSessionID } from "cojson/src/coValueCore.js";
 import { Effect, Queue } from "effect";
-import { BinaryCoStream, ID, Account, jazzReady, CoStream } from "..";
+import { BinaryCoStream, ID, Account, jazzReady, CoStream, co } from "..";
 import { Simplify } from "effect/Types";
 
 if (!("crypto" in globalThis)) {
@@ -18,55 +18,51 @@ beforeEach(async () => {
 
 describe("Simple CoStream operations", async () => {
     const me = await Account.create({
-        name: "Hermes Puggington",
+        creationProps: { name: "Hermes Puggington" },
     });
 
-    class TestStream extends CoStream<string> {}
-    TestStream.encoding({ _item: "json" });
+    class TestStream extends CoStream.Of(co.string) {}
 
-    const stream = new TestStream(["milk"], { owner: me });
+    const stream = TestStream.create(["milk"], { owner: me });
 
     test("Construction", () => {
-        expect(stream.by[me.id]?.value).toEqual("milk");
-        expect(stream.in[me.sessionID]?.value).toEqual("milk");
+        expect(stream[me.id]?.value).toEqual("milk");
+        expect(stream.perSession[me.sessionID]?.value).toEqual("milk");
     });
 
     describe("Mutation", () => {
         test("pushing", () => {
             stream.push("bread");
-            expect(stream.by[me.id]?.value).toEqual("bread");
-            expect(stream.in[me.sessionID]?.value).toEqual("bread");
+            expect(stream[me.id]?.value).toEqual("bread");
+            expect(stream.perSession[me.sessionID]?.value).toEqual("bread");
 
             stream.push("butter");
-            expect(stream.by[me.id]?.value).toEqual("butter");
-            expect(stream.in[me.sessionID]?.value).toEqual("butter");
+            expect(stream[me.id]?.value).toEqual("butter");
+            expect(stream.perSession[me.sessionID]?.value).toEqual("butter");
         });
     });
 });
 
 describe("CoStream resolution", async () => {
-    class TwiceNestedStream extends CoStream<string> {
+    class TwiceNestedStream extends CoStream.Of(co.string) {
         fancyValueOf(account: ID<Account>) {
-            return "Sir " + this.by[account]?.value;
+            return "Sir " + this[account]?.value;
         }
     }
-    TwiceNestedStream.encoding({ _item: "json" });
 
-    class NestedStream extends CoStream<TwiceNestedStream | null>{}
-    NestedStream.encoding({ _item: {ref: () => TwiceNestedStream} });
+    class NestedStream extends CoStream.Of(co.ref(TwiceNestedStream)) {}
 
-    class TestStream extends CoStream<NestedStream | null> {}
-    TestStream.encoding({ _item: {ref: () => NestedStream} });
+    class TestStream extends CoStream.Of(co.ref(NestedStream)) {}
 
     const initNodeAndStream = async () => {
         const me = await Account.create({
-            name: "Hermes Puggington",
+            creationProps: { name: "Hermes Puggington" },
         });
 
-        const stream = new TestStream(
+        const stream = TestStream.create(
             [
-                new NestedStream(
-                    [new TwiceNestedStream(["milk"], { owner: me })],
+                NestedStream.create(
+                    [TwiceNestedStream.create(["milk"], { owner: me })],
                     { owner: me }
                 ),
             ],
@@ -78,9 +74,9 @@ describe("CoStream resolution", async () => {
 
     test("Construction", async () => {
         const { me, stream } = await initNodeAndStream();
-        expect(
-            stream.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value
-        ).toEqual("milk");
+        expect(stream[me.id]?.value?.[me.id]?.value?.[me.id]?.value).toEqual(
+            "milk"
+        );
     });
 
     test("Loading and availability", async () => {
@@ -102,66 +98,66 @@ describe("CoStream resolution", async () => {
             as: meOnSecondPeer,
         });
 
-        expect(loadedStream?.by[me.id]?.value).toEqual(null);
-        expect(loadedStream?.by[me.id]?.ref?.id).toEqual(
-            stream.by[me.id]?.value?.id
+        expect(loadedStream?.[me.id]?.value).toEqual(null);
+        expect(loadedStream?.[me.id]?.ref?.id).toEqual(
+            stream[me.id]?.value?.id
         );
 
         const loadedNestedStream = await NestedStream.load(
-            stream.by[me.id]!.value!.id,
+            stream[me.id]!.value!.id,
             { as: meOnSecondPeer }
         );
 
-        // expect(loadedStream?.by[me.id]?.value).toEqual(loadedNestedStream);
-        expect(loadedStream?.by[me.id]?.value?.id).toEqual(
+        // expect(loadedStream?.[me.id]?.value).toEqual(loadedNestedStream);
+        expect(loadedStream?.[me.id]?.value?.id).toEqual(
             loadedNestedStream?.id
         );
-        expect(loadedStream?.by[me.id]?.value?.by[me.id]?.value).toEqual(null);
-        // expect(loadedStream?.by[me.id]?.ref?.value).toEqual(loadedNestedStream);
-        expect(loadedStream?.by[me.id]?.ref?.value?.id).toEqual(
+        expect(loadedStream?.[me.id]?.value?.[me.id]?.value).toEqual(null);
+        // expect(loadedStream?.[me.id]?.ref?.value).toEqual(loadedNestedStream);
+        expect(loadedStream?.[me.id]?.ref?.value?.id).toEqual(
             loadedNestedStream?.id
         );
-        expect(loadedStream?.by[me.id]?.value?.by[me.id]?.ref?.id).toEqual(
-            stream.by[me.id]?.value?.by[me.id]?.value?.id
+        expect(loadedStream?.[me.id]?.value?.[me.id]?.ref?.id).toEqual(
+            stream[me.id]?.value?.[me.id]?.value?.id
         );
 
         const loadedTwiceNestedStream = await TwiceNestedStream.load(
-            stream.by[me.id]!.value!.by[me.id]!.value!.id,
+            stream[me.id]!.value![me.id]!.value!.id,
             { as: meOnSecondPeer }
         );
 
-        // expect(loadedStream?.by[me.id]?.value?.by[me.id]?.value).toEqual(
+        // expect(loadedStream?.[me.id]?.value?.[me.id]?.value).toEqual(
         //     loadedTwiceNestedStream
         // );
-        expect(loadedStream?.by[me.id]?.value?.by[me.id]?.value?.id).toEqual(
+        expect(loadedStream?.[me.id]?.value?.[me.id]?.value?.id).toEqual(
             loadedTwiceNestedStream?.id
         );
         expect(
-            loadedStream?.by[me.id]?.value?.by[me.id]?.value?.fancyValueOf(
-                me.id
-            )
+            loadedStream?.[me.id]?.value?.[me.id]?.value?.fancyValueOf(me.id)
         ).toEqual("Sir milk");
-        // expect(loadedStream?.by[me.id]?.ref?.value).toEqual(loadedNestedStream);
-        expect(loadedStream?.by[me.id]?.ref?.value?.id).toEqual(loadedNestedStream?.id);
-        expect(loadedStream?.by[me.id]?.value?.by[me.id]?.ref?.value?.id).toEqual(
+        // expect(loadedStream?.[me.id]?.ref?.value).toEqual(loadedNestedStream);
+        expect(loadedStream?.[me.id]?.ref?.value?.id).toEqual(
+            loadedNestedStream?.id
+        );
+        expect(loadedStream?.[me.id]?.value?.[me.id]?.ref?.value?.id).toEqual(
             loadedTwiceNestedStream?.id
         );
 
-        const otherNestedStream = new NestedStream(
-            [new TwiceNestedStream(["butter"], { owner: meOnSecondPeer })],
+        const otherNestedStream = NestedStream.create(
+            [TwiceNestedStream.create(["butter"], { owner: meOnSecondPeer })],
             { owner: meOnSecondPeer }
         );
         loadedStream?.push(otherNestedStream);
-        // expect(loadedStream?.by[me.id]?.value).toEqual(otherNestedStream);
-        expect(loadedStream?.by[me.id]?.value?.id).toEqual(otherNestedStream?.id);
-        expect(loadedStream?.by[me.id]?.ref?.value?.id).toEqual(otherNestedStream?.id);
-        expect(loadedStream?.by[me.id]?.value?.by[me.id]?.value?.id).toEqual(
-            otherNestedStream.by[me.id]?.value?.id
+        // expect(loadedStream?.[me.id]?.value).toEqual(otherNestedStream);
+        expect(loadedStream?.[me.id]?.value?.id).toEqual(otherNestedStream?.id);
+        expect(loadedStream?.[me.id]?.ref?.value?.id).toEqual(
+            otherNestedStream?.id
+        );
+        expect(loadedStream?.[me.id]?.value?.[me.id]?.value?.id).toEqual(
+            otherNestedStream[me.id]?.value?.id
         );
         expect(
-            loadedStream?.by[me.id]?.value?.by[me.id]?.value?.fancyValueOf(
-                me.id
-            )
+            loadedStream?.[me.id]?.value?.[me.id]?.value?.fancyValueOf(me.id)
         ).toEqual("Sir butter");
     });
 
@@ -192,17 +188,18 @@ describe("CoStream resolution", async () => {
                     { as: meOnSecondPeer },
                     (subscribedStream) => {
                         console.log(
-                            "subscribedStream.by[me.id]",
-                            subscribedStream.by[me.id]
+                            "subscribedStream[me.id]",
+                            subscribedStream[me.id]
                         );
                         console.log(
-                            "subscribedStream.by[me.id]?.value?.by[me.id]?.value",
-                            subscribedStream.by[me.id]?.value?.by[me.id]?.value
+                            "subscribedStream[me.id]?.value?.[me.id]?.value",
+                            subscribedStream[me.id]?.value?.[me.id]?.value
                         );
                         console.log(
-                            "subscribedStream.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value",
-                            subscribedStream.by[me.id]?.value?.by[me.id]?.value
-                                ?.by[me.id]?.value
+                            "subscribedStream[me.id]?.value?.[me.id]?.value?.[me.id]?.value",
+                            subscribedStream[me.id]?.value?.[me.id]?.value?.[
+                                me.id
+                            ]?.value
                         );
                         Effect.runPromise(Queue.offer(queue, subscribedStream));
                     }
@@ -212,33 +209,31 @@ describe("CoStream resolution", async () => {
                 const te: T = stream;
 
                 const update1 = yield* $(Queue.take(queue));
-                expect(update1.by[me.id]?.value).toEqual(null);
+                expect(update1[me.id]?.value).toEqual(null);
 
                 const update2 = yield* $(Queue.take(queue));
-                expect(update2.by[me.id]?.value).toBeDefined();
-                expect(update2.by[me.id]?.value?.by[me.id]?.value).toBe(null);
+                expect(update2[me.id]?.value).toBeDefined();
+                expect(update2[me.id]?.value?.[me.id]?.value).toBe(null);
 
                 const update3 = yield* $(Queue.take(queue));
+                expect(update3[me.id]?.value?.[me.id]?.value).toBeDefined();
                 expect(
-                    update3.by[me.id]?.value?.by[me.id]?.value
-                ).toBeDefined();
-                expect(
-                    update3.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value
+                    update3[me.id]?.value?.[me.id]?.value?.[me.id]?.value
                 ).toBe("milk");
 
-                update3.by[me.id]!.value!.by[me.id]!.value!.push("bread");
+                update3[me.id]!.value![me.id]!.value!.push("bread");
 
                 const update4 = yield* $(Queue.take(queue));
                 expect(
-                    update4.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value
+                    update4[me.id]?.value?.[me.id]?.value?.[me.id]?.value
                 ).toBe("bread");
 
                 // When assigning a new nested stream, we get an update
-                const newTwiceNested = new TwiceNestedStream(["butter"], {
+                const newTwiceNested = TwiceNestedStream.create(["butter"], {
                     owner: meOnSecondPeer,
                 });
 
-                const newNested = new NestedStream([newTwiceNested], {
+                const newNested = NestedStream.create([newTwiceNested], {
                     owner: meOnSecondPeer,
                 });
 
@@ -246,14 +241,14 @@ describe("CoStream resolution", async () => {
 
                 const update5 = yield* $(Queue.take(queue));
                 expect(
-                    update5.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value
+                    update5[me.id]?.value?.[me.id]?.value?.[me.id]?.value
                 ).toBe("butter");
 
                 // we get updates when the new nested stream changes
                 newTwiceNested.push("jam");
                 const update6 = yield* $(Queue.take(queue));
                 expect(
-                    update6.by[me.id]?.value?.by[me.id]?.value?.by[me.id]?.value
+                    update6[me.id]?.value?.[me.id]?.value?.[me.id]?.value
                 ).toBe("jam");
             })
         );
@@ -262,10 +257,10 @@ describe("CoStream resolution", async () => {
 
 describe("Simple BinaryCoStream operations", async () => {
     const me = await Account.create({
-        name: "Hermes Puggington",
+        creationProps: { name: "Hermes Puggington" },
     });
 
-    const stream = new BinaryCoStream(undefined, { owner: me });
+    const stream = BinaryCoStream.create({ owner: me });
 
     test("Construction", () => {
         expect(stream.getChunks()).toBe(undefined);
@@ -290,10 +285,10 @@ describe("Simple BinaryCoStream operations", async () => {
 describe("BinaryCoStream loading & Subscription", async () => {
     const initNodeAndStream = async () => {
         const me = await Account.create({
-            name: "Hermes Puggington",
+            creationProps: { name: "Hermes Puggington" },
         });
 
-        const stream = new BinaryCoStream(undefined, { owner: me });
+        const stream = BinaryCoStream.create({ owner: me });
 
         stream.start({ mimeType: "text/plain" });
         stream.push(new Uint8Array([1, 2, 3]));
@@ -341,7 +336,7 @@ describe("BinaryCoStream loading & Subscription", async () => {
     test("Subscription", async () => {
         const { me } = await initNodeAndStream();
 
-        const stream = new BinaryCoStream(undefined, { owner: me });
+        const stream = BinaryCoStream.create({ owner: me });
 
         const [initialAsPeer, secondAsPeer] = connectedPeers(
             "initial",

package/src/tests/groupsAndAccounts.test.ts

@@ -0,0 +1,100 @@
+import { expect, describe, test, beforeEach } from "vitest";
+
+import { webcrypto } from "node:crypto";
+import { Account, jazzReady, CoMap, co, Group } from "..";
+
+if (!("crypto" in globalThis)) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (globalThis as any).crypto = webcrypto;
+}
+
+beforeEach(async () => {
+    await jazzReady;
+});
+
+describe("Custom accounts and groups", async () => {
+    class CustomProfile extends CoMap {
+        name = co.string;
+        color = co.string;
+    }
+
+    class CustomAccount extends Account {
+        profile = co.ref(CustomProfile);
+        root = co.ref(CoMap);
+
+        migrate(creationProps?: { name: string }) {
+            if (creationProps) {
+                const profileGroup = Group.create({ owner: this });
+                profileGroup.addMember("everyone", "reader");
+                this.profile = CustomProfile.create(
+                    { name: creationProps.name, color: "blue" },
+                    { owner: this }
+                );
+            }
+        }
+    }
+
+    class CustomGroup extends Group {
+        profile = co.null;
+        root = co.null;
+        [co.members] = co.ref(CustomAccount);
+
+        get nMembers() {
+            return this.members.length;
+        }
+    }
+
+    type T = CustomGroup[typeof co.members];
+
+    test("Custom account and group", async () => {
+        const me = await CustomAccount.create({
+            creationProps: { name: "Hermes Puggington" },
+        });
+
+        expect(me.profile).toBeDefined();
+        expect(me.profile?.name).toBe("Hermes Puggington");
+        expect(me.profile?.color).toBe("blue");
+
+        const group = new CustomGroup({ owner: me });
+        group.addMember("everyone", "reader");
+
+        expect(group.members).toMatchObject([
+            { id: me.id, role: "admin" },
+            { id: "everyone", role: "reader" },
+        ]);
+
+        expect(group.nMembers).toBe(2);
+
+        await new Promise<void>((resolve) => {
+            group.subscribe((update) => {
+                const meAsMember = update.members.find((member) => {
+                    return member.id === me.id && member.account?.profile;
+                });
+                if (meAsMember) {
+                    expect(meAsMember.account?.profile?.name).toBe(
+                        "Hermes Puggington"
+                    );
+                    expect(meAsMember.account?.profile?.color).toBe("blue");
+                    resolve();
+                }
+            });
+        });
+
+        class MyMap extends CoMap {
+            name = co.string;
+        }
+
+        const map = MyMap.create({ name: "test" }, { owner: group });
+
+        const meAsCastMember = map._owner
+            .as(CustomGroup)
+            .members.find((member) => member.id === me.id);
+        expect(meAsCastMember?.account?.profile?.name).toBe(
+            "Hermes Puggington"
+        );
+        expect(meAsCastMember?.account?.profile?.color).toBe("blue");
+
+        expect((map._owner as any).nMembers).toBeUndefined();
+        expect(map._owner.as(CustomGroup).nMembers).toBe(2);
+    });
+});