@dxos/echo 0.8.4-main.e8ec1fe → 0.8.4-main.ef1bc66f44

package/src/Obj.ts

@@ -5,21 +5,75 @@
 import * as Function from 'effect/Function';
 import * as Schema from 'effect/Schema';
 
-import { assertArgument, invariant } from '@dxos/invariant';
-import { type DXN } from '@dxos/keys';
-import * as LiveObject from '@dxos/live-object';
-import { assumeType, deepMapValues } from '@dxos/util';
-
-import { live } from './internal';
-import * as EchoSchema from './internal';
+import type { ForeignKey } from '@dxos/echo-protocol';
+import { createJsonPath, getValue as getValue$ } 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 {
+  type ObjectJSON as APIJSON,
+  type AnyEntity,
+  type AnyProperties,
+  type Comparator as ApiComparator,
+  type Meta as ApiMeta,
+  type ReadonlyMeta as ApiReadonlyMeta,
+  type EntityVersion as ApiVersion,
+  type ChangeCallback,
+  type InternalObjectProps,
+  type KindId,
+  MetaId,
+  type Mutable,
+  type ObjectMeta,
+  // TODO(dmaretskyi): Export ParentId?
+  ParentId,
+  type SnapshotKindId,
+  type VersionCompareResult,
+  VersionTypeId,
+  addTag as addTag$,
+  change as change$,
+  clone as clone$,
+  compareVersions,
+  decodeVersion,
+  deleteKeys as deleteKeys$,
+  encodeVersion,
+  getDXN as getDXN$,
+  getDatabase as getDatabase$,
+  getDescription as getDescription$,
+  getKeys as getKeys$,
+  getLabel as getLabel$,
+  getMetaChecked as getMeta$,
+  getSchema as getSchema$,
+  getSnapshot as getSnapshot$,
+  getTypeAnnotation,
+  getTypeDXN as getTypeDXN$,
+  getTypename as getTypename$,
+  isDeleted as isDeleted$,
+  isInstanceOf,
+  isVersion,
+  makeObject,
+  objectFromJSON,
+  removeTag as removeTag$,
+  setDescription as setDescription$,
+  setLabel as setLabel$,
+  setValue as setValue$,
+  sort as sort$,
+  sortByLabel as sortByLabel$,
+  sortByTypename as sortByTypename$,
+  subscribe as subscribe$,
+  objectToJSON as toJSON$,
+  version as version$,
+  versionValid,
+} from './internal';
 import type * as Ref from './Ref';
-import type * as Relation from './Relation';
-import * as Type from './Type';
+import type * as Type from './Type';
 
 /**
- * NOTE: Don't export: Obj.Any and Obj.Obj form the public API.
+ * Base type for all ECHO objects.
  */
-interface BaseObj extends EchoSchema.HasId, Type.OfKind<EchoSchema.EntityKind.Object> {}
+interface BaseObj extends AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {}
 
 /**
  * Object type with specific properties.
@@ -27,42 +81,65 @@ interface BaseObj extends EchoSchema.HasId, Type.OfKind<EchoSchema.EntityKind.Ob
 export type Obj<Props> = BaseObj & Props;
 
 /**
- * Base type for all ECHO objects.
- * This type does not define any properties.
+ * 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 BaseObj {}
+export interface Unknown extends BaseObj {}
 
 /**
  * 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 AnyProps extends BaseObj {
-  [key: string]: any;
-}
+export interface Any extends BaseObj, AnyProperties {}
 
-export const Any = Schema.Struct({}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/types/Any',
-    version: '0.1.0',
-  }),
-);
+/**
+ * Base type for snapshot objects (has SnapshotKindId instead of KindId).
+ */
+interface BaseSnapshot extends AnyEntity {
+  readonly [SnapshotKindId]: typeof Entity.Kind.Object;
+  readonly id: ObjectId;
+}
 
-type Props<T = any> = { id?: EchoSchema.ObjectId } & Type.Properties<T>;
+/**
+ * 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, KindId> & BaseSnapshot;
 
-export type MakeProps<T extends Type.Obj.Any> = NoInfer<Props<Schema.Schema.Type<T>>> & {
-  [Meta]?: Partial<EchoSchema.ObjectMeta>;
+const defaultMeta: ObjectMeta = {
+  keys: [],
 };
 
-export const Meta: unique symbol = EchoSchema.MetaId as any;
+type Props<T = any> = {
+  id?: ObjectId;
+  [Meta]?: Partial<ObjectMeta>;
+} & Type.Properties<T>;
 
-const DEFAULT_META: EchoSchema.ObjectMeta = {
-  keys: [],
-};
+// 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<ObjectMeta>;
+  [Parent]?: Unknown;
+} & NoInfer<Props<Schema.Schema.Type<S>>>;
 
 /**
- * Creates new object.
+ * 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.
@@ -73,41 +150,207 @@ const DEFAULT_META: EchoSchema.ObjectMeta = {
  * ```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.Obj.Any>(
+export const make: {
+  <S extends Type.Obj.Any>(schema: S, props: MakeProps<S>): Obj<Schema.Schema.Type<S>>;
+  /**
+   * @deprecated Pass meta as in the example: `Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' })`.
+   */
+  <S extends Type.Obj.Any>(schema: S, props: MakeProps<S>, meta: Partial<ObjectMeta>): Obj<Schema.Schema.Type<S>>;
+} = <S extends Type.Obj.Any>(
   schema: S,
   props: MakeProps<S>,
-  meta?: Partial<EchoSchema.ObjectMeta>,
-): LiveObject.Live<Schema.Schema.Type<S>> => {
-  assertArgument(
-    EchoSchema.getTypeAnnotation(schema)?.kind === EchoSchema.EntityKind.Object,
-    'schema',
-    'Expected an object schema',
-  );
-
-  if (props[EchoSchema.MetaId] != null) {
-    // Set default fields on meta on creation.
-    meta = { ...structuredClone(DEFAULT_META), ...props[EchoSchema.MetaId] };
-    delete props[EchoSchema.MetaId];
+  meta?: Partial<ObjectMeta>,
+): Obj<Schema.Schema.Type<S>> => {
+  assertArgument(getTypeAnnotation(schema)?.kind === Entity.Kind.Object, 'schema', 'Expected an object schema');
+
+  // Set default fields on meta on creation.
+  if (props[MetaId] != null) {
+    meta = { ...structuredClone(defaultMeta), ...props[MetaId] };
+    delete props[MetaId];
+  }
+
+  // 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;
+    }
   }
 
-  const filterUndefined = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
+  return 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<InternalObjectProps>(obj);
+  return typeof obj === 'object' && obj !== null && obj[Entity.KindId] === 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 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> = getSnapshot$ as any;
+
+export type CloneOptions = {
+  /**
+   * Retain the original object's ID.
+   * @default false
+   */
+  retainId?: boolean;
+
+  /**
+   * Recursively clone referenced objects.
+   * @default false
+   */
+  deep?: boolean;
+};
+
+/**
+ * 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 = clone$;
+
+//
+// Change
+//
+
+/**
+ * Makes all properties mutable recursively.
+ * Used to provide a mutable view of an object within `Obj.change`.
+ */
+export type { Mutable };
 
-  return live<Schema.Schema.Type<S>>(schema, filterUndefined as any, { keys: [], ...meta });
+/**
+ * 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: ChangeCallback<T>): void => {
+  change$(obj, callback);
 };
 
-export const isObject = (obj: unknown): obj is Any => {
-  assumeType<EchoSchema.InternalObjectProps>(obj);
-  return typeof obj === 'object' && obj !== null && obj[EchoSchema.EntityKindId] === EchoSchema.EntityKind.Object;
+/**
+ * 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 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 =
+  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)) {
  *   // john is Person
@@ -115,317 +358,274 @@ export const isObject = (obj: unknown): obj is Any => {
  * ```
  */
 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.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]) => {
   if (args.length === 1) {
-    return (obj: unknown) => EchoSchema.isInstanceOf(args[0], obj);
+    return (entity: unknown) => isInstanceOf(args[0], entity);
   }
 
-  return EchoSchema.isInstanceOf(args[0], args[1]);
+  return isInstanceOf(args[0], args[1]);
 }) as any;
 
-export const getSchema = EchoSchema.getSchema;
-
 // TODO(dmaretskyi): Allow returning undefined.
-export const getDXN = (obj: Any | Relation.Any): DXN => {
-  assertArgument(!Schema.isSchema(obj), '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 getDXN$(entity);
 };
 
 /**
  * @returns The DXN of the object's type.
  * @example dxn:example.com/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 = 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.Entity.Any | undefined = getSchema$ as any;
 
 /**
  * @returns The typename of the object's type.
+ * Accepts both reactive objects and snapshots.
  * @example `example.com/type/Person`
  */
-export const getTypename = (obj: Any | Relation.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 => 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 =>
+  getDatabase$(entity);
+
+//
+// Meta
+//
+
+export const Meta: unique symbol = MetaId as any;
+
+/**
+ * Deeply read-only version of ObjectMeta.
+ * Prevents mutation at all nesting levels (e.g., `meta.keys.push()` is a TypeScript error).
+ */
+export type ReadonlyMeta = ApiReadonlyMeta;
+
+/**
+ * Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
+ */
+export type Meta = ApiMeta;
 
+// TODO(burdon): Narrow type.
 // TODO(dmaretskyi): Allow returning undefined.
-export const getMeta = (obj: Any | Relation.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, (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 getMeta$(entity);
+}
 
 /**
  * @returns Foreign keys for the object from the specified source.
+ * Accepts both reactive objects and snapshots.
  */
 export const getKeys: {
-  (obj: Any | Relation.Any, source: string): EchoSchema.ForeignKey[];
-  (source: string): (obj: Any | Relation.Any) => EchoSchema.ForeignKey[];
-} = Function.dual(2, (obj: Any | Relation.Any, source?: string): EchoSchema.ForeignKey[] => {
-  const meta = EchoSchema.getMeta(obj);
-  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[] => getKeys$(entity, source!));
 
 /**
  * Delete all keys from the object for the specified source.
- * @param obj
- * @param source
- */
-export const deleteKeys = (obj: Any | Relation.Any, source: string) => {
-  const meta = EchoSchema.getMeta(obj);
-  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 => deleteKeys$(entity, source);
 
-// TODO(dmaretskyi): Default to `false`.
-export const isDeleted = (obj: Any | Relation.Any): boolean => {
-  const deleted = EchoSchema.isDeleted(obj);
-  invariant(typeof deleted === 'boolean', 'Invalid object.');
-  return deleted;
-};
+/**
+ * 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 => addTag$(entity, tag);
 
-export const getLabel = (obj: Any | Relation.Any): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    return EchoSchema.getLabel(schema, obj);
-  }
-};
+/**
+ * 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 => removeTag$(entity, tag);
 
-export const setLabel = (obj: Any | Relation.Any, label: string) => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    EchoSchema.setLabel(schema, obj, label);
-  }
-};
+/**
+ * Check if the object is deleted.
+ * Accepts both reactive objects and snapshots.
+ */
+// TODO(dmaretskyi): Default to `false`.
+export const isDeleted = (entity: Unknown | Snapshot): boolean => isDeleted$(entity);
 
-export const getDescription = (obj: Any | Relation.Any): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    return EchoSchema.getDescription(schema, obj);
-  }
-};
+//
+// Annotations
+//
 
-export const setDescription = (obj: Any | Relation.Any, description: string) => {
-  const schema = getSchema(obj);
-  if (schema != null) {
-    EchoSchema.setDescription(schema, obj, description);
-  }
-};
+/**
+ * Get the label of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getLabel = (entity: Unknown | Snapshot): string | undefined => getLabel$(entity);
 
-export const addTag = (obj: Any | Relation.Any, tag: string) => {
-  const meta = getMeta(obj);
-  meta.tags ??= [];
-  meta.tags.push(tag);
-};
+/**
+ * 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 => setLabel$(entity, label);
 
-export const removeTag = (obj: Any | Relation.Any, tag: string) => {
-  const meta = getMeta(obj);
-  if (!meta.tags) {
-    return;
-  }
-  for (let i = 0; i < meta.tags.length; i++) {
-    if (meta.tags[i] === tag) {
-      meta.tags.splice(i, 1);
-      i--;
-    }
-  }
-};
+/**
+ * Get the description of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export const getDescription = (entity: Unknown | Snapshot): string | undefined => getDescription$(entity);
 
-const compare = (a?: string, b?: string) => {
-  if (a == null) {
-    return b == null ? 0 : 1;
-  }
+/**
+ * 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 =>
+  setDescription$(entity, description);
 
-  if (b == null) {
-    return -1;
-  }
+/**
+ * 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 = ParentId as any;
 
-  return a.localeCompare(b);
+/**
+ * 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<InternalObjectProps>(entity);
+  return entity[ParentId] as Unknown | undefined;
 };
 
-export type Comparator = (a: Any, b: Any) => number;
-
-export const sortByLabel: Comparator = (a: Any, b: Any) => compare(getLabel(a), getLabel(b));
-export const sortByTypename: Comparator = (a: Any, b: Any) => compare(getTypename(a), getTypename(b));
-export const sort = (...comparators: Comparator[]): Comparator => {
-  return (a: Any, b: Any) => {
-    for (const comparator of comparators) {
-      const result = comparator(a, b);
-      if (result !== 0) {
-        return result;
-      }
-    }
-
-    return 0;
-  };
+/**
+ * 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<InternalObjectProps>(entity);
+  assumeType<InternalObjectProps | undefined>(parent);
+  entity[ParentId] = parent;
 };
 
+//
+// JSON
+//
+
 /**
  * JSON representation of an object.
  */
-export type JSON = EchoSchema.ObjectJSON;
+export type JSON = APIJSON;
 
 /**
  * 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.
  */
-// TODO(burdon): Base util type for Obj/Relation?
-export const toJSON = (obj: Any | Relation.Any): JSON => EchoSchema.objectToJSON(obj);
+export const toJSON = (entity: Unknown | Snapshot): JSON => toJSON$(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`.
  */
-export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver; dxn?: DXN }) => Promise<Any> =
-  EchoSchema.objectFromJSON as any;
+export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver; dxn?: DXN }) => Promise<Unknown> =
+  objectFromJSON as any;
 
 /**
- * Returns an immutable snapshot of an object.
+ * Comparator function type for sorting objects.
+ * Accepts both reactive objects and snapshots.
  */
-export const getSnapshot: <T extends Any>(obj: Obj<T>) => T = LiveObject.getSnapshot;
+export type Comparator = ApiComparator<Unknown | Snapshot>;
 
-export type CloneOptions = {
-  /**
-   * Retain the original object's ID.
-   * @default false
-   */
-  retainId?: boolean;
-};
+export const sortByLabel: Comparator = sortByLabel$ as Comparator;
+export const sortByTypename: Comparator = sortByTypename$ as Comparator;
+export const sort = (...comparators: Comparator[]): Comparator => sort$(...comparators) as Comparator;
 
-/**
- * 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 Any | Relation.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 (EchoSchema.Ref.isRef(value)) {
-      return value;
-    }
-    return recurse(value);
-  });
-  if (opts?.retainId) {
-    props.id = id;
-  }
-  const meta = getMeta(obj);
-  props[EchoSchema.MetaId] = deepMapValues(meta, (value, recurse) => {
-    if (EchoSchema.Ref.isRef(value)) {
-      return value;
-    }
-    return recurse(value);
-  });
-  return make(schema, props);
-};
+//
+// Version
+//
 
-export const VersionTypeId = EchoSchema.VersionTypeId;
-export type VersionType = typeof VersionTypeId;
+export { VersionTypeId };
+export type { VersionCompareResult };
 
 /**
  * Represent object version.
  * May be backed by Automerge.
  * Objects with no history are not versioned.
  */
-export interface Version {
-  [VersionTypeId]: {};
+export type Version = ApiVersion;
 
-  /**
-   * 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 = (obj: unknown): obj is Version => {
-  return obj != null && typeof obj === 'object' && VersionTypeId in obj;
-};
+export { isVersion, versionValid, compareVersions, encodeVersion, decodeVersion };
 
 /**
  * Returns the version of the object.
+ * Accepts both reactive objects and snapshots.
  */
-export const version = (obj: Any | Relation.Any): Version => {
-  const version = (obj as any)[EchoSchema.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 => version$(entity);