@dxos/echo-react 0.8.4-main.9735255 → 0.8.4-main.abd8ff62ef
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/{browser → neutral}/index.mjs +10 -9
- package/dist/lib/neutral/index.mjs.map +7 -0
- package/dist/lib/{browser → neutral}/meta.json +1 -1
- package/dist/types/src/useObject.d.ts.map +1 -1
- package/dist/types/src/useQuery.d.ts +2 -0
- package/dist/types/src/useQuery.d.ts.map +1 -1
- package/dist/types/src/useSchema.d.ts +1 -1
- package/dist/types/src/useSchema.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +7 -11
- package/src/useObject.test.tsx +52 -22
- package/src/useObject.ts +7 -6
- package/src/useQuery.ts +2 -0
- package/src/useSchema.ts +1 -1
- package/dist/lib/browser/index.mjs.map +0 -7
- package/dist/lib/node-esm/index.mjs +0 -155
- package/dist/lib/node-esm/index.mjs.map +0 -7
- package/dist/lib/node-esm/meta.json +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/echo-react",
|
|
3
|
-
"version": "0.8.4-main.
|
|
3
|
+
"version": "0.8.4-main.abd8ff62ef",
|
|
4
4
|
"description": "React integration for ECHO.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -16,23 +16,19 @@
|
|
|
16
16
|
".": {
|
|
17
17
|
"source": "./src/index.ts",
|
|
18
18
|
"types": "./dist/types/src/index.d.ts",
|
|
19
|
-
"
|
|
20
|
-
"node": "./dist/lib/node-esm/index.mjs"
|
|
19
|
+
"default": "./dist/lib/neutral/index.mjs"
|
|
21
20
|
}
|
|
22
21
|
},
|
|
23
22
|
"types": "dist/types/src/index.d.ts",
|
|
24
|
-
"typesVersions": {
|
|
25
|
-
"*": {}
|
|
26
|
-
},
|
|
27
23
|
"files": [
|
|
28
24
|
"dist",
|
|
29
25
|
"src"
|
|
30
26
|
],
|
|
31
27
|
"dependencies": {
|
|
32
|
-
"@effect-atom/atom": "^0.
|
|
33
|
-
"@effect-atom/atom-react": "^0.
|
|
34
|
-
"@dxos/echo": "0.8.4-main.
|
|
35
|
-
"@dxos/echo-atom": "0.8.4-main.
|
|
28
|
+
"@effect-atom/atom": "^0.5.1",
|
|
29
|
+
"@effect-atom/atom-react": "^0.5.0",
|
|
30
|
+
"@dxos/echo": "0.8.4-main.abd8ff62ef",
|
|
31
|
+
"@dxos/echo-atom": "0.8.4-main.abd8ff62ef"
|
|
36
32
|
},
|
|
37
33
|
"devDependencies": {
|
|
38
34
|
"@testing-library/react": "^16.3.0",
|
|
@@ -40,7 +36,7 @@
|
|
|
40
36
|
"@types/react-dom": "~19.2.3",
|
|
41
37
|
"react": "~19.2.3",
|
|
42
38
|
"react-dom": "~19.2.3",
|
|
43
|
-
"@dxos/echo-db": "0.8.4-main.
|
|
39
|
+
"@dxos/echo-db": "0.8.4-main.abd8ff62ef"
|
|
44
40
|
},
|
|
45
41
|
"peerDependencies": {
|
|
46
42
|
"react": "~19.2.3"
|
package/src/useObject.test.tsx
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import * as Registry from '@effect-atom/atom/Registry';
|
|
6
5
|
import { RegistryContext } from '@effect-atom/atom-react';
|
|
6
|
+
import * as Registry from '@effect-atom/atom/Registry';
|
|
7
7
|
import { renderHook, waitFor } from '@testing-library/react';
|
|
8
8
|
import React, { type PropsWithChildren } from 'react';
|
|
9
9
|
import { describe, expect, test } from 'vitest';
|
|
10
10
|
|
|
11
|
-
import { Obj } from '@dxos/echo';
|
|
12
|
-
import { TestSchema } from '@dxos/echo/testing';
|
|
11
|
+
import { Obj, Ref } from '@dxos/echo';
|
|
13
12
|
import { createObject } from '@dxos/echo-db';
|
|
13
|
+
import { TestSchema } from '@dxos/echo/testing';
|
|
14
14
|
|
|
15
15
|
import { useObject } from './useObject';
|
|
16
16
|
|
|
@@ -46,7 +46,6 @@ describe('useObject', () => {
|
|
|
46
46
|
const wrapper = createWrapper(registry);
|
|
47
47
|
|
|
48
48
|
const { result } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
49
|
-
|
|
50
49
|
const [value] = result.current;
|
|
51
50
|
expect(value).toBe('Test');
|
|
52
51
|
});
|
|
@@ -59,12 +58,11 @@ describe('useObject', () => {
|
|
|
59
58
|
const wrapper = createWrapper(registry);
|
|
60
59
|
|
|
61
60
|
const { result } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
62
|
-
|
|
63
61
|
expect(result.current[0]).toBe('Test');
|
|
64
62
|
|
|
65
|
-
// Update the property via Obj.
|
|
66
|
-
Obj.
|
|
67
|
-
|
|
63
|
+
// Update the property via Obj.update
|
|
64
|
+
Obj.update(obj, (obj) => {
|
|
65
|
+
obj.name = 'Updated';
|
|
68
66
|
});
|
|
69
67
|
|
|
70
68
|
// Wait for reactivity to update
|
|
@@ -81,12 +79,11 @@ describe('useObject', () => {
|
|
|
81
79
|
const wrapper = createWrapper(registry);
|
|
82
80
|
|
|
83
81
|
const { result } = renderHook(() => useObject(obj), { wrapper });
|
|
84
|
-
|
|
85
82
|
expect(result.current[0].name).toBe('Test');
|
|
86
83
|
|
|
87
|
-
// Update a property via Obj.
|
|
88
|
-
Obj.
|
|
89
|
-
|
|
84
|
+
// Update a property via Obj.update
|
|
85
|
+
Obj.update(obj, (obj) => {
|
|
86
|
+
obj.name = 'Updated';
|
|
90
87
|
});
|
|
91
88
|
|
|
92
89
|
// Wait for reactivity to update
|
|
@@ -103,12 +100,11 @@ describe('useObject', () => {
|
|
|
103
100
|
const wrapper = createWrapper(registry);
|
|
104
101
|
|
|
105
102
|
const { result } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
106
|
-
|
|
107
103
|
expect(result.current[0]).toBe('Test');
|
|
108
104
|
|
|
109
|
-
// Update a different property via Obj.
|
|
110
|
-
Obj.
|
|
111
|
-
|
|
105
|
+
// Update a different property via Obj.update
|
|
106
|
+
Obj.update(obj, (obj) => {
|
|
107
|
+
obj.email = 'newemail@example.com';
|
|
112
108
|
});
|
|
113
109
|
|
|
114
110
|
// Wait a bit to ensure no update happens
|
|
@@ -142,7 +138,6 @@ describe('useObject', () => {
|
|
|
142
138
|
const wrapper = createWrapper(registry);
|
|
143
139
|
|
|
144
140
|
const { result } = renderHook(() => useObject(obj), { wrapper });
|
|
145
|
-
|
|
146
141
|
const [value, updateCallback] = result.current;
|
|
147
142
|
expect(value.name).toBe('Test');
|
|
148
143
|
|
|
@@ -165,7 +160,6 @@ describe('useObject', () => {
|
|
|
165
160
|
const wrapper = createWrapper(registry);
|
|
166
161
|
|
|
167
162
|
const { result } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
168
|
-
|
|
169
163
|
const [value, updateCallback] = result.current;
|
|
170
164
|
expect(value).toBe('Test');
|
|
171
165
|
|
|
@@ -186,7 +180,6 @@ describe('useObject', () => {
|
|
|
186
180
|
const wrapper = createWrapper(registry);
|
|
187
181
|
|
|
188
182
|
const { result } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
189
|
-
|
|
190
183
|
const [value, updateCallback] = result.current;
|
|
191
184
|
expect(value).toBe('Test');
|
|
192
185
|
|
|
@@ -207,7 +200,6 @@ describe('useObject', () => {
|
|
|
207
200
|
const wrapper = createWrapper(registry);
|
|
208
201
|
|
|
209
202
|
const { result, rerender } = renderHook(() => useObject(obj, 'name'), { wrapper });
|
|
210
|
-
|
|
211
203
|
const [, firstUpdateCallback] = result.current;
|
|
212
204
|
|
|
213
205
|
rerender();
|
|
@@ -233,7 +225,6 @@ describe('useObject', () => {
|
|
|
233
225
|
const wrapper = createWrapper(registry);
|
|
234
226
|
|
|
235
227
|
const { result } = renderHook(() => useObject(undefined as TestSchema.Person | undefined, 'name'), { wrapper });
|
|
236
|
-
|
|
237
228
|
const [value] = result.current;
|
|
238
229
|
expect(value).toBeUndefined();
|
|
239
230
|
});
|
|
@@ -243,7 +234,6 @@ describe('useObject', () => {
|
|
|
243
234
|
const wrapper = createWrapper(registry);
|
|
244
235
|
|
|
245
236
|
const { result } = renderHook(() => useObject(undefined as TestSchema.Person | undefined), { wrapper });
|
|
246
|
-
|
|
247
237
|
const [, updateCallback] = result.current;
|
|
248
238
|
|
|
249
239
|
// Should not throw when calling update on undefined object.
|
|
@@ -254,6 +244,46 @@ describe('useObject', () => {
|
|
|
254
244
|
}).not.toThrow();
|
|
255
245
|
});
|
|
256
246
|
|
|
247
|
+
test('snapshot is referentially stable across re-renders for object', ({ expect }) => {
|
|
248
|
+
const obj: TestSchema.Person = createObject(
|
|
249
|
+
Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
|
|
250
|
+
);
|
|
251
|
+
const registry = Registry.make();
|
|
252
|
+
const wrapper = createWrapper(registry);
|
|
253
|
+
|
|
254
|
+
const { result, rerender } = renderHook(() => useObject(obj), { wrapper });
|
|
255
|
+
const [firstSnapshot] = result.current;
|
|
256
|
+
expect(firstSnapshot).toBeDefined();
|
|
257
|
+
|
|
258
|
+
rerender();
|
|
259
|
+
|
|
260
|
+
const [secondSnapshot] = result.current;
|
|
261
|
+
expect(secondSnapshot).toBe(firstSnapshot);
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
test('snapshot is referentially stable across re-renders for ref', ({ expect }) => {
|
|
265
|
+
const org: TestSchema.Organization = createObject(Obj.make(TestSchema.Organization, { name: 'DXOS' }));
|
|
266
|
+
const person: TestSchema.Person = createObject(
|
|
267
|
+
Obj.make(TestSchema.Person, {
|
|
268
|
+
name: 'Test',
|
|
269
|
+
username: 'test',
|
|
270
|
+
email: 'test@example.com',
|
|
271
|
+
employer: Ref.make(org),
|
|
272
|
+
}),
|
|
273
|
+
);
|
|
274
|
+
const registry = Registry.make();
|
|
275
|
+
const wrapper = createWrapper(registry);
|
|
276
|
+
|
|
277
|
+
const { result, rerender } = renderHook(() => useObject(person.employer!), { wrapper });
|
|
278
|
+
const [firstSnapshot] = result.current;
|
|
279
|
+
expect(firstSnapshot).toBeDefined();
|
|
280
|
+
|
|
281
|
+
rerender();
|
|
282
|
+
|
|
283
|
+
const [secondSnapshot] = result.current;
|
|
284
|
+
expect(secondSnapshot).toBe(firstSnapshot);
|
|
285
|
+
});
|
|
286
|
+
|
|
257
287
|
test('transitions from undefined to defined object', async () => {
|
|
258
288
|
const registry = Registry.make();
|
|
259
289
|
const wrapper = createWrapper(registry);
|
package/src/useObject.ts
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import * as Atom from '@effect-atom/atom/Atom';
|
|
6
5
|
import { useAtomValue } from '@effect-atom/atom-react';
|
|
6
|
+
import * as Atom from '@effect-atom/atom/Atom';
|
|
7
7
|
import { useCallback, useMemo } from 'react';
|
|
8
8
|
|
|
9
9
|
import { Obj, Ref } from '@dxos/echo';
|
|
@@ -123,20 +123,20 @@ export const useObject: {
|
|
|
123
123
|
if (obj === undefined) {
|
|
124
124
|
return;
|
|
125
125
|
}
|
|
126
|
-
Obj.
|
|
126
|
+
Obj.update(obj, (obj: any) => {
|
|
127
127
|
if (typeof updateOrValue === 'function') {
|
|
128
|
-
const returnValue = updateOrValue(property !== undefined ?
|
|
128
|
+
const returnValue = updateOrValue(property !== undefined ? obj[property] : obj);
|
|
129
129
|
if (returnValue !== undefined) {
|
|
130
130
|
if (property === undefined) {
|
|
131
131
|
throw new Error('Cannot re-assign the entire object');
|
|
132
132
|
}
|
|
133
|
-
|
|
133
|
+
obj[property] = returnValue;
|
|
134
134
|
}
|
|
135
135
|
} else {
|
|
136
136
|
if (property === undefined) {
|
|
137
137
|
throw new Error('Cannot re-assign the entire object');
|
|
138
138
|
}
|
|
139
|
-
|
|
139
|
+
obj[property] = updateOrValue;
|
|
140
140
|
}
|
|
141
141
|
});
|
|
142
142
|
},
|
|
@@ -148,8 +148,9 @@ export const useObject: {
|
|
|
148
148
|
// TODO(dxos): Property subscriptions on refs may not update correctly until the ref loads.
|
|
149
149
|
useObjectValue(objOrRef);
|
|
150
150
|
return [useObjectProperty(liveObj, property as any), callback];
|
|
151
|
+
} else {
|
|
152
|
+
return [useObjectValue(objOrRef), callback];
|
|
151
153
|
}
|
|
152
|
-
return [useObjectValue(objOrRef), callback];
|
|
153
154
|
}) as any;
|
|
154
155
|
|
|
155
156
|
/**
|
package/src/useQuery.ts
CHANGED
|
@@ -24,6 +24,8 @@ interface UseQueryFn {
|
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* Create subscription.
|
|
27
|
+
*
|
|
28
|
+
* @param queryOrFilter - The query or filter to apply. Query is memoized based on the AST. No need to call useMemo.
|
|
27
29
|
*/
|
|
28
30
|
export const useQuery: UseQueryFn = (
|
|
29
31
|
resource: Database.Queryable | undefined,
|
package/src/useSchema.ts
CHANGED
|
@@ -9,7 +9,7 @@ import { type Database, type Type } from '@dxos/echo';
|
|
|
9
9
|
/**
|
|
10
10
|
* Subscribe to and retrieve schema changes from a space's schema registry.
|
|
11
11
|
*/
|
|
12
|
-
export const useSchema = <T extends Type.
|
|
12
|
+
export const useSchema = <T extends Type.AnyEntity = Type.AnyEntity>(
|
|
13
13
|
db?: Database.Database,
|
|
14
14
|
typename?: string,
|
|
15
15
|
): T | undefined => {
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/useQuery.ts", "../../../src/useSchema.ts", "../../../src/useObject.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Entity, Filter, Query } from '@dxos/echo';\n\nconst EMPTY_ARRAY: never[] = [];\n\nconst noop = () => {};\n\ninterface UseQueryFn {\n <Q extends Query.Any, O extends Entity.Entity<Query.Type<Q>> = Entity.Entity<Query.Type<Q>>>(\n resource: Database.Queryable | undefined,\n query: Q,\n ): O[];\n\n <F extends Filter.Any, O extends Entity.Entity<Filter.Type<F>> = Entity.Entity<Filter.Type<F>>>(\n resource: Database.Queryable | undefined,\n filter: F,\n ): O[];\n}\n\n/**\n * Create subscription.\n */\nexport const useQuery: UseQueryFn = (\n resource: Database.Queryable | undefined,\n queryOrFilter: Query.Any | Filter.Any,\n): Entity.Any[] => {\n const query = Filter.is(queryOrFilter) ? Query.select(queryOrFilter) : queryOrFilter;\n\n const { getObjects, subscribe } = useMemo(() => {\n let queryResult = undefined;\n if (resource) {\n queryResult = resource.query(query);\n }\n\n let subscribed = false;\n return {\n getObjects: () => (subscribed && queryResult ? queryResult.results : EMPTY_ARRAY),\n subscribe: (cb: () => void) => {\n subscribed = true;\n const unsubscribe = queryResult?.subscribe(cb) ?? noop;\n return () => {\n unsubscribe?.();\n subscribed = false;\n };\n },\n };\n }, [resource, JSON.stringify(query.ast)]);\n\n // https://beta.reactjs.org/reference/react/useSyncExternalStore\n // NOTE: This hook will resubscribe whenever the callback passed to the first argument changes; make sure it is stable.\n const objects = useSyncExternalStore<Entity.Any[]>(subscribe, getObjects);\n return objects;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Type } from '@dxos/echo';\n\n/**\n * Subscribe to and retrieve schema changes from a space's schema registry.\n */\nexport const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(\n db?: Database.Database,\n typename?: string,\n): T | undefined => {\n const { subscribe, getSchema } = useMemo(() => {\n if (!typename || !db) {\n return {\n subscribe: () => () => {},\n getSchema: () => undefined,\n };\n }\n\n const query = db.schemaRegistry.query({ typename, location: ['database', 'runtime'] });\n const initialResult = query.runSync()[0];\n let currentSchema = initialResult;\n\n return {\n subscribe: (onStoreChange: () => void) => {\n const unsubscribe = query.subscribe(() => {\n currentSchema = query.results[0];\n onStoreChange();\n });\n\n return unsubscribe;\n },\n getSchema: () => currentSchema,\n };\n }, [typename, db]);\n\n return useSyncExternalStore(subscribe, getSchema) as T;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Atom from '@effect-atom/atom/Atom';\nimport { useAtomValue } from '@effect-atom/atom-react';\nimport { useCallback, useMemo } from 'react';\n\nimport { Obj, Ref } from '@dxos/echo';\nimport { AtomObj } from '@dxos/echo-atom';\n\nexport interface ObjectUpdateCallback<T> {\n (update: (obj: Obj.Mutable<T>) => void): void;\n (update: (obj: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n}\n\nexport interface ObjectPropUpdateCallback<T> {\n (update: (value: Obj.Mutable<T>) => void): void;\n (update: (value: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n (newValue: T): void;\n}\n\nexport const useObject: {\n /**\n * Hook to subscribe to a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns a snapshot (undefined if the ref hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to\n * @returns The current target snapshot (or undefined if not loaded) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a Ref's target object that may be undefined.\n * Returns a snapshot (undefined if the ref is undefined or hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @returns The current target snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T> | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object.\n * Returns a snapshot of the current object value and automatically re-renders when the object changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @returns The current object snapshot and update callback\n */\n <T extends Obj.Unknown>(obj: T): [Obj.Snapshot<T>, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object that may be undefined.\n * Returns a snapshot (undefined if the object is undefined).\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(obj: T | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an Echo object or Ref.\n * Handles both cases - if passed a Ref, dereferences it and subscribes to the target.\n * Returns a snapshot (undefined if ref hasn't loaded).\n *\n * @param objOrRef - The Echo object or Ref to subscribe to\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object.\n * Returns the current property value and automatically re-renders when the property changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @param property - Property key to subscribe to\n * @returns The current property value and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(obj: T, property: K): [T[K], ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object that may be undefined.\n * Returns undefined if the object is undefined.\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n ): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns undefined if the ref hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined if not loaded) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T>, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object that may be undefined.\n * Returns undefined if the ref is undefined or hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T> | undefined, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n} = (<T extends Obj.Unknown, K extends keyof T>(objOrRef: T | Ref.Ref<T> | undefined, property?: K): any => {\n // Get the live object for the callback (refs need to dereference).\n const isRef = Ref.isRef(objOrRef);\n const liveObj = isRef ? (objOrRef as Ref.Ref<T>)?.target : (objOrRef as T | undefined);\n\n const callback: ObjectPropUpdateCallback<unknown> = useCallback(\n (updateOrValue: unknown | ((obj: unknown) => unknown)) => {\n // Get current target for refs (may have loaded since render).\n const obj = isRef ? (objOrRef as Ref.Ref<T>)?.target : liveObj;\n if (obj === undefined) {\n return;\n }\n Obj.change(obj, (o: any) => {\n if (typeof updateOrValue === 'function') {\n const returnValue = updateOrValue(property !== undefined ? o[property] : o);\n if (returnValue !== undefined) {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = returnValue;\n }\n } else {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = updateOrValue;\n }\n });\n },\n [objOrRef, property, isRef, liveObj],\n );\n\n if (property !== undefined) {\n // For property subscriptions on refs, we subscribe to trigger re-render on load.\n // TODO(dxos): Property subscriptions on refs may not update correctly until the ref loads.\n useObjectValue(objOrRef);\n return [useObjectProperty(liveObj, property as any), callback];\n }\n return [useObjectValue(objOrRef), callback];\n}) as any;\n\n/**\n * Internal hook for subscribing to an Echo object or Ref.\n * AtomObj.make handles both objects and refs, returning snapshots.\n */\nconst useObjectValue = <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T> | undefined): Obj.Snapshot<T> | undefined => {\n const atom = useMemo(() => AtomObj.make(objOrRef), [objOrRef]);\n return useAtomValue(atom) as Obj.Snapshot<T> | undefined;\n};\n\n/**\n * Internal hook for subscribing to a specific property of an Echo object.\n * Uses useAtomValue directly since makeProperty returns the value directly.\n */\nconst useObjectProperty = <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n): T[K] | undefined => {\n const atom = useMemo(() => AtomObj.makeProperty(obj, property), [obj, property]);\n return useAtomValue(atom);\n};\n\n/**\n * Hook to subscribe to multiple Refs' target objects.\n * Automatically dereferences each ref and handles async loading.\n * Returns an array of loaded snapshots (filtering out undefined values).\n *\n * This hook is useful for aggregate computations like counts or filtering\n * across multiple refs without using .target directly.\n *\n * @param refs - Array of Refs to dereference and subscribe to\n * @returns Array of loaded target snapshots (excludes unloaded refs)\n */\nexport const useObjects = <T extends Obj.Unknown>(refs: readonly Ref.Ref<T>[]): Obj.Snapshot<T>[] => {\n const atom = useMemo(\n () =>\n Atom.make((get) => {\n const results: Obj.Snapshot<T>[] = [];\n for (const ref of refs) {\n const value = get(AtomObj.make(ref));\n if (value !== undefined) {\n results.push(value as Obj.Snapshot<T>);\n }\n }\n return results;\n }),\n [refs],\n );\n return useAtomValue(atom);\n};\n"],
|
|
5
|
-
"mappings": ";AAIA,SAASA,SAASC,4BAA4B;AAE9C,SAAqCC,QAAQC,aAAa;AAE1D,IAAMC,cAAuB,CAAA;AAE7B,IAAMC,OAAO,MAAA;AAAO;AAiBb,IAAMC,WAAuB,CAClCC,UACAC,kBAAAA;AAEA,QAAMC,QAAQC,OAAOC,GAAGH,aAAAA,IAAiBI,MAAMC,OAAOL,aAAAA,IAAiBA;AAEvE,QAAM,EAAEM,YAAYC,UAAS,IAAKC,QAAQ,MAAA;AACxC,QAAIC,cAAcC;AAClB,QAAIX,UAAU;AACZU,oBAAcV,SAASE,MAAMA,KAAAA;IAC/B;AAEA,QAAIU,aAAa;AACjB,WAAO;MACLL,YAAY,MAAOK,cAAcF,cAAcA,YAAYG,UAAUhB;MACrEW,WAAW,CAACM,OAAAA;AACVF,qBAAa;AACb,cAAMG,cAAcL,aAAaF,UAAUM,EAAAA,KAAOhB;AAClD,eAAO,MAAA;AACLiB,wBAAAA;AACAH,uBAAa;QACf;MACF;IACF;EACF,GAAG;IAACZ;IAAUgB,KAAKC,UAAUf,MAAMgB,GAAG;GAAE;AAIxC,QAAMC,UAAUC,qBAAmCZ,WAAWD,UAAAA;AAC9D,SAAOY;AACT;;;ACrDA,SAASE,WAAAA,UAASC,wBAAAA,6BAA4B;AAOvC,IAAMC,YAAY,CACvBC,IACAC,aAAAA;AAEA,QAAM,EAAEC,WAAWC,UAAS,IAAKC,SAAQ,MAAA;AACvC,QAAI,CAACH,YAAY,CAACD,IAAI;AACpB,aAAO;QACLE,WAAW,MAAM,MAAA;QAAO;QACxBC,WAAW,MAAME;MACnB;IACF;AAEA,UAAMC,QAAQN,GAAGO,eAAeD,MAAM;MAAEL;MAAUO,UAAU;QAAC;QAAY;;IAAW,CAAA;AACpF,UAAMC,gBAAgBH,MAAMI,QAAO,EAAG,CAAA;AACtC,QAAIC,gBAAgBF;AAEpB,WAAO;MACLP,WAAW,CAACU,kBAAAA;AACV,cAAMC,cAAcP,MAAMJ,UAAU,MAAA;AAClCS,0BAAgBL,MAAMQ,QAAQ,CAAA;AAC9BF,wBAAAA;QACF,CAAA;AAEA,eAAOC;MACT;MACAV,WAAW,MAAMQ;IACnB;EACF,GAAG;IAACV;IAAUD;GAAG;AAEjB,SAAOe,sBAAqBb,WAAWC,SAAAA;AACzC;;;ACrCA,YAAYa,UAAU;AACtB,SAASC,oBAAoB;AAC7B,SAASC,aAAaC,WAAAA,gBAAe;AAErC,SAASC,KAAKC,WAAW;AACzB,SAASC,eAAe;AAajB,IAAMC,YA2FR,CAA2CC,UAAsCC,aAAAA;AAEpF,QAAMC,QAAQC,IAAID,MAAMF,QAAAA;AACxB,QAAMI,UAAUF,QAASF,UAAyBK,SAAUL;AAE5D,QAAMM,WAA8CC,YAClD,CAACC,kBAAAA;AAEC,UAAMC,MAAMP,QAASF,UAAyBK,SAASD;AACvD,QAAIK,QAAQC,QAAW;AACrB;IACF;AACAC,QAAIC,OAAOH,KAAK,CAACI,MAAAA;AACf,UAAI,OAAOL,kBAAkB,YAAY;AACvC,cAAMM,cAAcN,cAAcP,aAAaS,SAAYG,EAAEZ,QAAAA,IAAYY,CAAAA;AACzE,YAAIC,gBAAgBJ,QAAW;AAC7B,cAAIT,aAAaS,QAAW;AAC1B,kBAAM,IAAIK,MAAM,oCAAA;UAClB;AACAF,YAAEZ,QAAAA,IAAYa;QAChB;MACF,OAAO;AACL,YAAIb,aAAaS,QAAW;AAC1B,gBAAM,IAAIK,MAAM,oCAAA;QAClB;AACAF,UAAEZ,QAAAA,IAAYO;MAChB;IACF,CAAA;EACF,GACA;IAACR;IAAUC;IAAUC;IAAOE;GAAQ;AAGtC,MAAIH,aAAaS,QAAW;AAG1BM,mBAAehB,QAAAA;AACf,WAAO;MAACiB,kBAAkBb,SAASH,QAAAA;MAAkBK;;EACvD;AACA,SAAO;IAACU,eAAehB,QAAAA;IAAWM;;AACpC;AAMA,IAAMU,iBAAiB,CAAwBhB,aAAAA;AAC7C,QAAMkB,OAAOC,SAAQ,MAAMC,QAAQC,KAAKrB,QAAAA,GAAW;IAACA;GAAS;AAC7D,SAAOsB,aAAaJ,IAAAA;AACtB;AAMA,IAAMD,oBAAoB,CACxBR,KACAR,aAAAA;AAEA,QAAMiB,OAAOC,SAAQ,MAAMC,QAAQG,aAAad,KAAKR,QAAAA,GAAW;IAACQ;IAAKR;GAAS;AAC/E,SAAOqB,aAAaJ,IAAAA;AACtB;AAaO,IAAMM,aAAa,CAAwBC,SAAAA;AAChD,QAAMP,OAAOC,SACX,MACOE,UAAK,CAACK,QAAAA;AACT,UAAMC,UAA6B,CAAA;AACnC,eAAWC,OAAOH,MAAM;AACtB,YAAMI,QAAQH,IAAIN,QAAQC,KAAKO,GAAAA,CAAAA;AAC/B,UAAIC,UAAUnB,QAAW;AACvBiB,gBAAQG,KAAKD,KAAAA;MACf;IACF;AACA,WAAOF;EACT,CAAA,GACF;IAACF;GAAK;AAER,SAAOH,aAAaJ,IAAAA;AACtB;",
|
|
6
|
-
"names": ["useMemo", "useSyncExternalStore", "Filter", "Query", "EMPTY_ARRAY", "noop", "useQuery", "resource", "queryOrFilter", "query", "Filter", "is", "Query", "select", "getObjects", "subscribe", "useMemo", "queryResult", "undefined", "subscribed", "results", "cb", "unsubscribe", "JSON", "stringify", "ast", "objects", "useSyncExternalStore", "useMemo", "useSyncExternalStore", "useSchema", "db", "typename", "subscribe", "getSchema", "useMemo", "undefined", "query", "schemaRegistry", "location", "initialResult", "runSync", "currentSchema", "onStoreChange", "unsubscribe", "results", "useSyncExternalStore", "Atom", "useAtomValue", "useCallback", "useMemo", "Obj", "Ref", "AtomObj", "useObject", "objOrRef", "property", "isRef", "Ref", "liveObj", "target", "callback", "useCallback", "updateOrValue", "obj", "undefined", "Obj", "change", "o", "returnValue", "Error", "useObjectValue", "useObjectProperty", "atom", "useMemo", "AtomObj", "make", "useAtomValue", "makeProperty", "useObjects", "refs", "get", "results", "ref", "value", "push"]
|
|
7
|
-
}
|
|
@@ -1,155 +0,0 @@
|
|
|
1
|
-
import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
|
|
2
|
-
|
|
3
|
-
// src/useQuery.ts
|
|
4
|
-
import { useMemo, useSyncExternalStore } from "react";
|
|
5
|
-
import { Filter, Query } from "@dxos/echo";
|
|
6
|
-
var EMPTY_ARRAY = [];
|
|
7
|
-
var noop = () => {
|
|
8
|
-
};
|
|
9
|
-
var useQuery = (resource, queryOrFilter) => {
|
|
10
|
-
const query = Filter.is(queryOrFilter) ? Query.select(queryOrFilter) : queryOrFilter;
|
|
11
|
-
const { getObjects, subscribe } = useMemo(() => {
|
|
12
|
-
let queryResult = void 0;
|
|
13
|
-
if (resource) {
|
|
14
|
-
queryResult = resource.query(query);
|
|
15
|
-
}
|
|
16
|
-
let subscribed = false;
|
|
17
|
-
return {
|
|
18
|
-
getObjects: () => subscribed && queryResult ? queryResult.results : EMPTY_ARRAY,
|
|
19
|
-
subscribe: (cb) => {
|
|
20
|
-
subscribed = true;
|
|
21
|
-
const unsubscribe = queryResult?.subscribe(cb) ?? noop;
|
|
22
|
-
return () => {
|
|
23
|
-
unsubscribe?.();
|
|
24
|
-
subscribed = false;
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
};
|
|
28
|
-
}, [
|
|
29
|
-
resource,
|
|
30
|
-
JSON.stringify(query.ast)
|
|
31
|
-
]);
|
|
32
|
-
const objects = useSyncExternalStore(subscribe, getObjects);
|
|
33
|
-
return objects;
|
|
34
|
-
};
|
|
35
|
-
|
|
36
|
-
// src/useSchema.ts
|
|
37
|
-
import { useMemo as useMemo2, useSyncExternalStore as useSyncExternalStore2 } from "react";
|
|
38
|
-
var useSchema = (db, typename) => {
|
|
39
|
-
const { subscribe, getSchema } = useMemo2(() => {
|
|
40
|
-
if (!typename || !db) {
|
|
41
|
-
return {
|
|
42
|
-
subscribe: () => () => {
|
|
43
|
-
},
|
|
44
|
-
getSchema: () => void 0
|
|
45
|
-
};
|
|
46
|
-
}
|
|
47
|
-
const query = db.schemaRegistry.query({
|
|
48
|
-
typename,
|
|
49
|
-
location: [
|
|
50
|
-
"database",
|
|
51
|
-
"runtime"
|
|
52
|
-
]
|
|
53
|
-
});
|
|
54
|
-
const initialResult = query.runSync()[0];
|
|
55
|
-
let currentSchema = initialResult;
|
|
56
|
-
return {
|
|
57
|
-
subscribe: (onStoreChange) => {
|
|
58
|
-
const unsubscribe = query.subscribe(() => {
|
|
59
|
-
currentSchema = query.results[0];
|
|
60
|
-
onStoreChange();
|
|
61
|
-
});
|
|
62
|
-
return unsubscribe;
|
|
63
|
-
},
|
|
64
|
-
getSchema: () => currentSchema
|
|
65
|
-
};
|
|
66
|
-
}, [
|
|
67
|
-
typename,
|
|
68
|
-
db
|
|
69
|
-
]);
|
|
70
|
-
return useSyncExternalStore2(subscribe, getSchema);
|
|
71
|
-
};
|
|
72
|
-
|
|
73
|
-
// src/useObject.ts
|
|
74
|
-
import * as Atom from "@effect-atom/atom/Atom";
|
|
75
|
-
import { useAtomValue } from "@effect-atom/atom-react";
|
|
76
|
-
import { useCallback, useMemo as useMemo3 } from "react";
|
|
77
|
-
import { Obj, Ref } from "@dxos/echo";
|
|
78
|
-
import { AtomObj } from "@dxos/echo-atom";
|
|
79
|
-
var useObject = (objOrRef, property) => {
|
|
80
|
-
const isRef = Ref.isRef(objOrRef);
|
|
81
|
-
const liveObj = isRef ? objOrRef?.target : objOrRef;
|
|
82
|
-
const callback = useCallback((updateOrValue) => {
|
|
83
|
-
const obj = isRef ? objOrRef?.target : liveObj;
|
|
84
|
-
if (obj === void 0) {
|
|
85
|
-
return;
|
|
86
|
-
}
|
|
87
|
-
Obj.change(obj, (o) => {
|
|
88
|
-
if (typeof updateOrValue === "function") {
|
|
89
|
-
const returnValue = updateOrValue(property !== void 0 ? o[property] : o);
|
|
90
|
-
if (returnValue !== void 0) {
|
|
91
|
-
if (property === void 0) {
|
|
92
|
-
throw new Error("Cannot re-assign the entire object");
|
|
93
|
-
}
|
|
94
|
-
o[property] = returnValue;
|
|
95
|
-
}
|
|
96
|
-
} else {
|
|
97
|
-
if (property === void 0) {
|
|
98
|
-
throw new Error("Cannot re-assign the entire object");
|
|
99
|
-
}
|
|
100
|
-
o[property] = updateOrValue;
|
|
101
|
-
}
|
|
102
|
-
});
|
|
103
|
-
}, [
|
|
104
|
-
objOrRef,
|
|
105
|
-
property,
|
|
106
|
-
isRef,
|
|
107
|
-
liveObj
|
|
108
|
-
]);
|
|
109
|
-
if (property !== void 0) {
|
|
110
|
-
useObjectValue(objOrRef);
|
|
111
|
-
return [
|
|
112
|
-
useObjectProperty(liveObj, property),
|
|
113
|
-
callback
|
|
114
|
-
];
|
|
115
|
-
}
|
|
116
|
-
return [
|
|
117
|
-
useObjectValue(objOrRef),
|
|
118
|
-
callback
|
|
119
|
-
];
|
|
120
|
-
};
|
|
121
|
-
var useObjectValue = (objOrRef) => {
|
|
122
|
-
const atom = useMemo3(() => AtomObj.make(objOrRef), [
|
|
123
|
-
objOrRef
|
|
124
|
-
]);
|
|
125
|
-
return useAtomValue(atom);
|
|
126
|
-
};
|
|
127
|
-
var useObjectProperty = (obj, property) => {
|
|
128
|
-
const atom = useMemo3(() => AtomObj.makeProperty(obj, property), [
|
|
129
|
-
obj,
|
|
130
|
-
property
|
|
131
|
-
]);
|
|
132
|
-
return useAtomValue(atom);
|
|
133
|
-
};
|
|
134
|
-
var useObjects = (refs) => {
|
|
135
|
-
const atom = useMemo3(() => Atom.make((get) => {
|
|
136
|
-
const results = [];
|
|
137
|
-
for (const ref of refs) {
|
|
138
|
-
const value = get(AtomObj.make(ref));
|
|
139
|
-
if (value !== void 0) {
|
|
140
|
-
results.push(value);
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
return results;
|
|
144
|
-
}), [
|
|
145
|
-
refs
|
|
146
|
-
]);
|
|
147
|
-
return useAtomValue(atom);
|
|
148
|
-
};
|
|
149
|
-
export {
|
|
150
|
-
useObject,
|
|
151
|
-
useObjects,
|
|
152
|
-
useQuery,
|
|
153
|
-
useSchema
|
|
154
|
-
};
|
|
155
|
-
//# sourceMappingURL=index.mjs.map
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/useQuery.ts", "../../../src/useSchema.ts", "../../../src/useObject.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Entity, Filter, Query } from '@dxos/echo';\n\nconst EMPTY_ARRAY: never[] = [];\n\nconst noop = () => {};\n\ninterface UseQueryFn {\n <Q extends Query.Any, O extends Entity.Entity<Query.Type<Q>> = Entity.Entity<Query.Type<Q>>>(\n resource: Database.Queryable | undefined,\n query: Q,\n ): O[];\n\n <F extends Filter.Any, O extends Entity.Entity<Filter.Type<F>> = Entity.Entity<Filter.Type<F>>>(\n resource: Database.Queryable | undefined,\n filter: F,\n ): O[];\n}\n\n/**\n * Create subscription.\n */\nexport const useQuery: UseQueryFn = (\n resource: Database.Queryable | undefined,\n queryOrFilter: Query.Any | Filter.Any,\n): Entity.Any[] => {\n const query = Filter.is(queryOrFilter) ? Query.select(queryOrFilter) : queryOrFilter;\n\n const { getObjects, subscribe } = useMemo(() => {\n let queryResult = undefined;\n if (resource) {\n queryResult = resource.query(query);\n }\n\n let subscribed = false;\n return {\n getObjects: () => (subscribed && queryResult ? queryResult.results : EMPTY_ARRAY),\n subscribe: (cb: () => void) => {\n subscribed = true;\n const unsubscribe = queryResult?.subscribe(cb) ?? noop;\n return () => {\n unsubscribe?.();\n subscribed = false;\n };\n },\n };\n }, [resource, JSON.stringify(query.ast)]);\n\n // https://beta.reactjs.org/reference/react/useSyncExternalStore\n // NOTE: This hook will resubscribe whenever the callback passed to the first argument changes; make sure it is stable.\n const objects = useSyncExternalStore<Entity.Any[]>(subscribe, getObjects);\n return objects;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Type } from '@dxos/echo';\n\n/**\n * Subscribe to and retrieve schema changes from a space's schema registry.\n */\nexport const useSchema = <T extends Type.Entity.Any = Type.Entity.Any>(\n db?: Database.Database,\n typename?: string,\n): T | undefined => {\n const { subscribe, getSchema } = useMemo(() => {\n if (!typename || !db) {\n return {\n subscribe: () => () => {},\n getSchema: () => undefined,\n };\n }\n\n const query = db.schemaRegistry.query({ typename, location: ['database', 'runtime'] });\n const initialResult = query.runSync()[0];\n let currentSchema = initialResult;\n\n return {\n subscribe: (onStoreChange: () => void) => {\n const unsubscribe = query.subscribe(() => {\n currentSchema = query.results[0];\n onStoreChange();\n });\n\n return unsubscribe;\n },\n getSchema: () => currentSchema,\n };\n }, [typename, db]);\n\n return useSyncExternalStore(subscribe, getSchema) as T;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Atom from '@effect-atom/atom/Atom';\nimport { useAtomValue } from '@effect-atom/atom-react';\nimport { useCallback, useMemo } from 'react';\n\nimport { Obj, Ref } from '@dxos/echo';\nimport { AtomObj } from '@dxos/echo-atom';\n\nexport interface ObjectUpdateCallback<T> {\n (update: (obj: Obj.Mutable<T>) => void): void;\n (update: (obj: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n}\n\nexport interface ObjectPropUpdateCallback<T> {\n (update: (value: Obj.Mutable<T>) => void): void;\n (update: (value: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n (newValue: T): void;\n}\n\nexport const useObject: {\n /**\n * Hook to subscribe to a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns a snapshot (undefined if the ref hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to\n * @returns The current target snapshot (or undefined if not loaded) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a Ref's target object that may be undefined.\n * Returns a snapshot (undefined if the ref is undefined or hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @returns The current target snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T> | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object.\n * Returns a snapshot of the current object value and automatically re-renders when the object changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @returns The current object snapshot and update callback\n */\n <T extends Obj.Unknown>(obj: T): [Obj.Snapshot<T>, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object that may be undefined.\n * Returns a snapshot (undefined if the object is undefined).\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(obj: T | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an Echo object or Ref.\n * Handles both cases - if passed a Ref, dereferences it and subscribes to the target.\n * Returns a snapshot (undefined if ref hasn't loaded).\n *\n * @param objOrRef - The Echo object or Ref to subscribe to\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object.\n * Returns the current property value and automatically re-renders when the property changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @param property - Property key to subscribe to\n * @returns The current property value and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(obj: T, property: K): [T[K], ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object that may be undefined.\n * Returns undefined if the object is undefined.\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n ): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns undefined if the ref hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined if not loaded) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T>, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object that may be undefined.\n * Returns undefined if the ref is undefined or hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T> | undefined, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n} = (<T extends Obj.Unknown, K extends keyof T>(objOrRef: T | Ref.Ref<T> | undefined, property?: K): any => {\n // Get the live object for the callback (refs need to dereference).\n const isRef = Ref.isRef(objOrRef);\n const liveObj = isRef ? (objOrRef as Ref.Ref<T>)?.target : (objOrRef as T | undefined);\n\n const callback: ObjectPropUpdateCallback<unknown> = useCallback(\n (updateOrValue: unknown | ((obj: unknown) => unknown)) => {\n // Get current target for refs (may have loaded since render).\n const obj = isRef ? (objOrRef as Ref.Ref<T>)?.target : liveObj;\n if (obj === undefined) {\n return;\n }\n Obj.change(obj, (o: any) => {\n if (typeof updateOrValue === 'function') {\n const returnValue = updateOrValue(property !== undefined ? o[property] : o);\n if (returnValue !== undefined) {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = returnValue;\n }\n } else {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = updateOrValue;\n }\n });\n },\n [objOrRef, property, isRef, liveObj],\n );\n\n if (property !== undefined) {\n // For property subscriptions on refs, we subscribe to trigger re-render on load.\n // TODO(dxos): Property subscriptions on refs may not update correctly until the ref loads.\n useObjectValue(objOrRef);\n return [useObjectProperty(liveObj, property as any), callback];\n }\n return [useObjectValue(objOrRef), callback];\n}) as any;\n\n/**\n * Internal hook for subscribing to an Echo object or Ref.\n * AtomObj.make handles both objects and refs, returning snapshots.\n */\nconst useObjectValue = <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T> | undefined): Obj.Snapshot<T> | undefined => {\n const atom = useMemo(() => AtomObj.make(objOrRef), [objOrRef]);\n return useAtomValue(atom) as Obj.Snapshot<T> | undefined;\n};\n\n/**\n * Internal hook for subscribing to a specific property of an Echo object.\n * Uses useAtomValue directly since makeProperty returns the value directly.\n */\nconst useObjectProperty = <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n): T[K] | undefined => {\n const atom = useMemo(() => AtomObj.makeProperty(obj, property), [obj, property]);\n return useAtomValue(atom);\n};\n\n/**\n * Hook to subscribe to multiple Refs' target objects.\n * Automatically dereferences each ref and handles async loading.\n * Returns an array of loaded snapshots (filtering out undefined values).\n *\n * This hook is useful for aggregate computations like counts or filtering\n * across multiple refs without using .target directly.\n *\n * @param refs - Array of Refs to dereference and subscribe to\n * @returns Array of loaded target snapshots (excludes unloaded refs)\n */\nexport const useObjects = <T extends Obj.Unknown>(refs: readonly Ref.Ref<T>[]): Obj.Snapshot<T>[] => {\n const atom = useMemo(\n () =>\n Atom.make((get) => {\n const results: Obj.Snapshot<T>[] = [];\n for (const ref of refs) {\n const value = get(AtomObj.make(ref));\n if (value !== undefined) {\n results.push(value as Obj.Snapshot<T>);\n }\n }\n return results;\n }),\n [refs],\n );\n return useAtomValue(atom);\n};\n"],
|
|
5
|
-
"mappings": ";;;AAIA,SAASA,SAASC,4BAA4B;AAE9C,SAAqCC,QAAQC,aAAa;AAE1D,IAAMC,cAAuB,CAAA;AAE7B,IAAMC,OAAO,MAAA;AAAO;AAiBb,IAAMC,WAAuB,CAClCC,UACAC,kBAAAA;AAEA,QAAMC,QAAQC,OAAOC,GAAGH,aAAAA,IAAiBI,MAAMC,OAAOL,aAAAA,IAAiBA;AAEvE,QAAM,EAAEM,YAAYC,UAAS,IAAKC,QAAQ,MAAA;AACxC,QAAIC,cAAcC;AAClB,QAAIX,UAAU;AACZU,oBAAcV,SAASE,MAAMA,KAAAA;IAC/B;AAEA,QAAIU,aAAa;AACjB,WAAO;MACLL,YAAY,MAAOK,cAAcF,cAAcA,YAAYG,UAAUhB;MACrEW,WAAW,CAACM,OAAAA;AACVF,qBAAa;AACb,cAAMG,cAAcL,aAAaF,UAAUM,EAAAA,KAAOhB;AAClD,eAAO,MAAA;AACLiB,wBAAAA;AACAH,uBAAa;QACf;MACF;IACF;EACF,GAAG;IAACZ;IAAUgB,KAAKC,UAAUf,MAAMgB,GAAG;GAAE;AAIxC,QAAMC,UAAUC,qBAAmCZ,WAAWD,UAAAA;AAC9D,SAAOY;AACT;;;ACrDA,SAASE,WAAAA,UAASC,wBAAAA,6BAA4B;AAOvC,IAAMC,YAAY,CACvBC,IACAC,aAAAA;AAEA,QAAM,EAAEC,WAAWC,UAAS,IAAKC,SAAQ,MAAA;AACvC,QAAI,CAACH,YAAY,CAACD,IAAI;AACpB,aAAO;QACLE,WAAW,MAAM,MAAA;QAAO;QACxBC,WAAW,MAAME;MACnB;IACF;AAEA,UAAMC,QAAQN,GAAGO,eAAeD,MAAM;MAAEL;MAAUO,UAAU;QAAC;QAAY;;IAAW,CAAA;AACpF,UAAMC,gBAAgBH,MAAMI,QAAO,EAAG,CAAA;AACtC,QAAIC,gBAAgBF;AAEpB,WAAO;MACLP,WAAW,CAACU,kBAAAA;AACV,cAAMC,cAAcP,MAAMJ,UAAU,MAAA;AAClCS,0BAAgBL,MAAMQ,QAAQ,CAAA;AAC9BF,wBAAAA;QACF,CAAA;AAEA,eAAOC;MACT;MACAV,WAAW,MAAMQ;IACnB;EACF,GAAG;IAACV;IAAUD;GAAG;AAEjB,SAAOe,sBAAqBb,WAAWC,SAAAA;AACzC;;;ACrCA,YAAYa,UAAU;AACtB,SAASC,oBAAoB;AAC7B,SAASC,aAAaC,WAAAA,gBAAe;AAErC,SAASC,KAAKC,WAAW;AACzB,SAASC,eAAe;AAajB,IAAMC,YA2FR,CAA2CC,UAAsCC,aAAAA;AAEpF,QAAMC,QAAQC,IAAID,MAAMF,QAAAA;AACxB,QAAMI,UAAUF,QAASF,UAAyBK,SAAUL;AAE5D,QAAMM,WAA8CC,YAClD,CAACC,kBAAAA;AAEC,UAAMC,MAAMP,QAASF,UAAyBK,SAASD;AACvD,QAAIK,QAAQC,QAAW;AACrB;IACF;AACAC,QAAIC,OAAOH,KAAK,CAACI,MAAAA;AACf,UAAI,OAAOL,kBAAkB,YAAY;AACvC,cAAMM,cAAcN,cAAcP,aAAaS,SAAYG,EAAEZ,QAAAA,IAAYY,CAAAA;AACzE,YAAIC,gBAAgBJ,QAAW;AAC7B,cAAIT,aAAaS,QAAW;AAC1B,kBAAM,IAAIK,MAAM,oCAAA;UAClB;AACAF,YAAEZ,QAAAA,IAAYa;QAChB;MACF,OAAO;AACL,YAAIb,aAAaS,QAAW;AAC1B,gBAAM,IAAIK,MAAM,oCAAA;QAClB;AACAF,UAAEZ,QAAAA,IAAYO;MAChB;IACF,CAAA;EACF,GACA;IAACR;IAAUC;IAAUC;IAAOE;GAAQ;AAGtC,MAAIH,aAAaS,QAAW;AAG1BM,mBAAehB,QAAAA;AACf,WAAO;MAACiB,kBAAkBb,SAASH,QAAAA;MAAkBK;;EACvD;AACA,SAAO;IAACU,eAAehB,QAAAA;IAAWM;;AACpC;AAMA,IAAMU,iBAAiB,CAAwBhB,aAAAA;AAC7C,QAAMkB,OAAOC,SAAQ,MAAMC,QAAQC,KAAKrB,QAAAA,GAAW;IAACA;GAAS;AAC7D,SAAOsB,aAAaJ,IAAAA;AACtB;AAMA,IAAMD,oBAAoB,CACxBR,KACAR,aAAAA;AAEA,QAAMiB,OAAOC,SAAQ,MAAMC,QAAQG,aAAad,KAAKR,QAAAA,GAAW;IAACQ;IAAKR;GAAS;AAC/E,SAAOqB,aAAaJ,IAAAA;AACtB;AAaO,IAAMM,aAAa,CAAwBC,SAAAA;AAChD,QAAMP,OAAOC,SACX,MACOE,UAAK,CAACK,QAAAA;AACT,UAAMC,UAA6B,CAAA;AACnC,eAAWC,OAAOH,MAAM;AACtB,YAAMI,QAAQH,IAAIN,QAAQC,KAAKO,GAAAA,CAAAA;AAC/B,UAAIC,UAAUnB,QAAW;AACvBiB,gBAAQG,KAAKD,KAAAA;MACf;IACF;AACA,WAAOF;EACT,CAAA,GACF;IAACF;GAAK;AAER,SAAOH,aAAaJ,IAAAA;AACtB;",
|
|
6
|
-
"names": ["useMemo", "useSyncExternalStore", "Filter", "Query", "EMPTY_ARRAY", "noop", "useQuery", "resource", "queryOrFilter", "query", "Filter", "is", "Query", "select", "getObjects", "subscribe", "useMemo", "queryResult", "undefined", "subscribed", "results", "cb", "unsubscribe", "JSON", "stringify", "ast", "objects", "useSyncExternalStore", "useMemo", "useSyncExternalStore", "useSchema", "db", "typename", "subscribe", "getSchema", "useMemo", "undefined", "query", "schemaRegistry", "location", "initialResult", "runSync", "currentSchema", "onStoreChange", "unsubscribe", "results", "useSyncExternalStore", "Atom", "useAtomValue", "useCallback", "useMemo", "Obj", "Ref", "AtomObj", "useObject", "objOrRef", "property", "isRef", "Ref", "liveObj", "target", "callback", "useCallback", "updateOrValue", "obj", "undefined", "Obj", "change", "o", "returnValue", "Error", "useObjectValue", "useObjectProperty", "atom", "useMemo", "AtomObj", "make", "useAtomValue", "makeProperty", "useObjects", "refs", "get", "results", "ref", "value", "push"]
|
|
7
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"inputs":{"src/useQuery.ts":{"bytes":5192,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true}],"format":"esm"},"src/useSchema.ts":{"bytes":4017,"imports":[{"path":"react","kind":"import-statement","external":true}],"format":"esm"},"src/useObject.ts":{"bytes":17411,"imports":[{"path":"@effect-atom/atom/Atom","kind":"import-statement","external":true},{"path":"@effect-atom/atom-react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"@dxos/echo-atom","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":638,"imports":[{"path":"src/useQuery.ts","kind":"import-statement","original":"./useQuery"},{"path":"src/useSchema.ts","kind":"import-statement","original":"./useSchema"},{"path":"src/useObject.ts","kind":"import-statement","original":"./useObject"}],"format":"esm"}},"outputs":{"dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":15154},"dist/lib/node-esm/index.mjs":{"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@effect-atom/atom/Atom","kind":"import-statement","external":true},{"path":"@effect-atom/atom-react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"@dxos/echo-atom","kind":"import-statement","external":true}],"exports":["useObject","useObjects","useQuery","useSchema"],"entryPoint":"src/index.ts","inputs":{"src/useQuery.ts":{"bytesInOutput":921},"src/index.ts":{"bytesInOutput":0},"src/useSchema.ts":{"bytesInOutput":889},"src/useObject.ts":{"bytesInOutput":1979}},"bytes":4041}}}
|