jazz-tools 0.7.0-alpha.4 → 0.7.0-alpha.7

package/src/implementation/encoding.ts

@@ -0,0 +1,105 @@
+import type { JsonValue, RawCoValue } from "cojson";
+import type { CoValue, CoValueClass } from "../internal.js";
+import type { Schema, TypeId } from "@effect/schema/Schema";
+
+export type ValMarker = { readonly __field: unique symbol };
+export type val<T> = T | (T & ValMarker);
+export type IsVal<C, R> = C extends infer _A | infer B
+    ? B extends ValMarker
+        ? R
+        : never
+    : never;
+
+export const SchemaInit = Symbol.for("SchemaInit");
+export type SchemaInit = typeof SchemaInit;
+
+export const InitValues = Symbol.for("InitValues");
+export type InitValues = typeof InitValues;
+
+export const ItemsSym = Symbol.for("items");
+export type ItemsSym = typeof ItemsSym;
+
+export const val = {
+    string: {[SchemaInit]: "json" satisfies Encoding } as unknown as val<string>,
+    number: {[SchemaInit]: "json" satisfies Encoding } as unknown as val<number>,
+    boolean: {[SchemaInit]: "json" satisfies Encoding } as unknown as val<boolean>,
+    literal: <T extends string | number | boolean>(
+        _lit: T
+    ): val<T> => {
+        return {[SchemaInit]: "json" satisfies Encoding } as any;
+    },
+    json: <T extends JsonValue>(): val<T> => {
+        return {[SchemaInit]: "json" satisfies Encoding } as any;
+    },
+    encoded: <T>(arg: Encoder<T>): val<T> => {
+        return { [SchemaInit]: { encoded: arg } satisfies Encoding } as any;
+    },
+    ref: <C extends CoValueClass>(
+        arg: (_raw: InstanceType<C>['_raw']) => C
+    ): val<InstanceType<C> | null> => {
+        return { [SchemaInit]: { ref: arg } satisfies Encoding } as any;
+    },
+    items: ItemsSym as ItemsSym,
+}
+
+export type JsonEncoded = "json";
+export type EncodedAs<V> = { encoded: Encoder<V> };
+export type RefEncoded<V extends CoValue> = {
+    ref: (raw: RawCoValue) => CoValueClass<V>;
+};
+
+export type Encoding = JsonEncoded | RefEncoded<CoValue> | EncodedAs<any>;
+
+export type EncodingFor<Field> = NonNullable<Field> extends CoValue
+    ? RefEncoded<NonNullable<Field>>
+    : NonNullable<Field> extends JsonValue
+      ? JsonEncoded
+      : EncodedAs<NonNullable<Field>>;
+
+export type EffectSchemaWithInputAndOutput<A, I = A> = Schema<
+    any,
+    any,
+    never
+> & {
+    [TypeId]: {
+        _A: (_: any) => A;
+        _I: (_: any) => I;
+    };
+};
+
+export type Encoder<V> = EffectSchemaWithInputAndOutput<V, JsonValue>;
+
+import { Date } from "@effect/schema/Schema";
+
+export const Encoders = {
+    Date,
+};
+
+export type EnsureCoValueNullable<
+    V,
+    Key extends string | ItemsSym,
+> = NonNullable<V> extends CoValue
+    ? null extends V
+        ? V
+        : Key extends string
+          ? [
+                `👋 CoMap fields that are CoValue references should be nullable, declare ${Key} as:`,
+                V | null,
+            ]
+          : [
+                `👋 CoMap fields that are CoValue references should be nullable, declare _item as:`,
+                V | null,
+            ]
+    : V;
+
+export type ValidItem<
+    Item,
+    ContainerType extends string,
+> = NonNullable<Item> extends CoValue
+    ? null extends Item
+        ? any
+        : [
+              `👋 CoList items that are CoValue references should be nullable, make sure the Item generic parameter of ${ContainerType} is:`,
+              Item | null,
+          ]
+    : any;

package/src/implementation/refs.ts

@@ -5,20 +5,23 @@ import type {
     CoValue,
     ID,
     Me,
-    SubclassedConstructor,
+    RefEncoded,
     UnavailableError,
-    indexSignature,
 } from "../internal.js";
 import { subscriptionsScopes } from "../internal.js";
 
-export class ValueRef<V extends CoValue> {
+export class Ref<V extends CoValue> {
     private cachedValue: V | undefined;
 
     constructor(
         readonly id: ID<V>,
         readonly controlledAccount: Account & Me,
-        readonly valueConstructor: SubclassedConstructor<V>
-    ) {}
+        readonly encoding: RefEncoded<V>
+    ) {
+        if (!("ref" in encoding)) {
+            throw new Error("Ref must be constructed with a ref encoding");
+        }
+    }
 
     get value() {
         if (this.cachedValue) return this.cachedValue;
@@ -27,9 +30,7 @@ export class ValueRef<V extends CoValue> {
             this.id as unknown as CoID<RawCoValue>
         );
         if (raw) {
-            const value = new this.valueConstructor(undefined, {
-                fromRaw: raw,
-            }) as V;
+            const value = this.encoding.ref(raw).fromRaw(raw);
             this.cachedValue = value;
             return value;
         } else {
@@ -63,10 +64,10 @@ export class ValueRef<V extends CoValue> {
         if (raw === "unavailable") {
             return "unavailable";
         } else {
-            return new ValueRef(
+            return new Ref(
                 this.id,
                 this.controlledAccount,
-                this.valueConstructor
+                this.encoding
             ).value!;
         }
     }
@@ -95,17 +96,17 @@ export class ValueRef<V extends CoValue> {
     }
 }
 
-export function makeRefs<Keys extends string | number | indexSignature>(
+export function makeRefs<Keys extends string | number>(
     getIdForKey: (key: Keys) => ID<CoValue> | undefined,
     getKeysWithIds: () => Keys[],
     controlledAccount: Account & Me,
-    valueConstructorForKey: (key: Keys) => SubclassedConstructor<CoValue>
-): { [K in Keys]: ValueRef<CoValue> } & {
-    [Symbol.iterator]: () => IterableIterator<ValueRef<CoValue>>;
+    refEncodingForKey: (key: Keys) => RefEncoded<CoValue>
+): { [K in Keys]: Ref<CoValue> } & {
+    [Symbol.iterator]: () => IterableIterator<Ref<CoValue>>;
     length: number;
 } {
-    const refs = {} as { [K in Keys]: ValueRef<CoValue> } & {
-        [Symbol.iterator]: () => IterableIterator<ValueRef<CoValue>>;
+    const refs = {} as { [K in Keys]: Ref<CoValue> } & {
+        [Symbol.iterator]: () => IterableIterator<Ref<CoValue>>;
         length: number;
     };
     return new Proxy(refs, {
@@ -113,10 +114,10 @@ export function makeRefs<Keys extends string | number | indexSignature>(
             if (key === Symbol.iterator) {
                 return function* () {
                     for (const key of getKeysWithIds()) {
-                        yield new ValueRef(
+                        yield new Ref(
                             getIdForKey(key)!,
                             controlledAccount,
-                            valueConstructorForKey(key)
+                            refEncodingForKey(key)
                         );
                     }
                 };
@@ -127,10 +128,10 @@ export function makeRefs<Keys extends string | number | indexSignature>(
             }
             const id = getIdForKey(key as Keys);
             if (!id) return undefined;
-            return new ValueRef(
+            return new Ref(
                 id as ID<CoValue>,
                 controlledAccount,
-                valueConstructorForKey(key as Keys)
+                refEncodingForKey(key as Keys)
             );
         },
         ownKeys() {

package/src/index.ts

@@ -1,5 +1,5 @@
-/** @category Internal types */
 export {
+    /** @category Internal types */
     cojsonReady as jazzReady,
     InviteSecret,
     Peer,
@@ -12,9 +12,9 @@ export {
 
 export { ID, CoValue } from "./internal.js";
 
-export { Encoders } from "./internal.js";
+export { Encoders, val } from "./internal.js";
 
-export { CoMap, indexSignature } from "./internal.js";
+export { CoMap } from "./internal.js";
 export { CoList } from "./internal.js";
 export { CoStream, BinaryCoStream } from "./internal.js";
 export { Group, Profile } from "./internal.js";

package/src/internal.ts

@@ -9,7 +9,7 @@ export * from "./coValues/group.js";
 
 export * from "./implementation/errors.js";
 export * from "./implementation/refs.js";
-export * from "./implementation/schema.js";
+export * from "./implementation/encoding.js";
 export * from "./implementation/subscriptionScope.js";
 
 export * from "./coValues/extensions/imageDef.js";

package/src/tests/coList.test.ts

@@ -4,7 +4,7 @@ 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 { Account, CoList, jazzReady } from "..";
+import { Account, CoList, val, jazzReady } from "..";
 
 if (!("crypto" in globalThis)) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -20,8 +20,7 @@ describe("Simple CoList operations", async () => {
         name: "Hermes Puggington",
     });
 
-    class TestList extends CoList<string> {}
-    TestList.encoding({ _item: "json" });
+    class TestList extends CoList.Of(val.string) {}
 
     const list = new TestList(["bread", "butter", "onion"], { owner: me });
 
@@ -115,18 +114,15 @@ describe("Simple CoList operations", async () => {
 });
 
 describe("CoList resolution", async () => {
-    class TwiceNestedList extends CoList<string> {
+    class TwiceNestedList extends CoList.Of(val.string) {
         joined() {
             return this.join(",");
         }
     }
-    TwiceNestedList.encoding({ _item: "json" });
 
-    class NestedList extends CoList<TwiceNestedList | null> {}
-    NestedList.encoding({ _item: { ref: () => TwiceNestedList } });
+    class NestedList extends CoList.Of(val.ref(() => TwiceNestedList)) {}
 
-    class TestList extends CoList<NestedList | null> {}
-    TestList.encoding({ _item: { ref: () => NestedList } });
+    class TestList extends CoList.Of(val.ref(() => NestedList)) {}
 
     const initNodeAndList = async () => {
         const me = await Account.create({

package/src/tests/coMap.test.ts

@@ -4,7 +4,8 @@ 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 { Account, jazzReady, Encoders, indexSignature, CoMap } from "..";
+import { Account, jazzReady, Encoders, CoMap } from "..";
+import { val } from "../internal";
 
 if (!("crypto" in globalThis)) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -21,21 +22,15 @@ describe("Simple CoMap operations", async () => {
     });
 
     class TestMap extends CoMap<TestMap> {
-        declare color: string;
-        declare height: number;
-        declare birthday: Date;
-        declare name?: string;
+        color = val.string;
+        _height = val.number;
+        birthday = val.encoded(Encoders.Date);
+        name? = val.string;
 
-        get _roughColor() {
+        get roughColor() {
             return this.color + "ish";
         }
     }
-    TestMap.encoding({
-        color: "json",
-        height: "json",
-        birthday: { encoded: Encoders.Date },
-        name: "json",
-    });
 
     console.log("TestMap schema", TestMap.prototype._encoding);
 
@@ -44,7 +39,7 @@ describe("Simple CoMap operations", async () => {
     const map = new TestMap(
         {
             color: "red",
-            height: 10,
+            _height: 10,
             birthday: birthday,
         },
         { owner: me }
@@ -52,10 +47,16 @@ describe("Simple CoMap operations", async () => {
 
     test("Construction", () => {
         expect(map.color).toEqual("red");
-        expect(map._roughColor).toEqual("redish");
-        expect(map.height).toEqual(10);
+        expect(map.roughColor).toEqual("redish");
+        expect(map._height).toEqual(10);
         expect(map.birthday).toEqual(birthday);
         expect(map._raw.get("birthday")).toEqual(birthday.toISOString());
+        expect(Object.keys(map)).toEqual([
+            "color",
+            "_height",
+            "birthday",
+            "name",
+        ]);
     });
 
     describe("Mutation", () => {
@@ -68,11 +69,11 @@ describe("Simple CoMap operations", async () => {
             expect(map.birthday).toEqual(newBirthday);
             expect(map._raw.get("birthday")).toEqual(newBirthday.toISOString());
 
-            Object.assign(map, { color: "green", height: 20 });
+            Object.assign(map, { color: "green", _height: 20 });
             expect(map.color).toEqual("green");
             expect(map._raw.get("color")).toEqual("green");
-            expect(map.height).toEqual(20);
-            expect(map._raw.get("height")).toEqual(20);
+            expect(map._height).toEqual(20);
+            expect(map._raw.get("_height")).toEqual(20);
 
             map.name = "Secret name";
             expect(map.name).toEqual("Secret name");
@@ -82,13 +83,9 @@ describe("Simple CoMap operations", async () => {
     });
 
     class RecursiveMap extends CoMap<RecursiveMap> {
-        declare name: string;
-        declare next: RecursiveMap | null;
+        name = val.string;
+        next: val<RecursiveMap | null> = val.ref(() => RecursiveMap);
     }
-    RecursiveMap.encoding({
-        name: "json",
-        next: { ref: () => RecursiveMap },
-    });
 
     const recursiveMap = new RecursiveMap(
         {
@@ -116,43 +113,69 @@ describe("Simple CoMap operations", async () => {
             expect(recursiveMap.next?.next?.name).toEqual("third");
         });
     });
+
+    class MapWithEnumOfMaps extends CoMap<MapWithEnumOfMaps> {
+        name = val.string;
+        child = val.ref<typeof ChildA | typeof ChildB>((raw) =>
+            raw.get("type") === "a" ? ChildA : ChildB
+        );
+    }
+
+    class ChildA extends CoMap<ChildA> {
+        type = val.literal("a");
+        value = val.number;
+    }
+
+    class ChildB extends CoMap<ChildB> {
+        type = val.literal("b");
+        value = val.string;
+    }
+
+    const mapWithEnum = new MapWithEnumOfMaps(
+        {
+            name: "enum",
+            child: new ChildA(
+                {
+                    type: "a",
+                    value: 5,
+                },
+                { owner: me }
+            ),
+        },
+        { owner: me }
+    );
+
+    test("Enum of maps", () => {
+        expect(mapWithEnum.name).toEqual("enum");
+        expect(mapWithEnum.child?.type).toEqual("a");
+        expect(mapWithEnum.child?.value).toEqual(5);
+        expect(mapWithEnum.child?.id).toBeDefined();
+    });
 });
 
 describe("CoMap resolution", async () => {
     class TwiceNestedMap extends CoMap<TwiceNestedMap> {
-        taste!: string;
+        taste = val.string;
     }
-    TwiceNestedMap.encoding({
-        taste: "json",
-    });
 
     class NestedMap extends CoMap<NestedMap> {
-        name!: string;
-        twiceNested!: TwiceNestedMap | null;
+        name = val.string;
+        twiceNested = val.ref(() => TwiceNestedMap);
 
         get _fancyName() {
             return "Sir " + this.name;
         }
     }
-    NestedMap.encoding({
-        name: "json",
-        twiceNested: { ref: () => TwiceNestedMap },
-    });
 
     class TestMap extends CoMap<TestMap> {
-        declare color: string;
-        declare height: number;
-        declare nested: NestedMap | null;
+        color = val.string;
+        height = val.number;
+        nested = val.ref(() => NestedMap);
 
         get _roughColor() {
             return this.color + "ish";
         }
     }
-    TestMap.encoding({
-        color: "json",
-        height: "json",
-        nested: { ref: () => NestedMap },
-    });
 
     const initNodeAndMap = async () => {
         const me = await Account.create({
@@ -342,13 +365,9 @@ describe("CoMap resolution", async () => {
     });
 
     class TestMapWithOptionalRef extends CoMap<TestMapWithOptionalRef> {
-        declare color: string;
-        declare nested?: NestedMap | null;
+        color = val.string;
+        nested? = val.ref(() => NestedMap);
     }
-    TestMapWithOptionalRef.encoding({
-        color: "json",
-        nested: { ref: () => NestedMap },
-    });
 
     test("Construction with optional", async () => {
         const me = await Account.create({
@@ -389,12 +408,9 @@ describe("CoMap resolution", async () => {
     });
 
     class TestRecord extends CoMap<TestRecord> {
-        declare [indexSignature]: number;
+        [val.items] = val.number;
     }
     interface TestRecord extends Record<string, number> {}
-    TestRecord.encoding({
-        [indexSignature]: "json",
-    });
 
     test("Construction with index signature", async () => {
         const me = await Account.create({