jazz-tools 0.7.0-alpha.2 → 0.7.0-alpha.21

package/src/coValues/group.ts

@@ -1,23 +1,18 @@
-import type { CoID, Everyone, RawCoMap, RawGroup, Role } from "cojson";
-import type {
-    CoValue,
-    CoValueClass,
-    ID,
-    PrimitiveField,
-    RefField,
-} from "../internal.js";
+import type { Everyone, RawGroup, Role } from "cojson";
+import type { CoValue, ID, JsonEncoded, RefEncoded } from "../internal.js";
 import {
     Account,
     CoMap,
     CoValueBase,
-    ValueRef,
+    Ref,
+    co,
     isControlledAccount,
+    AccountAndGroupProxyHandler,
 } from "../internal.js";
 
-export class Profile extends CoMap<{ name: string }> {
-    declare name: string;
+export class Profile extends CoMap<{ name: co<string> }> {
+    name = co.string;
 }
-Profile.encoding({ name: "json" });
 
 export class Group<
         Def extends { profile: Profile | null; root: CoMap | null } = {
@@ -28,31 +23,31 @@ export class Group<
     extends CoValueBase
     implements CoValue<"Group", RawGroup>
 {
-    id!: ID<this>;
-    _type!: "Group";
+    declare id: ID<this>;
+    declare _type: "Group";
     static {
         this.prototype._type = "Group";
     }
-    _raw!: RawGroup;
+    declare _raw: RawGroup;
 
-    static _encoding: any;
-    get _encoding(): {
+    static _schema: any;
+    get _schema(): {
         profile: Def["profile"] extends CoValue
-            ? RefField<Def["profile"]>
-            : PrimitiveField;
+            ? RefEncoded<Def["profile"]>
+            : JsonEncoded;
         root: Def["root"] extends CoValue
-            ? RefField<Def["root"]>
-            : PrimitiveField;
+            ? RefEncoded<Def["root"]>
+            : JsonEncoded;
     } {
-        return (this.constructor as typeof Group)._encoding;
+        return (this.constructor as typeof Group)._schema;
     }
     static {
-        this._encoding = {
+        this._schema = {
             profile: { json: true },
             root: { json: true },
         } as any;
-        Object.defineProperty(this.prototype, "_encoding", {
-            get: () => this._encoding,
+        Object.defineProperty(this.prototype, "_schema", {
+            get: () => this._schema,
         });
     }
 
@@ -63,10 +58,8 @@ export class Group<
     root!: Def["root"] extends CoMap ? Def["root"] | null : undefined;
 
     get _refs(): {
-        profile: Def["profile"] extends Profile
-            ? ValueRef<Def["profile"]>
-            : never;
-        root: Def["root"] extends CoMap ? ValueRef<Def["root"]> : never;
+        profile: Def["profile"] extends Profile ? Ref<Def["profile"]> : never;
+        root: Def["root"] extends CoMap ? Ref<Def["root"]> : never;
     } {
         const profileID = this._raw.get("profile") as unknown as
             | ID<NonNullable<Def["profile"]>>
@@ -77,25 +70,19 @@ export class Group<
         return {
             profile:
                 profileID &&
-                (new ValueRef(
+                (new Ref(
                     profileID,
                     this._loadedAs,
-                    (
-                        this._encoding.profile as RefField<
-                            NonNullable<Def["profile"]>
-                        >
-                    ).ref()
+                    this._schema.profile as RefEncoded<
+                        NonNullable<Def["profile"]>
+                    >
                 ) as any),
             root:
                 rootID &&
-                (new ValueRef(
+                (new Ref(
                     rootID,
                     this._loadedAs,
-                    (
-                        this._encoding.root as RefField<
-                            NonNullable<Def["root"]>
-                        >
-                    ).ref()
+                    this._schema.root as RefEncoded<NonNullable<Def["root"]>>
                 ) as any),
         };
     }
@@ -134,35 +121,12 @@ export class Group<
                 enumerable: false,
             },
             _raw: { value: raw, enumerable: false },
-            profile: {
-                get: () => {
-                    const ref = this._refs.profile;
-                    return ref ? ref.accessFrom(this) : (undefined as any);
-                },
-                set: (value: Def["profile"] | null) => {
-                    if (value) {
-                        this._raw.set(
-                            "profile",
-                            value.id as unknown as CoID<RawCoMap>
-                        );
-                    }
-                },
-            },
-            root: {
-                get: () => {
-                    const ref = this._refs.root;
-                    return ref ? ref.accessFrom(this) : (undefined as any);
-                },
-                set: (value: Def["root"] | null) => {
-                    if (value) {
-                        this._raw.set(
-                            "root",
-                            value.id as unknown as CoID<RawCoMap>
-                        );
-                    }
-                },
-            },
         });
+
+        return new Proxy(
+            this,
+            AccountAndGroupProxyHandler as ProxyHandler<this>
+        );
     }
 
     myRole(): Role | undefined {
@@ -172,15 +136,4 @@ export class Group<
     addMember(member: Everyone | Account, role: Role) {
         this._raw.addMember(member === "everyone" ? member : member._raw, role);
     }
-
-    static define<V extends Account>(
-        this: CoValueClass<V> & typeof Account,
-        fields: {
-            profile: V["_encoding"]["profile"];
-            root: V["_encoding"]["root"];
-        }
-    ) {
-        this._encoding ||= {};
-        Object.assign(this._encoding, fields);
-    }
 }

package/src/coValues/interfaces.ts

@@ -7,7 +7,7 @@ import {
     AccountCtx,
     Group,
     SubscriptionScope,
-    ValueRef,
+    Ref,
     inspect,
 } from "../internal.js";
 
@@ -15,10 +15,7 @@ export type SubclassedConstructor<T> = {
     new (...args: any[]): T;
 };
 
-export interface CoValueClass<
-    Value extends CoValue = CoValue,
-    Init = any,
-> {
+export interface CoValueClass<Value extends CoValue = CoValue, Init = any> {
     /** @category Construction and loading */
     new (init: Init, options: { owner: Account | Group }): Value;
 
@@ -81,11 +78,14 @@ export interface CoValue<Type extends string = string, Raw = any> {
 export function isCoValue(value: any): value is CoValue {
     return value && value._type !== undefined;
 }
+export function isCoValueClass(value: any): value is CoValueClass {
+    return typeof value === "function" && value.fromRaw !== undefined;
+}
 
 /** @category Schemas & CoValues - Abstract interfaces */
-export type ID<T> = CojsonInternalTypes.RawCoID & {
-    readonly __type: T;
-};
+export type ID<T> = CojsonInternalTypes.RawCoID & IDMarker<T>;
+
+type IDMarker<out T> = { __type(_: never): T };
 
 export class CoValueBase implements CoValue {
     id!: ID<this>;
@@ -117,7 +117,9 @@ export class CoValueBase implements CoValue {
     ): Effect.Effect<V, UnavailableError, AccountCtx> {
         return Effect.gen(this, function* (_) {
             const account = yield* _(AccountCtx);
-            return yield* _(new ValueRef(id as ID<V>, account, this).loadEf());
+            return yield* _(
+                new Ref(id as ID<V>, account, this as CoValueClass<V>).loadEf()
+            );
         });
     }
 
@@ -129,7 +131,7 @@ export class CoValueBase implements CoValue {
             onProgress?: (progress: number) => void;
         }
     ): Promise<V | undefined> {
-        return new ValueRef(id as ID<V>, options.as, this).load(
+        return new Ref(id as ID<V>, options.as, this as CoValueClass<V>).load(
             options?.onProgress && { onProgress: options.onProgress }
         );
     }

package/src/implementation/refs.ts

@@ -1,16 +1,31 @@
 import { Effect } from "effect";
 import type { CoID, RawCoValue } from "cojson";
-import type { Account, CoValue, ID, Me, SubclassedConstructor, UnavailableError, indexSignature} from '../internal.js';
-import { subscriptionsScopes } from '../internal.js';
+import type {
+    Account,
+    CoValue,
+    ID,
+    Me,
+    RefEncoded,
+    UnavailableError,
+} from "../internal.js";
+import {
+    instantiateRefEncoded,
+    isRefEncoded,
+    subscriptionsScopes,
+} from "../internal.js";
 
-export class ValueRef<V extends CoValue> {
+export class Ref<out V extends CoValue> {
     private cachedValue: V | undefined;
 
     constructor(
         readonly id: ID<V>,
         readonly controlledAccount: Account & Me,
-        readonly valueConstructor: SubclassedConstructor<V>
-    ) {}
+        readonly schema: RefEncoded<V>
+    ) {
+        if (!isRefEncoded(schema)) {
+            throw new Error("Ref must be constructed with a ref schema");
+        }
+    }
 
     get value() {
         if (this.cachedValue) return this.cachedValue;
@@ -19,7 +34,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 = instantiateRefEncoded(this.schema, raw);
             this.cachedValue = value;
             return value;
         } else {
@@ -43,7 +58,9 @@ export class ValueRef<V extends CoValue> {
         });
     }
 
-    private async loadHelper(options?: {onProgress: (p: number) => void}): Promise<V | "unavailable"> {
+    private async loadHelper(options?: {
+        onProgress: (p: number) => void;
+    }): Promise<V | "unavailable"> {
         const raw = await this.controlledAccount._raw.core.node.load(
             this.id as unknown as CoID<RawCoValue>,
             options?.onProgress
@@ -51,12 +68,14 @@ export class ValueRef<V extends CoValue> {
         if (raw === "unavailable") {
             return "unavailable";
         } else {
-            return new ValueRef(this.id, this.controlledAccount, this.valueConstructor)
+            return new Ref(this.id, this.controlledAccount, this.schema)
                 .value!;
         }
     }
 
-    async load(options?: {onProgress: (p: number) => void}): Promise<V | undefined> {
+    async load(options?: {
+        onProgress: (p: number) => void;
+    }): Promise<V | undefined> {
         const result = await this.loadHelper(options);
         if (result === "unavailable") {
             return undefined;
@@ -78,22 +97,28 @@ 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> } {
-    const refs = {} as { [K in Keys]: ValueRef<CoValue> };
+    refSchemaForKey: (key: Keys) => RefEncoded<CoValue>
+): { [K in Keys]: Ref<CoValue> } & {
+    [Symbol.iterator]: () => IterableIterator<Ref<CoValue>>;
+    length: number;
+} {
+    const refs = {} as { [K in Keys]: Ref<CoValue> } & {
+        [Symbol.iterator]: () => IterableIterator<Ref<CoValue>>;
+        length: number;
+    };
     return new Proxy(refs, {
-        get(target, key) {
+        get(_target, key) {
             if (key === Symbol.iterator) {
                 return function* () {
                     for (const key of getKeysWithIds()) {
-                        yield new ValueRef(
+                        yield new Ref(
                             getIdForKey(key)!,
                             controlledAccount,
-                            valueConstructorForKey(key)
+                            refSchemaForKey(key)
                         );
                     }
                 };
@@ -104,10 +129,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)
+                refSchemaForKey(key as Keys)
             );
         },
         ownKeys() {
@@ -115,3 +140,5 @@ export function makeRefs<Keys extends string | number | indexSignature>(
         },
     });
 }
+
+export type RefIfCoValue<V> = NonNullable<V> extends CoValue ? Ref<NonNullable<V>> : never;

package/src/implementation/schema.ts

@@ -1,25 +1,81 @@
-import type { JsonValue } from "cojson";
-import type { CoValue, CoValueClass } from "../internal.js";
-import type { Schema, TypeId } from "@effect/schema/Schema";
-
-export type PrimitiveField = "json";
-export type EncodedField<V> = { encoded: Encoder<V> };
-export type RefField<V extends CoValue> = {
-    ref: () => CoValueClass<V>;
+import type { JsonValue, RawCoValue } from "cojson";
+import { type CoValue, type CoValueClass, isCoValueClass } from "../internal.js";
+import type { Schema as EffectSchema,  TypeId } from "@effect/schema/Schema";
+
+export type CoMarker = { readonly __co: unique symbol };
+export type co<T> = T | (T & CoMarker);
+export type IfCo<C, R> = C extends infer _A | infer B
+    ? B extends CoMarker
+        ? 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 co = {
+    string: {
+        [SchemaInit]: "json" satisfies Schema,
+    } as unknown as co<string>,
+    number: {
+        [SchemaInit]: "json" satisfies Schema,
+    } as unknown as co<number>,
+    boolean: {
+        [SchemaInit]: "json" satisfies Schema,
+    } as unknown as co<boolean>,
+    literal: <T extends string | number | boolean>(_lit: T): co<T> => {
+        return { [SchemaInit]: "json" satisfies Schema } as any;
+    },
+    json: <T extends JsonValue>(): co<T> => {
+        return { [SchemaInit]: "json" satisfies Schema } as any;
+    },
+    encoded: <T>(arg: Encoder<T>): co<T> => {
+        return { [SchemaInit]: { encoded: arg } satisfies Schema } as any;
+    },
+    ref: <C extends CoValueClass>(
+        arg: C | ((_raw: InstanceType<C>["_raw"]) => C)
+    ): co<InstanceType<C> | null> => {
+        return { [SchemaInit]: arg satisfies Schema } as any;
+    },
+    items: ItemsSym as ItemsSym,
 };
 
-export type FieldDescriptor =
-    | PrimitiveField
-    | RefField<CoValue>
-    | EncodedField<any>;
+export type JsonEncoded = "json";
+export type EncodedAs<V> = { encoded: Encoder<V> };
+export type RefEncoded<V extends CoValue> =
+    | CoValueClass<V>
+    | ((raw: RawCoValue) => CoValueClass<V>);
 
-export type FieldDescriptorFor<Field> = NonNullable<Field> extends CoValue
-    ? RefField<NonNullable<Field>>
+export function isRefEncoded<V extends CoValue>(
+    schema: Schema
+): schema is RefEncoded<V> {
+    return typeof schema === "function";
+}
+
+export function instantiateRefEncoded<V extends CoValue>(
+    schema: RefEncoded<V>,
+    raw: RawCoValue
+): V {
+    return isCoValueClass(schema)
+        ? schema.fromRaw(raw)
+        : (schema as (raw: RawCoValue) => CoValueClass<V>)(raw).fromRaw(raw);
+}
+
+export type Schema = JsonEncoded | RefEncoded<CoValue> | EncodedAs<any>;
+
+export type SchemaFor<Field> = NonNullable<Field> extends CoValue
+    ? RefEncoded<NonNullable<Field>>
     : NonNullable<Field> extends JsonValue
-      ? PrimitiveField
-      : EncodedField<NonNullable<Field>>;
+      ? JsonEncoded
+      : EncodedAs<NonNullable<Field>>;
 
-export type EffectSchemaWithInputAndOutput<A, I = A> = Schema<
+export type EffectSchemaWithInputAndOutput<A, I = A> = EffectSchema<
     any,
     any,
     never
@@ -38,12 +94,9 @@ export const Encoders = {
     Date,
 };
 
-export const indexSignature = Symbol.for("indexSignature");
-export type indexSignature = typeof indexSignature;
-
 export type EnsureCoValueNullable<
     V,
-    Key extends string | indexSignature,
+    Key extends string | ItemsSym,
 > = NonNullable<V> extends CoValue
     ? null extends V
         ? V
@@ -53,17 +106,19 @@ export type EnsureCoValueNullable<
                 V | null,
             ]
           : [
-                `👋 CoMap fields that are CoValue references should be nullable, declare [indexSignature] as:`,
+                `👋 CoMap fields that are CoValue references should be nullable, declare _item as:`,
                 V | null,
             ]
     : V;
 
-export type EnsureItemNullable<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;
+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/index.ts

@@ -1,23 +1,25 @@
-/** @category Internal types */
 export {
+    /** @category Internal types */
     cojsonReady as jazzReady,
+    cojsonInternals,
+    MAX_RECOMMENDED_TX_SIZE,
+} from "cojson";
+export type {
     InviteSecret,
     Peer,
     SessionID,
     AgentID,
     SyncMessage,
-    cojsonInternals,
-    MAX_RECOMMENDED_TX_SIZE,
 } from "cojson";
 
-export { ID, CoValue } from "./internal.js";
+export type { ID, CoValue } from "./internal.js";
 
-export { Encoders } from "./internal.js";
+export { Encoders, co } 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";
-export { Account, Me } from "./internal.js";
+export { Account, type Me } from "./internal.js";
 export { ImageDefinition } from "./internal.js";
-export { CoValueBase, CoValueClass } from "./internal.js";
+export { CoValueBase, type CoValueClass } from "./internal.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, co, 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(co.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(co.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(co.ref(TwiceNestedList)) {}
 
-    class TestList extends CoList<NestedList | null> {}
-    TestList.encoding({ _item: { ref: () => NestedList } });
+    class TestList extends CoList.Of(co.ref(NestedList)) {}
 
     const initNodeAndList = async () => {
         const me = await Account.create({