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

package/src/Dataset.ts

@@ -0,0 +1,34 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+// @import-as-namespace
+
+import { pipe } from 'effect/Function';
+import * as Predicate from 'effect/Predicate';
+import * as Schema from 'effect/Schema';
+
+import * as Collection from './Collection';
+import * as Feed from './Feed';
+import * as Obj from './Obj';
+import * as Type from './Type';
+import * as View from './View';
+
+/**
+ * Abstract set of objects, represented by a view, feed, or collection.
+ * Schema-level union of the underlying type entities (rebuilt via
+ * `Type.getSchema`) so this can still be consumed by Schema-side APIs such
+ * as `Filter.type(...)` on a union.
+ */
+export type Dataset = Feed.Feed | Collection.Collection | View.View;
+export const Dataset = Schema.Union(
+  Type.getSchema(Feed.Feed),
+  Type.getSchema(Collection.Collection),
+  Type.getSchema(View.View),
+);
+
+export const isDataset: (value: unknown) => value is Dataset = pipe(
+  Obj.instanceOf(Feed.Feed),
+  Predicate.or(Obj.instanceOf(Collection.Collection)),
+  Predicate.or(Obj.instanceOf(View.View)),
+);

package/src/Entity.test.ts

@@ -0,0 +1,132 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, expect, test } from 'vitest';
+
+import * as Entity from './Entity';
+import * as Obj from './Obj';
+import * as Relation from './Relation';
+import { TestSchema } from './testing';
+import * as Type from './Type';
+
+const makeObject = () =>
+  Obj.make(TestSchema.Person, {
+    name: 'Test',
+    username: 'test',
+    email: 'test@example.com',
+    tasks: [],
+  });
+
+const makeRelation = (obj: TestSchema.Person) =>
+  Relation.make(TestSchema.HasManager, { [Relation.Source]: obj, [Relation.Target]: obj });
+
+describe('Entity', () => {
+  test('Entity.Unknown accepts any object or relation', () => {
+    const obj = makeObject();
+    const rel = makeRelation(obj);
+    const doSomething = (entity: Entity.Unknown) => entity;
+    expect(doSomething(obj)).toBe(obj);
+    expect(doSomething(rel)).toBe(rel);
+  });
+
+  // `isEntity` is a bare brand check (`[KindId] !== undefined`). All three entity
+  // kinds — objects, relations, and type entities — carry the brand, so all three
+  // are recognised as entities. (Type entities brand with `EntityKind.Type`.)
+  describe('isEntity / isSnapshot', () => {
+    test('object instance is an entity', () => {
+      const obj = makeObject();
+      expect(Entity.isEntity(obj)).toBe(true);
+      expect(Entity.isSnapshot(obj)).toBe(false);
+    });
+
+    test('relation instance is an entity', () => {
+      const rel = makeRelation(makeObject());
+      expect(Entity.isEntity(rel)).toBe(true);
+      expect(Entity.isSnapshot(rel)).toBe(false);
+    });
+
+    test('type entity is an entity', () => {
+      expect(Entity.isEntity(TestSchema.Person)).toBe(true);
+      expect(Entity.isSnapshot(TestSchema.Person)).toBe(false);
+    });
+
+    test('non-entities are rejected', () => {
+      expect(Entity.isEntity(null)).toBe(false);
+      expect(Entity.isEntity({})).toBe(false);
+      expect(Entity.isEntity({ id: 'x' })).toBe(false);
+      expect(Entity.isEntity('string')).toBe(false);
+    });
+  });
+
+  // Object and relation instances behave identically across the Entity.* accessor
+  // surface: these accessors are written for runtime instances and read the
+  // instance's identity, type pointer and metadata.
+  describe.each([
+    ['object', () => makeObject(), 'com.example.type.person'],
+    ['relation', () => makeRelation(makeObject()), 'com.example.type.hasManager'],
+  ] as const)('instance accessors (%s)', (_label, make, typename) => {
+    test('getURI returns an echo URI', () => {
+      const entity = make();
+      expect(Entity.getURI(entity)).toMatch(/^echo:/);
+    });
+
+    test('getTypename returns the typename', () => {
+      expect(Entity.getTypename(make())).toBe(typename);
+    });
+
+    test('getTypeURI returns the type DXN', () => {
+      expect(Entity.getTypeURI(make())).toBe(`dxn:${typename}:0.1.0`);
+    });
+
+    test('getType resolves back to the type entity', () => {
+      const type = Entity.getType(make());
+      expect(type).toBeDefined();
+      expect(Type.getTypename(type!)).toBe(typename);
+    });
+
+    test('getMeta returns metadata', () => {
+      expect(Entity.getMeta(make())).toBeDefined();
+    });
+
+    test('isDeleted is false for a live entity', () => {
+      expect(Entity.isDeleted(make())).toBe(false);
+    });
+
+    test('toJSON serializes the entity', () => {
+      const json = Entity.toJSON(make());
+      expect(json).toMatchObject({ '@type': expect.stringContaining(typename) });
+    });
+  });
+
+  // Type entities are first-class entities: the Entity.* accessors work on them too.
+  // `getURI`/`getTypename` return the type's OWN identity, while `getType`/`getTypeURI`
+  // (which mean "the type this entity is an instance of") resolve to the meta-type
+  // `Type.Type`.
+  describe('type entity', () => {
+    test('isEntity / getMeta / isDeleted', () => {
+      expect(Entity.isEntity(TestSchema.Person)).toBe(true);
+      expect(Entity.getMeta(TestSchema.Person)).toBeDefined();
+      expect(Entity.isDeleted(TestSchema.Person)).toBe(false);
+    });
+
+    test('getURI / getTypename return the type entity’s own identity', () => {
+      expect(Entity.getURI(TestSchema.Person)).toBe('dxn:com.example.type.person:0.1.0');
+      expect(Entity.getTypename(TestSchema.Person)).toBe('com.example.type.person');
+    });
+
+    test('getType / getTypeURI resolve to the meta-type (Type.Type)', () => {
+      expect(Entity.getType(TestSchema.Person)).toBe(Type.Type);
+      expect(Entity.getTypeURI(TestSchema.Person)).toBe('dxn:org.dxos.type.schema:0.1.0');
+    });
+
+    test('Entity.* and Type.* agree on type identity', () => {
+      expect(Entity.getURI(TestSchema.Person)).toBe(Type.getURI(TestSchema.Person));
+      expect(Entity.getTypename(TestSchema.Person)).toBe(Type.getTypename(TestSchema.Person));
+      expect(Type.isType(TestSchema.Person)).toBe(true);
+      expect(Type.isObject(TestSchema.Person)).toBe(true);
+      expect(Type.isRelation(TestSchema.HasManager)).toBe(true);
+      expect(Type.getVersion(TestSchema.Person)).toBe('0.1.0');
+    });
+  });
+});

package/src/Entity.ts

@@ -0,0 +1,332 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import type { ForeignKey } from '@dxos/echo-protocol';
+import type { ObjectId, URI } from '@dxos/keys';
+
+import * as internal from './internal';
+import type * as Relation from './Relation';
+import * as Type from './Type';
+
+// Re-export KindId and SnapshotKindId from internal.
+export const KindId = internal.KindId;
+export type KindId = typeof internal.KindId;
+export const SnapshotKindId = internal.SnapshotKindId;
+export type SnapshotKindId = typeof internal.SnapshotKindId;
+
+// NOTE: Relation does not extend Obj so that, for example, we can prevent Relations from being used as source and target objects.
+//  However, we generally refer to Obj and Relation instances as "objects",
+//  and many API methods accept both Obj.Unknown and Relation.Unknown (i.e., Entity.Unknown) instances.
+
+export const Kind = internal.EntityKind;
+export type Kind = internal.EntityKind;
+export const KindSchema = internal.EntityKindSchema;
+
+/**
+ * Assigns a kind to an Object or Relation instance.
+ * NOTE: Needed to make `isRelation` and `isObject` checks work.
+ */
+export interface OfKind<K extends Kind> {
+  readonly [KindId]: K;
+  readonly id: ObjectId;
+}
+
+/**
+ * Assigns a snapshot kind to an Object or Relation snapshot.
+ */
+export interface SnapshotOfKind<K extends Kind> {
+  readonly [SnapshotKindId]: K;
+  readonly id: ObjectId;
+}
+
+/**
+ * Obj or Relation with a specific set of properties.
+ */
+export type Entity<Props> = OfKind<Kind> & Props;
+
+/**
+ * Unknown Obj or Relation (reactive).
+ */
+export interface Unknown extends OfKind<Kind> {}
+
+/**
+ * Effect Schema for any ECHO entity (object or relation).
+ *
+ * Kind-agnostic counterpart to `Obj.Unknown` / `Relation.Unknown` — validates
+ * the structural shape (id + properties) without constraining `[KindId]`. Used
+ * in operation input schemas that accept any entity flavour (e.g.
+ * `Schema.Array(Entity.Unknown)`).
+ *
+ * The cast bridges the runtime structural schema to the branded `Unknown` type:
+ * `[KindId]` is a symbol brand that can't be expressed in a runtime `Struct`,
+ * so the entity guarantee is carried at the type level only (same approach as
+ * `Obj.Unknown` / `Relation.Unknown`). Unlike those, this is kind-agnostic so it
+ * isn't an `UnknownTypeSchema<_, K>` (there's no single `K`) and carries no
+ * `TypeAnnotation`.
+ */
+export const Unknown: Schema.Schema<Unknown> = Schema.Struct({
+  id: Schema.String,
+}).pipe(
+  Schema.extend(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+) as unknown as Schema.Schema<Unknown>;
+
+/**
+ * Snapshot of an Obj or Relation.
+ * Branded with SnapshotKindId instead of KindId.
+ */
+export interface Snapshot extends SnapshotOfKind<Kind> {}
+
+/**
+ * Object with arbitrary properties.
+ *
+ * NOTE: Due to how typescript works, this type is not assignable to a specific schema type.
+ * In that case, use `Obj.instanceOf` to check if an object is of a specific type.
+ *
+ * This type is very permissive and allows accessing any property on the object.
+ * We should move to Obj.Unknown that is not permissive and requires explicit instanceof checks..
+ */
+export interface Any extends OfKind<Kind> {
+  [key: string]: unknown;
+}
+
+/**
+ * Returns all properties of an object or relation except for the id and kind.
+ */
+export type Properties<T> = Omit<T, 'id' | KindId | Relation.Source | Relation.Target>;
+
+/**
+ * Check if a value is an ECHO entity (object or relation).
+ * Returns `false` for snapshots.
+ */
+export const isEntity = (value: unknown): value is Unknown => {
+  if (typeof value !== 'object' || value === null) {
+    return false;
+  }
+  return (value as any)[KindId] !== undefined;
+};
+
+/**
+ * Test if a value is an instance of a given object or relation type.
+ *
+ * Kind-agnostic counterpart to `Obj.instanceOf` / `Relation.instanceOf` —
+ * use this when the caller's input type is `Type.AnyObj | Type.AnyRelation`.
+ *
+ * @example
+ * ```ts
+ * // Caller doesn't know whether `type` is object- or relation-kind.
+ * const matches = <T extends Type.AnyObj | Type.AnyRelation>(type: T, value: unknown) =>
+ *   Entity.instanceOf(type, value);
+ * ```
+ */
+export const instanceOf: {
+  <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Type.InstanceType<S>;
+  <S extends Type.AnyEntity>(schema: S, value: unknown): value is Type.InstanceType<S>;
+} = ((...args: [schema: Type.AnyEntity, value?: unknown]) => {
+  if (args.length === 1) {
+    return (entity: unknown) => internal.isInstanceOf(args[0], entity);
+  }
+  return internal.isInstanceOf(args[0], args[1]);
+}) as any;
+
+/**
+ * Check if a value is an ECHO entity snapshot.
+ * Returns `false` for entities.
+ */
+export const isSnapshot = (value: unknown): value is Snapshot => {
+  if (typeof value !== 'object' || value === null) {
+    return false;
+  }
+  return (value as any)[SnapshotKindId] !== undefined;
+};
+
+// TODO(dmaretskyi): Type introspection -- move to kind.
+export const getKind = internal.getEntityKind;
+
+/**
+ * Property that accesses metadata for an entity.
+ */
+export const Meta: unique symbol = internal.MetaId as any;
+
+/**
+ * Property that accesses metadata for an entity.
+ */
+export type Meta = typeof Meta;
+
+//
+// Entity-level functions that work on any entity (object or relation).
+// Use these when you don't know or care about the specific entity kind.
+// For kind-specific functions, use Obj.* or Relation.*.
+//
+
+/**
+ * JSON representation of an entity.
+ */
+export type JSON = internal.ObjectJSON;
+
+/**
+ * Whether the entity is a type-kind entity (a `Type.Type` produced by
+ * `Type.makeObject` / `Type.makeRelation`, or a persisted schema). Type entities
+ * carry their identity (typename/version) on themselves rather than referencing a
+ * separate type, so the accessors below route them through the `Type.*` module.
+ */
+const isTypeEntity = (entity: unknown): boolean => internal.getEntityKindBrand(entity) === internal.EntityKind.Type;
+
+/**
+ * Any value the read accessors operate on: a reactive entity or a snapshot.
+ * Type entities (`Type.AnyEntity`) are also accepted — they're first-class
+ * entities, and `Unknown`'s kind-agnostic brand already subsumes them.
+ */
+export type AnyInput = Unknown | Snapshot;
+
+/**
+ * Get the canonical URI of an entity (object, relation, or type). Returns `URI.URI` —
+ * an `EchoURI` for object/relation instances and persisted types, or a typename
+ * `DXN` for static type entities; narrow with `EchoURI.parse(uri)` or
+ * `DXN.tryMake(uri)` at the point of use.
+ */
+export const getURI = (entity: AnyInput): URI.URI =>
+  isTypeEntity(entity) ? Type.getURI(entity as Type.AnyEntity) : internal.getUri(entity as Unknown);
+
+/**
+ * Get the DXN of an entity's type. For object/relation instances this is the URI
+ * of the type they were created from; for a type entity it is the URI of the
+ * meta-type ({@link Type.Type}, `dxn:org.dxos.type.schema:0.1.0`).
+ */
+export const getTypeURI = (entity: AnyInput): URI.URI | undefined =>
+  isTypeEntity(entity) ? Type.getURI(Type.Type) : internal.getTypeURI(entity as Unknown);
+
+/**
+ * Get the type entity (`Type.AnyEntity`) the instance was created from.
+ *
+ * Returns `undefined` when the entity's type isn't registered in this runtime
+ * (e.g. a freshly deserialized snapshot whose type entity hasn't been wired
+ * up yet, or an entity loaded from storage before its schema is known). To
+ * get the Effect Schema from the returned entity, use `Type.getSchema(...)`.
+ *
+ * For a type entity, returns the meta-type {@link Type.Type} (a type entity's
+ * type is "Type").
+ */
+export const getType = (entity: AnyInput): Type.AnyEntity | undefined =>
+  isTypeEntity(entity) ? Type.Type : (internal.getType(entity) as Type.AnyEntity | undefined);
+
+/**
+ * Get the typename of an entity's type. For object/relation instances this is the
+ * typename of the type they were created from; for a type entity it is the type's
+ * own typename (e.g. `com.example.type.person`).
+ */
+export const getTypename = (entity: AnyInput): string | undefined =>
+  isTypeEntity(entity) ? Type.getTypename(entity as Type.AnyEntity) : internal.getTypename(entity as Unknown);
+
+/**
+ * Get the database an entity belongs to.
+ */
+export const getDatabase = (entity: Unknown | Snapshot): any | undefined => internal.getDatabase(entity);
+
+/**
+ * Get the metadata for an entity.
+ * Returns mutable meta when passed a mutable entity (inside change callback).
+ * Returns read-only meta when passed a regular entity or snapshot.
+ */
+// TODO(wittjosiah): When passed a Snapshot, should return a snapshot of meta, not the live meta proxy.
+export function getMeta(entity: Mutable<Unknown>): internal.ObjectMeta;
+export function getMeta(entity: Unknown | Snapshot): internal.ReadonlyMeta;
+export function getMeta(entity: Unknown | Snapshot | Mutable<Unknown>): internal.ObjectMeta | internal.ReadonlyMeta {
+  return internal.getMetaChecked(entity);
+}
+
+/**
+ * Get foreign keys for an entity from the specified source.
+ */
+export const getKeys = (entity: Unknown | Snapshot, source: string): ForeignKey[] => internal.getKeys(entity, source);
+
+/**
+ * Check if an entity is deleted.
+ */
+export const isDeleted = (entity: Unknown | Snapshot): boolean => internal.isDeleted(entity);
+
+/**
+ * Get the label of an entity.
+ *
+ * @param options.fallback `'typename'` returns the entity's typename when no
+ *   label is set (e.g. `org.dxos.type.table`).
+ */
+export const getLabel = (entity: Unknown | Snapshot, options?: internal.GetLabelOptions): string | undefined =>
+  internal.getLabel(entity, options);
+
+/**
+ * Set the label of an entity.
+ * Must be called within an `Entity.update` / `Obj.update` / `Relation.update` callback.
+ */
+export const setLabel = (entity: Mutable<Unknown>, label: string): void => internal.setLabel(entity, label);
+
+/**
+ * Get the description of an entity.
+ */
+export const getDescription = (entity: Unknown | Snapshot): string | undefined => internal.getDescription(entity);
+
+/**
+ * Convert an entity to its JSON representation.
+ */
+export const toJSON = (entity: Unknown | Snapshot): JSON => internal.objectToJSON(entity);
+
+/**
+ * Subscribe to changes on an entity (object or relation).
+ * @returns Unsubscribe function.
+ */
+export const subscribe = (entity: Unknown, callback: () => void): (() => void) => {
+  return internal.subscribe(entity, callback);
+};
+
+//
+// Change
+//
+
+/**
+ * Used to provide a mutable view of an entity within `Entity.update`.
+ */
+export type Mutable<T> = internal.Mutable<T>;
+
+/**
+ * Perform mutations on an entity (object or relation) within a change context.
+ *
+ * Entities are read-only by default. Mutations are batched and notifications fire
+ * when the callback completes. Direct mutations outside of `Entity.update` will throw
+ * at runtime.
+ *
+ * @param entity - The echo entity (object or relation) to mutate.
+ * @param callback - Receives a mutable view of the entity. All mutations must occur here.
+ *
+ * @example
+ * ```typescript
+ * // Mutate within Entity.update
+ * Entity.update(entity, (obj) => {
+ *   obj.name = 'Updated';
+ *   obj.count = 42;
+ * });
+ *
+ * // Direct mutation throws
+ * entity.name = 'Bob'; // Error: Cannot modify outside Entity.update()
+ * ```
+ *
+ * Note: For type-specific operations, prefer `Obj.update` or `Relation.update`.
+ */
+export const update = <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>): void => {
+  internal.change(entity, callback);
+};
+
+/**
+ * Add a tag to an entity.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
+ */
+export const addTag = (entity: Mutable<Unknown>, tag: string): void => internal.addTag(entity, tag);
+
+/**
+ * Remove a tag from an entity.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
+ */
+export const removeTag = (entity: Mutable<Unknown>, tag: string): void => internal.removeTag(entity, tag);

package/src/Err.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { BaseError, type BaseErrorOptions } from '@dxos/errors';
+import { type URI } from '@dxos/keys';
+
+export class SchemaNotFoundError extends BaseError.extend('SchemaNotFoundError', 'Schema not found') {
+  constructor(schema: string, options?: BaseErrorOptions) {
+    super({ context: { schema }, ...options });
+  }
+}
+
+export class ObjectNotFoundError extends BaseError.extend('ObjectNotFoundError', 'Object not found') {
+  constructor(uri: URI.URI, options?: BaseErrorOptions) {
+    super({ context: { uri }, ...options });
+  }
+}
+
+/**
+ * Reason why getting a reactive object from a snapshot failed.
+ * - `no-database`: The snapshot is not associated with a database.
+ * - `object-not-found`: The object was removed or does not exist in the database.
+ */
+export type GetReactiveErrorReason = 'no-database' | 'object-not-found';
+
+/**
+ * Error thrown when a reactive object cannot be resolved from a snapshot.
+ * Extends `BaseError` with a `reason` and optional `snapshotId` in its context.
+ */
+export class GetReactiveError extends BaseError.extend(
+  'GetReactiveError',
+  'Failed to get reactive object from snapshot',
+) {
+  constructor(options: { reason: GetReactiveErrorReason; snapshotId?: string } & BaseErrorOptions) {
+    super({ context: { reason: options.reason, snapshotId: options.snapshotId }, ...options });
+  }
+}