@dxos/echo 0.8.4-main.7ace549 → 0.8.4-main.8360d9e660

package/src/Obj.ts

@@ -2,92 +2,144 @@
 // Copyright 2025 DXOS.org
 //
 
+// @import-as-namespace
+
+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 { assertArgument, invariant } from '@dxos/invariant';
+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 { getSnapshot as getSnapshot$ } from '@dxos/live-object';
-import { assumeType, deepMapValues } from '@dxos/util';
+import { assumeType } from '@dxos/util';
 
+import type * as Database from './Database';
 import * as Entity from './Entity';
-import {
-  type AnyEchoObject,
-  type AnyProperties,
-  type InternalObjectProps,
-  MetaId,
-  type ObjectJSON,
-  type ObjectMeta,
-  ObjectVersionId,
-  VersionTypeId,
-  getDescription as getDescription$,
-  getLabel as getLabel$,
-  getMeta as getMeta$,
-  getObjectDXN,
-  getSchema as getSchema$,
-  getSchemaTypename,
-  getTypeAnnotation,
-  getTypeDXN as getTypeDXN$,
-  isDeleted as isDeleted$,
-  isInstanceOf,
-  makeObject,
-  objectFromJSON,
-  objectToJSON,
-  setDescription as setDescription$,
-  setLabel as setLabel$,
-} from './internal';
-import * as Ref from './Ref';
-import * as Type from './Type';
+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 Type from './Type';
 
 /**
  * Base type for all ECHO objects.
- * @private
  */
-interface BaseObj extends AnyEchoObject, Entity.OfKind<typeof Entity.Kind.Object> {}
+interface BaseObj extends internal.AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {}
 
 /**
- * Base type for all Obj objects.
+ * Object type with specific properties.
  */
-export interface Any extends BaseObj {}
+export type OfShape<Props> = BaseObj & Props;
 
-export const Any = Schema.Struct({}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Any',
-    version: '0.1.0',
-  }),
-);
+/**
+ * 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 Unknown extends BaseObj {}
 
 /**
- * Object type with specific properties.
+ * 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' }));
+ * ```
  */
-export type Obj<Props> = BaseObj & Props;
+// 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>,
+);
+
+/**
 
 /**
  * Object with arbitrary properties.
  *
- * NOTE: Due to how typescript works, this type is not assignable to a specific schema type.
+ * 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 {}
+
+/**
+ * Base type for snapshot objects (has SnapshotKindId instead of KindId).
  */
-export interface AnyProps extends BaseObj, AnyProperties {}
+interface BaseSnapshot extends internal.AnyEntity {
+  readonly [Entity.SnapshotKindId]: typeof Entity.Kind.Object;
+  readonly id: ObjectId;
+}
 
-const defaultMeta: ObjectMeta = {
+/**
+ * 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 Props<T = any> = {
+type MakePropsInternal<T extends Unknown> = {
   id?: ObjectId;
-  [Meta]?: Partial<ObjectMeta>;
-} & Type.Properties<T>;
+  [Meta]?: Partial<internal.ObjectMeta>;
+} & Entity.Properties<T>;
 
 // TODO(burdon): Should we allow the caller to set the id?
-export type MakeProps<T extends Schema.Schema.AnyNoContext> = {
+/**
+ * Props type for object creation with a given schema.
+ */
+export type MakeProps<S extends Schema.Schema.AnyNoContext> = {
   id?: ObjectId;
-  [Meta]?: Partial<ObjectMeta>;
-} & NoInfer<Props<Schema.Schema.Type<T>>>;
+  [Meta]?: Partial<internal.ObjectMeta>;
+  [Parent]?: Unknown;
+} & MakePropsInternal<Schema.Schema.Type<S>>;
 
 /**
- * Creates a new object of the given types.
+ * 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.
@@ -98,24 +150,39 @@ export type MakeProps<T extends Schema.Schema.AnyNoContext> = {
  * ```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 Schema.Schema.AnyNoContext>(
+export const make = <S extends Type.AnyObj>(
   schema: S,
-  props: MakeProps<S>,
-  meta?: Partial<ObjectMeta>,
-): Obj<Schema.Schema.Type<S>> => {
-  assertArgument(getTypeAnnotation(schema)?.kind === Entity.Kind.Object, 'schema', 'Expected an object schema');
+  props: NoInfer<MakeProps<S>>,
+): OfShape<Schema.Schema.Type<S>> => {
+  assertArgument(
+    internal.getTypeAnnotation(schema)?.kind === Entity.Kind.Object,
+    'schema',
+    'Expected an object schema',
+  );
+
+  let meta: internal.ObjectMeta | undefined = undefined;
 
   // Set default fields on meta on creation.
-  if (props[MetaId] != null) {
-    meta = { ...structuredClone(defaultMeta), ...props[MetaId] };
-    delete props[MetaId];
+  if (props[internal.MetaId] != null) {
+    meta = { ...structuredClone(defaultMeta), ...props[internal.MetaId] };
+    delete props[internal.MetaId];
   }
 
-  // Filter undefined values.
-  const filterUndefined = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
+  // 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 makeObject<Schema.Schema.Type<S>>(schema, filterUndefined as any, {
+  return internal.makeObject<Schema.Schema.Type<S>>(schema, filterUndefined as any, {
     ...defaultMeta,
     ...meta,
   });
@@ -124,19 +191,90 @@ export const make = <S extends Schema.Schema.AnyNoContext>(
 /**
  * Determine if object is an ECHO object.
  */
-export const isObject = (obj: unknown): obj is Any => {
-  assumeType<InternalObjectProps>(obj);
+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 getSnapshot: <T extends Any>(obj: Obj<T>) => T = getSnapshot$;
+export const getReactiveOrThrow = <T extends Unknown>(snapshot: Snapshot<T>): T =>
+  Effect.runSync(getReactive(snapshot));
 
 export type CloneOptions = {
   /**
@@ -144,6 +282,12 @@ export type CloneOptions = {
    * @default false
    */
   retainId?: boolean;
+
+  /**
+   * Recursively clone referenced objects.
+   * @default false
+   */
+  deep?: boolean;
 };
 
 /**
@@ -151,31 +295,107 @@ export type CloneOptions = {
  * 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 Any>(obj: T, opts?: CloneOptions): T => {
-  const { id, ...data } = obj;
-  const schema = getSchema$(obj);
-  invariant(schema != null, 'Object should have a schema');
-  const props: any = deepMapValues(data, (value, recurse) => {
-    if (Ref.isRef(value)) {
-      return value;
-    }
-    return recurse(value);
-  });
+export const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T = objInternal.clone;
 
-  if (opts?.retainId) {
-    props.id = id;
-  }
-  const meta = getMeta(obj);
-  props[MetaId] = deepMapValues(meta, (value, recurse) => {
-    if (Ref.isRef(value)) {
-      return value;
-    }
-    return recurse(value);
-  });
+//
+// 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>;
 
-  return make(schema as Type.Obj.Any, props);
+/**
+ * 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, (p) => {
+ *   p.name = 'Jane';
+ *   p.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, (p) => {
+ *   Obj.setValue(p, ['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
 //
@@ -196,147 +416,250 @@ export type ID = ObjectId;
  * ```
  */
 export const instanceOf: {
-  <S extends Type.Entity.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
-  <S extends Type.Entity.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
-} = ((...args: [schema: Type.Entity.Any, value: unknown] | [schema: Type.Entity.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 (entity: unknown) => isInstanceOf(args[0], entity);
+    return (entity: unknown) => internal.isInstanceOf(args[0], entity);
   }
 
-  return isInstanceOf(args[0], args[1]);
+  return internal.isInstanceOf(args[0], args[1]);
+}) as any;
+
+/**
+ * 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 = (entity: Entity.Unknown): 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.');
-  const dxn = getObjectDXN(entity);
-  invariant(dxn != null, 'Invalid object.');
-  return dxn;
+  return internal.getDXN(entity);
 };
 
 /**
  * @returns The DXN of the object's type.
- * @example dxn:example.com/type/Person:1.0.0
+ * @example dxn:com.example.type.person:1.0.0
  */
-// TODO(burdon): Must define and return type for expando.
-export const getTypeDXN = getTypeDXN$;
+// 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.
  */
-export const getSchema = getSchema$;
+// 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/Person`
+ * Accepts both reactive objects and snapshots.
+ * @example `com.example.type.person`
  */
-export const getTypename = (entity: Entity.Unknown): string | undefined => {
-  const schema = getSchema$(entity);
-  if (schema == null) {
-    // Try to extract typename from DXN.
-    return getTypeDXN$(entity)?.asTypeDXN()?.type;
-  }
+export const getTypename = (entity: Unknown | Snapshot): string | undefined => internal.getTypename(entity);
 
-  return 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
 //
 
-export const Meta: unique symbol = MetaId as any;
+/**
+ * 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 = (entity: AnyProperties): ObjectMeta => {
-  const meta = getMeta$(entity);
-  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, (p) => {
+ *   const meta = Obj.getMeta(p);     // 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: Entity.Unknown, source: string): ForeignKey[];
-  (source: string): (entity: Entity.Unknown) => ForeignKey[];
-} = Function.dual(2, (entity: Entity.Unknown, source?: string): ForeignKey[] => {
-  const meta = getMeta(entity);
-  invariant(meta != null, 'Invalid object.');
-  return meta.keys.filter((key) => key.source === source);
-});
+  (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.
- * @param entity
- * @param source
- */
-export const deleteKeys = (entity: Entity.Unknown, source: string) => {
-  const meta = getMeta(entity);
-  for (let i = 0; i < meta.keys.length; i++) {
-    if (meta.keys[i].source === source) {
-      meta.keys.splice(i, 1);
-      i--;
-    }
-  }
-};
+ * 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);
 
-export const addTag = (entity: Entity.Unknown, tag: string) => {
-  const meta = getMeta(entity);
-  meta.tags ??= [];
-  meta.tags.push(tag);
-};
+/**
+ * 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);
 
-export const removeTag = (entity: Entity.Unknown, tag: string) => {
-  const meta = getMeta(entity);
-  if (!meta.tags) {
-    return;
-  }
-  for (let i = 0; i < meta.tags.length; i++) {
-    if (meta.tags[i] === tag) {
-      meta.tags.splice(i, 1);
-      i--;
-    }
-  }
-};
+/**
+ * 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 = (entity: Entity.Unknown): boolean => {
-  const deleted = isDeleted$(entity);
-  invariant(typeof deleted === 'boolean', 'Invalid object.');
-  return deleted;
-};
+export const isDeleted = (entity: Unknown | Snapshot): boolean => objInternal.isDeleted(entity);
 
 //
 // Annotations
 //
 
-export const getLabel = (entity: Entity.Unknown): string | undefined => {
-  const schema = getSchema$(entity);
-  if (schema != null) {
-    return getLabel$(schema, entity);
-  }
-};
+/**
+ * Get the label of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getLabel = (entity: Unknown | Snapshot): string | undefined => internal.getLabel(entity);
 
-export const setLabel = (entity: Entity.Unknown, label: string) => {
-  const schema = getSchema$(entity);
-  if (schema != null) {
-    setLabel$(schema, entity, label);
-  }
-};
+/**
+ * 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);
 
-export const getDescription = (entity: Entity.Unknown): string | undefined => {
-  const schema = getSchema$(entity);
-  if (schema != null) {
-    return getDescription$(schema, entity);
-  }
+/**
+ * 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;
 };
 
-export const setDescription = (entity: Entity.Unknown, description: string) => {
-  const schema = getSchema$(entity);
-  if (schema != null) {
-    setDescription$(schema, entity, description);
-  }
+/**
+ * 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;
 };
 
 //
@@ -346,14 +669,15 @@ export const setDescription = (entity: Entity.Unknown, description: string) => {
 /**
  * JSON representation of an object.
  */
-export type JSON = 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 = (entity: Entity.Unknown): JSON => objectToJSON(entity);
+export const toJSON = (entity: Unknown | Snapshot): JSON => objInternal.objectToJSON(entity);
 
 /**
  * Creates an object from its json representation, performing schema validation.
@@ -363,136 +687,45 @@ export const toJSON = (entity: Entity.Unknown): JSON => objectToJSON(entity);
  *
  * @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 }) => Promise<Any> =
-  objectFromJSON as any;
+export const fromJSON: (
+  json: unknown,
+  options?: { refResolver?: Ref.Resolver; dxn?: DXN; database?: Database.Database },
+) => Promise<Unknown> = objInternal.objectFromJSON as any;
 
-//
-// Sorting
-//
-
-const compare = (a?: string, b?: string) => {
-  if (a == null) {
-    return b == null ? 0 : 1;
-  }
-
-  if (b == null) {
-    return -1;
-  }
-
-  return a.localeCompare(b);
-};
+/**
+ * Comparator function type for sorting objects.
+ * Accepts both reactive objects and snapshots.
+ */
+export type Comparator = internal.Comparator<Unknown | Snapshot>;
 
-export type Comparator = (a: Entity.Unknown, b: Entity.Unknown) => number;
-
-export const sortByLabel: Comparator = (a: Entity.Unknown, b: Entity.Unknown) => compare(getLabel(a), getLabel(b));
-export const sortByTypename: Comparator = (a: Entity.Unknown, b: Entity.Unknown) =>
-  compare(getTypename(a), getTypename(b));
-export const sort = (...comparators: Comparator[]): Comparator => {
-  return (a: Entity.Unknown, b: Entity.Unknown) => {
-    for (const comparator of comparators) {
-      const result = comparator(a, b);
-      if (result !== 0) {
-        return result;
-      }
-    }
-
-    return 0;
-  };
-};
+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
 //
 
-/**
- * Unique symbol for version type identification.
- */
-export { VersionTypeId };
+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 interface Version {
-  [VersionTypeId]: {};
+export type Version = internal.EntityVersion;
 
-  /**
-   * Whether the object is versioned.
-   */
-  versioned: boolean;
-
-  /**
-   * Automerge heads.
-   */
-  automergeHeads?: string[];
-}
-
-const unversioned: Version = {
-  [VersionTypeId]: {},
-  versioned: false,
-};
-
-/**
- * Checks that `obj` is a version object.
- */
-export const isVersion = (entity: unknown): entity is Version => {
-  return entity != null && typeof entity === 'object' && VersionTypeId in entity;
-};
+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 version = (entity: Entity.Unknown): Version => {
-  const version = (entity as any)[ObjectVersionId];
-  if (version === undefined) {
-    return unversioned;
-  }
-
-  return version;
-};
-
-/**
- * Checks that `version` is a valid version object.
- */
-export const versionValid = (version: Version): boolean => {
-  assertArgument(isVersion(version), 'version', 'Invalid version object');
-  return !!version.versioned;
-};
-
-export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
-
-/**
- * Compares two versions.
- * @param version1
- * @param version2
- * @returns 'unversioned' if either object is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
- */
-export const compareVersions = (version1: Version, version2: Version): VersionCompareResult => {
-  assertArgument(isVersion(version1), 'version1', 'Invalid version object');
-  assertArgument(isVersion(version2), 'version2', 'Invalid version object');
-
-  if (!versionValid(version1) || !versionValid(version2)) {
-    return 'unversioned';
-  }
-
-  if (version1.automergeHeads?.length !== version2.automergeHeads?.length) {
-    return 'different';
-  }
-  if (version1.automergeHeads?.some((head) => !version2.automergeHeads?.includes(head))) {
-    return 'different';
-  }
-
-  return 'equal';
-};
-
-export const encodeVersion = (version: Version): string => {
-  return JSON.stringify(version);
-};
-
-export const decodeVersion = (version: string): Version => {
-  const parsed = JSON.parse(version);
-  parsed[VersionTypeId] = {};
-  return parsed;
-};
+export const version = (entity: Unknown | Snapshot): Version => internal.version(entity);