@dxos/echo-atom 0.8.4-main.ef1bc66f44 → 0.8.4-main.fcc0d83b33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-atom",
-  "version": "0.8.4-main.ef1bc66f44",
+  "version": "0.8.4-main.fcc0d83b33",
   "description": "Effect Atom wrappers for ECHO objects with explicit subscriptions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -20,25 +20,25 @@
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
     "@effect-atom/atom": "^0.5.1",
-    "lodash.isequal": "^4.5.0",
-    "@dxos/echo": "0.8.4-main.ef1bc66f44",
-    "@dxos/invariant": "0.8.4-main.ef1bc66f44",
-    "@dxos/echo-db": "0.8.4-main.ef1bc66f44",
-    "@dxos/util": "0.8.4-main.ef1bc66f44"
+    "@dxos/echo": "0.8.4-main.fcc0d83b33",
+    "@dxos/echo-db": "0.8.4-main.fcc0d83b33",
+    "@dxos/invariant": "0.8.4-main.fcc0d83b33",
+    "@dxos/util": "0.8.4-main.fcc0d83b33"
   },
   "devDependencies": {
-    "@types/lodash.isequal": "^4.5.0",
-    "@dxos/random": "0.8.4-main.ef1bc66f44",
-    "@dxos/test-utils": "0.8.4-main.ef1bc66f44"
+    "effect": "3.20.0",
+    "@dxos/context": "0.8.4-main.fcc0d83b33",
+    "@dxos/random": "0.8.4-main.fcc0d83b33",
+    "@dxos/test-utils": "0.8.4-main.fcc0d83b33"
+  },
+  "peerDependencies": {
+    "effect": "3.20.0"
   },
   "publishConfig": {
     "access": "public"

package/src/atom.test.ts

@@ -3,11 +3,12 @@
 //
 
 import * as Registry from '@effect-atom/atom/Registry';
-import { describe, expect, test } from 'vitest';
+import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Obj, Ref } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 
 import * as AtomObj from './atom';
 
@@ -54,7 +55,7 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(registry.get(emailAtom)).toBe('test@example.com');
   });
 
-  test('atom updates when object is mutated via Obj.change', () => {
+  test('atom updates when object is mutated via Obj.update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -71,9 +72,9 @@ describe('Echo Atom - Basic Functionality', () => {
       { immediate: true },
     );
 
-    // Mutate object via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    // Mutate object via Obj.update.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // Subscription should have fired: immediate + update.
@@ -84,7 +85,7 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(obj.name).toBe('Updated');
   });
 
-  test('property atom supports updater pattern via Obj.change', () => {
+  test('property atom supports updater pattern via Obj.update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Task, {
         title: 'Task',
@@ -103,9 +104,9 @@ describe('Echo Atom - Basic Functionality', () => {
       { immediate: true },
     );
 
-    // Update through Obj.change.
-    Obj.change(obj, (o) => {
-      o.title = (o.title ?? '') + ' Updated';
+    // Update through Obj.update.
+    Obj.update(obj, (obj) => {
+      obj.title = (obj.title ?? '') + ' Updated';
     });
 
     // Subscription should have fired: immediate + update.
@@ -139,8 +140,8 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(propertyUpdateCount).toBe(1);
 
     // Mutate the standalone object.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated Standalone';
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated Standalone';
     });
 
     // Both atoms should have received updates.
@@ -243,8 +244,8 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the object.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // The subscription should still work.
@@ -275,8 +276,8 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the specific property.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // The subscription should still work.
@@ -306,3 +307,92 @@ describe('Echo Atom - Referential Equality', () => {
     expect(atom1).toBe(atom2);
   });
 });
+
+describe('AtomObj.makeWithReactive', () => {
+  test('returns object for direct obj input', () => {
+    const obj = createObject(
+      Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
+    );
+
+    const registry = Registry.make();
+    const atom = AtomObj.makeWithReactive(obj);
+    const result = registry.get(atom);
+
+    expect(result).toBe(obj);
+    expect(result?.name).toBe('Test');
+  });
+
+  test('returns same atom for same object', () => {
+    const obj = createObject(
+      Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
+    );
+
+    const atom1 = AtomObj.makeWithReactive(obj);
+    const atom2 = AtomObj.makeWithReactive(obj);
+
+    expect(atom1).toBe(atom2);
+  });
+
+  describe('with ref input', () => {
+    let testBuilder: InstanceType<typeof EchoTestBuilder>;
+
+    beforeEach(async () => {
+      testBuilder = await new EchoTestBuilder().open();
+    });
+
+    afterEach(async () => {
+      await testBuilder.close();
+    });
+
+    test('returns resolved object for ref', async ({ expect }) => {
+      const { db } = await testBuilder.createDatabase({
+        types: [TestSchema.Person, TestSchema.Task],
+      });
+      const task = db.add(Obj.make(TestSchema.Task, { title: 'Task 1' }));
+      const person = db.add(
+        Obj.make(TestSchema.Person, {
+          name: 'Test',
+          username: 'test',
+          email: 'test@example.com',
+          tasks: [Ref.make(task)],
+        }),
+      );
+      await db.flush();
+
+      const ref = person.tasks![0];
+      const registry = Registry.make();
+      const atom = AtomObj.makeWithReactive(ref);
+      const result = registry.get(atom);
+
+      expect(result).toBe(task);
+      expect(result?.title).toBe('Task 1');
+    });
+
+    test('returns undefined when ref target was removed', async ({ expect }) => {
+      const { db } = await testBuilder.createDatabase({
+        types: [TestSchema.Person, TestSchema.Task],
+      });
+      const task = db.add(Obj.make(TestSchema.Task, { title: 'Task 1' }));
+      const person = db.add(
+        Obj.make(TestSchema.Person, {
+          name: 'Test',
+          username: 'test',
+          email: 'test@example.com',
+          tasks: [Ref.make(task)],
+        }),
+      );
+      await db.flush();
+
+      const ref = person.tasks![0];
+      const registry = Registry.make();
+      const atom = AtomObj.makeWithReactive(ref);
+
+      expect(registry.get(atom)).toBe(task);
+
+      db.remove(task);
+      await db.flush();
+
+      expect(registry.get(atom)).toBeUndefined();
+    });
+  });
+});

package/src/atom.ts

@@ -3,9 +3,12 @@
 //
 
 import * as Atom from '@effect-atom/atom/Atom';
-import isEqual from 'lodash.isequal';
+import * as Result from '@effect-atom/atom/Result';
+import * as Effect from 'effect/Effect';
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
 
-import { Obj, Ref } from '@dxos/echo';
+import { type Entity, Obj, Ref, Relation } from '@dxos/echo';
 import { assertArgument } from '@dxos/invariant';
 
 import { loadRefTarget } from './ref-utils';
@@ -23,7 +26,7 @@ const objectFamily = Atom.family(<T extends Obj.Unknown>(obj: T): Atom.Atom<Obj.
     get.addFinalizer(() => unsubscribe());
 
     return Obj.getSnapshot(obj);
-  });
+  }).pipe(Atom.keepAlive);
 });
 
 /**
@@ -48,7 +51,7 @@ const refFamily = Atom.family(<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Ato
     });
 
     return loadRefTarget(ref, get, setupTargetSubscription);
-  });
+  }).pipe(Atom.keepAlive);
 });
 
 /**
@@ -80,7 +83,7 @@ const propertyFamily = Atom.family(<T extends Obj.Unknown>(obj: T) =>
 
       const unsubscribe = Obj.subscribe(obj, () => {
         const newValue = obj[key];
-        if (!isEqual(previousSnapshot, newValue)) {
+        if (previousSnapshot !== newValue) {
           previousSnapshot = snapshotForComparison(newValue);
           // Return a snapshot copy so React sees a new reference.
           get.setSelf(snapshotForComparison(newValue));
@@ -91,43 +94,46 @@ const propertyFamily = Atom.family(<T extends Obj.Unknown>(obj: T) =>
 
       // Return a snapshot copy so React sees a new reference.
       return snapshotForComparison(obj[key]);
-    });
+    }).pipe(Atom.keepAlive);
   }),
 );
 
 /**
- * Create a read-only atom for a reactive object or ref.
- * Works with Echo objects, plain reactive objects (from Obj.make), and Refs.
- * Returns immutable snapshots of the object data (branded with SnapshotKindId).
+ * Create a read-only atom for a single reactive object or ref.
+ * Returns {@link Obj.Snapshot} (immutable plain data), not the live reactive object.
+ * Use this when you need one object's data for display or React dependency tracking.
  * The atom updates automatically when the object is mutated.
  * For refs, automatically handles async loading.
- * Uses Atom.family internally - same object/ref reference returns same atom instance.
+ * Uses Atom.family internally - same object/ref returns same atom instance.
  *
  * @param objOrRef - The reactive object or ref to create an atom for, or undefined.
- * @returns An atom that returns the object snapshot. Returns undefined only for refs (async loading) or undefined input.
+ * @returns An atom that returns the object snapshot (plain data). Returns undefined only for refs (async loading) or undefined input.
  */
 export function make<T extends Obj.Unknown>(obj: T): Atom.Atom<Obj.Snapshot<T>>;
+export function make<T extends Relation.Unknown>(relation: T): Atom.Atom<Relation.Snapshot<T>>;
+export function make<T extends Entity.Unknown>(entity: T): Atom.Atom<Entity.Snapshot>;
 export function make<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Atom<Obj.Snapshot<T> | undefined>;
 export function make<T extends Obj.Unknown>(
   objOrRef: T | Ref.Ref<T> | undefined,
 ): Atom.Atom<Obj.Snapshot<T> | undefined>;
-export function make<T extends Obj.Unknown>(
+export function make<T extends Entity.Unknown>(
   objOrRef: T | Ref.Ref<T> | undefined,
-): Atom.Atom<Obj.Snapshot<T> | undefined> {
+): Atom.Atom<Entity.Snapshot | undefined> {
   if (objOrRef === undefined) {
-    return Atom.make<Obj.Snapshot<T> | undefined>(() => undefined);
+    return Atom.make<Entity.Snapshot | undefined>(() => undefined);
   }
 
   // Handle Ref inputs.
   if (Ref.isRef(objOrRef)) {
-    return refFamily(objOrRef as Ref.Ref<T>);
+    return refFamily(objOrRef as any);
   }
 
   // At this point, objOrRef is definitely T (not a Ref).
   const obj = objOrRef as T;
-  assertArgument(Obj.isObject(obj), 'obj', 'Object must be a reactive object');
+  assertArgument(Obj.isObject(obj) || Relation.isRelation(obj), 'obj', 'Object must be a reactive object');
 
-  return objectFamily(obj);
+  // TODO(dmaretskyi): Fix echo types during review.
+  return objectFamily(obj as any);
 }
 
 /**
@@ -155,6 +161,69 @@ export function makeProperty<T extends Obj.Unknown, K extends keyof T>(
   }
 
   assertArgument(Obj.isObject(obj), 'obj', 'Object must be a reactive object');
-  assertArgument(key in obj, 'key', 'Property must exist on object');
   return propertyFamily(obj)(key);
 }
+
+/**
+ * Atom family for ECHO objects - returns the live object, not a snapshot.
+ * Same as objectFamily but returns T instead of Obj.Snapshot<T>.
+ */
+const objectWithReactiveFamily = Atom.family(<T extends Obj.Unknown>(obj: T): Atom.Atom<T> => {
+  return Atom.make<T>((get) => {
+    const unsubscribe = Obj.subscribe(obj, () => {
+      get.setSelf(obj);
+    });
+
+    get.addFinalizer(() => unsubscribe());
+
+    return obj;
+  }).pipe(Atom.keepAlive);
+});
+
+/**
+ * Atom family for ECHO refs - returns the live reactive object, not a snapshot.
+ * Resolves the ref via the database; returns undefined while loading or if unresolved.
+ */
+const refWithReactiveFamily = Atom.family(<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Atom<T | undefined> => {
+  const effect = (get: Atom.Context) =>
+    Effect.gen(function* () {
+      const snapshot = get(make(ref));
+      if (snapshot == null) {
+        return undefined;
+      }
+      const option = yield* Obj.getReactiveOption(snapshot);
+      return Option.getOrElse(option, () => undefined);
+    });
+
+  return Function.pipe(
+    Atom.make(effect),
+    Atom.map((result) => Result.getOrElse(result, () => undefined)),
+  );
+});
+
+/**
+ * Like {@link make} but returns the live reactive object instead of a snapshot.
+ * Same input: Obj or Ref.Ref. Same output shape: Atom that updates when the object mutates.
+ * Prefer {@link make} (snapshot) unless you need the live Obj.Obj for generic mutations (e.g. Obj.update).
+ *
+ * @param objOrRef - The reactive object or ref.
+ * @returns An atom that returns the live object. Returns undefined for refs (async loading) or undefined input.
+ */
+export function makeWithReactive<T extends Obj.Unknown>(obj: T): Atom.Atom<T>;
+export function makeWithReactive<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Atom<T | undefined>;
+export function makeWithReactive<T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T> | undefined): Atom.Atom<T | undefined>;
+export function makeWithReactive<T extends Obj.Unknown>(
+  objOrRef: T | Ref.Ref<T> | undefined,
+): Atom.Atom<T | undefined> {
+  if (objOrRef === undefined) {
+    return Atom.make<T | undefined>(() => undefined);
+  }
+
+  if (Ref.isRef(objOrRef)) {
+    return refWithReactiveFamily(objOrRef as Ref.Ref<T>);
+  }
+
+  const obj = objOrRef as T;
+  assertArgument(Obj.isObject(obj), 'obj', 'Object must be a reactive object');
+  return objectWithReactiveFamily(obj);
+}

package/src/batching.test.ts

@@ -6,13 +6,13 @@ import * as Registry from '@effect-atom/atom/Registry';
 import { describe, expect, test } from 'vitest';
 
 import { Obj } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { TestSchema } from '@dxos/echo/testing';
 
 import * as AtomObj from './atom';
 
 describe('Echo Atom - Batch Updates', () => {
-  test('multiple updates to same object atom in single Obj.change fire single update', () => {
+  test('multiple updates to same object atom in single Obj.update fire single update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -33,14 +33,14 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1); // Verify immediate update fired.
 
-    // Make multiple updates to the same object in a single Obj.change call.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
-      o.email = 'updated@example.com';
-      o.username = 'updated';
+    // Make multiple updates to the same object in a single Obj.update call.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated1';
+      obj.email = 'updated@example.com';
+      obj.username = 'updated';
     });
 
-    // Should have fired once for initial + once for the Obj.change (not once per property update).
+    // Should have fired once for initial + once for the Obj.update (not once per property update).
     expect(updateCount).toBe(2);
 
     // Verify final state.
@@ -50,7 +50,7 @@ describe('Echo Atom - Batch Updates', () => {
     expect(finalValue.username).toBe('updated');
   });
 
-  test('multiple separate Obj.change calls fire separate updates', () => {
+  test('multiple separate Obj.update calls fire separate updates', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -71,18 +71,18 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1);
 
-    // Make multiple separate Obj.change calls.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
+    // Make multiple separate Obj.update calls.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated1';
     });
-    Obj.change(obj, (o) => {
-      o.email = 'updated@example.com';
+    Obj.update(obj, (obj) => {
+      obj.email = 'updated@example.com';
     });
-    Obj.change(obj, (o) => {
-      o.username = 'updated';
+    Obj.update(obj, (obj) => {
+      obj.username = 'updated';
     });
 
-    // Should have fired once for initial + once per Obj.change call.
+    // Should have fired once for initial + once per Obj.update call.
     expect(updateCount).toBe(4);
 
     // Verify final state.
@@ -92,7 +92,7 @@ describe('Echo Atom - Batch Updates', () => {
     expect(finalValue.username).toBe('updated');
   });
 
-  test('multiple updates to same property atom in single Obj.change fire single update', () => {
+  test('multiple updates to same property atom in single Obj.update fire single update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -113,14 +113,14 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1);
 
-    // Make multiple updates to the same property in a single Obj.change call.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
-      o.name = 'Updated2';
-      o.name = 'Updated3';
+    // Make multiple updates to the same property in a single Obj.update call.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated1';
+      obj.name = 'Updated2';
+      obj.name = 'Updated3';
     });
 
-    // Should have fired once for initial + once for the Obj.change (not once per assignment).
+    // Should have fired once for initial + once for the Obj.update (not once per assignment).
     expect(updateCount).toBe(2);
 
     // Verify final state.