@dxos/echo 0.8.4-staging.ac66bdf99f → 0.9.0

package/src/internal/Format/object.ts

@@ -20,9 +20,25 @@ import { FormatAnnotation, TypeFormat } from './types';
  * }
  * Note: optional third element for altitude.
  */
+/** Decimal places retained for stored coordinates (~1.1cm at the equator). */
+export const GEO_PRECISION = 7;
+
+const roundCoordinate = (value: number): number => {
+  const factor = 10 ** GEO_PRECISION;
+  return Math.round(value * factor) / factor;
+};
+
+/** Longitude/latitude clamped to range and rounded to {@link GEO_PRECISION} decimal places. */
+const Coordinate = (min: number, max: number, title: string) =>
+  Schema.transform(Schema.Number.pipe(Schema.clamp(min, max)), Schema.Number, {
+    strict: true,
+    decode: roundCoordinate,
+    encode: roundCoordinate,
+  }).annotations({ title });
+
 export const GeoPoint = Schema.Tuple(
-  Schema.Number.pipe(Schema.annotations({ title: 'Longitude' }), Schema.clamp(-180, 180), Schema.multipleOf(0.000001)),
-  Schema.Number.pipe(Schema.annotations({ title: 'Latitude' }), Schema.clamp(-90, 90), Schema.multipleOf(0.000001)),
+  Coordinate(-180, 180, 'Longitude'),
+  Coordinate(-90, 90, 'Latitude'),
   Schema.optionalElement(Schema.Number).annotations({
     title: 'Height ASL (m)',
   }),
@@ -52,8 +68,9 @@ export namespace GeoLocation {
    */
   export const toGeoPoint = ({ longitude, latitude, height }: GeoLocation): GeoPoint => {
     // TODO(ZaymonFC): Use schema validation instead of doing this manually.
-    const clampedLongitude = clamp(longitude, -180, 180);
-    const clampedLatitude = clamp(latitude, -90, 90);
+    // Clamp + round to match the `Format.GeoPoint` decode/encode path so both produce identical tuples.
+    const clampedLongitude = roundCoordinate(clamp(longitude, -180, 180));
+    const clampedLatitude = roundCoordinate(clamp(latitude, -90, 90));
     return height !== undefined ? [clampedLongitude, clampedLatitude, height] : [clampedLongitude, clampedLatitude];
   };
 

package/src/internal/Format/types.ts

@@ -7,7 +7,7 @@ import type * as JSONSchema from 'effect/JSONSchema';
 import * as Option from 'effect/Option';
 import * as SchemaAST from 'effect/SchemaAST';
 
-import { createAnnotationHelper } from '../Annotation';
+import { createAnnotationHelper } from '../Annotation/util';
 import { type JsonSchemaType } from '../JsonSchema';
 
 // TODO(burdon): Rename PropertyType.

package/src/internal/JsonSchema/annotations.ts

@@ -4,7 +4,7 @@
 
 import * as SchemaAST from 'effect/SchemaAST';
 
-import { GeneratorAnnotationId, LabelAnnotationId, PropertyMetaAnnotationId } from '../Annotation';
+import { GeneratorAnnotationId, LabelAnnotationId, PropertyMetaAnnotationId } from '../Annotation/annotations';
 import { CurrencyAnnotationId, FormatAnnotationId } from '../Format';
 import { type JsonSchemaEchoAnnotations, type JsonSchemaType } from '../JsonSchema';
 

package/src/internal/JsonSchema/json-schema-type.ts

@@ -4,7 +4,7 @@
 
 import * as Schema from 'effect/Schema';
 
-import { JsonPath, type JsonProp } from '@dxos/effect';
+import { SchemaEx } from '@dxos/effect';
 
 import { type Mutable } from '../common/proxy';
 import { EntityKindSchema } from '../common/types';
@@ -34,7 +34,7 @@ export const JsonSchemaEchoAnnotations = Schema.Struct({
    * Label for this schema.
    * Mapped from {@link LabelAnnotationId}.
    */
-  labelProp: Schema.optional(Schema.Union(JsonPath, Schema.Array(JsonPath))),
+  labelProp: Schema.optional(Schema.Union(SchemaEx.JsonPath, Schema.Array(SchemaEx.JsonPath))),
 
   /**
    * Generator function for this schema.
@@ -339,14 +339,14 @@ export const JsonSchemaType: Schema.Schema<JsonSchemaType> = _JsonSchemaType;
 
 // TODO(burdon): Factor out JSON schema utils.
 
-export const getSchemaProperty = (schema: JsonSchemaType, property: JsonProp): JsonSchemaType | undefined => {
+export const getSchemaProperty = (schema: JsonSchemaType, property: SchemaEx.JsonProp): JsonSchemaType | undefined => {
   return schema.properties?.[property];
 };
 
 // TODO(burdon): Properties should be ordered.
 export const setSchemaProperty = (
   schema: Mutable<JsonSchemaType>,
-  property: JsonProp,
+  property: SchemaEx.JsonProp,
   value: Mutable<JsonSchemaType>,
 ) => {
   schema.properties ??= {};

package/src/internal/JsonSchema/json-schema.test.ts

@@ -7,8 +7,8 @@ import * as Schema from 'effect/Schema';
 import * as SchemaAST from 'effect/SchemaAST';
 import { describe, expect, test } from 'vitest';
 
-import { type JsonProp, findAnnotation } from '@dxos/effect';
-import { ObjectId } from '@dxos/keys';
+import { SchemaEx } from '@dxos/effect';
+import { DXN, EntityId } from '@dxos/keys';
 import { log } from '@dxos/log';
 
 import { TestSchema, prepareAstForCompare } from '../../testing';
@@ -26,7 +26,7 @@ import { EchoObjectSchema } from '../Entity';
 import { Email, FormatAnnotation, TypeFormat } from '../Format';
 import { JsonSchemaType, getNormalizedEchoAnnotations, getSchemaProperty, setSchemaProperty } from '../JsonSchema';
 import { Ref, createSchemaReference, getReferenceAst, getSchemaReference } from '../Ref';
-import { PersistentSchema } from '../Type';
+import { TypeSchema } from '../Type';
 import { toEffectSchema, toJsonSchema } from './json-schema';
 
 const EXAMPLE_NAMESPACE = '@example';
@@ -34,26 +34,18 @@ const EXAMPLE_NAMESPACE = '@example';
 describe('effect-to-json', () => {
   test('type annotation', () => {
     const Test = Schema.Struct({ name: Schema.String }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
+      Type.makeObject(DXN.make('com.example.type.test', '0.1.0')),
     );
     const jsonSchema = toJsonSchema(Test);
-    expect((jsonSchema as any).$id).toEqual('dxn:type:com.example.type.test');
-    expect((jsonSchema as any).version).toEqual('0.1.0');
+    expect(jsonSchema.$id).toEqual('dxn:com.example.type.test:0.1.0');
+    expect(jsonSchema.version).toEqual('0.1.0');
   });
 
   test('property meta annotation', () => {
     const meta = { maxLength: 0 };
     const Test = Schema.Struct({
       name: Schema.String.pipe(PropertyMeta(EXAMPLE_NAMESPACE, meta)),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.test', '0.1.0')));
     const jsonSchema = toJsonSchema(Test);
     expect(getNormalizedEchoAnnotations(jsonSchema.properties!.name!)!.meta![EXAMPLE_NAMESPACE]).to.deep.eq(meta);
   });
@@ -61,20 +53,10 @@ describe('effect-to-json', () => {
   test('reference annotation', () => {
     const Nested = Schema.Struct({
       name: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.testNested',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.testNested', '0.1.0')));
     const Test = Schema.Struct({
       name: Ref(Nested),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.test', '0.1.0')));
     const jsonSchema = toJsonSchema(Test);
     // log.info('schema', { jsonSchema });
     const nested = jsonSchema.properties!.name;
@@ -86,44 +68,24 @@ describe('effect-to-json', () => {
   test.skip('reference annotation with lookup property', () => {
     const Nested = Schema.Struct({
       name: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.testNested',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.testNested', '0.1.0')));
     const Test = Schema.Struct({
       name: Ref(Nested).annotations({ [FieldLookupAnnotationId]: 'name' }),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.test', '0.1.0')));
     const jsonSchema = toJsonSchema(Test);
     const effectSchema = toEffectSchema(jsonSchema);
 
-    const annotation = findAnnotation<string>(effectSchema.ast, FieldLookupAnnotationId);
+    const annotation = SchemaEx.findAnnotation<string>(effectSchema.ast, FieldLookupAnnotationId);
     expect(annotation).to.not.toBeUndefined();
   });
 
   test('array of references', () => {
     const Nested = Schema.Struct({
       name: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.testNested',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.testNested', '0.1.0')));
     const Test = Schema.Struct({
       name: Schema.Array(Ref(Nested)),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.test', '0.1.0')));
 
     const jsonSchema = toJsonSchema(Test);
     expectReferenceAnnotation((jsonSchema.properties!.name as any).items);
@@ -132,20 +94,10 @@ describe('effect-to-json', () => {
   test('optional references', () => {
     const Nested = Schema.Struct({
       name: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.testNested',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.testNested', '0.1.0')));
     const Test = Schema.Struct({
       name: Schema.optional(Ref(Nested)),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.test',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.test', '0.1.0')));
     const jsonSchema = toJsonSchema(Test);
     expectReferenceAnnotation(jsonSchema.properties!.name);
   });
@@ -163,17 +115,12 @@ describe('effect-to-json', () => {
       email: Schema.String.pipe(FormatAnnotation.set(TypeFormat.Email)).annotations({
         description: 'Email address',
       }),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.person',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.person', '0.1.0')));
 
     const jsonSchema = toJsonSchema(TempSchema);
     expect(jsonSchema).to.deep.eq({
       $schema: 'http://json-schema.org/draft-07/schema#',
-      $id: 'dxn:type:com.example.type.person',
+      $id: 'dxn:com.example.type.person:0.1.0',
 
       entityKind: EntityKind.Object,
       typename: 'com.example.type.person',
@@ -214,29 +161,19 @@ describe('effect-to-json', () => {
   test('reference property by ref', () => {
     const Organization = Schema.Struct({
       field: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.organization',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.organization', '0.1.0')));
 
     const Contact = Schema.Struct({
       name: Schema.String,
       organization: Ref(Organization).annotations({ description: 'Contact organization' }),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.person',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.person', '0.1.0')));
 
     // log.info('Contact', { ast: Contact.ast });
 
     const jsonSchema = toJsonSchema(Contact);
     expect(jsonSchema).toEqual({
       $schema: 'http://json-schema.org/draft-07/schema#',
-      $id: 'dxn:type:com.example.type.person',
+      $id: 'dxn:com.example.type.person:0.1.0',
 
       entityKind: EntityKind.Object,
       typename: 'com.example.type.person',
@@ -259,7 +196,7 @@ describe('effect-to-json', () => {
               $ref: '/schemas/echo/ref',
               reference: {
                 schema: {
-                  $ref: 'dxn:type:com.example.type.organization',
+                  $ref: 'dxn:com.example.type.organization',
                 },
                 schemaVersion: '0.1.0',
               },
@@ -276,31 +213,26 @@ describe('effect-to-json', () => {
   test('add reference property', () => {
     const Organization = Schema.Struct({
       field: Schema.String,
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.organization',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.organization', '0.1.0')));
 
     const Contact = Schema.Struct({
       name: Schema.String,
       organization: Ref(Organization).annotations({ description: 'Contact organization' }),
-    }).pipe(
-      Type.object({
-        typename: 'com.example.type.person',
-        version: '0.1.0',
-      }),
-    );
+    }).pipe(Type.makeObject(DXN.make('com.example.type.person', '0.1.0')));
 
     const jsonSchema = toJsonSchema(Contact);
-    setSchemaProperty(jsonSchema, 'organization' as JsonProp, createSchemaReference(Organization.typename));
-    const { typename } = getSchemaReference(getSchemaProperty(jsonSchema, 'organization' as JsonProp) ?? {}) ?? {};
-    expect(typename).to.eq(Organization.typename);
+    setSchemaProperty(
+      jsonSchema,
+      'organization' as SchemaEx.JsonProp,
+      createSchemaReference(Type.getTypename(Organization)),
+    );
+    const { typename } =
+      getSchemaReference(getSchemaProperty(jsonSchema, 'organization' as SchemaEx.JsonProp) ?? {}) ?? {};
+    expect(typename).to.eq(Type.getTypename(Organization));
   });
 
-  test('serialize circular schema (PersistentSchema)', () => {
-    const jsonSchema = toJsonSchema(PersistentSchema);
+  test('serialize circular schema (TypeSchema)', () => {
+    const jsonSchema = toJsonSchema(TypeSchema);
     expect(Object.keys(jsonSchema.properties!).length).toBeGreaterThan(0);
 
     // TODO(dmaretskyi): Currently unable to deserialize.
@@ -349,18 +281,18 @@ describe('effect-to-json', () => {
     const schema = TestSchema.EmployedBy;
     const jsonSchema = toJsonSchema(schema);
     expect(jsonSchema).toEqual({
-      $id: 'dxn:type:com.example.type.employed-by',
+      $id: 'dxn:com.example.type.employedBy:0.1.0',
       $schema: 'http://json-schema.org/draft-07/schema#',
       entityKind: 'relation',
-      typename: 'com.example.type.employed-by',
+      typename: 'com.example.type.employedBy',
       version: '0.1.0',
       relationSource: {
         // TODO(dmaretskyi): Should those point to specific schema version?
-        $ref: 'dxn:type:com.example.type.person',
+        $ref: 'dxn:com.example.type.person',
       },
       relationTarget: {
         // TODO(dmaretskyi): Should those point to specific schema version?
-        $ref: 'dxn:type:com.example.type.organization',
+        $ref: 'dxn:com.example.type.organization',
       },
       type: 'object',
       properties: {
@@ -382,19 +314,13 @@ describe('effect-to-json', () => {
 
   test('label prop', () => {
     const Organization = Schema.Struct({
-      id: ObjectId,
+      id: EntityId,
       name: Schema.String,
-    }).pipe(
-      EchoObjectSchema({
-        typename: 'com.example.type.organization',
-        version: '0.1.0',
-      }),
-      LabelAnnotation.set(['name']),
-    );
+    }).pipe(LabelAnnotation.set(['name']), EchoObjectSchema(DXN.make('com.example.type.organization', '0.1.0')));
 
     const jsonSchema = toJsonSchema(Organization);
     expect(jsonSchema).toEqual({
-      $id: 'dxn:type:com.example.type.organization',
+      $id: 'dxn:com.example.type.organization:0.1.0',
       $schema: 'http://json-schema.org/draft-07/schema#',
       typename: 'com.example.type.organization',
       version: '0.1.0',
@@ -421,9 +347,9 @@ describe('effect-to-json', () => {
 
   test('object id with description', () => {
     const schema = Schema.Struct({
-      id: ObjectId.annotations({ description: 'The id' }),
+      id: EntityId.annotations({ description: 'The id' }),
     });
-    // log.info('schema', { schema: ObjectId.ast });
+    // log.info('schema', { schema: EntityId.ast });
     const jsonSchema = toJsonSchema(schema);
     expect(jsonSchema).toMatchInlineSnapshot(`
       {
@@ -467,7 +393,7 @@ describe('effect-to-json', () => {
   const expectReferenceAnnotation = (object: JsonSchemaType) => {
     expect(object.reference).to.deep.eq({
       schema: {
-        $ref: 'dxn:type:com.example.type.testNested',
+        $ref: 'dxn:com.example.type.testNested',
       },
       schemaVersion: '0.1.0',
     });
@@ -494,12 +420,7 @@ describe('json-to-effect', () => {
     test(`deserialized equals original ${partial ? 'with partial' : ''}`, () => {
       const Organization = Schema.Struct({
         field: Schema.String,
-      }).pipe(
-        Type.object({
-          typename: 'com.example.type.organization',
-          version: '0.1.0',
-        }),
-      );
+      }).pipe(Type.makeObject(DXN.make('com.example.type.organization', '0.1.0')));
 
       const fields = {
         string: Schema.String,
@@ -516,10 +437,7 @@ describe('json-to-effect', () => {
       } as const;
 
       const Test = (partial ? Schema.partial(Schema.Struct(fields)) : Schema.Struct(fields)).pipe(
-        Type.object({
-          typename: 'com.example.type.test',
-          version: '0.1.0',
-        }),
+        Type.makeObject(DXN.make('com.example.type.test', '0.1.0')),
       );
 
       const jsonSchema = toJsonSchema(Test);
@@ -527,11 +445,12 @@ describe('json-to-effect', () => {
 
       const schema = toEffectSchema(jsonSchema);
 
-      expect(() => expect(schema.ast).to.deep.eq(Test.ast)).to.throw();
-      expect(() => expect(prepareAstForCompare(Test.ast)).to.deep.eq(Test.ast)).to.throw();
-      expect(() => expect(schema.ast).to.deep.eq(prepareAstForCompare(Test.ast))).to.throw();
+      const testAst = Type.getSchema(Test).ast;
+      expect(() => expect(schema.ast).to.deep.eq(testAst)).to.throw();
+      expect(() => expect(prepareAstForCompare(testAst)).to.deep.eq(testAst)).to.throw();
+      expect(() => expect(schema.ast).to.deep.eq(prepareAstForCompare(testAst))).to.throw();
       // log.info('', { original: prepareAstForCompare(Schema.ast), deserialized: prepareAstForCompare(schema.ast) });
-      expect(prepareAstForCompare(schema.ast)).to.deep.eq(prepareAstForCompare(Test.ast));
+      expect(prepareAstForCompare(schema.ast)).to.deep.eq(prepareAstForCompare(testAst));
 
       // TODO(dmaretskyi): Fix.
       // expect(
@@ -542,9 +461,9 @@ describe('json-to-effect', () => {
     });
   }
 
-  test('legacy schema with dxn:type $id gets decoded', () => {
+  test('legacy schema with echo.type annotation gets decoded', () => {
     const jsonSchema: JsonSchemaType = {
-      $id: 'dxn:type:com.example.type.project',
+      $id: 'dxn:com.example.type.project',
       $schema: 'http://json-schema.org/draft-07/schema#',
       additionalProperties: false,
       echo: {
@@ -579,7 +498,7 @@ describe('json-to-effect', () => {
       typename: 'com.example.type.project',
       version: '0.1.0',
     });
-    expect(getTypeIdentifierAnnotation(schema)).to.deep.eq('dxn:echo:@:01JERV1HQCQZDQ4NVCJ42QB38F');
+    expect(getTypeIdentifierAnnotation(schema)).to.deep.eq('echo:/01JERV1HQCQZDQ4NVCJ42QB38F');
   });
 
   test('symbol annotations get compared', () => {
@@ -602,7 +521,7 @@ describe('json-to-effect', () => {
     const schema = TestSchema.HasManager;
     const jsonSchema = toJsonSchema(schema);
     const effectSchema = toEffectSchema(jsonSchema);
-    expect(prepareAstForCompare(effectSchema.ast)).to.deep.eq(prepareAstForCompare(schema.ast));
+    expect(prepareAstForCompare(effectSchema.ast)).to.deep.eq(prepareAstForCompare(Type.getSchema(schema).ast));
   });
 
   test('generator annotation', () => {
@@ -714,7 +633,7 @@ describe('json-to-effect', () => {
             "$ref": "/schemas/echo/ref",
             "reference": {
               "schema": {
-                "$ref": "dxn:type:com.example.type.person",
+                "$ref": "dxn:com.example.type.person",
               },
               "schemaVersion": "0.1.0",
             },
@@ -735,9 +654,9 @@ describe('json-to-effect', () => {
   test('object nested inside another struct', () => {
     const Contact = Schema.Struct({
       name: Schema.String,
-    }).pipe(EchoObjectSchema({ typename: 'com.example.type.person', version: '0.1.0' }));
+    }).pipe(EchoObjectSchema(DXN.make('com.example.type.person', '0.1.0')));
     const input = Schema.Struct({
-      contact: Contact,
+      contact: Type.getSchema(Contact),
     });
     const jsonSchema = toJsonSchema(input);
     expect(jsonSchema).toMatchInlineSnapshot(`
@@ -746,7 +665,7 @@ describe('json-to-effect', () => {
         "additionalProperties": false,
         "properties": {
           "contact": {
-            "$id": "dxn:type:com.example.type.person",
+            "$id": "dxn:com.example.type.person:0.1.0",
             "additionalProperties": false,
             "entityKind": "object",
             "properties": {
@@ -795,7 +714,7 @@ describe('reference', () => {
       $schema: 'http://json-schema.org/draft-07/schema#',
       reference: {
         schema: {
-          $ref: 'dxn:type:com.example.type.person',
+          $ref: 'dxn:com.example.type.person',
         },
         schemaVersion: '0.1.0',
       },
@@ -813,7 +732,7 @@ describe('reference', () => {
           $ref: '/schemas/echo/ref',
           reference: {
             schema: {
-              $ref: 'dxn:type:com.example.type.person',
+              $ref: 'dxn:com.example.type.person',
             },
             schemaVersion: '0.1.0',
           },
@@ -834,7 +753,7 @@ describe('reference', () => {
           $ref: '/schemas/echo/ref',
           reference: {
             schema: {
-              $ref: 'dxn:type:com.example.type.person',
+              $ref: 'dxn:com.example.type.person',
             },
             schemaVersion: '0.1.0',
           },
@@ -853,8 +772,15 @@ describe('reference', () => {
     const deserializedSchema = toEffectSchema(jsonSchema);
     const refAst = getReferenceAst(deserializedSchema.ast);
     expect(refAst).toEqual({
-      typename: TestSchema.Person.typename,
-      version: TestSchema.Person.version,
+      typename: Type.getTypename(TestSchema.Person),
+      version: Type.getVersion(TestSchema.Person),
     });
   });
+
+  test('empty struct round-trips as TypeLiteral', () => {
+    const schema = Schema.Struct({});
+    const jsonSchema = toJsonSchema(schema);
+    const deserialized = toEffectSchema(jsonSchema);
+    expect(deserialized.ast._tag).toBe('TypeLiteral');
+  });
 });