@dxos/echo 0.8.4-main.bc674ce → 0.8.4-main.bd9b33e6c8

package/src/internal/{json-schema → JsonSchema}/json-schema-type.ts

@@ -6,9 +6,9 @@ import * as Schema from 'effect/Schema';
 
 import { JsonPath, type JsonProp } from '@dxos/effect';
 
-import { FormatAnnotation, TypeFormat } from '../formats';
-import { type Mutable } from '../proxy';
-import { EntityKindSchema } from '../types';
+import { FormatAnnotation, TypeFormat } from '../Format';
+import { type Mutable } from '../common/proxy';
+import { EntityKindSchema } from '../common/types';
 
 //
 // JSON Schema
@@ -119,7 +119,7 @@ const _JsonSchemaType = Schema.Struct({
    * Typename of this schema.
    * Only on schema representing an ECHO object.
    *
-   * @example 'example.com/type/MyType'
+   * @example 'com.example.type.my-type'
    */
   typename: Schema.optional(Schema.String),
 

package/src/internal/{json-schema → JsonSchema}/json-schema.test.ts

@@ -20,13 +20,13 @@ import {
   PropertyMeta,
   getTypeAnnotation,
   getTypeIdentifierAnnotation,
-} from '../annotations';
-import { EchoObjectSchema } from '../entities';
-import { Email, FormatAnnotation, TypeFormat } from '../formats';
-import { JsonSchemaType, getNormalizedEchoAnnotations, getSchemaProperty, setSchemaProperty } from '../json-schema';
-import { Ref, createSchemaReference, getReferenceAst, getSchemaReference } from '../ref';
-import { PersistentSchema } from '../schema';
-import { EntityKind } from '../types';
+} from '../Annotation';
+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 { EntityKind } from '../common/types';
 
 import { toEffectSchema, toJsonSchema } from './json-schema';
 
@@ -36,12 +36,12 @@ describe('effect-to-json', () => {
   test('type annotation', () => {
     const Test = Schema.Struct({ name: Schema.String }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
     const jsonSchema = toJsonSchema(Test);
-    expect((jsonSchema as any).$id).toEqual('dxn:type:example.com/type/Test');
+    expect((jsonSchema as any).$id).toEqual('dxn:type:com.example.type.test');
     expect((jsonSchema as any).version).toEqual('0.1.0');
   });
 
@@ -51,7 +51,7 @@ describe('effect-to-json', () => {
       name: Schema.String.pipe(PropertyMeta(EXAMPLE_NAMESPACE, meta)),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
@@ -64,7 +64,7 @@ describe('effect-to-json', () => {
       name: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/TestNested',
+        typename: 'com.example.type.testNested',
         version: '0.1.0',
       }),
     );
@@ -72,7 +72,7 @@ describe('effect-to-json', () => {
       name: Ref(Nested),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
@@ -89,7 +89,7 @@ describe('effect-to-json', () => {
       name: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/TestNested',
+        typename: 'com.example.type.testNested',
         version: '0.1.0',
       }),
     );
@@ -97,7 +97,7 @@ describe('effect-to-json', () => {
       name: Ref(Nested).annotations({ [FieldLookupAnnotationId]: 'name' }),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
@@ -113,7 +113,7 @@ describe('effect-to-json', () => {
       name: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/TestNested',
+        typename: 'com.example.type.testNested',
         version: '0.1.0',
       }),
     );
@@ -121,7 +121,7 @@ describe('effect-to-json', () => {
       name: Schema.Array(Ref(Nested)),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
@@ -135,7 +135,7 @@ describe('effect-to-json', () => {
       name: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/TestNested',
+        typename: 'com.example.type.testNested',
         version: '0.1.0',
       }),
     );
@@ -143,7 +143,7 @@ describe('effect-to-json', () => {
       name: Schema.optional(Ref(Nested)),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Test',
+        typename: 'com.example.type.test',
         version: '0.1.0',
       }),
     );
@@ -166,7 +166,7 @@ describe('effect-to-json', () => {
       }),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Person',
+        typename: 'com.example.type.person',
         version: '0.1.0',
       }),
     );
@@ -174,10 +174,10 @@ describe('effect-to-json', () => {
     const jsonSchema = toJsonSchema(TempSchema);
     expect(jsonSchema).to.deep.eq({
       $schema: 'http://json-schema.org/draft-07/schema#',
-      $id: 'dxn:type:example.com/type/Person',
+      $id: 'dxn:type:com.example.type.person',
 
       entityKind: EntityKind.Object,
-      typename: 'example.com/type/Person',
+      typename: 'com.example.type.person',
       version: '0.1.0',
 
       type: 'object',
@@ -217,7 +217,7 @@ describe('effect-to-json', () => {
       field: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Organization',
+        typename: 'com.example.type.organization',
         version: '0.1.0',
       }),
     );
@@ -227,7 +227,7 @@ describe('effect-to-json', () => {
       organization: Ref(Organization).annotations({ description: 'Contact organization' }),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Person',
+        typename: 'com.example.type.person',
         version: '0.1.0',
       }),
     );
@@ -237,10 +237,10 @@ describe('effect-to-json', () => {
     const jsonSchema = toJsonSchema(Contact);
     expect(jsonSchema).toEqual({
       $schema: 'http://json-schema.org/draft-07/schema#',
-      $id: 'dxn:type:example.com/type/Person',
+      $id: 'dxn:type:com.example.type.person',
 
       entityKind: EntityKind.Object,
-      typename: 'example.com/type/Person',
+      typename: 'com.example.type.person',
       version: '0.1.0',
 
       type: 'object',
@@ -260,7 +260,7 @@ describe('effect-to-json', () => {
               $ref: '/schemas/echo/ref',
               reference: {
                 schema: {
-                  $ref: 'dxn:type:example.com/type/Organization',
+                  $ref: 'dxn:type:com.example.type.organization',
                 },
                 schemaVersion: '0.1.0',
               },
@@ -279,7 +279,7 @@ describe('effect-to-json', () => {
       field: Schema.String,
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Organization',
+        typename: 'com.example.type.organization',
         version: '0.1.0',
       }),
     );
@@ -289,7 +289,7 @@ describe('effect-to-json', () => {
       organization: Ref(Organization).annotations({ description: 'Contact organization' }),
     }).pipe(
       Type.object({
-        typename: 'example.com/type/Person',
+        typename: 'com.example.type.person',
         version: '0.1.0',
       }),
     );
@@ -350,18 +350,18 @@ describe('effect-to-json', () => {
     const schema = TestSchema.EmployedBy;
     const jsonSchema = toJsonSchema(schema);
     expect(jsonSchema).toEqual({
-      $id: 'dxn:type:example.com/type/EmployedBy',
+      $id: 'dxn:type:com.example.type.employed-by',
       $schema: 'http://json-schema.org/draft-07/schema#',
       entityKind: 'relation',
-      typename: 'example.com/type/EmployedBy',
+      typename: 'com.example.type.employed-by',
       version: '0.1.0',
       relationSource: {
         // TODO(dmaretskyi): Should those point to specific schema version?
-        $ref: 'dxn:type:example.com/type/Person',
+        $ref: 'dxn:type:com.example.type.person',
       },
       relationTarget: {
         // TODO(dmaretskyi): Should those point to specific schema version?
-        $ref: 'dxn:type:example.com/type/Organization',
+        $ref: 'dxn:type:com.example.type.organization',
       },
       type: 'object',
       properties: {
@@ -387,7 +387,7 @@ describe('effect-to-json', () => {
       name: Schema.String,
     }).pipe(
       EchoObjectSchema({
-        typename: 'example.com/type/Organization',
+        typename: 'com.example.type.organization',
         version: '0.1.0',
       }),
       LabelAnnotation.set(['name']),
@@ -395,9 +395,9 @@ describe('effect-to-json', () => {
 
     const jsonSchema = toJsonSchema(Organization);
     expect(jsonSchema).toEqual({
-      $id: 'dxn:type:example.com/type/Organization',
+      $id: 'dxn:type:com.example.type.organization',
       $schema: 'http://json-schema.org/draft-07/schema#',
-      typename: 'example.com/type/Organization',
+      typename: 'com.example.type.organization',
       version: '0.1.0',
       entityKind: 'object',
       type: 'object',
@@ -468,7 +468,7 @@ describe('effect-to-json', () => {
   const expectReferenceAnnotation = (object: JsonSchemaType) => {
     expect(object.reference).to.deep.eq({
       schema: {
-        $ref: 'dxn:type:example.com/type/TestNested',
+        $ref: 'dxn:type:com.example.type.testNested',
       },
       schemaVersion: '0.1.0',
     });
@@ -497,7 +497,7 @@ describe('json-to-effect', () => {
         field: Schema.String,
       }).pipe(
         Type.object({
-          typename: 'example.com/type/Organization',
+          typename: 'com.example.type.organization',
           version: '0.1.0',
         }),
       );
@@ -518,7 +518,7 @@ describe('json-to-effect', () => {
 
       const Test = (partial ? Schema.partial(Schema.Struct(fields)) : Schema.Struct(fields)).pipe(
         Type.object({
-          typename: 'example.com/type/Test',
+          typename: 'com.example.type.test',
           version: '0.1.0',
         }),
       );
@@ -545,13 +545,13 @@ describe('json-to-effect', () => {
 
   test('legacy schema with dxn:type $id gets decoded', () => {
     const jsonSchema: JsonSchemaType = {
-      $id: 'dxn:type:example.com/type/Project',
+      $id: 'dxn:type:com.example.type.project',
       $schema: 'http://json-schema.org/draft-07/schema#',
       additionalProperties: false,
       echo: {
         type: {
           schemaId: '01JERV1HQCQZDQ4NVCJ42QB38F',
-          typename: 'example.com/type/Project',
+          typename: 'com.example.type.project',
           version: '0.1.0',
         },
       },
@@ -577,7 +577,7 @@ describe('json-to-effect', () => {
     const schema = toEffectSchema(jsonSchema);
     expect(getTypeAnnotation(schema)).to.deep.eq({
       kind: EntityKind.Object,
-      typename: 'example.com/type/Project',
+      typename: 'com.example.type.project',
       version: '0.1.0',
     });
     expect(getTypeIdentifierAnnotation(schema)).to.deep.eq('dxn:echo:@:01JERV1HQCQZDQ4NVCJ42QB38F');
@@ -715,7 +715,7 @@ describe('json-to-effect', () => {
             "$ref": "/schemas/echo/ref",
             "reference": {
               "schema": {
-                "$ref": "dxn:type:example.com/type/Person",
+                "$ref": "dxn:type:com.example.type.person",
               },
               "schemaVersion": "0.1.0",
             },
@@ -736,7 +736,7 @@ describe('json-to-effect', () => {
   test('object nested inside another struct', () => {
     const Contact = Schema.Struct({
       name: Schema.String,
-    }).pipe(EchoObjectSchema({ typename: 'example.com/type/Person', version: '0.1.0' }));
+    }).pipe(EchoObjectSchema({ typename: 'com.example.type.person', version: '0.1.0' }));
     const input = Schema.Struct({
       contact: Contact,
     });
@@ -747,7 +747,7 @@ describe('json-to-effect', () => {
         "additionalProperties": false,
         "properties": {
           "contact": {
-            "$id": "dxn:type:example.com/type/Person",
+            "$id": "dxn:type:com.example.type.person",
             "additionalProperties": false,
             "entityKind": "object",
             "properties": {
@@ -767,7 +767,7 @@ describe('json-to-effect', () => {
               "id",
             ],
             "type": "object",
-            "typename": "example.com/type/Person",
+            "typename": "com.example.type.person",
             "version": "0.1.0",
           },
         },
@@ -796,7 +796,7 @@ describe('reference', () => {
       $schema: 'http://json-schema.org/draft-07/schema#',
       reference: {
         schema: {
-          $ref: 'dxn:type:example.com/type/Person',
+          $ref: 'dxn:type:com.example.type.person',
         },
         schemaVersion: '0.1.0',
       },
@@ -814,7 +814,7 @@ describe('reference', () => {
           $ref: '/schemas/echo/ref',
           reference: {
             schema: {
-              $ref: 'dxn:type:example.com/type/Person',
+              $ref: 'dxn:type:com.example.type.person',
             },
             schemaVersion: '0.1.0',
           },
@@ -835,7 +835,7 @@ describe('reference', () => {
           $ref: '/schemas/echo/ref',
           reference: {
             schema: {
-              $ref: 'dxn:type:example.com/type/Person',
+              $ref: 'dxn:type:com.example.type.person',
             },
             schemaVersion: '0.1.0',
           },

package/src/internal/{json-schema → JsonSchema}/json-schema.ts

@@ -22,9 +22,9 @@ import {
   TypeAnnotationId,
   TypeIdentifierAnnotationId,
   makeTypeJsonSchemaAnnotation,
-} from '../annotations';
-import { type JsonSchemaReferenceInfo, createEchoReferenceSchema } from '../ref';
-import { ANY_OBJECT_TYPENAME, ANY_OBJECT_VERSION, EntityKind, EntityKindSchema } from '../types';
+} from '../Annotation';
+import { type JsonSchemaReferenceInfo, createEchoReferenceSchema } from '../Ref';
+import { ANY_OBJECT_TYPENAME, ANY_OBJECT_VERSION, EntityKind, EntityKindSchema } from '../common/types';
 
 import { CustomAnnotations, DecodedAnnotations, EchoAnnotations } from './annotations';
 import {
@@ -465,11 +465,13 @@ const jsonSchemaFieldsToAnnotations = (schema: JsonSchemaType): SchemaAST.Annota
     }
   }
 
-  annotations[TypeIdentifierAnnotationId] = decodeTypeIdentifierAnnotation(schema);
+  const typeIdentifier = decodeTypeIdentifierAnnotation(schema);
+  annotations[TypeIdentifierAnnotationId] = typeIdentifier;
   const typeAnnotation = decodeTypeAnnotation(schema);
   if (typeAnnotation) {
     annotations[TypeAnnotationId] = typeAnnotation;
     annotations[SchemaAST.JSONSchemaAnnotationId] = makeTypeJsonSchemaAnnotation({
+      identifier: typeIdentifier,
       kind: typeAnnotation.kind,
       typename: typeAnnotation.typename,
       version: typeAnnotation.version,

package/src/internal/{object → Obj}/clone.ts

@@ -6,9 +6,9 @@ import { invariant } from '@dxos/invariant';
 import { deepMapValues } from '@dxos/util';
 
 import type * as Obj from '../../Obj';
-import { makeObject } from '../proxy';
-import { Ref } from '../ref';
-import { getMeta, getSchema } from '../types';
+import { makeObject } from '../common/proxy';
+import { Ref } from '../Ref';
+import { getMeta, getSchema } from '../common/types';
 
 /**
  * Clones an object or relation.

package/src/internal/{object → Obj}/common.ts

@@ -4,8 +4,8 @@
 
 import * as Schema from 'effect/Schema';
 
-import { getTypename } from '../annotations';
-import { type AnyProperties } from '../types';
+import { getTypename } from '../Annotation';
+import { type AnyProperties } from '../common/types';
 
 // TODO(dmaretskyi): Rename to represent commonality between objects and relations (e.g. `entity`).
 export type TypedObjectOptions = {

package/src/internal/{object → Obj}/create-object.test.ts

@@ -11,9 +11,9 @@ import { DXN } from '@dxos/keys';
 
 import { Relation } from '../../index';
 import { TestSchema } from '../../testing';
-import { getSchemaDXN, getTypeDXN, isInstanceOf } from '../annotations';
-import { ATTR_RELATION_SOURCE, ATTR_RELATION_TARGET } from '../entities';
-import { ATTR_META, ATTR_TYPE, getSchema } from '../types';
+import { getSchemaDXN, getTypeDXN, isInstanceOf } from '../Annotation';
+import { ATTR_RELATION_SOURCE, ATTR_RELATION_TARGET } from '../Entity';
+import { ATTR_META, ATTR_TYPE, getSchema } from '../common/types';
 
 import { createObject } from './create-object';
 import { objectToJSON } from './json-serializer';
@@ -110,7 +110,7 @@ describe('create (static version)', () => {
     const text = inspect(contact);
     expect(text).toContain('Bot');
     expect(text).toContain('bot@example.com');
-    expect(text).toContain('example.com/type/Person');
+    expect(text).toContain('com.example.type.person');
     expect(text).toContain('0.1.0');
   });
 });

package/src/internal/{object → Obj}/create-object.ts

@@ -8,7 +8,7 @@ import { raise } from '@dxos/debug';
 import { assertArgument, failedInvariant } from '@dxos/invariant';
 import { ObjectId } from '@dxos/keys';
 
-import { getSchemaDXN, getTypeAnnotation, setTypename } from '../annotations';
+import { getSchemaDXN, getTypeAnnotation, setTypename } from '../Annotation';
 import {
   RelationSourceDXNId,
   RelationSourceId,
@@ -16,9 +16,9 @@ import {
   RelationTargetId,
   assertObjectModel,
   getObjectDXN,
-} from '../entities';
-import { defineHiddenProperty } from '../proxy';
-import { EntityKind, KindId, MetaId, setSchema } from '../types';
+} from '../Entity';
+import { defineHiddenProperty } from '../common/proxy';
+import { EntityKind, KindId, MetaId, setSchema } from '../common/types';
 
 import { attachedTypedObjectInspector } from './inspect';
 import { attachTypedJsonSerializer } from './json-serializer';
@@ -42,7 +42,7 @@ export type CreateObjectProps<T> = T extends { id: string } ? Omit<T, 'id' | Kin
  *   name: Schema.String,
  *   email: Schema.String,
  * }).pipe(Type.object({
- *   typename: 'example.com/type/Person',
+ *   typename: 'com.example.type.person',
  *   version: '0.1.0',
  * }))
  *

package/src/internal/{object → Obj}/deleted.ts

@@ -2,8 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-import { ObjectDeletedId } from '../entities';
-import { type AnyProperties } from '../types';
+import { ObjectDeletedId } from '../Entity';
+import { type AnyProperties } from '../common/types';
 
 /**
  * @returns `true` if the object has been marked as deleted.

package/src/internal/{object → Obj}/inspect.ts

@@ -6,8 +6,8 @@ import type { InspectOptionsStylized, inspect as inspectFn } from 'node:util';
 
 import { type CustomInspectFunction, inspectCustom } from '@dxos/debug';
 
-import { getTypeDXN } from '../annotations';
-import { ATTR_META, ATTR_TYPE, type AnyEntity, MetaId } from '../types';
+import { getTypeDXN } from '../Annotation';
+import { ATTR_META, ATTR_TYPE, type AnyEntity, MetaId } from '../common/types';
 
 /*
  * @internal

package/src/internal/{object → Obj}/json-serializer.test.ts

@@ -8,12 +8,12 @@ import { DXN } from '@dxos/keys';
 
 import * as Obj from '../../Obj';
 import { TestSchema } from '../../testing';
-import { getSchemaDXN, getSchemaTypename, getTypeDXN, getTypename } from '../annotations';
-import { getMetaChecked } from '../api';
-import { RelationSourceId, RelationTargetId, getObjectDXN } from '../entities';
-import { makeObject } from '../proxy';
-import { Ref, StaticRefResolver } from '../ref';
-import { ATTR_TYPE, EntityKind, KindId, MetaId, TypeId, getSchema } from '../types';
+import { getSchemaDXN, getSchemaTypename, getTypeDXN, getTypename } from '../Annotation';
+import { getMetaChecked } from '../common/api';
+import { RelationSourceId, RelationTargetId, getObjectDXN } from '../Entity';
+import { makeObject } from '../common/proxy';
+import { Ref, StaticRefResolver } from '../Ref';
+import { ATTR_TYPE, EntityKind, KindId, MetaId, TypeId, getSchema } from '../common/types';
 
 import { createObject } from './create-object';
 import { objectFromJSON, objectToJSON } from './json-serializer';
@@ -21,8 +21,8 @@ import { objectFromJSON, objectToJSON } from './json-serializer';
 describe('Object JSON serializer', () => {
   test('should serialize and deserialize object', async () => {
     const contact = makeObject(TestSchema.Person, { name: 'Alice' });
-    Obj.change(contact, (c) => {
-      getMetaChecked(c).keys.push({ id: '12345', source: 'example.com' });
+    Obj.change(contact, (obj) => {
+      getMetaChecked(obj).keys.push({ id: '12345', source: 'example.com' });
     });
 
     const task = createObject(TestSchema.Task, {
@@ -95,4 +95,27 @@ describe('Object JSON serializer', () => {
     expect(getObjectDXN(contactFromJson)).toEqual(getObjectDXN(contact));
     expect(getTypeDXN(contactFromJson)).toEqual(getSchemaDXN(TestSchema.Person));
   });
+
+  test('deserializes expando without leaking internal json keys', async () => {
+    const expando = Obj.make(TestSchema.Expando, { message: 'local-only' });
+    const expandoJson = objectToJSON(expando);
+
+    const refResolver = new StaticRefResolver().addSchema(TestSchema.Expando);
+    const expandoFromJson = (await objectFromJSON(expandoJson, { refResolver })) as TestSchema.Expando;
+
+    expect(expandoFromJson.id).toBe(expando.id);
+    expect(expandoFromJson.message).toBe('local-only');
+    expect((expandoFromJson as any)[ATTR_TYPE]).toBeUndefined();
+  });
+
+  test('deserializes expando without schema resolver and without leaking internal json keys', async () => {
+    const expando = Obj.make(TestSchema.Expando, { message: 'local-only' });
+    const expandoJson = objectToJSON(expando);
+
+    const expandoFromJson = (await objectFromJSON(expandoJson)) as TestSchema.Expando;
+
+    expect(expandoFromJson.id).toBe(expando.id);
+    expect(expandoFromJson.message).toBe('local-only');
+    expect((expandoFromJson as any)[ATTR_TYPE]).toBeUndefined();
+  });
 });