@dxos/echo 0.8.4-main.74a063c4e0 → 0.8.4-main.765dc60934

package/src/Json.ts

@@ -0,0 +1,102 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { DXN } from '@dxos/keys';
+
+import * as Database from './Database';
+import * as Obj from './Obj';
+
+/**
+ * `JSON.stringify` replacer signature.
+ *
+ * Defined here (rather than re-imported from a UI package) so other ECHO-aware utilities can
+ * share a stable signature without creating a dependency edge into the UI tree.
+ */
+export type JsonReplacer = (key: string, value: any) => any;
+
+export type CreateRefReplacerOptions = {
+  db: Database.Database;
+  /** How many ref hops to follow. `0` leaves all refs as-is. Default: `1`. */
+  depth?: number;
+};
+
+const isEncodedRef = (value: unknown): value is { '/': string } =>
+  typeof value === 'object' &&
+  value !== null &&
+  Object.keys(value as object).length === 1 &&
+  typeof (value as { '/': unknown })['/'] === 'string';
+
+const toJson = (obj: Obj.Any): unknown => (typeof (obj as any).toJSON === 'function' ? (obj as any).toJSON() : obj);
+
+/**
+ * Returns a {@link JsonReplacer} that inlines ECHO ref objects (`{ "/": "dxn:echo:..." }`) up to
+ * `depth` ref hops. Beyond that depth refs are left in their encoded form.
+ *
+ * Implemented as a per-call `JSON.stringify` replacer (not a one-shot tree walk at root) so it
+ * composes with wrappers like `safeStringify` that intercept the root call. JSON.stringify
+ * already drives the recursion; we only need to (a) detect a ref at the current callback,
+ * (b) resolve and return the target if hop budget remains, and (c) tag the returned object
+ * with its hop count so children know how far in they are.
+ *
+ * The hop count is tracked per-object via a `WeakMap`: a ref-resolved target's children inherit
+ * `parentHops + 1`; a regular intermediate object's children inherit `parentHops`. This makes the
+ * budget count *ref hops*, not tree depth — a ref deep in a tree still resolves once when
+ * `depth >= 1`.
+ *
+ * Note: ECHO objects' `toJSON` runs before the replacer is invoked, so by the time we see a
+ * value refs are already encoded as `{ "/": "dxn:..." }`.
+ */
+export const createRefReplacer = ({ db, depth = 1 }: CreateRefReplacerOptions): JsonReplacer => {
+  // Per-object hop count. Set when we return an object (via ref resolution or pass-through) so
+  // the child callbacks (which carry that object as `this`) can read it.
+  const hops = new WeakMap<object, number>();
+
+  return function (this: any, key: string, value: any) {
+    // Hop count for this call: hops at the parent, or 0 for the root.
+    const parentHops = this && typeof this === 'object' ? (hops.get(this) ?? 0) : 0;
+    if (isEncodedRef(value)) {
+      if (parentHops >= depth) {
+        return value;
+      }
+
+      // The `{ '/': string }` shape is shared with non-DXN IPLD-style refs (e.g. CIDs);
+      // an unparseable string would otherwise crash the whole `JSON.stringify`.
+      // Treat any parse miss as "leave as-is" rather than propagating.
+      const dxnString = value['/'];
+      if (!dxnString.startsWith('dxn:')) {
+        return value;
+      }
+
+      let echoId: string | undefined;
+      try {
+        echoId = DXN.parse(dxnString).asEchoDXN()?.echoId;
+      } catch {
+        return value;
+      }
+
+      if (!echoId) {
+        return value;
+      }
+      const target = db.getObjectById(echoId);
+      if (!target) {
+        return value;
+      }
+
+      const encoded = toJson(target);
+      if (encoded != null && typeof encoded === 'object') {
+        // Children of the resolved target are one hop deeper.
+        hops.set(encoded as object, parentHops + 1);
+      }
+      return encoded;
+    }
+
+    // Pass-through object: children inherit the parent's hop count (this branch doesn't burn
+    // budget).
+    if (value != null && typeof value === 'object') {
+      hops.set(value, parentHops);
+    }
+
+    return value;
+  };
+};

package/src/Migration.ts

@@ -0,0 +1,106 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+// @import-as-namespace
+
+import type * as Schema from 'effect/Schema';
+
+import { type DXN } from '@dxos/keys';
+
+import type * as Database from './Database';
+import type * as Entity from './Entity';
+import { MetaId, type ObjectMeta, getSchemaDXN } from './internal';
+
+/**
+ * Result returned by a migration's `transform` callback.
+ * The data shape matches the target schema; the optional `[Obj.Meta]` symbol key lets the
+ * transform update the object's meta (e.g. `key` / `version`) atomically with the data swap.
+ */
+export type TransformResult<To extends Schema.Schema.AnyNoContext> = Omit<
+  Schema.Schema.Type<To>,
+  'id' | Entity.KindId
+> & {
+  [MetaId]?: Partial<ObjectMeta>;
+};
+
+type DefineObjectMigrationOptions<From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext> = {
+  from: From;
+  to: To;
+  /**
+   * Pure function that converts the old object data to the new object data.
+   *
+   * The returned object may include an optional `[Obj.Meta]` entry to update the object's meta
+   * (e.g. registry `key` / `version`) atomically with the data swap.
+   */
+  // TODO(dmaretskyi): `id` should not be a part of the schema.
+  transform: (from: Schema.Schema.Type<From>, context: ObjectMigrationContext) => Promise<TransformResult<To>>;
+
+  /**
+   * Callback that is called after the object is migrated. Called for every object that is migrated.
+   *
+   * NOTE: Database mutations performed in this callback are not guaranteed to be idempotent.
+   *       If multiple peers run the migration separately, the effects may be applied multiple times.
+   */
+  onMigration?: (params: OnMigrateProps<From, To>) => Promise<void>;
+};
+
+/**
+ * Context passed to object migration callbacks.
+ */
+export type ObjectMigrationContext = {
+  db: Database.Database;
+};
+
+type OnMigrateProps<From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext> = {
+  before: Schema.Schema.Type<From>;
+  object: Schema.Schema.Type<To>;
+  db: Database.Database;
+};
+
+/**
+ * Definition of a migration from one object schema version to another.
+ */
+export type ObjectMigration = {
+  fromType: DXN;
+  toType: DXN;
+  fromSchema: Schema.Schema.AnyNoContext;
+  toSchema: Schema.Schema.AnyNoContext;
+  transform: (from: unknown, context: ObjectMigrationContext) => Promise<unknown>;
+  onMigration?: (params: OnMigrateProps<any, any>) => Promise<void>;
+};
+
+/**
+ * Define a migration between two object schemas.
+ *
+ * @example
+ * ```ts
+ * const migration = Migration.define({
+ *   from: ContactV1,
+ *   to: ContactV2,
+ *   transform: async (from) => ({ name: `${from.firstName} ${from.lastName}` }),
+ *   onMigration: async () => {},
+ * });
+ * ```
+ */
+export const define = <From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext>(
+  options: DefineObjectMigrationOptions<From, To>,
+): ObjectMigration => {
+  const fromType = getSchemaDXN(options.from);
+  if (!fromType) {
+    throw new Error('Invalid from schema');
+  }
+  const toType = getSchemaDXN(options.to);
+  if (!toType) {
+    throw new Error('Invalid to schema');
+  }
+
+  return {
+    fromType,
+    toType,
+    fromSchema: options.from,
+    toSchema: options.to,
+    transform: options.transform as any,
+    onMigration: options.onMigration as any,
+  };
+};

package/src/Obj.test.ts

@@ -117,7 +117,7 @@ describe('Obj', () => {
 
     test('returns keys from reactive object and snapshot', ({ expect }) => {
       const obj = Obj.make(TestSchema.Person, { name: 'Test' });
-      Obj.change(obj, (obj) => {
+      Obj.update(obj, (obj) => {
         const meta = Obj.getMeta(obj);
         meta.keys.push({ source: SOURCE, id: 'key-1' });
         meta.keys.push({ source: SOURCE, id: 'key-2' });
@@ -166,8 +166,8 @@ describe('Obj', () => {
 
       const cloned = Obj.clone(original);
 
-      Obj.change(original, (obj) => {
-        obj.name = 'Bob';
+      Obj.update(original, (original) => {
+        original.name = 'Bob';
       });
 
       expect(original.name).toBe('Bob');
@@ -206,8 +206,8 @@ describe('Obj', () => {
       expect(cloned.employer?.target).toBe(person.employer?.target);
 
       // Modifying the referenced object affects both
-      Obj.change(employer, (org) => {
-        org.name = 'Updated DXOS';
+      Obj.update(employer, (employer) => {
+        employer.name = 'Updated DXOS';
       });
 
       expect(cloned.employer?.target?.name).toBe('Updated DXOS');
@@ -234,8 +234,8 @@ describe('Obj', () => {
       expect(cloned.employer?.target?.name).toBe(employer.name);
 
       // Modifying the original referenced object does not affect the clone
-      Obj.change(employer, (org) => {
-        org.name = 'Updated DXOS';
+      Obj.update(employer, (employer) => {
+        employer.name = 'Updated DXOS';
       });
 
       expect(cloned.employer?.target?.name).toBe('DXOS');
@@ -333,8 +333,8 @@ describe('Obj', () => {
       expect(cloned.address?.coordinates.lng).toBe(-122.4194);
 
       // Modifying nested properties should be independent
-      Obj.change(person, (obj) => {
-        obj.address!.city = 'New York';
+      Obj.update(person, (person) => {
+        person.address!.city = 'New York';
       });
 
       expect(cloned.address?.city).toBe('San Francisco');
@@ -366,8 +366,8 @@ describe('Obj', () => {
       expect(cloned.tasks?.[2]?.target).not.toBe(task3);
 
       // Modifying original tasks should not affect cloned ones
-      Obj.change(task1, (obj) => {
-        obj.title = 'Updated Task 1';
+      Obj.update(task1, (task1) => {
+        task1.title = 'Updated Task 1';
       });
 
       expect(cloned.tasks?.[0]?.target?.title).toBe('Task 1');
@@ -449,8 +449,8 @@ describe('Obj', () => {
     test('returns false when values already match', () => {
       const target = Obj.make(TestSchema.Organization, { name: 'Acme', properties: { region: 'EU' } });
       const source = Obj.make(TestSchema.Organization, { name: 'Acme', properties: { region: 'EU' } });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source)).toBe(false);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source)).toBe(false);
       });
     });
 
@@ -463,8 +463,8 @@ describe('Obj', () => {
         name: 'New',
         properties: { a: '2', b: '3' },
       });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source)).toBe(true);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source)).toBe(true);
       });
       expect(target.name).toBe('New');
       expect(target.properties).toEqual({ a: '2', b: '3' });
@@ -487,8 +487,8 @@ describe('Obj', () => {
         employer: Ref.make(orgB),
         address: { city: 'Portland', state: 'OR', zip: '97201', coordinates: { lat: 45.5, lng: -122.6 } },
       });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source)).toBe(true);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source)).toBe(true);
       });
       expect(target.employer?.dxn.toString()).toBe(Ref.make(orgB).dxn.toString());
       expect(target.address?.city).toBe('Portland');
@@ -510,8 +510,8 @@ describe('Obj', () => {
         email: 'bob@x.test',
         tasks: [Ref.make(t1), Ref.make(t3)],
       });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source)).toBe(true);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source)).toBe(true);
       });
       expect(target.tasks?.map((r) => r.dxn.toString())).toEqual(source.tasks?.map((r) => r.dxn.toString()));
     });
@@ -519,8 +519,8 @@ describe('Obj', () => {
     test('respects include option', () => {
       const target = Obj.make(TestSchema.Organization, { name: 'Keep', properties: { x: '1' } });
       const source = Obj.make(TestSchema.Organization, { name: 'Drop', properties: { x: '2' } });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source, { include: ['properties'] })).toBe(true);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source, { include: ['properties'] })).toBe(true);
       });
       expect(target.name).toBe('Keep');
       expect(target.properties).toEqual({ x: '2' });
@@ -529,8 +529,8 @@ describe('Obj', () => {
     test('respects exclude option', () => {
       const target = Obj.make(TestSchema.Organization, { name: 'Old', properties: { x: '1' } });
       const source = Obj.make(TestSchema.Organization, { name: 'New', properties: { x: '2' } });
-      Obj.change(target, (mutable) => {
-        expect(Obj.updateFrom(mutable, source, { exclude: ['name'] })).toBe(true);
+      Obj.update(target, (target) => {
+        expect(Obj.updateFrom(target, source, { exclude: ['name'] })).toBe(true);
       });
       expect(target.name).toBe('Old');
       expect(target.properties).toEqual({ x: '2' });

package/src/Obj.ts

@@ -13,7 +13,7 @@ import * as Utils from 'effect/Utils';
 
 import type { ForeignKey } from '@dxos/echo-protocol';
 import { createJsonPath } from '@dxos/effect';
-import { assertArgument } from '@dxos/invariant';
+import { assertArgument, invariant } from '@dxos/invariant';
 import { type DXN, ObjectId } from '@dxos/keys';
 import { assumeType, deepMapValues } from '@dxos/util';
 
@@ -304,7 +304,7 @@ export const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T = objI
 
 /**
  * Makes all properties mutable recursively.
- * Used to provide a mutable view of an object within `Obj.change`.
+ * Used to provide a mutable view of an object within `Obj.update`.
  */
 export type Mutable<T> = internal.Mutable<T>;
 
@@ -312,33 +312,33 @@ 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
+ * when the callback completes. Direct mutations outside of `Obj.update` 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 obj - The echo object to mutate. Use `Relation.update` 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) => {
+ * // Mutate within Obj.update
+ * Obj.update(person, (obj) => {
  *   obj.name = 'Jane';
  *   obj.age = 30;
  * });
  * // ONE notification fires here
  *
  * // Direct mutation throws
- * person.name = 'Bob'; // Error: Cannot modify outside Obj.change()
+ * person.name = 'Bob'; // Error: Cannot modify outside Obj.update()
  * ```
  *
- * Note: Only accepts objects. Use `Relation.change` for relations.
+ * Note: Only accepts objects. Use `Relation.update` for relations.
  */
-export const change = <T extends Unknown>(obj: T, callback: internal.ChangeCallback<T>): void => {
+export const update = <T extends Unknown>(obj: T, callback: internal.ChangeCallback<T>): void => {
   internal.change(obj, callback);
 };
 
@@ -373,7 +373,7 @@ export const getValue = (obj: Unknown | Snapshot, path: readonly (string | numbe
  * 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.
+ * Must be called within an `Obj.update` 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.
@@ -387,7 +387,7 @@ export const getValue = (obj: Unknown | Snapshot, path: readonly (string | numbe
  * ```ts
  * const person = Obj.make(Person, { name: 'John' });
  * // Person schema has: addresses: Schema.Array(Address)
- * Obj.change(person, (obj) => {
+ * Obj.update(person, (obj) => {
  *   Obj.setValue(obj, ['addresses', 0, 'street'], '123 Main St');
  * });
  * // Creates: person.addresses = [{ street: '123 Main St' }]
@@ -470,16 +470,19 @@ export const getDXN = (entity: Unknown | Snapshot): DXN => {
 /**
  * @returns The DXN of the object's type.
  * @example dxn:com.example.type.person:1.0.0
+ * @throws If the object is missing its type (corrupted object).
  */
-// TODO(wittjosiah): Narrow types.
-export const getTypeDXN: (obj: unknown | undefined) => DXN | undefined = internal.getTypeDXN as any;
+export const getTypeDXN = (obj: Unknown | Snapshot): DXN => {
+  const type = internal.getTypeDXN(obj);
+  invariant(type != null, 'Corrupted object: missing type.');
+  return type;
+};
 
 /**
  * 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;
+export const getSchema: (obj: Unknown | Snapshot) => Type.AnyEntity | undefined = internal.getSchema as any;
 
 /**
  * @returns The typename of the object's type.
@@ -517,7 +520,7 @@ export const Meta = internal.MetaId;
 export type ReadonlyMeta = internal.ReadonlyMeta;
 
 /**
- * Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
+ * Mutable meta type returned by `Obj.getMeta` inside an `Obj.update` callback.
  */
 export type Meta = internal.Meta;
 
@@ -525,7 +528,7 @@ export type Meta = internal.Meta;
 // TODO(dmaretskyi): Allow returning undefined.
 /**
  * Get the metadata for an object.
- * Returns mutable meta when passed a mutable object (inside `Obj.change` callback).
+ * Returns mutable meta when passed a mutable object (inside `Obj.update` callback).
  * Returns read-only meta when passed a regular object or snapshot.
  *
  * @example
@@ -534,7 +537,7 @@ export type Meta = internal.Meta;
  * const meta = Obj.getMeta(person);  // ReadonlyMeta
  *
  * // Mutable access inside change callback
- * Obj.change(person, (obj) => {
+ * Obj.update(person, (obj) => {
  *   const meta = Obj.getMeta(obj);     // ObjectMeta (mutable)
  *   meta.tags ??= [];
  *   meta.tags.push('important');
@@ -559,7 +562,7 @@ export const getKeys: {
 
 /**
  * Delete all keys from the object for the specified source.
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` 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.
@@ -568,7 +571,7 @@ export const deleteKeys = (entity: Mutable<Unknown>, source: string): void => in
 
 /**
  * Add a tag to the object.
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` 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.
@@ -577,7 +580,7 @@ export const addTag = (entity: Mutable<Unknown>, tag: string): void => internal.
 
 /**
  * Remove a tag from the object.
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` 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.
@@ -603,7 +606,7 @@ export const getLabel = (entity: Unknown | Snapshot): string | undefined => inte
 
 /**
  * Set the label of the object.
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` 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.
@@ -618,7 +621,7 @@ export const getDescription = (entity: Unknown | Snapshot): string | undefined =
 
 /**
  * Set the description of the object.
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` 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.
@@ -741,7 +744,7 @@ const prepareAssignValue = (value: unknown): unknown =>
  * References are compared by target DXN; other values use Effect `Equal.equals` inside a structural region,
  * with recursive comparison for arrays and plain object-shaped property bags (excluding `id`).
  *
- * Must be called within an `Obj.change` callback.
+ * Must be called within an `Obj.update` callback.
  *
  * @returns Whether any property was updated.
  */
@@ -808,7 +811,7 @@ export const toJSON = (entity: Unknown | Snapshot): JSON => objInternal.objectTo
  */
 export const fromJSON: (
   json: unknown,
-  options?: { refResolver?: Ref.Resolver; dxn?: DXN; database?: Database.Database },
+  options?: { refResolver?: Ref.Resolver; dxn?: DXN; database?: Database.Database; parent?: Unknown },
 ) => Promise<Unknown> = objInternal.objectFromJSON as any;
 
 /**