@dxos/echo 0.8.4-main.ead640a → 0.8.4-main.effb148878

package/src/internal/object/entity.ts

@@ -1,248 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-import * as SchemaAST from 'effect/SchemaAST';
-import type * as Types from 'effect/Types';
-
-import { raise } from '@dxos/debug';
-import { assertArgument, invariant } from '@dxos/invariant';
-import { DXN } from '@dxos/keys';
-
-import {
-  EntityKind,
-  type TypeAnnotation,
-  TypeAnnotationId,
-  type TypeMeta,
-  getEntityKind,
-  getSchemaTypename,
-  getTypeIdentifierAnnotation,
-} from '../ast';
-import { type HasId, type ToMutable } from '../types';
-
-import { type RelationSourceTargetRefs } from './relation';
-
-// TODO(burdon): Define Schema type for `typename` and use consistently for all DXN-like properties.
-
-// type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
-type EchoTypeSchemaProps<T, ExtraFields = {}> = Types.Simplify<HasId & ToMutable<T> & ExtraFields>;
-
-export interface EchoTypeSchema<Self extends Schema.Schema.Any, ExtraFields = {}>
-  extends TypeMeta,
-    Schema.AnnotableClass<
-      EchoTypeSchema<Self, ExtraFields>,
-      EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields>,
-      EchoTypeSchemaProps<Schema.Schema.Encoded<Self>, ExtraFields>,
-      Schema.Schema.Context<Self>
-    > {
-  // make(
-  //   props: RequiredKeys<Schema.TypeLiteral.Constructor<Fields, []>> extends never
-  //     ? void | Simplify<Schema.TypeLiteral.Constructor<Fields, []>>
-  //     : Simplify<Schema.TypeLiteral.Constructor<Fields, []>>,
-  //   options?: MakeOptions,
-  // ): Simplify<Schema.TypeLiteral.Type<Fields, []>>;
-
-  instanceOf(value: unknown): boolean;
-}
-
-/**
- * Pipeable function to add ECHO object annotations to a schema.
- */
-// TODO(dmaretskyi): Rename EchoObjectSchema.
-export const EchoObject: {
-  // TODO(burdon): Tighten Self type to Schema.TypeLiteral or Schema.Struct to facilitate definition of `make` method.
-  // (meta: TypeMeta): <Self extends Schema.Struct<Fields>, Fields extends Schema.Struct.Fields>(self: Self) => EchoObjectSchema<Self, Fields>;
-  (meta: TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => EchoTypeSchema<Self>;
-} = ({ typename, version }) => {
-  return <Self extends Schema.Schema.Any>(self: Self): EchoTypeSchema<Self> => {
-    invariant(typeof TypeAnnotationId === 'symbol', 'Sanity.');
-    invariant(SchemaAST.isTypeLiteral(self.ast), 'Schema must be a TypeLiteral.');
-
-    // TODO(dmaretskyi): Does `Schema.mutable` work for deep mutability here?
-    // TODO(dmaretskyi): Do not do mutable here.
-    const schemaWithId = Schema.extend(Schema.mutable(self), Schema.Struct({ id: Schema.String }));
-    const ast = SchemaAST.annotations(schemaWithId.ast, {
-      // TODO(dmaretskyi): `extend` kills the annotations.
-      ...self.ast.annotations,
-      [TypeAnnotationId]: { kind: EntityKind.Object, typename, version } satisfies TypeAnnotation,
-      // TODO(dmaretskyi): TypeIdentifierAnnotationId?
-      [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
-        kind: EntityKind.Object,
-        typename,
-        version,
-      }),
-    });
-
-    return makeEchoObjectSchema<Self>(/* self.fields, */ ast, typename, version);
-  };
-};
-
-export type EchoRelationOptions<
-  TSource extends Schema.Schema.AnyNoContext,
-  TTarget extends Schema.Schema.AnyNoContext,
-> = TypeMeta & {
-  source: TSource;
-  target: TTarget;
-};
-
-// TODO(dmaretskyi): Rename EchoRelationSchema.
-export const EchoRelation = <Source extends Schema.Schema.AnyNoContext, Target extends Schema.Schema.AnyNoContext>(
-  options: EchoRelationOptions<Source, Target>,
-) => {
-  assertArgument(Schema.isSchema(options.source), 'source');
-  assertArgument(Schema.isSchema(options.target), 'target');
-  const sourceDXN = getDXNForRelationSchemaRef(options.source);
-  const targetDXN = getDXNForRelationSchemaRef(options.target);
-  if (getEntityKind(options.source) !== EntityKind.Object) {
-    raise(new Error('Source schema must be an echo object schema.'));
-  }
-  if (getEntityKind(options.target) !== EntityKind.Object) {
-    raise(new Error('Target schema must be an echo object schema.'));
-  }
-
-  return <Self extends Schema.Schema.Any>(
-    self: Self,
-  ): EchoTypeSchema<Self, RelationSourceTargetRefs<Schema.Schema.Type<Source>, Schema.Schema.Type<Target>>> => {
-    invariant(SchemaAST.isTypeLiteral(self.ast), 'Schema must be a TypeLiteral.');
-
-    // TODO(dmaretskyi): Does `Schema.mutable` work for deep mutability here?
-    // TODO(dmaretskyi): Do not do mutable here.
-    const schemaWithId = Schema.extend(Schema.mutable(self), Schema.Struct({ id: Schema.String }));
-    const ast = SchemaAST.annotations(schemaWithId.ast, {
-      // TODO(dmaretskyi): `extend` kills the annotations.
-      ...self.ast.annotations,
-      [TypeAnnotationId]: {
-        kind: EntityKind.Relation,
-        typename: options.typename,
-        version: options.version,
-        sourceSchema: sourceDXN,
-        targetSchema: targetDXN,
-      } satisfies TypeAnnotation,
-      // TODO(dmaretskyi): TypeIdentifierAnnotationId?
-
-      [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
-        kind: EntityKind.Relation,
-        typename: options.typename,
-        version: options.version,
-        relationSource: sourceDXN,
-        relationTarget: targetDXN,
-      }),
-    });
-
-    return makeEchoObjectSchema<Self>(/* self.fields, */ ast, options.typename, options.version);
-  };
-};
-
-/**
- * @returns JSON-schema annotation so that the schema can be serialized with correct parameters.
- */
-export const makeTypeJsonSchemaAnnotation = (options: {
-  identifier?: string;
-  kind: EntityKind;
-  typename: string;
-  version: string;
-  relationSource?: string;
-  relationTarget?: string;
-}) => {
-  assertArgument(!!options.relationSource === (options.kind === EntityKind.Relation), 'relationSource');
-  assertArgument(!!options.relationTarget === (options.kind === EntityKind.Relation), 'relationTarget');
-
-  const obj = {
-    // TODO(dmaretskyi): Should this include the version?
-    $id: options.identifier ?? DXN.fromTypename(options.typename).toString(),
-    entityKind: options.kind,
-    version: options.version,
-    typename: options.typename,
-  } as any;
-  if (options.kind === EntityKind.Relation) {
-    obj.relationSource = { $ref: options.relationSource };
-    obj.relationTarget = { $ref: options.relationTarget };
-  }
-  return obj;
-};
-
-const getDXNForRelationSchemaRef = (schema: Schema.Schema.Any): string => {
-  assertArgument(Schema.isSchema(schema), 'schema');
-  const identifier = getTypeIdentifierAnnotation(schema);
-  if (identifier) {
-    return identifier;
-  }
-
-  const typename = getSchemaTypename(schema);
-  if (!typename) {
-    throw new Error('Schema must have a typename');
-  }
-
-  return DXN.fromTypename(typename).toString();
-};
-
-// type MakeOptions =
-//   | boolean
-//   | {
-//       readonly disableValidation?: boolean;
-//     };
-
-// NOTE: Utils copied from Effect `Schema.ts`.
-// const _ownKeys = (o: object): Array<PropertyKey> =>
-//   (Object.keys(o) as Array<PropertyKey>).concat(Object.getOwnPropertySymbols(o));
-
-// const _lazilyMergeDefaults = (
-//   fields: Schema.Struct.Fields,
-//   out: Record<PropertyKey, unknown>,
-// ): { [x: string | symbol]: unknown } => {
-//   const ownKeys = _ownKeys(fields);
-//   for (const key of ownKeys) {
-//     const field = fields[key];
-//     if (out[key] === undefined && Schema.isPropertySignature(field)) {
-//       const ast = field.ast;
-//       const defaultValue = ast._tag === 'PropertySignatureDeclaration' ? ast.defaultValue : ast.to.defaultValue;
-//       if (defaultValue !== undefined) {
-//         out[key] = defaultValue();
-//       }
-//     }
-//   }
-//   return out;
-// };
-
-// const _getDisableValidationMakeOption = (options: MakeOptions | undefined): boolean =>
-//   Predicate.isBoolean(options) ? options : options?.disableValidation ?? false;
-
-const makeEchoObjectSchema = <Self extends Schema.Schema.Any>(
-  // fields: Fields,
-  ast: SchemaAST.AST,
-  typename: string,
-  version: string,
-): EchoTypeSchema<Self> => {
-  return class EchoObjectSchemaClass extends Schema.make<
-    EchoTypeSchemaProps<Schema.Schema.Type<Self>>,
-    EchoTypeSchemaProps<Schema.Schema.Encoded<Self>>,
-    Schema.Schema.Context<Self>
-  >(ast) {
-    static readonly typename = typename;
-    static readonly version = version;
-
-    static override annotations(
-      annotations: Schema.Annotations.GenericSchema<EchoTypeSchemaProps<Schema.Schema.Type<Self>>>,
-    ): EchoTypeSchema<Self> {
-      const schema = Schema.make<EchoTypeSchemaProps<Schema.Schema.Type<Self>>>(ast).annotations(annotations);
-      return makeEchoObjectSchema<Self>(/* fields, */ schema.ast, typename, version);
-    }
-
-    // static make(
-    //   props: RequiredKeys<Schema.TypeLiteral.Constructor<Fields, []>> extends never
-    //     ? void | Simplify<Schema.TypeLiteral.Constructor<Fields, []>>
-    //     : Simplify<Schema.TypeLiteral.Constructor<Fields, []>>,
-    //   options?: MakeOptions,
-    // ): Simplify<Schema.TypeLiteral.Type<Fields, []>> {
-    //   const propsWithDefaults: any = _lazilyMergeDefaults(fields, { ...(props as any) });
-    //   return _getDisableValidationMakeOption(options)
-    //     ? propsWithDefaults
-    //     : ParseResult.validateSync(this)(propsWithDefaults);
-    // }
-
-    static instanceOf(value: unknown): boolean {
-      return Schema.is(this)(value);
-    }
-  };
-};

package/src/internal/object/expando.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { EchoObject } from './entity';
-
-export const EXPANDO_TYPENAME = 'dxos.org/type/Expando';
-
-const ExpandoSchema = Schema.Struct({}, { key: Schema.String, value: Schema.Any }).pipe(
-  EchoObject({ typename: EXPANDO_TYPENAME, version: '0.1.0' }),
-);
-
-/**
- * Expando object is an object with an arbitrary set of properties.
- */
-// TODO(dmaretskyi): Can we consider expando a top-type, i.e. have a ref to expando potentially be a valid ref to any object?
-export interface Expando extends Schema.Schema.Type<typeof ExpandoSchema> {}
-
-export const Expando: Schema.Schema<Expando> = ExpandoSchema;

package/src/internal/object/ids.ts

@@ -1,12 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { DXN, ObjectId, QueueSubspaceTags, SpaceId } from '@dxos/keys';
-
-// TODO(burdon): Move to @dxos/keys once ObjectId is moved there.
-/**
- * @deprecated Use `db.queues.create()`
- */
-export const createQueueDXN = (spaceId = SpaceId.random(), queueId = ObjectId.random()) =>
-  new DXN(DXN.kind.QUEUE, [QueueSubspaceTags.DATA, spaceId, queueId]);

package/src/internal/object/index.ts

@@ -1,19 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './common';
-export * from './create';
-export * from './entity';
-export * from './expando';
-export * from './ids';
-export * from './json-serializer';
-export * from './meta';
-export type * from './relation';
-export * from './typed-object';
-export * from './typename';
-export * from './deleted';
-export * from './model';
-export * from './accessors';
-export * from './schema-validator';
-export * from './version';

package/src/internal/object/json-serializer.test.ts

@@ -1,99 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, expect, test } from 'vitest';
-
-import { DXN } from '@dxos/keys';
-
-import { EntityKind, getSchemaDXN, getSchemaTypename } from '../ast';
-import { Ref, StaticRefResolver } from '../ref';
-import { Testing } from '../testing';
-
-import { getObjectDXN, getSchema } from './accessors';
-import { create } from './create';
-import { objectFromJSON, objectToJSON } from './json-serializer';
-import { getMeta } from './meta';
-import { ATTR_TYPE, EntityKindId, MetaId, RelationSourceId, RelationTargetId, TypeId } from './model';
-import { getType, getTypename } from './typename';
-
-describe('Object JSON serializer', () => {
-  test('should serialize and deserialize object', async () => {
-    const contact = create(Testing.Contact, {
-      name: 'John Doe',
-    });
-    getMeta(contact).keys.push({ id: '12345', source: 'crm.example.com' });
-
-    const task = create(Testing.Task, {
-      title: 'Polish my shoes',
-      assignee: Ref.make(contact),
-    });
-
-    const contactJson = objectToJSON(contact);
-    const taskJson = objectToJSON(task);
-
-    expect(contactJson.id).toBe(contact.id);
-    expect(contactJson[ATTR_TYPE]).toEqual(getSchemaDXN(Testing.Contact)!.toString());
-    expect(contactJson.name).toEqual('John Doe');
-
-    expect(taskJson.id).toBe(task.id);
-    expect(taskJson[ATTR_TYPE]).toEqual(getSchemaDXN(Testing.Task)!.toString());
-    expect(taskJson.title).toEqual('Polish my shoes');
-    expect(taskJson.assignee).toEqual({ '/': DXN.fromLocalObjectId(contact.id).toString() });
-
-    const refResolver = new StaticRefResolver()
-      .addSchema(Testing.Contact)
-      .addSchema(Testing.Task)
-      .addObject(contact)
-      .addObject(task);
-
-    const contactFromJson = (await objectFromJSON(contactJson, { refResolver })) as Testing.Contact;
-    const taskFromJson = (await objectFromJSON(taskJson, { refResolver })) as Testing.Task;
-
-    expect(contactFromJson.id).toBe(contact.id);
-    expect(contactFromJson.name).toBe('John Doe');
-    expect((contactFromJson as any)[TypeId]).toEqual(getSchemaDXN(Testing.Contact));
-    expect((contactFromJson as any)[EntityKindId]).toBe(EntityKind.Object);
-    expect((contactFromJson as any)[RelationSourceId]).toBeUndefined();
-    expect((contactFromJson as any)[RelationTargetId]).toBeUndefined();
-    expect((contactFromJson as any)[MetaId]).toEqual({
-      keys: [
-        {
-          id: '12345',
-          source: 'crm.example.com',
-        },
-      ],
-    });
-    expect(getType(contactFromJson)?.toString()).toBe(getSchemaDXN(Testing.Contact)!.toString());
-    expect(getTypename(contactFromJson)).toBe(getSchemaTypename(Testing.Contact));
-    expect(getObjectDXN(contactFromJson)?.toString()).toEqual(getObjectDXN(contact)?.toString());
-    expect(getSchema(contactFromJson)).toEqual(Testing.Contact);
-
-    expect(taskFromJson.id).toBe(task.id);
-    expect(taskFromJson.title).toBe('Polish my shoes');
-    expect(taskFromJson.assignee!.dxn).toEqual(DXN.fromLocalObjectId(contact.id));
-    expect(taskFromJson.assignee!.target).toEqual(contact);
-    expect(await taskFromJson.assignee!.load()).toEqual(contact);
-    expect((taskFromJson as any)[TypeId]).toEqual(getSchemaDXN(Testing.Task));
-    expect((taskFromJson as any)[EntityKindId]).toBe(EntityKind.Object);
-    expect((taskFromJson as any)[RelationSourceId]).toBeUndefined();
-    expect((taskFromJson as any)[RelationTargetId]).toBeUndefined();
-    expect((taskFromJson as any)[MetaId]).toEqual({ keys: [] });
-    expect(getSchema(taskFromJson)).toEqual(Testing.Task);
-  });
-
-  test('serialize with unresolved schema', async () => {
-    const contact = create(Testing.Contact, {
-      name: 'John Doe',
-    });
-    const contactJson = objectToJSON(contact);
-    const contactFromJson: any = await objectFromJSON(contactJson);
-
-    expect(contactFromJson.id).toBe(contact.id);
-    expect(contactFromJson.name).toBe('John Doe');
-    expect(getSchema(contactFromJson)).toBeUndefined();
-    expect(getTypename(contactFromJson)).toEqual(getSchemaTypename(Testing.Contact));
-    expect(getObjectDXN(contactFromJson)).toEqual(getObjectDXN(contact));
-    expect(getType(contactFromJson)).toEqual(getSchemaDXN(Testing.Contact));
-  });
-});

package/src/internal/object/json-serializer.ts

@@ -1,225 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { raise } from '@dxos/debug';
-import { type EncodedReference, type ObjectMeta, isEncodedReference } from '@dxos/echo-protocol';
-import { assertArgument, invariant } from '@dxos/invariant';
-import { DXN, ObjectId } from '@dxos/keys';
-import { defineHiddenProperty } from '@dxos/live-object';
-import { assumeType, deepMapValues, visitValues } from '@dxos/util';
-
-import { EntityKind } from '../ast';
-import { Ref, type RefResolver, refFromEncodedReference, setRefResolver } from '../ref';
-import { type AnyEchoObject } from '../types';
-
-import { setSchema } from './accessors';
-import { ObjectMetaSchema } from './meta';
-import {
-  ATTR_DELETED,
-  ATTR_META,
-  ATTR_RELATION_SOURCE,
-  ATTR_RELATION_TARGET,
-  ATTR_SELF_DXN,
-  ATTR_TYPE,
-  EntityKindId,
-  MetaId,
-  type ObjectJSON,
-  RelationSourceDXNId,
-  RelationSourceId,
-  RelationTargetDXNId,
-  RelationTargetId,
-  SelfDXNId,
-  TypeId,
-  assertObjectModelShape,
-} from './model';
-import { getType, setTypename } from './typename';
-
-type DeepReplaceRef<T> =
-  T extends Ref<any> ? EncodedReference : T extends object ? { [K in keyof T]: DeepReplaceRef<T[K]> } : T;
-
-type SerializedObject<T extends { id: string }> = { [K in keyof T]: DeepReplaceRef<T[K]> } & ObjectJSON;
-
-/**
- * Converts object to it's JSON representation.
- */
-export const objectToJSON = <T extends AnyEchoObject>(obj: T): SerializedObject<T> => {
-  const typename = getType(obj)?.toString();
-  invariant(typename && typeof typename === 'string');
-  return typedJsonSerializer.call(obj);
-};
-
-/**
- * Creates an object from it's json representation.
- * Performs schema validation.
- * References and schema will be resolvable if the `refResolver` is provided.
- *
- * The function need to be async to support resolving the schema as well as the relation endpoints.
- */
-export const objectFromJSON = async (
-  jsonData: unknown,
-  { refResolver, dxn }: { refResolver?: RefResolver; dxn?: DXN } = {},
-): Promise<AnyEchoObject> => {
-  assumeType<ObjectJSON>(jsonData);
-  assertArgument(typeof jsonData === 'object' && jsonData !== null, 'jsonData', 'expect object');
-  assertArgument(typeof jsonData[ATTR_TYPE] === 'string', 'jsonData[ATTR_TYPE]', 'expected object to have a type');
-  assertArgument(typeof jsonData.id === 'string', 'jsonData.id', 'expected object to have an id');
-
-  const type = DXN.parse(jsonData[ATTR_TYPE]);
-  const schema = await refResolver?.resolveSchema(type);
-  invariant(schema === undefined || Schema.isSchema(schema));
-
-  let obj: any;
-  if (schema != null) {
-    obj = await schema.pipe(Schema.decodeUnknownPromise)(jsonData);
-    if (refResolver) {
-      setRefResolverOnData(obj, refResolver);
-    }
-  } else {
-    obj = decodeGeneric(jsonData, { refResolver });
-  }
-
-  invariant(ObjectId.isValid(obj.id), 'Invalid object id');
-
-  setTypename(obj, type);
-  if (schema) {
-    setSchema(obj, schema);
-  }
-
-  const isRelation =
-    typeof jsonData[ATTR_RELATION_SOURCE] === 'string' || typeof jsonData[ATTR_RELATION_TARGET] === 'string';
-  if (isRelation) {
-    const sourceDxn: DXN = DXN.parse(jsonData[ATTR_RELATION_SOURCE] ?? raise(new TypeError('Missing relation source')));
-    const targetDxn: DXN = DXN.parse(jsonData[ATTR_RELATION_TARGET] ?? raise(new TypeError('Missing relation target')));
-
-    // TODO(dmaretskyi): Async!
-    const source = (await refResolver?.resolve(sourceDxn)) as AnyEchoObject | undefined;
-    const target = (await refResolver?.resolve(targetDxn)) as AnyEchoObject | undefined;
-
-    defineHiddenProperty(obj, EntityKindId, EntityKind.Relation);
-    defineHiddenProperty(obj, RelationSourceDXNId, sourceDxn);
-    defineHiddenProperty(obj, RelationTargetDXNId, targetDxn);
-    defineHiddenProperty(obj, RelationSourceId, source);
-    defineHiddenProperty(obj, RelationTargetId, target);
-  } else {
-    defineHiddenProperty(obj, EntityKindId, EntityKind.Object);
-  }
-
-  if (typeof jsonData[ATTR_META] === 'object') {
-    const meta = await ObjectMetaSchema.pipe(Schema.decodeUnknownPromise)(jsonData[ATTR_META]);
-
-    // Defensive programming.
-    invariant(Array.isArray(meta.keys));
-
-    defineHiddenProperty(obj, MetaId, meta);
-  }
-
-  if (dxn) {
-    defineHiddenProperty(obj, SelfDXNId, dxn);
-  }
-
-  assertObjectModelShape(obj);
-  invariant((obj as any)[ATTR_TYPE] === undefined, 'Invalid object model');
-  invariant((obj as any)[ATTR_SELF_DXN] === undefined, 'Invalid object model');
-  invariant((obj as any)[ATTR_DELETED] === undefined, 'Invalid object model');
-  invariant((obj as any)[ATTR_RELATION_SOURCE] === undefined, 'Invalid object model');
-  invariant((obj as any)[ATTR_RELATION_TARGET] === undefined, 'Invalid object model');
-  invariant((obj as any)[ATTR_META] === undefined, 'Invalid object model');
-  return obj;
-};
-
-const decodeGeneric = (jsonData: unknown, options: { refResolver?: RefResolver }) => {
-  const {
-    [ATTR_TYPE]: _type,
-    [ATTR_META]: _meta,
-    [ATTR_DELETED]: _deleted,
-    [ATTR_RELATION_SOURCE]: _relationSource,
-    [ATTR_RELATION_TARGET]: _relationTarget,
-    [ATTR_SELF_DXN]: _selfDxn,
-    ...props
-  } = jsonData as any;
-
-  return deepMapValues(props, (value, recurse) => {
-    if (isEncodedReference(value)) {
-      return refFromEncodedReference(value, options.refResolver);
-    }
-    return recurse(value);
-  });
-};
-
-export const setRefResolverOnData = (obj: AnyEchoObject, refResolver: RefResolver) => {
-  const go = (value: unknown) => {
-    if (Ref.isRef(value)) {
-      setRefResolver(value, refResolver);
-    } else {
-      visitValues(value, go);
-    }
-  };
-
-  go(obj);
-};
-
-export const attachTypedJsonSerializer = (obj: any) => {
-  const descriptor = Object.getOwnPropertyDescriptor(obj, 'toJSON');
-  if (descriptor) {
-    return;
-  }
-
-  Object.defineProperty(obj, 'toJSON', {
-    value: typedJsonSerializer,
-    writable: false,
-    enumerable: false,
-    // Setting `configurable` to false breaks proxy invariants, should be fixable.
-    configurable: true,
-  });
-};
-
-// NOTE: KEEP as function.
-const typedJsonSerializer = function (this: any) {
-  const { id, ...rest } = this;
-  const result: any = {
-    id,
-  };
-
-  if (this[TypeId]) {
-    result[ATTR_TYPE] = this[TypeId].toString();
-  }
-
-  if (this[SelfDXNId]) {
-    result[ATTR_SELF_DXN] = this[SelfDXNId].toString();
-  }
-
-  if (this[RelationSourceDXNId]) {
-    const sourceDXN = this[RelationSourceDXNId];
-    invariant(sourceDXN instanceof DXN);
-    result[ATTR_RELATION_SOURCE] = sourceDXN.toString();
-  }
-  if (this[RelationTargetDXNId]) {
-    const targetDXN = this[RelationTargetDXNId];
-    invariant(targetDXN instanceof DXN);
-    result[ATTR_RELATION_TARGET] = targetDXN.toString();
-  }
-
-  if (this[MetaId]) {
-    result[ATTR_META] = serializeMeta(this[MetaId]);
-  }
-
-  Object.assign(result, serializeData(rest));
-  return result;
-};
-
-const serializeData = (data: unknown) => {
-  return deepMapValues(data, (value, recurse) => {
-    if (Ref.isRef(value)) {
-      // TODO(dmaretskyi): Should this be configurable?
-      return value.noInline().encode();
-    }
-    return recurse(value);
-  });
-};
-
-const serializeMeta = (meta: ObjectMeta) => {
-  return deepMapValues(meta, (value, recurse) => recurse(value));
-};

package/src/internal/object/meta.ts

@@ -1,61 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { ForeignKey } from '@dxos/echo-protocol';
-import { invariant } from '@dxos/invariant';
-import { type Comparator, intersection } from '@dxos/util';
-
-import { type BaseObject } from '../types';
-
-import { MetaId } from './model';
-
-//
-// ObjectMeta
-//
-
-// TODO(dmaretskyi): Rename to ObjectMeta
-export const ObjectMetaSchema = Schema.mutable(
-  Schema.Struct({
-    keys: Schema.mutable(Schema.Array(ForeignKey)),
-
-    /**
-     * A set of tags.
-     * Tags are arbitrary application-defined strings.
-     * ECHO makes no assumptions about the tag structure.
-     */
-    // TODO(dmaretskyi): Has to be optional for compatibility with old data.
-    // Defaulting to an empty array is possible but requires a bit more work.
-    tags: Schema.optional(Schema.mutable(Schema.Array(Schema.String))),
-  }),
-);
-export type ObjectMeta = Schema.Schema.Type<typeof ObjectMetaSchema>;
-
-export const foreignKey = (source: string, id: string): ForeignKey => ({ source, id });
-export const foreignKeyEquals = (a: ForeignKey, b: ForeignKey) => a.source === b.source && a.id === b.id;
-
-/**
- * Get metadata from object.
- * Only callable on the object root.
- * @deprecated Use {@link getMeta}.
- */
-// TODO(dmaretskyi): Remove.
-export const getObjectMeta = (obj: any): ObjectMeta => {
-  return getMeta(obj);
-};
-
-/*
- * Get metadata from object.
- * Only callable on the object root.
- */
-export const getMeta = (obj: BaseObject): ObjectMeta => {
-  const metadata = (obj as any)[MetaId];
-  invariant(metadata, 'ObjectMeta not found.');
-  return metadata;
-};
-
-// TODO(dmaretskyi): Move to echo-schema.
-export const compareForeignKeys: Comparator<BaseObject> = (a: BaseObject, b: BaseObject) =>
-  intersection(getMeta(a).keys, getMeta(b).keys, foreignKeyEquals).length > 0;