@dxos/echo 0.8.4-main.548089c → 0.8.4-main.59c2e9b

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/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/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/Person: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/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));
-};

package/src/internal/query/index.ts

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

package/src/internal/query/query.ts

@@ -1,23 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-// TODO(wittjosiah): Remove. Use ordering in queries instead.
-
-/** @deprecated */
-const SortDirection = Schema.Union(Schema.Literal('asc'), Schema.Literal('desc'));
-/** @deprecated */
-export type SortDirectionType = Schema.Schema.Type<typeof SortDirection>;
-
-/** @deprecated */
-const FieldSort = Schema.Struct({
-  fieldId: Schema.String,
-  direction: SortDirection,
-}).pipe(Schema.mutable);
-
-/** @deprecated */
-export interface FieldSortType extends Schema.Schema.Type<typeof FieldSort> {}
-/** @deprecated */
-export const FieldSortType: Schema.Schema<FieldSortType> = FieldSort;

package/src/internal/schema/runtime-schema-registry.ts

@@ -1,78 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-
-import { raise } from '@dxos/debug';
-import { invariant } from '@dxos/invariant';
-import { type DXN } from '@dxos/keys';
-import { defaultMap } from '@dxos/util';
-
-import { getSchemaTypename, getSchemaVersion } from '../ast';
-
-import { StoredSchema } from './stored-schema';
-
-/**
- * Runtime registry of static schema objects (i.e., not Dynamic .
- */
-// TODO(burdon): Reconcile with EchoSchemaRegistry.
-export class RuntimeSchemaRegistry {
-  private readonly _registry = new Map<string, Schema.Schema.AnyNoContext[]>();
-
-  constructor() {
-    this._registry.set(StoredSchema.typename, [StoredSchema]);
-  }
-
-  get schemas(): Schema.Schema.AnyNoContext[] {
-    return Array.from(this._registry.values()).flat();
-  }
-
-  hasSchema<S extends Schema.Schema.AnyNoContext>(schema: S): boolean {
-    const typename = getSchemaTypename(schema);
-    const version = getSchemaVersion(schema);
-    invariant(typename, 'Invalid schema');
-
-    const schemas = this._registry.get(typename);
-    return schemas?.some((schema) => getSchemaVersion(schema) === version) ?? false;
-  }
-
-  getSchemaByDXN(dxn: DXN): Schema.Schema.AnyNoContext | undefined {
-    const components = dxn.asTypeDXN();
-    if (!components) {
-      return undefined;
-    }
-
-    const { type, version } = components;
-    const allSchemas = this._registry.get(type) ?? [];
-    if (version) {
-      return allSchemas.find((s) => getSchemaVersion(s) === version);
-    } else {
-      // If no version is specified, return the earliest version for backwards compatibility.
-      // TODO(dmaretskyi): Probably not correct to compare lexicographically, but it's good enough for now.
-      return allSchemas.sort((a, b) =>
-        (getSchemaVersion(a) ?? '0.0.0').localeCompare(getSchemaVersion(b) ?? '0.0.0'),
-      )[0];
-    }
-  }
-
-  /**
-   * @deprecated Use getSchemaByDXN.
-   */
-  getSchema(typename: string): Schema.Schema.AnyNoContext | undefined {
-    return this._registry.get(typename)?.[0];
-  }
-
-  addSchema(types: Schema.Schema.AnyNoContext[]): void {
-    types.forEach((schema) => {
-      const typename = getSchemaTypename(schema) ?? raise(new TypeError('Schema has no typename'));
-      const version = getSchemaVersion(schema) ?? raise(new TypeError('Schema has no version'));
-      const versions = defaultMap(this._registry, typename, () => []);
-      if (versions.some((schema) => getSchemaVersion(schema) === version)) {
-        throw new Error(`Schema version already registered: ${typename}:${version}`);
-      }
-
-      versions.push(schema);
-    });
-  }
-}

package/src/internal/schema/snapshot.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-/**
- * Returns a non-reactive snapshot of the given live object.
- * @deprecated Use `getSnapshot` from `@dxos/live-object` instead.
- */
-// TODO(wittjosiah): Types.
-export const getSnapshot = (object: any): any => {
-  if (typeof object !== 'object') {
-    return object;
-  }
-
-  if (Array.isArray(object)) {
-    return object.map(getSnapshot);
-  }
-
-  const result: any = {};
-  for (const key in object) {
-    result[key] = getSnapshot(object[key]);
-  }
-
-  return result;
-};

package/src/internal/schema/stored-schema.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { SchemaVersion, Typename } from '../ast';
-import { JsonSchemaType } from '../json-schema';
-import { EchoObject } from '../object';
-
-/**
- * Persistent representation of a schema.
- */
-export const StoredSchema = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  typename: Typename,
-  version: SchemaVersion,
-  jsonSchema: JsonSchemaType,
-}).pipe(
-  EchoObject({
-    typename: 'dxos.org/type/Schema',
-    version: '0.1.0',
-  }),
-);
-
-export type StoredSchema = Schema.Schema.Type<typeof StoredSchema>;

package/src/internal/testing/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './types';
-export * from './utils';