@dxos/echo 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

package/src/Obj.ts

@@ -2,161 +2,730 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
+// @import-as-namespace
 
-import * as EchoSchema from '@dxos/echo-schema';
-import { assertArgument, invariant } from '@dxos/invariant';
-import { type DXN } from '@dxos/keys';
-import type * as LiveObject from '@dxos/live-object';
-import { live } from '@dxos/live-object';
+import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
+
+import type { ForeignKey } from '@dxos/echo-protocol';
+import { createJsonPath } from '@dxos/effect';
+import { assertArgument } from '@dxos/invariant';
+import { type DXN, ObjectId } from '@dxos/keys';
 import { assumeType } from '@dxos/util';
 
+import type * as Database from './Database';
+import * as Entity from './Entity';
+import * as Err from './Err';
+import * as objInternal from './internal/Obj';
+import * as internal from './internal';
 import type * as Ref from './Ref';
-import type * as Relation from './Relation';
 import type * as Type from './Type';
 
-// NOTE: Don't export: Obj.Any and Obj.Obj form the public API.
-interface ObjBase extends Type.OfKind<EchoSchema.EntityKind.Object> {
-  readonly id: EchoSchema.ObjectId;
-}
+/**
+ * Base type for all ECHO objects.
+ */
+interface BaseObj extends internal.AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {}
 
 /**
  * Object type with specific properties.
  */
-export type Obj<Props> = ObjBase & Props;
+export type OfShape<Props> = BaseObj & Props;
 
 /**
- * Base type for all ECHO objects.
+ * Object with no known properties beyond id and kind.
+ * Use this when the object's schema/properties are not known.
+ * For objects with arbitrary properties, use `Obj.AnyProps`.
+ *
+ * NOTE: This is a TypeScript type only, not a schema.
+ * To validate that a value is an ECHO object, use `Schema.is(Type.Obj)`.
  */
-export interface Any extends ObjBase {}
+export interface Unknown extends BaseObj {}
 
-type Props<T> = { id?: EchoSchema.ObjectId } & Type.Properties<T>;
+/**
+ * Runtime Effect schema for any ECHO object.
+ * Use for validation, parsing, or as a reference target for collections.
+ *
+ * NOTE: `Schema.is(Type.Obj)` does STRUCTURAL validation only (checks for `id` field).
+ * Use `Obj.isObject()` for proper ECHO instance type guards that check the KindId brand.
+ *
+ * @example
+ * ```ts
+ * // Structural type guard (accepts any object with id field)
+ * if (Schema.is(Type.Obj)(unknownValue)) { ... }
+ *
+ * // ECHO instance type guard (checks KindId brand)
+ * if (Obj.isObject(unknownValue)) { ... }
+ *
+ * // Reference to any object type
+ * const Collection = Schema.Struct({
+ *   objects: Schema.Array(Ref.Ref(Obj.Unknown)),
+ * }).pipe(Type.object({ typename: 'Collection', version: '0.1.0' }));
+ * ```
+ */
+// TODO(wittjosiah): Investigate if Schema.filter can validate KindId on ECHO instances.
+//   Effect Schema normalizes proxy objects to plain objects before calling filter predicates.
+//   Possible approaches: custom Schema.declare, AST manipulation, or upstream contribution.
+export const Unknown: Type.Obj<Unknown> = Schema.Struct({
+  id: Schema.String,
+}).pipe(
+  Schema.extend(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+  // TODO(dmaretskyi): Clean this up.
+  // NOTE: The EchoObjectSchema annotation is required for Ref.Ref(Obj.Unknown) to work.
+  //   The typename/version only satisfy ECHO schema machinery for reference targets.
+  internal.EchoObjectSchema({ typename: internal.ANY_OBJECT_TYPENAME, version: internal.ANY_OBJECT_VERSION }),
+  (schema) =>
+    Object.assign(schema, {
+      [internal.SchemaKindId]: (schema as any)[internal.SchemaKindId],
+    }) as unknown as Type.Obj<Unknown>,
+);
 
-export type MakeProps<S extends Type.Obj.Any> = NoInfer<Props<Schema.Schema.Type<S>>>;
+/**
+
+/**
+ * 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.
+ *
+ * Prefer using `Obj.Unknown` when you don't need to access arbitrary properties.
+ */
+export interface Any extends BaseObj, internal.AnyProperties {}
 
 /**
- * Creates new object.
+ * Base type for snapshot objects (has SnapshotKindId instead of KindId).
  */
-// TODO(dmaretskyi): Move meta into props.
-export const make = <S extends Type.Obj.Any>(
+interface BaseSnapshot extends internal.AnyEntity {
+  readonly [Entity.SnapshotKindId]: typeof Entity.Kind.Object;
+  readonly id: ObjectId;
+}
+
+/**
+ * Immutable snapshot of an ECHO object.
+ * Branded with SnapshotKindId (not KindId).
+ * Property values are frozen at the time the snapshot was created.
+ * Returned by getSnapshot() and hooks like useObject().
+ *
+ * Snapshots are structurally identical to reactive objects but have a different brand,
+ * making them distinguishable at the TypeScript level. Neither is assignable to the other.
+ */
+export type Snapshot<T extends Unknown = Unknown> = Omit<T, Entity.KindId> & BaseSnapshot;
+
+/**
+ * JSON-encoded properties for objects.
+ */
+export interface BaseObjJson {
+  id: string;
+}
+
+const defaultMeta: internal.ObjectMeta = {
+  keys: [],
+};
+
+type MakePropsInternal<T extends Unknown> = {
+  id?: ObjectId;
+  [Meta]?: Partial<internal.ObjectMeta>;
+} & Entity.Properties<T>;
+
+// TODO(burdon): Should we allow the caller to set the id?
+/**
+ * Props type for object creation with a given schema.
+ */
+export type MakeProps<S extends Schema.Schema.AnyNoContext> = {
+  id?: ObjectId;
+  [Meta]?: Partial<internal.ObjectMeta>;
+  [Parent]?: Unknown;
+} & MakePropsInternal<Schema.Schema.Type<S>>;
+
+/**
+ * Creates a new echo object of the given schema.
+ * @param schema - Object schema.
+ * @param props - Object properties.
+ * @param meta - Object metadata (deprecated) -- pass with Obj.Meta.
+ *
+ * Meta can be passed as a symbol in `props`.
+ *
+ * Example:
+ * ```ts
+ * const obj = Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' });
+ * ```
+ *
+ * Note: Only accepts object schemas, not relation schemas. Use `Relation.make` for relations.
+ */
+export const make = <S extends Type.AnyObj>(
   schema: S,
-  props: MakeProps<S>,
-  meta?: EchoSchema.ObjectMeta,
-): LiveObject.Live<Schema.Schema.Type<S>> => {
+  props: NoInfer<MakeProps<S>>,
+): OfShape<Schema.Schema.Type<S>> => {
   assertArgument(
-    EchoSchema.getTypeAnnotation(schema)?.kind === EchoSchema.EntityKind.Object,
+    internal.getTypeAnnotation(schema)?.kind === Entity.Kind.Object,
+    'schema',
     'Expected an object schema',
   );
 
-  if (props[EchoSchema.MetaId] != null) {
-    meta = props[EchoSchema.MetaId] as any;
-    delete props[EchoSchema.MetaId];
+  let meta: internal.ObjectMeta | undefined = undefined;
+
+  // Set default fields on meta on creation.
+  if (props[internal.MetaId] != null) {
+    meta = { ...structuredClone(defaultMeta), ...props[internal.MetaId] };
+    delete props[internal.MetaId];
   }
 
-  return live<Schema.Schema.Type<S>>(schema, props as any, meta);
+  // Filter undefined values (Object.entries only returns string-keyed properties).
+  const filterUndefined: any = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
+
+  // Copy symbol properties (like ParentId) that Object.entries doesn't include.
+  for (const sym of Object.getOwnPropertySymbols(props)) {
+    const value = (props as any)[sym];
+    if (value !== undefined) {
+      filterUndefined[sym] = value;
+    }
+  }
+
+  return internal.makeObject<Schema.Schema.Type<S>>(schema, filterUndefined as any, {
+    ...defaultMeta,
+    ...meta,
+  });
+};
+
+/**
+ * Determine if object is an ECHO object.
+ */
+export const isObject = (obj: unknown): obj is Unknown => {
+  assumeType<internal.InternalObjectProps>(obj);
+  return typeof obj === 'object' && obj !== null && obj[Entity.KindId] === Entity.Kind.Object;
+};
+
+export const isSnapshot = (obj: unknown): obj is Snapshot => {
+  assumeType<internal.InternalObjectProps>(obj);
+  return typeof obj === 'object' && obj !== null && (obj as any)[Entity.SnapshotKindId] === Entity.Kind.Object;
+};
+
+/**
+ * Subscribe to object updates.
+ * The callback is called synchronously when the object is modified.
+ * Only accepts reactive objects (not snapshots).
+ * @returns Unsubscribe function.
+ */
+export const subscribe = (obj: Unknown, callback: () => void): (() => void) => {
+  return internal.subscribe(obj, callback);
+};
+
+//
+// Snapshot
+//
+
+/**
+ * Returns an immutable snapshot of an object.
+ * The snapshot is branded with SnapshotKindId instead of KindId,
+ * making it distinguishable from the reactive object at the type level.
+ */
+export const getSnapshot: <T extends Unknown>(obj: T) => Snapshot<T> = objInternal.getSnapshot as any;
+
+/**
+ * Returns the reactive version of an object from the database, given its snapshot.
+ * Inverse of `Obj.getSnapshot`.
+ *
+ * Uses `Obj.getDatabase` internally to get the database from the snapshot,
+ * then resolves the reactive object by ID.
+ *
+ * @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
+ * @returns Effect that succeeds with the reactive object, or fails with `GetReactiveError`.
+ * @example
+ * ```ts
+ * const snapshot = Obj.getSnapshot(obj);
+ * const reactive = Obj.getReactive(snapshot).pipe(
+ *   Effect.runSync
+ * );
+ * ```
+ */
+export const getReactive = <T extends Unknown>(snapshot: Snapshot<T>): Effect.Effect<T, Err.GetReactiveError> =>
+  Effect.gen(function* () {
+    const db = internal.getDatabase(snapshot);
+    if (!db) {
+      return yield* Effect.fail(new Err.GetReactiveError({ reason: 'no-database', snapshotId: snapshot.id }));
+    }
+    const obj = db.getObjectById(snapshot.id);
+    if (!obj) {
+      return yield* Effect.fail(new Err.GetReactiveError({ reason: 'object-not-found', snapshotId: snapshot.id }));
+    }
+    return obj as T;
+  });
+
+/**
+ * Like `Obj.getReactive` but returns `Option.none()` instead of failing when the object
+ * cannot be resolved (no database, object not found).
+ *
+ * @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
+ * @returns Effect that succeeds with `Option.some(reactive)` or `Option.none()`.
+ */
+export const getReactiveOption = <T extends Unknown>(snapshot: Snapshot<T>): Effect.Effect<Option.Option<T>, never> =>
+  getReactive(snapshot).pipe(
+    Effect.map(Option.some),
+    Effect.catchAll(() => Effect.succeed(Option.none())),
+  );
+
+/**
+ * Synchronous version of `Obj.getReactive`. Returns the reactive object or throws
+ * `GetReactiveError` when the object cannot be resolved (no database, object not found).
+ *
+ * @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
+ * @returns The reactive object.
+ * @throws {Err.GetReactiveError} When the object cannot be resolved.
+ */
+export const getReactiveOrThrow = <T extends Unknown>(snapshot: Snapshot<T>): T =>
+  Effect.runSync(getReactive(snapshot));
+
+export type CloneOptions = {
+  /**
+   * Retain the original object's ID.
+   * @default false
+   */
+  retainId?: boolean;
+
+  /**
+   * Recursively clone referenced objects.
+   * @default false
+   */
+  deep?: boolean;
 };
 
-export const isObject = (obj: unknown): obj is Any => {
-  assumeType<EchoSchema.InternalObjectProps>(obj);
-  return typeof obj === 'object' && obj !== null && obj[EchoSchema.EntityKindId] === EchoSchema.EntityKind.Object;
+/**
+ * Clones an object or relation.
+ * This does not clone referenced objects, only the properties in the object.
+ * @returns A new object with the same schema and properties.
+ */
+export const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T = objInternal.clone;
+
+//
+// Change
+//
+
+/**
+ * Makes all properties mutable recursively.
+ * Used to provide a mutable view of an object within `Obj.change`.
+ */
+export type Mutable<T> = internal.Mutable<T>;
+
+/**
+ * Perform mutations on an echo object within a controlled context.
+ *
+ * All mutations within the callback are batched and trigger a single notification
+ * when the callback completes. Direct mutations outside of `Obj.change` will throw
+ * an error for echo objects.
+ *
+ * This function also works with nested objects within echo objects (e.g., Template structs)
+ * that are reactive at runtime.
+ *
+ * @param obj - The echo object to mutate. Use `Relation.change` for relations.
+ * @param callback - The callback that performs mutations on the object.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, { name: 'John', age: 25 });
+ *
+ * // Mutate within Obj.change
+ * Obj.change(person, (obj) => {
+ *   obj.name = 'Jane';
+ *   obj.age = 30;
+ * });
+ * // ONE notification fires here
+ *
+ * // Direct mutation throws
+ * person.name = 'Bob'; // Error: Cannot modify outside Obj.change()
+ * ```
+ *
+ * Note: Only accepts objects. Use `Relation.change` for relations.
+ */
+export const change = <T extends Unknown>(obj: T, callback: internal.ChangeCallback<T>): void => {
+  internal.change(obj, callback);
+};
+
+/**
+ * Get a deeply nested property from an object.
+ *
+ * Similar to lodash.get and getDeep from @dxos/util.
+ * This is the complementary function to setValue.
+ * Accepts both reactive objects and snapshots.
+ *
+ * @param obj - The ECHO object to get the property from.
+ * @param path - Path to the property (array of keys).
+ * @returns The value at the path, or undefined if not found.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, {
+ *   name: 'John',
+ *   addresses: [{ street: '123 Main St' }]
+ * });
+ *
+ * Obj.getValue(person, ['addresses', 0, 'street']); // '123 Main St'
+ * Obj.getValue(person, ['addresses', 1, 'street']); // undefined
+ * ```
+ */
+export const getValue = (obj: Unknown | Snapshot, path: readonly (string | number)[]): any => {
+  return internal.getValue(obj, createJsonPath(path));
 };
 
+/**
+ * Set a deeply nested property on an object, using the object's schema to determine
+ * whether to initialize nested data as an empty object or array.
+ *
+ * Similar to lodash.set and setDeep from @dxos/util, but schema-aware.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ *
+ * @param obj - The mutable ECHO object to set the property on.
+ * @param path - Path to the property (array of keys).
+ * @param value - Value to set.
+ * @returns The value that was set.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, { name: 'John' });
+ * // Person schema has: addresses: Schema.Array(Address)
+ * Obj.change(person, (obj) => {
+ *   Obj.setValue(obj, ['addresses', 0, 'street'], '123 Main St');
+ * });
+ * // Creates: person.addresses = [{ street: '123 Main St' }]
+ * ```
+ */
+// TODO(wittjosiah): Compute possible path values + type value based on generic object type.
+export const setValue: (obj: Mutable<Unknown>, path: readonly (string | number)[], value: any) => void =
+  objInternal.setValue as any;
+
+//
+// Type
+//
+
+// TODO(burdon): To discuss: prefer over ObjectId or Key.ObjectId or Type.ID?
+export const ID = ObjectId;
+export type ID = ObjectId;
+
 /**
  * Test if object or relation is an instance of a schema.
  * @example
  * ```ts
  * const john = Obj.make(Person, { name: 'John' });
- * const johnIsPerson = Obj.instanceOf(Person)(john);
- *
  * const isPerson = Obj.instanceOf(Person);
- * if(isPerson(john)) {
+ * if (isPerson(john)) {
  *   // john is Person
  * }
  * ```
  */
 export const instanceOf: {
-  <S extends Type.Relation.Any | Type.Obj.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
-  <S extends Type.Relation.Any | Type.Obj.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
-} = ((
-  ...args: [schema: Type.Relation.Any | Type.Obj.Any, value: unknown] | [schema: Type.Relation.Any | Type.Obj.Any]
-) => {
+  <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
+  <S extends Type.AnyEntity>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
+} = ((...args: [schema: Type.AnyEntity, value: unknown] | [schema: Type.AnyEntity]) => {
   if (args.length === 1) {
-    return (obj: unknown) => EchoSchema.isInstanceOf(args[0], obj);
+    return (entity: unknown) => internal.isInstanceOf(args[0], entity);
   }
 
-  return EchoSchema.isInstanceOf(args[0], args[1]);
+  return internal.isInstanceOf(args[0], args[1]);
 }) as any;
 
-export const getSchema = EchoSchema.getSchema;
+/**
+ * Test if a snapshot is an instance of a schema.
+ * Mirrors `instanceOf` but only accepts values branded with SnapshotKindId.
+ * Use when the value is known to be a snapshot (e.g. from `getSnapshot` or `useObject`).
+ *
+ * @example
+ * ```ts
+ * const snapshot = Obj.getSnapshot(person);
+ * if (Obj.snapshotOf(Person, snapshot)) {
+ *   // snapshot is Obj.Snapshot<Person>
+ * }
+ * ```
+ */
+export const snapshotOf: {
+  <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Snapshot<Schema.Schema.Type<S>>;
+  <S extends Type.AnyEntity>(schema: S, value: unknown): value is Snapshot<Schema.Schema.Type<S>>;
+} = ((...args: [schema: Type.AnyEntity, value: unknown] | [schema: Type.AnyEntity]) => {
+  const check = (entity: unknown) =>
+    entity != null &&
+    typeof entity === 'object' &&
+    Entity.SnapshotKindId in entity &&
+    internal.isInstanceOf(args[0], entity);
+
+  if (args.length === 1) {
+    return (entity: unknown) => check(entity);
+  }
+
+  return check(args[1]);
+}) as any;
 
 // TODO(dmaretskyi): Allow returning undefined.
-export const getDXN = (obj: Any): DXN => {
-  assertArgument(!Schema.isSchema(obj), 'Object should not be a schema.');
-  const dxn = EchoSchema.getObjectDXN(obj);
-  invariant(dxn != null, 'Invalid object.');
-  return dxn;
+/**
+ * Get the DXN of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getDXN = (entity: Unknown | Snapshot): DXN => {
+  assertArgument(!Schema.isSchema(entity), 'obj', 'Object should not be a schema.');
+  return internal.getDXN(entity);
 };
 
 /**
  * @returns The DXN of the object's type.
- * @example dxn:example.com/type/Contact:1.0.0
+ * @example dxn:com.example.type.person:1.0.0
  */
-// TODO(burdon): Expando does not have a type.
-export const getTypeDXN = EchoSchema.getType;
+// TODO(wittjosiah): Narrow types.
+export const getTypeDXN: (obj: unknown | undefined) => DXN | undefined = internal.getTypeDXN as any;
+
+/**
+ * Get the schema of the object.
+ * Returns the branded ECHO schema used to create the object.
+ */
+// TODO(wittjosiah): Narrow types.
+export const getSchema: (obj: unknown | undefined) => Type.AnyEntity | undefined = internal.getSchema as any;
 
 /**
  * @returns The typename of the object's type.
- * @example `example.com/type/Contact`
+ * Accepts both reactive objects and snapshots.
+ * @example `com.example.type.person`
  */
-export const getTypename = (obj: Any): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema == null) {
-    // Try to extract typename from DXN.
-    return EchoSchema.getType(obj)?.asTypeDXN()?.type;
-  }
+export const getTypename = (entity: Unknown | Snapshot): string | undefined => internal.getTypename(entity);
 
-  return EchoSchema.getSchemaTypename(schema);
-};
+//
+// Database
+//
 
+/**
+ * Get the database the object belongs to.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getDatabase = (entity: Entity.Unknown | Entity.Snapshot): Database.Database | undefined =>
+  internal.getDatabase(entity);
+
+//
+// Meta
+//
+
+/**
+ * Property that accesses metadata for an entity.
+ *
+ * Alias for `Entity.Meta`.
+ */
+export const Meta = internal.MetaId;
+
+/**
+ * Deeply read-only version of ObjectMeta.
+ * Prevents mutation at all nesting levels (e.g., `meta.keys.push()` is a TypeScript error).
+ */
+export type ReadonlyMeta = internal.ReadonlyMeta;
+
+/**
+ * Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
+ */
+export type Meta = internal.Meta;
+
+// TODO(burdon): Narrow type.
 // TODO(dmaretskyi): Allow returning undefined.
-export const getMeta = (obj: Any): EchoSchema.ObjectMeta => {
-  const meta = EchoSchema.getMeta(obj);
-  invariant(meta != null, 'Invalid object.');
-  return meta;
-};
+/**
+ * Get the metadata for an object.
+ * Returns mutable meta when passed a mutable object (inside `Obj.change` callback).
+ * Returns read-only meta when passed a regular object or snapshot.
+ *
+ * @example
+ * ```ts
+ * // Read-only access outside change callback
+ * const meta = Obj.getMeta(person);  // ReadonlyMeta
+ *
+ * // Mutable access inside change callback
+ * Obj.change(person, (obj) => {
+ *   const meta = Obj.getMeta(obj);     // ObjectMeta (mutable)
+ *   meta.tags ??= [];
+ *   meta.tags.push('important');
+ * });
+ * ```
+ */
+// TODO(wittjosiah): When passed a Snapshot, should return a snapshot of meta, not the live meta proxy.
+export function getMeta(entity: Mutable<Unknown>): Meta;
+export function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
+export function getMeta(entity: Unknown | Snapshot | Mutable<Unknown>): Meta | ReadonlyMeta {
+  return internal.getMetaChecked(entity);
+}
 
+/**
+ * @returns Foreign keys for the object from the specified source.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getKeys: {
+  (entity: Unknown | Snapshot, source: string): ForeignKey[];
+  (source: string): (entity: Unknown | Snapshot) => ForeignKey[];
+} = Function.dual(2, (entity: Unknown | Snapshot, source?: string): ForeignKey[] => internal.getKeys(entity, source!));
+
+/**
+ * Delete all keys from the object for the specified source.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export const deleteKeys = (entity: Mutable<Unknown>, source: string): void => internal.deleteKeys(entity, source);
+
+/**
+ * Add a tag to the object.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export const addTag = (entity: Mutable<Unknown>, tag: string): void => internal.addTag(entity, tag);
+
+/**
+ * Remove a tag from the object.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export const removeTag = (entity: Mutable<Unknown>, tag: string): void => internal.removeTag(entity, tag);
+
+/**
+ * Check if the object is deleted.
+ * Accepts both reactive objects and snapshots.
+ */
 // TODO(dmaretskyi): Default to `false`.
-export const isDeleted = (obj: Any): boolean => {
-  const deleted = EchoSchema.isDeleted(obj);
-  invariant(typeof deleted === 'boolean', 'Invalid object.');
-  return deleted;
+export const isDeleted = (entity: Unknown | Snapshot): boolean => objInternal.isDeleted(entity);
+
+//
+// Annotations
+//
+
+/**
+ * Get the label of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getLabel = (entity: Unknown | Snapshot): string | undefined => internal.getLabel(entity);
+
+/**
+ * Set the label of the object.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export const setLabel = (entity: Mutable<Unknown>, label: string): void => internal.setLabel(entity, label);
+
+/**
+ * Get the description of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getDescription = (entity: Unknown | Snapshot): string | undefined => internal.getDescription(entity);
+
+/**
+ * Set the description of the object.
+ * Must be called within an `Obj.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export const setDescription = (entity: Mutable<Unknown>, description: string): void =>
+  internal.setDescription(entity, description);
+
+/**
+ * Symbol to set parent when creating objects with `Obj.make`.
+ * @example
+ * ```ts
+ * Obj.make(TestSchema.Person, {
+ *   [Obj.Parent]: parentObject,
+ *   name: 'John',
+ * })
+ * ```
+ */
+export const Parent: unique symbol = internal.ParentId as any;
+
+/**
+ * Get the parent of an object.
+ * The parent is always loaded together with the object.
+ * Only objects are allowed to have a parent
+ * @returns The parent object, or undefined if the object has no parent.
+ */
+export const getParent = (entity: Unknown | Snapshot): Unknown | undefined => {
+  assertArgument(isObject(entity), 'Expected an object');
+  assumeType<internal.InternalObjectProps>(entity);
+  return entity[internal.ParentId] as Unknown | undefined;
 };
 
-// TODO(burdon): Rename "label"
-export const getLabel = (obj: Any): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    return EchoSchema.getLabel(schema, obj);
-  }
+/**
+ * Sets the parent of an object.
+ * If a parent (or any transitive parent) is deleted, the object will be deleted.
+ * Only objects are allowed to have a parent.
+ */
+export const setParent = (entity: Unknown, parent: Any | undefined) => {
+  assertArgument(isObject(entity), 'Expected an object');
+  assertArgument(parent === undefined || isObject(parent), 'Expected an object');
+  assumeType<internal.InternalObjectProps>(entity);
+  assumeType<internal.InternalObjectProps | undefined>(parent);
+  entity[internal.ParentId] = parent;
 };
 
+//
+// JSON
+//
+
 /**
  * JSON representation of an object.
  */
-export type JSON = EchoSchema.ObjectJSON;
+export type JSON = internal.ObjectJSON;
 
 /**
  * Converts object to its JSON representation.
+ * Accepts both reactive objects and snapshots.
  *
  * The same algorithm is used when calling the standard `JSON.stringify(obj)` function.
  */
-export const toJSON = (obj: Any | Relation.Any): JSON => EchoSchema.objectToJSON(obj);
+export const toJSON = (entity: Unknown | Snapshot): JSON => objInternal.objectToJSON(entity);
 
 /**
  * Creates an object from its json representation, performing schema validation.
  * References and schemas 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.
+ * The function must be async to support resolving the schema as well as the relation endpoints.
+ *
+ * @param options.refResolver - Resolver for references. Produces hydrated references that can be resolved.
+ * @param options.dxn - Override object DXN. Changes the result of `Obj.getDXN`.
+ * @param options.database - Database to associate with the object.
+ */
+export const fromJSON: (
+  json: unknown,
+  options?: { refResolver?: Ref.Resolver; dxn?: DXN; database?: Database.Database },
+) => Promise<Unknown> = objInternal.objectFromJSON as any;
+
+/**
+ * Comparator function type for sorting objects.
+ * Accepts both reactive objects and snapshots.
+ */
+export type Comparator = internal.Comparator<Unknown | Snapshot>;
+
+export const sortByLabel: Comparator = internal.sortByLabel as Comparator;
+export const sortByTypename: Comparator = internal.sortByTypename as Comparator;
+export const sort = (...comparators: Comparator[]): Comparator => internal.sort(...comparators) as Comparator;
+
+//
+// Version
+//
+
+export const VersionTypeId = internal.VersionTypeId;
+export type VersionCompareResult = internal.VersionCompareResult;
+
+/**
+ * Represent object version.
+ * May be backed by Automerge.
+ * Objects with no history are not versioned.
+ */
+export type Version = internal.EntityVersion;
+
+export const isVersion = internal.isVersion;
+export const versionValid = internal.versionValid;
+export const compareVersions = internal.compareVersions;
+export const encodeVersion = internal.encodeVersion;
+export const decodeVersion = internal.decodeVersion;
+
+/**
+ * Returns the version of the object.
+ * Accepts both reactive objects and snapshots.
  */
-export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver }) => Promise<Any> =
-  EchoSchema.objectFromJSON as any;
+export const version = (entity: Unknown | Snapshot): Version => internal.version(entity);