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

package/src/coValues/account.ts

@@ -15,14 +15,14 @@ import type {
     CoMap,
     CoValue,
     CoValueClass,
-    FieldDescriptor,
+    Encoding,
     Group,
     ID,
-    RefField,
+    RefEncoded,
     SubclassedConstructor,
     UnavailableError,
 } from "../internal.js";
-import { CoValueBase, Profile, ValueRef, inspect } from "../internal.js";
+import { CoValueBase, Profile, Ref, inspect } from "../internal.js";
 import type { Stream } from "effect/Stream";
 
 export class Account<
@@ -40,8 +40,8 @@ export class Account<
 
     static _encoding: any;
     get _encoding(): {
-        profile: FieldDescriptor;
-        root: FieldDescriptor;
+        profile: Encoding;
+        root: Encoding;
     } {
         return (this.constructor as typeof Account)._encoding;
     }
@@ -66,10 +66,10 @@ export class Account<
 
     get _refs(): {
         profile: NonNullable<Def["profile"]> extends Profile
-            ? ValueRef<NonNullable<Def["profile"]>> | null
+            ? Ref<NonNullable<Def["profile"]>> | null
             : null;
         root: NonNullable<Def["root"]> extends CoMap
-            ? ValueRef<NonNullable<Def["root"]>> | null
+            ? Ref<NonNullable<Def["root"]>> | null
             : null;
     } {
         const profileID = this._raw.get("profile") as unknown as ID<
@@ -79,22 +79,22 @@ export class Account<
             | ID<NonNullable<Def["root"]>>
             | undefined;
         return {
-            profile: profileID && (new ValueRef(
+            profile: profileID && (new Ref(
                 profileID,
                 this._loadedAs,
                 (
-                    this._encoding.profile as RefField<
+                    this._encoding.profile as RefEncoded<
                         NonNullable<Def["profile"]> & CoValue
                     >
                 ).ref()
             )) as any,
             root:
                 rootID &&
-                (new ValueRef(
+                (new Ref(
                     rootID,
                     this._loadedAs,
                     (
-                        this._encoding.root as RefField<NonNullable<Def["root"]> & CoValue>
+                        this._encoding.root as RefEncoded<NonNullable<Def["root"]> & CoValue>
                     ).ref()
                 ) as any),
         };

package/src/coValues/coList.ts

@@ -4,11 +4,11 @@ import type { Effect, Stream } from "effect";
 import type {
     AccountCtx,
     CoValue,
-    EnsureItemNullable,
-    FieldDescriptor,
-    FieldDescriptorFor,
+    ValidItem,
+    Encoding,
+    EncodingFor,
     ID,
-    RefField,
+    RefEncoded,
     SubclassedConstructor,
     UnavailableError,
 } from "../internal.js";
@@ -16,13 +16,13 @@ import {
     Account,
     CoValueBase,
     Group,
-    ValueRef,
+    Ref,
     inspect,
     makeRefs,
 } from "../internal.js";
 import { Schema } from "@effect/schema";
 
-export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
+export class CoList<Item extends ValidItem<Item, "Co.List"> = any>
     extends Array<Item>
     implements CoValue<"CoList", RawCoList>
 {
@@ -35,7 +35,7 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
 
     static _encoding: any;
     get _encoding(): {
-        _item: FieldDescriptorFor<Item>;
+        _item: EncodingFor<Item>;
     } {
         return (this.constructor as typeof CoList)._encoding;
     }
@@ -48,8 +48,15 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
 
     get _refs(): {
         [idx: number]: NonNullable<Item> extends CoValue
-            ? ValueRef<NonNullable<Item>>
+            ? Ref<NonNullable<Item>>
             : never;
+    } & {
+        length: number;
+        [Symbol.iterator](): IterableIterator<
+            NonNullable<Item> extends CoValue
+                ? Ref<NonNullable<Item>>
+                : never
+        >;
     } {
         return makeRefs<number>(
             (idx) => this._raw.get(idx) as unknown as ID<CoValue>,
@@ -59,14 +66,14 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
                     (_, idx) => idx
                 ),
             this._loadedAs,
-            (_idx) => (this._encoding._item as RefField<CoValue>).ref()
+            (_idx) => (this._encoding._item as RefEncoded<CoValue>).ref()
         ) as any;
     }
 
     get _edits(): {
         [idx: number]: {
             value?: Item;
-            ref?: Item extends CoValue ? ValueRef<Item> : never;
+            ref?: Item extends CoValue ? Ref<Item> : never;
             by?: Account;
             madeAt: Date;
         };
@@ -122,7 +129,7 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
     }
 
     private toRawItems(items: Item[]) {
-        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        const itemDescriptor = this._encoding._item as Encoding;
         const rawItems =
             itemDescriptor === "json"
                 ? items
@@ -199,7 +206,7 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
     }
 
     toJSON() {
-        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        const itemDescriptor = this._encoding._item as Encoding;
         if (itemDescriptor === "json") {
             return this._raw.asArray();
         } else if ("encoded" in itemDescriptor) {
@@ -265,8 +272,8 @@ export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
     }
 }
 
-function CoListProxyHandler<Item extends EnsureItemNullable<Item, "Co.List">>(
-    itemDescriptor: FieldDescriptor
+function CoListProxyHandler<Item extends ValidItem<Item, "Co.List">>(
+    itemDescriptor: Encoding
 ): ProxyHandler<CoList<Item>> {
     return {
         get(target, key, receiver) {
@@ -281,7 +288,7 @@ function CoListProxyHandler<Item extends EnsureItemNullable<Item, "Co.List">>(
                 } else if ("ref" in itemDescriptor) {
                     return rawValue === undefined
                         ? undefined
-                        : new ValueRef(
+                        : new Ref(
                               rawValue as unknown as ID<CoValue>,
                               target._loadedAs,
                               itemDescriptor.ref()

package/src/coValues/coMap.ts

@@ -4,27 +4,24 @@ import { Schema } from "@effect/schema";
 import type {
     CoValue,
     Encoder,
-    FieldDescriptor,
-    FieldDescriptorFor,
+    Encoding,
+    EncodingFor,
     Group,
     ID,
-    RefField,
+    RefEncoded,
     EnsureCoValueNullable,
     CoValueClass,
 } from "../internal.js";
 import {
     Account,
     CoValueBase,
-    ValueRef,
+    Ref,
     inspect,
     makeRefs,
     subscriptionsScopes,
-    indexSignature,
 } from "../internal.js";
 
-type EnsureValid<
-    Fields extends { [key: string]: any; [indexSignature]?: any },
-> = {
+type ValidFields<Fields extends { [key: string]: any; _item?: any }> = {
     [Key in OwnKeys<Fields> as IfOptionalKey<
         Key,
         Fields
@@ -35,10 +32,7 @@ type EnsureValid<
         Fields
     >]: EnsureCoValueNullable<Fields[Key], Key>;
 } & {
-    [Key in indexSignature]?: EnsureCoValueNullable<
-        Fields[indexSignature],
-        Key
-    >;
+    [Key in "_item"]?: EnsureCoValueNullable<Fields["_item"], Key>;
 };
 
 type IfOptionalKey<Key extends keyof Obj, Obj> = Pick<
@@ -56,10 +50,10 @@ type IfRequiredKey<Key extends keyof Obj, Obj> = Pick<
 
 type DefaultFields = {
     [key: string]: any;
-    [indexSignature]?: any;
+    _item?: any;
 };
 
-export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
+export class CoMap<Fields extends ValidFields<Fields> = DefaultFields>
     extends CoValueBase
     implements CoValue<"CoMap", RawCoMap>
 {
@@ -72,10 +66,10 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
 
     static _encoding: any;
     get _encoding(): {
-        [Key in OwnKeys<Fields>]: FieldDescriptorFor<Fields[Key]>;
+        [Key in OwnKeys<Fields>]: EncodingFor<Fields[Key]>;
     } & {
-        [indexSignature]: indexSignature extends keyof Fields
-            ? FieldDescriptorFor<Fields[indexSignature]>
+        _item: "_item" extends keyof Fields
+            ? EncodingFor<Fields["_item"]>
             : never;
     } {
         return (this.constructor as typeof CoMap)._encoding;
@@ -85,7 +79,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
         [Key in OwnKeys<Fields> as NonNullable<Fields[Key]> extends CoValue
             ? Key
             : never]: NonNullable<Fields[Key]> extends CoValue
-            ? ValueRef<NonNullable<Fields[Key]>>
+            ? Ref<NonNullable<Fields[Key]>>
             : never;
     } {
         return makeRefs<OwnKeys<Fields>>(
@@ -94,18 +88,18 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
                 Object.keys(this._encoding).filter((key) => {
                     const schema = this._encoding[
                         key as keyof typeof this._encoding
-                    ] as FieldDescriptor;
+                    ] as Encoding;
                     schema !== "json" && "ref" in schema;
                 }) as OwnKeys<Fields>[],
             this._loadedAs,
-            (key) => (this._encoding[key] as RefField<CoValue>).ref()
+            (key) => (this._encoding[key] as RefEncoded<CoValue>).ref()
         ) as any;
     }
 
     get _edits(): {
         [Key in OwnKeys<Fields>]: {
             value?: Fields[Key];
-            ref?: Fields[Key] extends CoValue ? ValueRef<Fields[Key]> : never;
+            ref?: Fields[Key] extends CoValue ? Ref<Fields[Key]> : never;
             by?: Account;
             madeAt: Date;
         };
@@ -117,7 +111,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
 
                 const descriptor = target._encoding[
                     key as keyof typeof target._encoding
-                ] as FieldDescriptor;
+                ] as Encoding;
 
                 return {
                     value:
@@ -127,14 +121,14 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
                               ? Schema.decodeSync(descriptor.encoded)(
                                     rawEdit.value
                                 )
-                              : new ValueRef(
+                              : new Ref(
                                     rawEdit.value as ID<CoValue>,
                                     target._loadedAs,
                                     descriptor.ref()
                                 ).accessFrom(target),
                     ref:
                         descriptor !== "json" && "ref" in descriptor
-                            ? new ValueRef(
+                            ? new Ref(
                                   rawEdit.value as ID<CoValue>,
                                   target._loadedAs,
                                   descriptor.ref()
@@ -142,7 +136,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
                             : undefined,
                     by:
                         rawEdit.by &&
-                        new ValueRef(
+                        new Ref(
                             rawEdit.by as ID<Account>,
                             target._loadedAs,
                             Account
@@ -188,7 +182,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
 
         this.definePropertiesFromSchema();
 
-        if (this._encoding[indexSignature]) {
+        if (this._encoding._item) {
             return new Proxy(this, CoMapProxyHandler<Fields>());
         }
     }
@@ -196,7 +190,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
     toJSON() {
         const jsonedFields = this._raw.keys().map((key) => {
             const tKey = key as OwnKeys<Fields>;
-            const descriptor = this._encoding[tKey] as FieldDescriptor;
+            const descriptor = this._encoding[tKey] as Encoding;
 
             if (descriptor == "json" || "encode" in descriptor) {
                 return [key, this._raw.get(key)];
@@ -240,7 +234,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
 
                     const descriptor = (this._encoding[
                         key as keyof typeof this._encoding
-                    ] || this._encoding[indexSignature]) as FieldDescriptor;
+                    ] || this._encoding._item) as Encoding;
 
                     if (descriptor === "json") {
                         rawInit[key] = initValue as JsonValue;
@@ -275,7 +269,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
     private definePropertiesFromSchema() {
         for (const [key, fieldSchema] of Object.entries(this._encoding)) {
             if (key === "indexSignature") continue;
-            const descriptor = fieldSchema as FieldDescriptor;
+            const descriptor = fieldSchema as Encoding;
             if (descriptor === "json") {
                 Object.defineProperty(
                     this,
@@ -294,7 +288,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
                     key,
                     this.refPropDef(
                         key as string,
-                        (descriptor as RefField<CoValue>).ref
+                        (descriptor as RefEncoded<CoValue>).ref
                     )
                 );
             }
@@ -339,7 +333,7 @@ export class CoMap<Fields extends EnsureValid<Fields> = DefaultFields>
                 const rawID = this._raw.get(key);
                 return rawID === undefined
                     ? undefined
-                    : new ValueRef(
+                    : new Ref(
                           rawID as unknown as ID<CoValue>,
                           this._loadedAs,
                           ref()
@@ -369,14 +363,12 @@ export type CoMapInit<Fields extends object> = {
 } & { [Key in OwnKeys<Fields>]?: Fields[Key] };
 
 // TODO: cache handlers per descriptor for performance?
-function CoMapProxyHandler<Fields extends EnsureValid<Fields>>(): ProxyHandler<
+function CoMapProxyHandler<Fields extends ValidFields<Fields>>(): ProxyHandler<
     CoMap<Fields>
 > {
     return {
         get(target, key, receiver) {
-            const descriptor = target._encoding[
-                indexSignature
-            ] as FieldDescriptor;
+            const descriptor = target._encoding._item as Encoding;
             if (key in target || typeof key === "symbol") {
                 return Reflect.get(target, key, receiver);
             } else {
@@ -391,7 +383,7 @@ function CoMapProxyHandler<Fields extends EnsureValid<Fields>>(): ProxyHandler<
                 } else if ("ref" in descriptor) {
                     return raw === undefined
                         ? undefined
-                        : new ValueRef(
+                        : new Ref(
                               raw as unknown as ID<CoValue>,
                               target._loadedAs,
                               descriptor.ref()
@@ -400,9 +392,7 @@ function CoMapProxyHandler<Fields extends EnsureValid<Fields>>(): ProxyHandler<
             }
         },
         set(target, key, value, receiver) {
-            const descriptor = target._encoding[
-                indexSignature
-            ] as FieldDescriptor;
+            const descriptor = target._encoding._item as Encoding;
             if (key in target || typeof key === "symbol") {
                 return Reflect.set(target, key, value, receiver);
             } else {
@@ -423,7 +413,7 @@ function CoMapProxyHandler<Fields extends EnsureValid<Fields>>(): ProxyHandler<
             }
         },
         ownKeys(target) {
-            const keys = Reflect.ownKeys(target);
+            const keys = Reflect.ownKeys(target).filter((k) => k !== "_item");
             for (const key of target._raw.keys()) {
                 if (!keys.includes(key)) {
                     keys.push(key);

package/src/coValues/coStream.ts

@@ -11,27 +11,27 @@ import type {
 import { cojsonInternals } from "cojson";
 import type {
     CoValue,
-    EnsureItemNullable,
-    FieldDescriptor,
-    FieldDescriptorFor,
+    ValidItem,
+    Encoding,
+    EncodingFor,
     Group,
     ID,
     Me,
 } from "../internal.js";
-import { Account, CoValueBase, ValueRef, inspect } from "../internal.js";
+import { Account, CoValueBase, Ref, inspect } from "../internal.js";
 import { Schema } from "@effect/schema";
 
 export type CoStreamEntry<Item> = {
     value: NonNullable<Item> extends CoValue ? NonNullable<Item> | null : Item;
     ref?: NonNullable<Item> extends CoValue
-        ? ValueRef<NonNullable<Item>>
+        ? Ref<NonNullable<Item>>
         : never;
     by?: Account;
     madeAt: Date;
     tx: CojsonInternalTypes.TransactionID;
 };
 
-export class CoStream<Item extends EnsureItemNullable<Item, "Co.Stream"> = any>
+export class CoStream<Item extends ValidItem<Item, "Co.Stream"> = any>
     extends CoValueBase
     implements CoValue<"CoStream", RawCoStream>
 {
@@ -46,7 +46,7 @@ export class CoStream<Item extends EnsureItemNullable<Item, "Co.Stream"> = any>
     _item!: Item;
     static _encoding: any;
     get _encoding(): {
-        _item: FieldDescriptorFor<Item>;
+        _item: EncodingFor<Item>;
     } {
         return (this.constructor as typeof CoStream)._encoding;
     }
@@ -155,7 +155,7 @@ export class CoStream<Item extends EnsureItemNullable<Item, "Co.Stream"> = any>
     }
 
     private pushItem(item: Item) {
-        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        const itemDescriptor = this._encoding._item as Encoding;
 
         if (itemDescriptor === "json") {
             this._raw.push(item as JsonValue);
@@ -167,7 +167,7 @@ export class CoStream<Item extends EnsureItemNullable<Item, "Co.Stream"> = any>
     }
 
     toJSON() {
-        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        const itemDescriptor = this._encoding._item as Encoding;
         const mapper =
             itemDescriptor === "json"
                 ? (v: unknown) => v
@@ -216,7 +216,7 @@ function entryFromRawEntry<Item>(
     },
     loadedAs: Account & Me,
     accountID: ID<Account> | undefined,
-    itemField: FieldDescriptor
+    itemField: Encoding
 ) {
     return {
         get value(): Item | undefined {
@@ -231,7 +231,7 @@ function entryFromRawEntry<Item>(
         get ref() {
             if (itemField !== "json" && "ref" in itemField) {
                 const rawId = rawEntry.value;
-                return new ValueRef(
+                return new Ref(
                     rawId as unknown as ID<CoValue>,
                     loadedAs,
                     itemField.ref()
@@ -241,7 +241,7 @@ function entryFromRawEntry<Item>(
         get by() {
             return (
                 accountID &&
-                new ValueRef(
+                new Ref(
                     accountID as unknown as ID<Account>,
                     loadedAs,
                     Account

package/src/coValues/extensions/imageDef.ts

@@ -1,7 +1,6 @@
 import {
     BinaryCoStream,
     CoMap,
-    indexSignature,
     subscriptionsScopes,
 } from "../../internal.js";
 
@@ -10,7 +9,7 @@ export class ImageDefinition extends CoMap<ImageDefinition> {
     declare placeholderDataURL?: string;
 
     [res: `${number}x${number}`]: BinaryCoStream | null;
-    declare [indexSignature]: BinaryCoStream | null;
+    declare _item: BinaryCoStream | null;
 
     get _highestResAvailable():
         | { res: `${number}x${number}`; stream: BinaryCoStream }
@@ -56,5 +55,5 @@ export class ImageDefinition extends CoMap<ImageDefinition> {
 ImageDefinition.encoding({
     originalSize: "json",
     placeholderDataURL: "json",
-    [indexSignature]: { ref: () => BinaryCoStream },
+    _item: { ref: () => BinaryCoStream },
 });

package/src/coValues/group.ts

@@ -3,14 +3,14 @@ import type {
     CoValue,
     CoValueClass,
     ID,
-    PrimitiveField,
-    RefField,
+    JsonEncoded,
+    RefEncoded,
 } from "../internal.js";
 import {
     Account,
     CoMap,
     CoValueBase,
-    ValueRef,
+    Ref,
     isControlledAccount,
 } from "../internal.js";
 
@@ -38,11 +38,11 @@ export class Group<
     static _encoding: any;
     get _encoding(): {
         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;
     }
@@ -64,9 +64,9 @@ export class Group<
 
     get _refs(): {
         profile: Def["profile"] extends Profile
-            ? ValueRef<Def["profile"]>
+            ? Ref<Def["profile"]>
             : never;
-        root: Def["root"] extends CoMap ? ValueRef<Def["root"]> : never;
+        root: Def["root"] extends CoMap ? Ref<Def["root"]> : never;
     } {
         const profileID = this._raw.get("profile") as unknown as
             | ID<NonNullable<Def["profile"]>>
@@ -77,22 +77,22 @@ export class Group<
         return {
             profile:
                 profileID &&
-                (new ValueRef(
+                (new Ref(
                     profileID,
                     this._loadedAs,
                     (
-                        this._encoding.profile as RefField<
+                        this._encoding.profile as RefEncoded<
                             NonNullable<Def["profile"]>
                         >
                     ).ref()
                 ) as any),
             root:
                 rootID &&
-                (new ValueRef(
+                (new Ref(
                     rootID,
                     this._loadedAs,
                     (
-                        this._encoding.root as RefField<
+                        this._encoding.root as RefEncoded<
                             NonNullable<Def["root"]>
                         >
                     ).ref()

package/src/coValues/interfaces.ts

@@ -7,7 +7,7 @@ import {
     AccountCtx,
     Group,
     SubscriptionScope,
-    ValueRef,
+    Ref,
     inspect,
 } from "../internal.js";
 
@@ -117,7 +117,7 @@ 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).loadEf());
         });
     }
 
@@ -129,7 +129,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).load(
             options?.onProgress && { onProgress: options.onProgress }
         );
     }