@dxos/echo-solid 0.8.4-main.ef1bc66f44 → 0.8.4-main.effb148878

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-solid",
-  "version": "0.8.4-main.ef1bc66f44",
+  "version": "0.8.4-main.effb148878",
   "description": "Solid.js integration for ECHO.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/dxos/dxos"
   },
-  "license": "MIT",
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": false,
   "type": "module",
@@ -20,9 +20,6 @@
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
@@ -30,19 +27,19 @@
   "dependencies": {
     "@effect-atom/atom": "^0.5.1",
     "@solid-primitives/utils": "^6.3.2",
-    "@dxos/echo": "0.8.4-main.ef1bc66f44",
-    "@dxos/echo-atom": "0.8.4-main.ef1bc66f44",
-    "@dxos/effect-atom-solid": "0.8.4-main.ef1bc66f44"
+    "@dxos/echo": "0.8.4-main.effb148878",
+    "@dxos/echo-atom": "0.8.4-main.effb148878",
+    "@dxos/effect-atom-solid": "0.8.4-main.effb148878"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",
-    "solid-js": "^1.9.9",
-    "vite-plugin-solid": "^2.11.10",
-    "vitest": "3.2.4",
-    "@dxos/echo-db": "0.8.4-main.ef1bc66f44"
+    "solid-js": "^1.9.11",
+    "vite-plugin-solid": "^2.11.12",
+    "vitest": "4.1.7",
+    "@dxos/echo-db": "0.8.4-main.effb148878"
   },
   "peerDependencies": {
-    "solid-js": "^1.9.9"
+    "solid-js": "^1.9.11"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -4,4 +4,4 @@
 
 export * from './useObject';
 export * from './useQuery';
-export * from './useSchema';
+export * from './useType';

package/src/useObject.test.tsx

@@ -8,8 +8,8 @@ import { describe, expect, test } from 'vitest';
 
 import type { Entity } from '@dxos/echo';
 import { Obj } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { TestSchema } from '@dxos/echo/testing';
 import { Registry } from '@dxos/effect-atom-solid';
 import { RegistryProvider } from '@dxos/effect-atom-solid';
 
@@ -86,9 +86,9 @@ describe('useObject', () => {
     expect(result).toBe('Test');
     expect(getByTestId('value').textContent).toBe('Test');
 
-    // Update the property via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    // Update the property via Obj.update.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // Wait for reactivity to update.
@@ -118,9 +118,9 @@ describe('useObject', () => {
     expect(valueAccessor?.()?.name).toBe('Test');
     expect(getByTestId('name').textContent).toBe('Test');
 
-    // Update a property via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    // Update a property via Obj.update.
+    Obj.update(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // Wait for reactivity to update.
@@ -149,9 +149,9 @@ describe('useObject', () => {
 
     expect(result).toBe('Test');
 
-    // Update a different property via Obj.change.
-    Obj.change(obj, (o) => {
-      o.email = 'newemail@example.com';
+    // Update a different property via Obj.update.
+    Obj.update(obj, (obj) => {
+      obj.email = 'newemail@example.com';
     });
 
     // Name should still be 'Test'.

package/src/useObject.ts

@@ -160,20 +160,20 @@ export function useObject<T extends Obj.Unknown, K extends keyof T>(
       return;
     }
 
-    Obj.change(obj, (o: any) => {
+    Obj.update(obj, (obj: any) => {
       if (typeof updateOrValue === 'function') {
-        const returnValue = (updateOrValue as (obj: unknown) => unknown)(property !== undefined ? o[property] : o);
+        const returnValue = (updateOrValue as (obj: unknown) => unknown)(property !== undefined ? obj[property] : obj);
         if (returnValue !== undefined) {
           if (property === undefined) {
             throw new Error('Cannot re-assign the entire object');
           }
-          o[property] = returnValue;
+          obj[property] = returnValue;
         }
       } else {
         if (property === undefined) {
           throw new Error('Cannot re-assign the entire object');
         }
-        o[property] = updateOrValue;
+        obj[property] = updateOrValue;
       }
     });
   };
@@ -182,8 +182,9 @@ export function useObject<T extends Obj.Unknown, K extends keyof T>(
     // For property subscriptions on refs, we subscribe to trigger re-render on load.
     useObjectValue(registry, objOrRef);
     return [useObjectProperty(registry, liveObj, property), callback as ObjectPropUpdateCallback<T[K]>];
+  } else {
+    return [useObjectValue(registry, objOrRef), callback as ObjectUpdateCallback<T>];
   }
-  return [useObjectValue(registry, objOrRef), callback as ObjectUpdateCallback<T>];
 }
 
 /**
@@ -301,7 +302,7 @@ export const useObjects = <T extends Obj.Unknown>(refs: MaybeAccessor<readonly R
     const subscribeToTarget = (ref: Ref.Ref<T>) => {
       const target = ref.target;
       if (target) {
-        const key = ref.dxn.toString();
+        const key = ref.uri;
         if (!targetUnsubscribes.has(key)) {
           targetUnsubscribes.set(key, Obj.subscribe(target, triggerUpdate));
         }

package/src/useQuery.test.tsx

@@ -7,8 +7,8 @@ import { type JSX, createSignal } from 'solid-js';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Filter, Obj, Query } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 
 import { useQuery } from './useQuery';
 

package/src/{useSchema.test.tsx → useType.test.tsx}

@@ -7,12 +7,12 @@ import { type JSX, createMemo } from 'solid-js';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Type } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 
-import { useSchema } from './useSchema';
+import { useType } from './useType';
 
-describe('useSchema', () => {
+describe('useType', () => {
   let testBuilder: EchoTestBuilder;
   let db: any;
 
@@ -30,7 +30,7 @@ describe('useSchema', () => {
     let result: any;
 
     render(() => {
-      const schema = useSchema(undefined, 'dxos.test.Person');
+      const schema = useType(undefined, 'dxos.test.Person');
       result = schema();
       return (<div>test</div>) as JSX.Element;
     });
@@ -42,7 +42,7 @@ describe('useSchema', () => {
     let result: any;
 
     render(() => {
-      const schema = useSchema(db, undefined);
+      const schema = useType(db, undefined);
       result = schema();
       return (<div>test</div>) as JSX.Element;
     });
@@ -54,7 +54,7 @@ describe('useSchema', () => {
     let result: any;
 
     render(() => {
-      const schema = useSchema(db, 'dxos.test.NonExistent');
+      const schema = useType(db, 'dxos.test.NonExistent');
       result = schema();
       return (<div>test</div>) as JSX.Element;
     });
@@ -72,7 +72,7 @@ describe('useSchema', () => {
     let schemaAccessor: (() => any) | undefined;
 
     function TestComponent() {
-      const schema = useSchema(db, registeredSchema.typename);
+      const schema = useType(db, Type.getTypename(registeredSchema)!);
       schemaAccessor = schema;
       const t = createMemo(() => {
         const s = schema();
@@ -84,13 +84,13 @@ describe('useSchema', () => {
     const { getByTestId } = render(() => <TestComponent />);
 
     await waitFor(() => {
-      expect(getByTestId('typename').textContent).toBe(registeredSchema.typename);
+      expect(getByTestId('typename').textContent).toBe(Type.getTypename(registeredSchema)!);
     });
 
     // Get the actual result from the accessor
     const result = schemaAccessor?.();
     expect(result).toBeDefined();
-    expect(result?.typename).toBe(registeredSchema.typename);
+    expect(Type.getTypename(result!)).toBe(Type.getTypename(registeredSchema)!);
   });
 
   test.skip('updates when schema is added', async () => {
@@ -100,10 +100,10 @@ describe('useSchema', () => {
     // The runtime registry query subscription doesn't fire when schemas are registered.
     // See: packages/core/echo/echo-db/src/proxy-db/runtime-schema-registry.ts:57
     let schemaAccessor: (() => any) | undefined;
-    const typename = 'example.com/type/Person';
+    const typename = 'com.example.type.person';
 
     function TestComponent() {
-      const schema = useSchema(db, typename);
+      const schema = useType(db, typename);
       schemaAccessor = schema;
       const t = createMemo(() => {
         const s = schema();
@@ -125,13 +125,13 @@ describe('useSchema', () => {
     // The schema registry query should pick up the new schema
     // It reads from db.graph.schemaRegistry.schemas which should include the newly registered schema
     await waitFor(() => {
-      expect(getByTestId('typename').textContent).toBe(registeredSchema.typename);
+      expect(getByTestId('typename').textContent).toBe(Type.getTypename(registeredSchema)!);
     });
 
     // Get the actual result from the accessor
     const result = schemaAccessor?.();
     expect(result).toBeDefined();
-    expect(result?.typename).toBe(registeredSchema.typename);
+    expect(Type.getTypename(result!)).toBe(Type.getTypename(registeredSchema)!);
   });
 
   test('accepts reactive database accessor', async () => {
@@ -141,7 +141,7 @@ describe('useSchema', () => {
     let dbAccessor: any = db;
 
     function TestComponent() {
-      const schema = useSchema(() => dbAccessor, registeredSchema.typename);
+      const schema = useType(() => dbAccessor, Type.getTypename(registeredSchema)!);
       schemaAccessor = schema;
       const t = createMemo(() => {
         const s = schema();
@@ -153,7 +153,7 @@ describe('useSchema', () => {
     const { getByTestId } = render(() => <TestComponent />);
 
     await waitFor(() => {
-      expect(getByTestId('typename').textContent).toBe(registeredSchema.typename);
+      expect(getByTestId('typename').textContent).toBe(Type.getTypename(registeredSchema)!);
     });
 
     // Get the actual result from the accessor
@@ -172,10 +172,10 @@ describe('useSchema', () => {
     const [registeredSchema] = await db.schemaRegistry.register([TestSchema.Person]);
 
     let schemaAccessor: (() => any) | undefined;
-    let typename: string | undefined = registeredSchema.typename;
+    let typename: string | undefined = Type.getTypename(registeredSchema)!;
 
     function TestComponent() {
-      const schema = useSchema(db, () => typename);
+      const schema = useType(db, () => typename);
       schemaAccessor = schema;
       const t = createMemo(() => {
         const s = schema();
@@ -187,20 +187,20 @@ describe('useSchema', () => {
     const { getByTestId } = render(() => <TestComponent />);
 
     await waitFor(() => {
-      expect(getByTestId('typename').textContent).toBe(registeredSchema.typename);
+      expect(getByTestId('typename').textContent).toBe(Type.getTypename(registeredSchema)!);
     });
 
     // Get the actual result from the accessor
     let result = schemaAccessor?.();
     expect(result).toBeDefined();
-    expect(result?.typename).toBe(registeredSchema.typename);
+    expect(Type.getTypename(result!)).toBe(Type.getTypename(registeredSchema)!);
 
     // Change typename
     typename = undefined;
 
     await waitFor(() => {
       // Should keep previous value when typename becomes undefined
-      expect(getByTestId('typename').textContent).toBe(registeredSchema.typename);
+      expect(getByTestId('typename').textContent).toBe(Type.getTypename(registeredSchema)!);
     });
     result = schemaAccessor?.();
     expect(result).toBeDefined();

package/src/{useSchema.ts → useType.ts}

@@ -9,18 +9,18 @@ import { type Database, type Type } from '@dxos/echo';
 type MaybeAccessor<T> = T | Accessor<T>;
 
 /**
- * Subscribe to and retrieve schema changes from a database's schema registry.
+ * Subscribe to and retrieve type changes from a database's schema registry.
  * Accepts either values or accessors for db and typename.
  *
  * @param db - The database instance (can be reactive)
- * @param typename - The schema typename to query (can be reactive)
- * @returns An accessor that returns the current schema or undefined
+ * @param typename - The typename to query (can be reactive)
+ * @returns An accessor that returns the current type or undefined
  */
-export const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(
+export const useType = (
   db?: MaybeAccessor<Database.Database | undefined>,
   typename?: MaybeAccessor<string | undefined>,
-): Accessor<T | undefined> => {
-  // Derive the schema query reactively
+): Accessor<Type.Type | undefined> => {
+  // Derive the type query reactively
   const query = createMemo(() => {
     const resolvedDb = typeof db === 'function' ? db() : db;
     const resolvedTypename = typeof typename === 'function' ? typename() : typename;
@@ -30,8 +30,8 @@ export const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(
     return resolvedDb.schemaRegistry.query({ typename: resolvedTypename, location: ['database', 'runtime'] });
   });
 
-  // Store the current schema in a signal
-  const [schema, setSchema] = createSignal<T | undefined>(undefined);
+  // Store the current type in a signal
+  const [type, setType] = createSignal<Type.Type | undefined>(undefined);
 
   // Subscribe to query changes
   createEffect(() => {
@@ -47,7 +47,7 @@ export const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(
       () => {
         // Access results inside the callback to ensure query is running
         const results = q.results;
-        setSchema(() => results[0] as T | undefined);
+        setType(() => results[0]);
       },
       { fire: true },
     );
@@ -55,5 +55,5 @@ export const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(
     onCleanup(unsubscribe);
   });
 
-  return schema;
+  return type;
 };

package/dist/types/src/useSchema.d.ts

@@ -1,14 +0,0 @@
-import { type Accessor } from 'solid-js';
-import { type Database, type Type } from '@dxos/echo';
-type MaybeAccessor<T> = T | Accessor<T>;
-/**
- * Subscribe to and retrieve schema changes from a database's schema registry.
- * Accepts either values or accessors for db and typename.
- *
- * @param db - The database instance (can be reactive)
- * @param typename - The schema typename to query (can be reactive)
- * @returns An accessor that returns the current schema or undefined
- */
-export declare const useSchema: <T extends Type.Entity.Any = Type.Entity.Any>(db?: MaybeAccessor<Database.Database | undefined>, typename?: MaybeAccessor<string | undefined>) => Accessor<T | undefined>;
-export {};
-//# sourceMappingURL=useSchema.d.ts.map

package/dist/types/src/useSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../src/useSchema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,QAAQ,EAAqD,MAAM,UAAU,CAAC;AAE5F,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAEtD,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExC;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EACnE,KAAK,aAAa,CAAC,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,EACjD,WAAW,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,KAC3C,QAAQ,CAAC,CAAC,GAAG,SAAS,CAqCxB,CAAC"}

package/dist/types/src/useSchema.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=useSchema.test.d.ts.map

package/dist/types/src/useSchema.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSchema.test.d.ts","sourceRoot":"","sources":["../../../src/useSchema.test.tsx"],"names":[],"mappings":""}