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

package/src/internal/object/model.ts

@@ -1,170 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-
-import { type ForeignKey } from '@dxos/echo-protocol';
-import { invariant } from '@dxos/invariant';
-import { DXN, ObjectId } from '@dxos/keys';
-import { assumeType } from '@dxos/util';
-
-import { EntityKind } from '../ast';
-
-import { type ObjectMeta } from './meta';
-import type { Version } from './version';
-
-//
-// Defines the internal model of the echo object.
-//
-
-/**
- * Entity kind.
- */
-export const EntityKindId = Symbol('@dxos/echo/EntityKind');
-
-/**
- * DXN to the object itself.
- */
-export const SelfDXNId = Symbol('@dxos/echo/DXN');
-
-/**
- * Property name for self DXN when object is serialized to JSON.
- */
-export const ATTR_SELF_DXN = '@dxn';
-
-/**
- * DXN to the object type.
- */
-export const TypeId = Symbol('@dxos/echo/Type');
-
-/**
- * Property name for typename when object is serialized to JSON.
- */
-export const ATTR_TYPE = '@type';
-
-/**
- * Reference to the object schema.
- */
-export const SchemaId = Symbol('@dxos/echo/Schema');
-
-/**
- * Deletion marker.
- */
-export const DeletedId = Symbol('@dxos/echo/Deleted');
-
-/**
- * Property name for deleted when object is serialized to JSON.
- */
-export const ATTR_DELETED = '@deleted';
-
-/**
- * Metadata section.
- */
-export const MetaId = Symbol('@dxos/echo/Meta');
-
-/**
- * Property name for meta when object is serialized to JSON.
- */
-export const ATTR_META = '@meta';
-
-/**
- * Used to access relation source ref on live ECHO objects.
- * Reading this symbol must return `Live<EchoObject<any>>` or a DXN.
- */
-export const RelationSourceDXNId: unique symbol = Symbol('@dxos/echo/RelationSourceDXN');
-
-/**
- * Property name for relation source when object is serialized to JSON.
- */
-export const ATTR_RELATION_SOURCE = '@relationSource';
-
-/**
- * Used to access relation target ref on live ECHO objects.
- * Reading this symbol must return `Live<EchoObject<any>>` or a DXN.
- */
-export const RelationTargetDXNId: unique symbol = Symbol('@dxos/echo/RelationTargetDXN');
-
-/**
- * Property name for relation target when object is serialized to JSON.
- */
-export const ATTR_RELATION_TARGET = '@relationTarget';
-
-/**
- * Used to access relation source ref on live ECHO objects.
- * Reading this symbol must return `Live<EchoObject<any>>` or a DXN.
- */
-export const RelationSourceId: unique symbol = Symbol('@dxos/echo/RelationSource');
-
-/**
- * Used to access relation target ref on live ECHO objects.
- * Reading this symbol must return `Live<EchoObject<any>>` or a DXN.
- */
-export const RelationTargetId: unique symbol = Symbol('@dxos/echo/RelationTarget');
-
-/**
- * Getter to get object version.
- */
-export const ObjectVersionId: unique symbol = Symbol('@dxos/echo/ObjectVersion');
-
-/**
- * Internal runtime representation of an object.
- * The fields are accessed through getter functions.
- */
-export interface InternalObjectProps {
-  id: ObjectId;
-  readonly [SelfDXNId]?: DXN;
-
-  // Echo supports untyped objects O_O.
-  readonly [TypeId]?: DXN;
-
-  /**
-   * Returns the schema for the object.
-   */
-  readonly [SchemaId]?: Schema.Schema.AnyNoContext;
-  readonly [EntityKindId]: EntityKind;
-  readonly [DeletedId]?: boolean;
-  readonly [MetaId]?: ObjectMeta;
-  readonly [RelationSourceDXNId]?: DXN;
-  readonly [RelationTargetDXNId]?: DXN;
-  readonly [RelationSourceId]?: InternalObjectProps;
-  readonly [RelationTargetId]?: InternalObjectProps;
-  readonly [ObjectVersionId]?: Version;
-}
-
-/**
- * JSON representation of an object or relation.
- */
-export interface ObjectJSON {
-  id: string;
-  [ATTR_SELF_DXN]?: DXN.String;
-  [ATTR_TYPE]: DXN.String;
-  [ATTR_DELETED]?: boolean;
-  [ATTR_META]?: ObjectMetaJSON;
-  [ATTR_RELATION_SOURCE]?: DXN.String;
-  [ATTR_RELATION_TARGET]?: DXN.String;
-}
-
-export interface ObjectMetaJSON {
-  keys: ForeignKey[];
-  tags?: string[];
-}
-
-// NOTE: Keep as `function` to avoid type inference issues.
-// eslint-disable-next-line prefer-arrow-functions/prefer-arrow-functions
-export function assertObjectModelShape(obj: unknown): asserts obj is InternalObjectProps {
-  invariant(typeof obj === 'object' && obj !== null, 'Invalid object model: not an object');
-  assumeType<InternalObjectProps>(obj);
-  invariant(ObjectId.isValid(obj.id), 'Invalid object model: invalid id');
-  invariant(obj[TypeId] === undefined || obj[TypeId] instanceof DXN, 'Invalid object model: invalid type');
-  invariant(
-    obj[EntityKindId] === EntityKind.Object || obj[EntityKindId] === EntityKind.Relation,
-    'Invalid object model: invalid entity kind',
-  );
-  if (obj[EntityKindId] === EntityKind.Relation) {
-    invariant(obj[RelationSourceDXNId] instanceof DXN, 'Invalid object model: invalid relation source');
-    invariant(obj[RelationTargetDXNId] instanceof DXN, 'Invalid object model: invalid relation target');
-    invariant(!(obj[RelationSourceId] instanceof DXN), 'Invalid object model: source pointer is a DXN');
-    invariant(!(obj[RelationTargetId] instanceof DXN), 'Invalid object model: target pointer is a DXN');
-  }
-}

package/src/internal/object/relation.ts

@@ -1,24 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type { RelationSourceId, RelationTargetId } from './model';
-
-/**
- * Source and target props on relations.
- */
-// TODO(burdon): any?
-export type RelationSourceTargetRefs<Source = any, Target = any> = {
-  /**
-   * Source ECHO live object.
-   */
-  [RelationSourceId]: Source;
-
-  /**
-   * Target ECHO live object.
-   */
-  [RelationTargetId]: Target;
-};
-
-export type RelationSource<R> = R extends RelationSourceTargetRefs<infer Source, infer _Target> ? Source : never;
-export type RelationTarget<R> = R extends RelationSourceTargetRefs<infer _Source, infer Target> ? Target : never;

package/src/internal/object/typed-object.test.ts

@@ -1,34 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-import * as SchemaAST from 'effect/SchemaAST';
-import { describe, expect, test } from 'vitest';
-
-import { TypedObject } from './typed-object';
-
-class Organization extends TypedObject({
-  typename: 'example.com/type/Organization',
-  version: '0.1.0',
-})({
-  name: Schema.String,
-}) {}
-
-describe('EchoObject class DSL', () => {
-  test('type is a valid schema', async () => {
-    expect(Schema.isSchema(Organization)).to.be.true;
-  });
-
-  test('static typename accessor', async () => {
-    expect(Organization.typename).to.eq('example.com/type/Organization');
-  });
-
-  test('expect constructor to throw', async () => {
-    expect(() => new Organization()).to.throw();
-  });
-
-  test('expect schema', async () => {
-    expect(SchemaAST.isTypeLiteral(Organization.ast)).to.be.true;
-  });
-});

package/src/internal/object/typed-object.ts

@@ -1,88 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-import * as SchemaAST from 'effect/SchemaAST';
-
-import { invariant } from '@dxos/invariant';
-
-import { EntityKind, SchemaVersion, type TypeAnnotation, TypeAnnotationId, type TypeMeta, Typename } from '../ast';
-import { type HasId } from '../types';
-
-import { type TypedObjectFields, type TypedObjectOptions, makeTypedEntityClass } from './common';
-import { makeTypeJsonSchemaAnnotation } from './entity';
-
-/**
- * Definition for an object type that can be stored in an ECHO database.
- * Implements effect schema to define object properties.
- * Has a typename and version.
- *
- * In contrast to {@link EchoSchema} this definition is not recorded in the database.
- */
-export interface TypedObject<A = any, I = any> extends TypeMeta, Schema.Schema<A, I> {}
-
-/**
- * Typed object that could be used as a prototype in class definitions.
- * This is an internal API type.
- * Use {@link TypedObject} for the common use-cases.
- */
-export interface TypedObjectPrototype<A = any, I = any> extends TypedObject<A, I> {
-  /** Type constructor. */
-  new (): HasId & A;
-}
-
-export type TypedObjectProps = TypeMeta & {
-  // TODO(dmaretskyi): Remove after all legacy types has been removed.
-  disableValidation?: boolean;
-};
-
-/**
- * Base class factory for typed objects.
- * @deprecated Use Function.pipe(Type.Obj) instead.
- */
-export const TypedObject = ({
-  typename: typenameParam,
-  version: versionParam,
-  disableValidation,
-}: TypedObjectProps) => {
-  const typename = Typename.make(typenameParam, { disableValidation });
-  const version = SchemaVersion.make(versionParam, { disableValidation });
-
-  /**
-   * Return class definition factory.
-   */
-  return <SchemaFields extends Schema.Struct.Fields, Options extends TypedObjectOptions>(
-    fields: SchemaFields,
-    options?: Options,
-  ): TypedObjectPrototype<TypedObjectFields<SchemaFields, Options>, Schema.Struct.Encoded<SchemaFields>> => {
-    // Create schema from fields.
-    const schema: Schema.Schema.All = options?.record
-      ? Schema.Struct(fields, { key: Schema.String, value: Schema.Any })
-      : Schema.Struct(fields);
-
-    // Set ECHO object id property.
-    const typeSchema = Schema.extend(
-      Schema.mutable(options?.partial ? Schema.partial(schema) : schema),
-      Schema.Struct({ id: Schema.String }),
-    );
-
-    // Set ECHO annotations.
-    invariant(typeof EntityKind.Object === 'string');
-    const annotatedSchema = typeSchema.annotations({
-      [TypeAnnotationId]: { kind: EntityKind.Object, typename, version } satisfies TypeAnnotation,
-      [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
-        kind: EntityKind.Object,
-        typename,
-        version,
-      }),
-    });
-
-    /**
-     * Return class definition.
-     * NOTE: Actual reactive ECHO objects must be created via the `live(Type)` function.
-     */
-    // TODO(burdon): This is missing fields required by TypedObject (e.g., Type, Encoded, Context)?
-    return class TypedObject extends makeTypedEntityClass(typename, version, annotatedSchema as any) {} as any;
-  };
-};

package/src/internal/object/typename.ts

@@ -1,61 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { invariant } from '@dxos/invariant';
-import { DXN } from '@dxos/keys';
-
-import { getSchemaTypename } from '../ast';
-import { type BaseObject } from '../types';
-
-import { getSchema } from './accessors';
-import { TypeId } from './model';
-
-/**
- * Gets the typename of the object without the version.
- * Returns only the name portion, not the DXN.
- * @example "example.org/type/Contact"
- */
-export const getTypename = (obj: BaseObject): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    // Try to extract typename from DXN.
-    return getSchemaTypename(schema);
-  } else {
-    const type = getType(obj);
-    return type?.asTypeDXN()?.type;
-  }
-};
-
-/**
- * @internal
- */
-// TODO(dmaretskyi): Rename setTypeDXN.
-export const setTypename = (obj: any, typename: DXN) => {
-  invariant(typename instanceof DXN, 'Invalid type.');
-  Object.defineProperty(obj, TypeId, {
-    value: typename,
-    writable: false,
-    enumerable: false,
-    configurable: false,
-  });
-};
-
-/**
- * @returns Object type as {@link DXN}.
- * @returns undefined if the object doesn't have a type.
- * @example `dxn:example.com/type/Contact:1.0.0`
- */
-export const getType = (obj: BaseObject): DXN | undefined => {
-  if (!obj) {
-    return undefined;
-  }
-
-  const type = (obj as any)[TypeId];
-  if (!type) {
-    return undefined;
-  }
-
-  invariant(type instanceof DXN, 'Invalid object.');
-  return type;
-};

package/src/internal/object/version.ts

@@ -1,22 +0,0 @@
-//
-// NOTE: Those types must match the ones defined at @dxos/echo. We duplicated them murely due to technical constrains.
-//
-
-/**
- * Getter to get object version.
- */
-//
-// Copyright 2025 DXOS.org
-//
-
-export const VersionTypeId: unique symbol = Symbol('@dxos/echo/Version');
-
-/**
- * Represent object version.
- * May be backed by Automerge.
- * Objects with no history are not versioned.
- */
-export interface Version {
-  [VersionTypeId]: {};
-  automergeHeads?: string[];
-}

package/src/internal/projection/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './compose';

package/src/internal/proxy/handler.test.ts

@@ -1,163 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { inspect } from 'node:util';
-
-import { describe, expect, test } from 'vitest';
-
-import { registerSignalsRuntime } from '@dxos/echo-signals';
-import type { Live } from '@dxos/live-object';
-import { objectData } from '@dxos/live-object';
-import { isNode } from '@dxos/util';
-
-import { ATTR_META } from '..';
-import { Testing, updateCounter } from '../testing';
-
-import { live } from './reactive-object';
-
-registerSignalsRuntime();
-
-const TEST_OBJECT: Testing.TestSchema = {
-  string: 'foo',
-  number: 42,
-  boolean: true,
-  null: null,
-  stringArray: ['1', '2', '3'],
-  object: { field: 'bar' },
-};
-
-for (const schema of [undefined, Testing.TestSchemaWithClass]) {
-  const createObject = (props: Partial<Testing.TestSchemaWithClass> = {}): Live<Testing.TestSchemaWithClass> => {
-    return schema == null ? (live(props) as Testing.TestSchemaWithClass) : live(schema, props);
-  };
-
-  describe(`Non-echo specific proxy properties${schema == null ? '' : ' with schema'}`, () => {
-    test.skipIf(!isNode())('inspect', () => {
-      const obj = createObject({ string: 'bar' });
-      const str = inspect(obj, { colors: false });
-      expect(str).to.eq(`${schema == null ? '' : 'Typed '}{ string: 'bar' }`);
-    });
-
-    test('data symbol', async () => {
-      const obj = createObject({ ...TEST_OBJECT });
-      const objData: any = (obj as any)[objectData];
-      expect(objData).to.deep.contain({
-        '@type': `${schema ? 'Typed' : ''}ReactiveObject`,
-        ...TEST_OBJECT,
-      });
-    });
-
-    test('can assign class instances', () => {
-      const obj = createObject();
-
-      const classInstance = new Testing.TestClass();
-      obj.classInstance = classInstance;
-      expect(obj.classInstance!.field).to.eq('value');
-      expect(obj.classInstance instanceof Testing.TestClass).to.eq(true);
-      expect(obj.classInstance === classInstance).to.be.true;
-
-      obj.classInstance!.field = 'baz';
-      expect(obj.classInstance!.field).to.eq('baz');
-    });
-
-    describe('class instance equality', () => {
-      test('toJSON', () => {
-        const original = { classInstance: new Testing.TestClass() };
-        const reactive = createObject(original);
-        if (!schema) {
-          expect(JSON.stringify(reactive)).to.eq(JSON.stringify(original));
-        } else {
-          expect(JSON.stringify(reactive)).to.eq(
-            JSON.stringify({
-              [ATTR_META]: {
-                keys: [],
-              },
-              ...original,
-            }),
-          );
-        }
-      });
-
-      test('chai deep equal works', () => {
-        const original = { classInstance: new Testing.TestClass() };
-        const reactive = createObject(original);
-        expect(reactive).to.deep.eq(original);
-        expect(reactive).to.not.deep.eq({ ...original, number: 11 });
-      });
-
-      test('jest deep equal works', () => {
-        const original = { classInstance: new Testing.TestClass() };
-        const reactive = createObject(original);
-        expect(reactive).toEqual(original);
-        expect(reactive).not.toEqual({ ...original, number: 11 });
-      });
-    });
-
-    describe('signal updates', () => {
-      test('not in nested class instances', () => {
-        const obj = createObject({ classInstance: new Testing.TestClass() });
-        using updates = updateCounter(() => {
-          obj.classInstance!.field;
-        });
-        expect(updates.count, 'update count').to.eq(0);
-
-        obj.classInstance!.field = 'baz';
-        expect(updates.count, 'update count').to.eq(0);
-      });
-    });
-  });
-}
-
-describe('getters', () => {
-  test('add getter to object', () => {
-    let value = 'foo';
-    const obj = live({
-      get getter() {
-        return value;
-      },
-    });
-    expect(obj.getter).to.eq('foo');
-
-    value = 'bar';
-    expect(obj.getter).to.eq('bar');
-  });
-
-  test('signal updates', () => {
-    const innerObj = live({
-      string: 'bar',
-    });
-
-    const obj = live({
-      field: 1,
-      get getter() {
-        return innerObj.string;
-      },
-    });
-
-    using updates = updateCounter(() => {
-      const value = obj.getter;
-      expect(value).to.exist;
-    });
-
-    innerObj.string = 'baz';
-    expect(obj.getter).to.eq('baz');
-    expect(updates.count, 'update count').to.eq(1);
-
-    obj.field = 2;
-    expect(updates.count, 'update count').to.eq(1);
-  });
-
-  test('getter for array', () => {
-    const value = [1];
-    const obj = live({
-      get getter() {
-        return value;
-      },
-    });
-    expect(obj.getter).to.have.length(1);
-
-    value.push(2);
-    expect(obj.getter).to.have.length(2);
-  });
-});

package/src/internal/proxy/reactive-object.ts

@@ -1,108 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-
-import { ObjectId } from '@dxos/keys';
-import {
-  type Live,
-  UntypedReactiveHandler,
-  createProxy,
-  defineHiddenProperty,
-  isValidProxyTarget,
-} from '@dxos/live-object';
-
-import { getTypeAnnotation } from '../ast';
-import { EntityKindId, Expando, MetaId, type ObjectMeta, ObjectMetaSchema, attachTypedJsonSerializer } from '../object';
-import type { BaseObject, CreationProps } from '../types';
-
-import { TypedReactiveHandler, prepareTypedTarget } from './typed-handler';
-
-/**
- * Creates a reactive object from a plain Javascript object.
- * Optionally provides a TS-effect schema.
- *
- * @depreacted Use `Obj.make`.
- */
-// TODO(dmaretskyi): Deep mutability.
-// TODO(dmaretskyi): Invert generics (generic over schema) to have better error messages.
-// TODO(dmaretskyi): Could mutate original object making it unusable.
-// TODO(burdon): Use Schema.make() to handle defaults?
-export const live: {
-  <T extends BaseObject>(obj: T): Live<T>;
-  <T extends BaseObject>(
-    schema: Schema.Schema<T, any, never>,
-    obj: NoInfer<CreationProps<T>>,
-    meta?: ObjectMeta,
-  ): Live<T>;
-} = <T extends BaseObject>(
-  objOrSchema: Schema.Schema<T, any> | T,
-  obj?: CreationProps<T>,
-  meta?: ObjectMeta,
-): Live<T> => {
-  // TODO(dmaretskyi): Remove Expando special case.
-  if (obj && (objOrSchema as any) !== Expando) {
-    return createReactiveObject<T>({ ...obj } as T, meta, objOrSchema as Schema.Schema<T, any>);
-  } else if (obj && (objOrSchema as any) === Expando) {
-    return createReactiveObject<T>({ ...obj } as T, meta, undefined, { expando: true });
-  } else {
-    return createReactiveObject<T>(objOrSchema as T, meta);
-  }
-};
-
-const createReactiveObject = <T extends BaseObject>(
-  obj: T,
-  meta?: ObjectMeta,
-  schema?: Schema.Schema<T>,
-  options?: { expando?: boolean },
-): Live<T> => {
-  if (!isValidProxyTarget(obj)) {
-    throw new Error('Value cannot be made into a reactive object.');
-  }
-
-  if (schema) {
-    const annotation = getTypeAnnotation(schema);
-    const shouldGenerateId = options?.expando || !!annotation;
-    if (shouldGenerateId) {
-      setIdOnTarget(obj);
-    }
-    if (annotation) {
-      defineHiddenProperty(obj, EntityKindId, annotation.kind);
-    }
-    initMeta(obj, meta);
-    prepareTypedTarget(obj, schema);
-    attachTypedJsonSerializer(obj);
-    return createProxy<T>(obj, TypedReactiveHandler.instance);
-  } else {
-    if (options?.expando) {
-      setIdOnTarget(obj);
-    }
-    initMeta(obj, meta);
-    return createProxy<T>(obj, UntypedReactiveHandler.instance);
-  }
-};
-
-/**
- * Set ID on ECHO object targets during creation.
- * Used for objects with schema and the ones explicitly marked as Expando.
- */
-const setIdOnTarget = (target: any) => {
-  // invariant(!('id' in target), 'Object already has an `id` field, which is reserved.');
-  if ('id' in target && target.id !== undefined && target.id !== null) {
-    if (!ObjectId.isValid(target.id)) {
-      throw new Error('Invalid object id format.');
-    }
-  } else {
-    target.id = ObjectId.random();
-  }
-};
-
-/**
- * Set metadata on object.
- */
-// TODO(dmaretskyi): Move to echo-schema.
-const initMeta = <T>(obj: T, meta: ObjectMeta = { keys: [] }) => {
-  prepareTypedTarget(meta, ObjectMetaSchema);
-  defineHiddenProperty(obj, MetaId, createProxy(meta, TypedReactiveHandler.instance as any));
-};