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

package/src/implementation/{schema.ts → encoding.ts}

@@ -2,22 +2,22 @@ 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> = {
+export type JsonEncoded = "json";
+export type EncodedAs<V> = { encoded: Encoder<V> };
+export type RefEncoded<V extends CoValue> = {
     ref: () => CoValueClass<V>;
 };
 
-export type FieldDescriptor =
-    | PrimitiveField
-    | RefField<CoValue>
-    | EncodedField<any>;
+export type Encoding =
+    | JsonEncoded
+    | RefEncoded<CoValue>
+    | EncodedAs<any>;
 
-export type FieldDescriptorFor<Field> = NonNullable<Field> extends CoValue
-    ? RefField<NonNullable<Field>>
+export type EncodingFor<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<
     any,
@@ -38,12 +38,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,
 > = NonNullable<V> extends CoValue
     ? null extends V
         ? V
@@ -53,12 +50,12 @@ 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> =
+export type ValidItem<Item, ContainerType extends string> =
     NonNullable<Item> extends CoValue
         ? null extends Item
             ? any

package/src/implementation/refs.ts

@@ -7,11 +7,10 @@ import type {
     Me,
     SubclassedConstructor,
     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(
@@ -63,7 +62,7 @@ export class ValueRef<V extends CoValue> {
         if (raw === "unavailable") {
             return "unavailable";
         } else {
-            return new ValueRef(
+            return new Ref(
                 this.id,
                 this.controlledAccount,
                 this.valueConstructor
@@ -95,17 +94,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>>;
+): { [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,7 +112,7 @@ 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)
@@ -127,7 +126,7 @@ 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)

package/src/index.ts

@@ -1,5 +1,5 @@
-/** @category Internal types */
 export {
+    /** @category Internal types */
     cojsonReady as jazzReady,
     InviteSecret,
     Peer,
@@ -14,7 +14,7 @@ export { ID, CoValue } from "./internal.js";
 
 export { Encoders } 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/coMap.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, jazzReady, Encoders, indexSignature, CoMap } from "..";
+import { Account, jazzReady, Encoders, CoMap } from "..";
 
 if (!("crypto" in globalThis)) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -389,11 +389,11 @@ describe("CoMap resolution", async () => {
     });
 
     class TestRecord extends CoMap<TestRecord> {
-        declare [indexSignature]: number;
+        declare _item: number;
     }
     interface TestRecord extends Record<string, number> {}
     TestRecord.encoding({
-        [indexSignature]: "json",
+        _item: "json",
     });
 
     test("Construction with index signature", async () => {

package/dist/implementation/schema.js

@@ -1,6 +0,0 @@
-import { Date } from "@effect/schema/Schema";
-export const Encoders = {
-    Date,
-};
-export const indexSignature = Symbol.for("indexSignature");
-//# sourceMappingURL=schema.js.map

package/dist/implementation/schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/implementation/schema.ts"],"names":[],"mappings":"AAkCA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,IAAI;CACP,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC"}