@dxos/react-client 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae
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/.storybook/main.mts +2 -4
- package/.storybook/preview.mts +2 -2
- package/dist/lib/browser/chunk-5UKA2BMA.mjs +179 -0
- package/dist/lib/browser/chunk-5UKA2BMA.mjs.map +7 -0
- package/dist/lib/browser/chunk-PFF63FPR.mjs +16 -0
- package/dist/lib/browser/chunk-PFF63FPR.mjs.map +7 -0
- package/dist/lib/browser/chunk-TSF6Y5VB.mjs +8 -0
- package/dist/lib/browser/chunk-TSF6Y5VB.mjs.map +7 -0
- package/dist/lib/browser/devtools/index.mjs +2 -1
- package/dist/lib/browser/devtools/index.mjs.map +1 -1
- package/dist/lib/browser/echo/index.mjs +44 -94
- package/dist/lib/browser/echo/index.mjs.map +4 -4
- package/dist/lib/browser/halo/index.mjs +7 -20
- package/dist/lib/browser/halo/index.mjs.map +2 -2
- package/dist/lib/browser/index.mjs +114 -12
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/mesh/index.mjs +2 -1
- package/dist/lib/browser/mesh/index.mjs.map +1 -1
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +83 -110
- package/dist/lib/browser/testing/index.mjs.map +3 -3
- package/dist/lib/node-esm/chunk-373DPHEQ.mjs +10 -0
- package/dist/lib/node-esm/chunk-373DPHEQ.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-NETTSER2.mjs +17 -0
- package/dist/lib/node-esm/chunk-NETTSER2.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-T3QTQHBD.mjs +180 -0
- package/dist/lib/node-esm/chunk-T3QTQHBD.mjs.map +7 -0
- package/dist/lib/node-esm/devtools/index.mjs +2 -1
- package/dist/lib/node-esm/devtools/index.mjs.map +1 -1
- package/dist/lib/node-esm/echo/index.mjs +44 -94
- package/dist/lib/node-esm/echo/index.mjs.map +4 -4
- package/dist/lib/node-esm/halo/index.mjs +7 -20
- package/dist/lib/node-esm/halo/index.mjs.map +2 -2
- package/dist/lib/node-esm/index.mjs +114 -12
- package/dist/lib/node-esm/index.mjs.map +4 -4
- package/dist/lib/node-esm/mesh/index.mjs +2 -1
- package/dist/lib/node-esm/mesh/index.mjs.map +1 -1
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +83 -110
- package/dist/lib/node-esm/testing/index.mjs.map +3 -3
- package/dist/types/src/client/ClientProvider.d.ts +0 -10
- package/dist/types/src/client/ClientProvider.d.ts.map +1 -1
- package/dist/types/src/echo/index.d.ts +2 -2
- package/dist/types/src/echo/index.d.ts.map +1 -1
- package/dist/types/src/echo/useMembers.d.ts +2 -2
- package/dist/types/src/echo/useMembers.d.ts.map +1 -1
- package/dist/types/src/echo/useQueue.d.ts +2 -2
- package/dist/types/src/echo/useQueue.d.ts.map +1 -1
- package/dist/types/src/echo/useSpaceInvitations.d.ts +3 -2
- package/dist/types/src/echo/useSpaceInvitations.d.ts.map +1 -1
- package/dist/types/src/echo/useSpaceProperties.d.ts +13 -0
- package/dist/types/src/echo/useSpaceProperties.d.ts.map +1 -0
- package/dist/types/src/echo/useSpaces.d.ts +17 -8
- package/dist/types/src/echo/useSpaces.d.ts.map +1 -1
- package/dist/types/src/testing/ClientRepeater.d.ts +5 -4
- package/dist/types/src/testing/ClientRepeater.d.ts.map +1 -1
- package/dist/types/src/testing/ClientRepeater.stories.d.ts.map +1 -1
- package/dist/types/src/testing/context.d.ts +4 -2
- package/dist/types/src/testing/context.d.ts.map +1 -1
- package/dist/types/src/testing/withClientProvider.d.ts +0 -3
- package/dist/types/src/testing/withClientProvider.d.ts.map +1 -1
- package/dist/types/src/testing/withClientProvider.stories.d.ts +1 -0
- package/dist/types/src/testing/withClientProvider.stories.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/docs/README.md +38 -38
- package/moon.yml +2 -5
- package/package.json +35 -32
- package/src/client/ClientProvider.tsx +12 -26
- package/src/echo/index.ts +2 -2
- package/src/echo/useMembers.ts +5 -3
- package/src/echo/useQueue.ts +2 -2
- package/src/echo/useSpaceInvitations.ts +9 -4
- package/src/echo/useSpaceProperties.ts +28 -0
- package/src/echo/useSpaces.test.tsx +1 -1
- package/src/echo/useSpaces.ts +33 -12
- package/src/echo/useSyncState.ts +2 -2
- package/src/halo/Passkey.stories.tsx +3 -3
- package/src/testing/ClientRepeater.stories.tsx +9 -4
- package/src/testing/ClientRepeater.tsx +9 -12
- package/src/testing/context.tsx +4 -3
- package/src/testing/withClientProvider.stories.tsx +14 -9
- package/src/testing/withClientProvider.tsx +62 -79
- package/tsconfig.json +3 -3
- package/typedoc.json +1 -1
- package/vitest.config.ts +1 -1
- package/dist/lib/browser/chunk-TA2HGRAF.mjs +0 -309
- package/dist/lib/browser/chunk-TA2HGRAF.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-ZJMNF7GC.mjs +0 -311
- package/dist/lib/node-esm/chunk-ZJMNF7GC.mjs.map +0 -7
- package/dist/types/src/echo/useQuery.d.ts +0 -11
- package/dist/types/src/echo/useQuery.d.ts.map +0 -1
- package/dist/types/src/echo/useQuery.test.d.ts +0 -2
- package/dist/types/src/echo/useQuery.test.d.ts.map +0 -1
- package/dist/types/src/echo/useSchema.d.ts +0 -8
- package/dist/types/src/echo/useSchema.d.ts.map +0 -1
- package/dist/types/src/playwright/playwright.config.d.ts +0 -3
- package/dist/types/src/playwright/playwright.config.d.ts.map +0 -1
- package/dist/types/src/playwright/smoke.spec.d.ts +0 -2
- package/dist/types/src/playwright/smoke.spec.d.ts.map +0 -1
- package/src/echo/useQuery.test.tsx +0 -129
- package/src/echo/useQuery.ts +0 -72
- package/src/echo/useSchema.ts +0 -54
- package/src/playwright/playwright.config.ts +0 -17
- package/src/playwright/smoke.spec.ts +0 -24
package/docs/README.md
CHANGED
|
@@ -168,41 +168,41 @@ dxos/react-client --> dxos/react-async
|
|
|
168
168
|
|
|
169
169
|
## Dependencies
|
|
170
170
|
|
|
171
|
-
| Module
|
|
172
|
-
|
|
173
|
-
| [`@dxos/async`](../../../common/async/docs/README.md)
|
|
174
|
-
| [`@dxos/broadcast`](../../../core/mesh/broadcast/docs/README.md)
|
|
175
|
-
| [`@dxos/client`](../../client/docs/README.md)
|
|
176
|
-
| [`@dxos/client-services`](../../client-services/docs/README.md)
|
|
177
|
-
| [`@dxos/codec-protobuf`](../../../common/codec-protobuf/docs/README.md)
|
|
178
|
-
| [`@dxos/config`](../../config/docs/README.md)
|
|
179
|
-
| [`@dxos/context`](../../../common/context/docs/README.md)
|
|
180
|
-
| [`@dxos/credentials`](../../../core/halo/credentials/docs/README.md)
|
|
181
|
-
| [`@dxos/crypto`](../../../common/crypto/docs/README.md)
|
|
182
|
-
| [`@dxos/debug`](../../../common/debug/docs/README.md)
|
|
183
|
-
| [`@dxos/echo-db`](../../../core/echo/echo-db/docs/README.md)
|
|
184
|
-
| [`@dxos/errors`](../../errors/docs/README.md)
|
|
185
|
-
| [`@dxos/feed-store`](../../../common/feed-store/docs/README.md)
|
|
186
|
-
| [`@dxos/hypercore`](../../../common/hypercore/docs/README.md)
|
|
187
|
-
| [`@dxos/keyring`](../../../core/halo/keyring/docs/README.md)
|
|
188
|
-
| [`@dxos/keys`](../../../common/keys/docs/README.md)
|
|
189
|
-
| [`@dxos/log`](../../../common/log/docs/README.md)
|
|
190
|
-
| [`@dxos/mesh-protocol`](../../../core/mesh/mesh-protocol/docs/README.md)
|
|
191
|
-
| [`@dxos/messaging`](../../../core/mesh/messaging/docs/README.md)
|
|
192
|
-
| [`@dxos/model-factory`](../../../core/echo/model-factory/docs/README.md)
|
|
193
|
-
| [`@dxos/network-generator`](../../../core/mesh/network-generator/docs/README.md)
|
|
194
|
-
| [`@dxos/network-manager`](../../../core/mesh/network-manager/docs/README.md)
|
|
195
|
-
| [`@dxos/document-model`](../../../core/echo/document-model/docs/README.md)
|
|
196
|
-
| [`@dxos/protocol-plugin-presence`](../../../core/mesh/protocol-plugin-presence/docs/README.md)
|
|
197
|
-
| [`@dxos/protocol-plugin-replicator`](../../../core/mesh/protocol-plugin-replicator/docs/README.md) |
|
|
198
|
-
| [`@dxos/protocol-plugin-rpc`](../../../core/mesh/protocol-plugin-rpc/docs/README.md)
|
|
199
|
-
| [`@dxos/protocols`](../../../core/protocols/docs/README.md)
|
|
200
|
-
| [`@dxos/random-access-storage`](../../../common/random-access-storage/docs/README.md)
|
|
201
|
-
| [`@dxos/react-async`](../../../common/react-async/docs/README.md)
|
|
202
|
-
| [`@dxos/rpc`](../../../core/mesh/rpc/docs/README.md)
|
|
203
|
-
| [`@dxos/rpc-tunnel`](../../../core/mesh/rpc-tunnel/docs/README.md)
|
|
204
|
-
| [`@dxos/teleport`](../../../core/mesh/teleport/docs/README.md)
|
|
205
|
-
| [`@dxos/teleport-plugin-replicator`](../../../core/mesh/teleport-plugin-replicator/docs/README.md) |
|
|
206
|
-
| [`@dxos/text-model`](../../../core/echo/text-model/docs/README.md)
|
|
207
|
-
| [`@dxos/timeframe`](../../../common/timeframe/docs/README.md)
|
|
208
|
-
| [`@dxos/util`](../../../common/util/docs/README.md)
|
|
171
|
+
| Module | Direct |
|
|
172
|
+
| -------------------------------------------------------------------------------------------------- | ------- |
|
|
173
|
+
| [`@dxos/async`](../../../common/async/docs/README.md) | ✓ |
|
|
174
|
+
| [`@dxos/broadcast`](../../../core/mesh/broadcast/docs/README.md) | |
|
|
175
|
+
| [`@dxos/client`](../../client/docs/README.md) | ✓ |
|
|
176
|
+
| [`@dxos/client-services`](../../client-services/docs/README.md) | ✓ |
|
|
177
|
+
| [`@dxos/codec-protobuf`](../../../common/codec-protobuf/docs/README.md) | ✓ |
|
|
178
|
+
| [`@dxos/config`](../../config/docs/README.md) | ✓ |
|
|
179
|
+
| [`@dxos/context`](../../../common/context/docs/README.md) | |
|
|
180
|
+
| [`@dxos/credentials`](../../../core/halo/credentials/docs/README.md) | |
|
|
181
|
+
| [`@dxos/crypto`](../../../common/crypto/docs/README.md) | |
|
|
182
|
+
| [`@dxos/debug`](../../../common/debug/docs/README.md) | ✓ |
|
|
183
|
+
| [`@dxos/echo-db`](../../../core/echo/echo-db/docs/README.md) | |
|
|
184
|
+
| [`@dxos/errors`](../../errors/docs/README.md) | |
|
|
185
|
+
| [`@dxos/feed-store`](../../../common/feed-store/docs/README.md) | |
|
|
186
|
+
| [`@dxos/hypercore`](../../../common/hypercore/docs/README.md) | |
|
|
187
|
+
| [`@dxos/keyring`](../../../core/halo/keyring/docs/README.md) | |
|
|
188
|
+
| [`@dxos/keys`](../../../common/keys/docs/README.md) | ✓ |
|
|
189
|
+
| [`@dxos/log`](../../../common/log/docs/README.md) | ✓ |
|
|
190
|
+
| [`@dxos/mesh-protocol`](../../../core/mesh/mesh-protocol/docs/README.md) | |
|
|
191
|
+
| [`@dxos/messaging`](../../../core/mesh/messaging/docs/README.md) | ✓ |
|
|
192
|
+
| [`@dxos/model-factory`](../../../core/echo/model-factory/docs/README.md) | |
|
|
193
|
+
| [`@dxos/network-generator`](../../../core/mesh/network-generator/docs/README.md) | |
|
|
194
|
+
| [`@dxos/network-manager`](../../../core/mesh/network-manager/docs/README.md) | |
|
|
195
|
+
| [`@dxos/document-model`](../../../core/echo/document-model/docs/README.md) | |
|
|
196
|
+
| [`@dxos/protocol-plugin-presence`](../../../core/mesh/protocol-plugin-presence/docs/README.md) | |
|
|
197
|
+
| [`@dxos/protocol-plugin-replicator`](../../../core/mesh/protocol-plugin-replicator/docs/README.md) | |
|
|
198
|
+
| [`@dxos/protocol-plugin-rpc`](../../../core/mesh/protocol-plugin-rpc/docs/README.md) | |
|
|
199
|
+
| [`@dxos/protocols`](../../../core/protocols/docs/README.md) | ✓ |
|
|
200
|
+
| [`@dxos/random-access-storage`](../../../common/random-access-storage/docs/README.md) | |
|
|
201
|
+
| [`@dxos/react-async`](../../../common/react-async/docs/README.md) | ✓ |
|
|
202
|
+
| [`@dxos/rpc`](../../../core/mesh/rpc/docs/README.md) | ✓ |
|
|
203
|
+
| [`@dxos/rpc-tunnel`](../../../core/mesh/rpc-tunnel/docs/README.md) | ✓ |
|
|
204
|
+
| [`@dxos/teleport`](../../../core/mesh/teleport/docs/README.md) | |
|
|
205
|
+
| [`@dxos/teleport-plugin-replicator`](../../../core/mesh/teleport-plugin-replicator/docs/README.md) | |
|
|
206
|
+
| [`@dxos/text-model`](../../../core/echo/text-model/docs/README.md) | |
|
|
207
|
+
| [`@dxos/timeframe`](../../../common/timeframe/docs/README.md) | |
|
|
208
|
+
| [`@dxos/util`](../../../common/util/docs/README.md) | ✓ |
|
package/moon.yml
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
|
|
1
|
+
layer: library
|
|
2
2
|
language: typescript
|
|
3
3
|
tags:
|
|
4
|
-
- e2e
|
|
5
4
|
- ts-build
|
|
6
5
|
- ts-test
|
|
6
|
+
- ts-test-storybook
|
|
7
7
|
- typedoc
|
|
8
8
|
- pack
|
|
9
9
|
- storybook
|
|
@@ -18,6 +18,3 @@ tasks:
|
|
|
18
18
|
- '--entryPoint=src/mesh/index.ts'
|
|
19
19
|
- '--entryPoint=src/testing/index.ts'
|
|
20
20
|
- '--entryPoint=src/worker.ts'
|
|
21
|
-
test:
|
|
22
|
-
inputs:
|
|
23
|
-
- .storybook/*
|
package/package.json
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/react-client",
|
|
3
|
-
"version": "0.8.4-main.
|
|
3
|
+
"version": "0.8.4-main.c85a9c8dae",
|
|
4
4
|
"description": "React client API",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/dxos/dxos"
|
|
10
|
+
},
|
|
7
11
|
"license": "MIT",
|
|
8
12
|
"author": "DXOS.org",
|
|
9
|
-
"sideEffects":
|
|
13
|
+
"sideEffects": false,
|
|
10
14
|
"type": "module",
|
|
11
15
|
"exports": {
|
|
12
16
|
"./devtools": {
|
|
@@ -85,43 +89,42 @@
|
|
|
85
89
|
}
|
|
86
90
|
},
|
|
87
91
|
"dependencies": {
|
|
88
|
-
"
|
|
89
|
-
"@dxos/
|
|
90
|
-
"@dxos/
|
|
91
|
-
"@dxos/
|
|
92
|
-
"@dxos/
|
|
93
|
-
"@dxos/
|
|
94
|
-
"@dxos/
|
|
95
|
-
"@dxos/
|
|
96
|
-
"@dxos/echo
|
|
97
|
-
"@dxos/
|
|
98
|
-
"@dxos/
|
|
99
|
-
"@dxos/
|
|
100
|
-
"@dxos/
|
|
101
|
-
"@dxos/
|
|
102
|
-
"@dxos/util": "0.8.4-main.c4373fc"
|
|
92
|
+
"@dxos/async": "0.8.4-main.c85a9c8dae",
|
|
93
|
+
"@dxos/config": "0.8.4-main.c85a9c8dae",
|
|
94
|
+
"@dxos/codec-protobuf": "0.8.4-main.c85a9c8dae",
|
|
95
|
+
"@dxos/context": "0.8.4-main.c85a9c8dae",
|
|
96
|
+
"@dxos/debug": "0.8.4-main.c85a9c8dae",
|
|
97
|
+
"@dxos/echo-react": "0.8.4-main.c85a9c8dae",
|
|
98
|
+
"@dxos/log": "0.8.4-main.c85a9c8dae",
|
|
99
|
+
"@dxos/protocols": "0.8.4-main.c85a9c8dae",
|
|
100
|
+
"@dxos/echo": "0.8.4-main.c85a9c8dae",
|
|
101
|
+
"@dxos/react-hooks": "0.8.4-main.c85a9c8dae",
|
|
102
|
+
"@dxos/node-std": "0.8.4-main.c85a9c8dae",
|
|
103
|
+
"@dxos/invariant": "0.8.4-main.c85a9c8dae",
|
|
104
|
+
"@dxos/util": "0.8.4-main.c85a9c8dae",
|
|
105
|
+
"@dxos/client": "0.8.4-main.c85a9c8dae"
|
|
103
106
|
},
|
|
104
107
|
"devDependencies": {
|
|
105
|
-
"@types/react": "~19.2.
|
|
106
|
-
"@types/react-dom": "~19.2.
|
|
107
|
-
"react": "~19.2.
|
|
108
|
-
"react-dom": "~19.2.
|
|
108
|
+
"@types/react": "~19.2.7",
|
|
109
|
+
"@types/react-dom": "~19.2.3",
|
|
110
|
+
"react": "~19.2.3",
|
|
111
|
+
"react-dom": "~19.2.3",
|
|
109
112
|
"typedoc": "0.28.1",
|
|
110
|
-
"@dxos/
|
|
111
|
-
"@dxos/react-ui": "0.8.4-main.
|
|
112
|
-
"@dxos/
|
|
113
|
-
"@dxos/
|
|
114
|
-
"@dxos/
|
|
115
|
-
"@dxos/
|
|
113
|
+
"@dxos/react-ui-syntax-highlighter": "0.8.4-main.c85a9c8dae",
|
|
114
|
+
"@dxos/react-ui": "0.8.4-main.c85a9c8dae",
|
|
115
|
+
"@dxos/storybook-utils": "0.8.4-main.c85a9c8dae",
|
|
116
|
+
"@dxos/test-utils": "0.8.4-main.c85a9c8dae",
|
|
117
|
+
"@dxos/ui-theme": "0.8.4-main.c85a9c8dae",
|
|
118
|
+
"@dxos/random": "0.8.4-main.c85a9c8dae"
|
|
116
119
|
},
|
|
117
120
|
"peerDependencies": {
|
|
118
|
-
"react": "
|
|
119
|
-
"react-dom": "
|
|
121
|
+
"react": "~19.2.3",
|
|
122
|
+
"react-dom": "~19.2.3"
|
|
120
123
|
},
|
|
121
124
|
"optionalDependencies": {
|
|
122
|
-
"@dxos/random": "0.8.4-main.
|
|
123
|
-
"@dxos/
|
|
124
|
-
"@dxos/react-ui
|
|
125
|
+
"@dxos/random": "0.8.4-main.c85a9c8dae",
|
|
126
|
+
"@dxos/ui-theme": "0.8.4-main.c85a9c8dae",
|
|
127
|
+
"@dxos/react-ui": "0.8.4-main.c85a9c8dae"
|
|
125
128
|
},
|
|
126
129
|
"publishConfig": {
|
|
127
130
|
"access": "public"
|
|
@@ -13,7 +13,6 @@ import React, {
|
|
|
13
13
|
|
|
14
14
|
import { Client, type ClientOptions, type ClientServicesProvider, SystemStatus } from '@dxos/client';
|
|
15
15
|
import { type Config } from '@dxos/config';
|
|
16
|
-
import { registerSignalsRuntime } from '@dxos/echo-signals/react';
|
|
17
16
|
import { log } from '@dxos/log';
|
|
18
17
|
import { useAsyncEffect, useControlledState } from '@dxos/react-hooks';
|
|
19
18
|
import { type MaybePromise, type Provider, getAsyncProviderValue } from '@dxos/util';
|
|
@@ -56,12 +55,6 @@ export type ClientProviderProps = Omit<ClientOptions, 'config' | 'services'> &
|
|
|
56
55
|
*/
|
|
57
56
|
fallback?: FunctionComponent<Partial<ClientContextProps>>;
|
|
58
57
|
|
|
59
|
-
/**
|
|
60
|
-
* Enable (by default) registration of Preact signals runtime for reactive ECHO objects.
|
|
61
|
-
* @see https://www.npmjs.com/package/@preact/signals-react
|
|
62
|
-
*/
|
|
63
|
-
signalsRuntime?: boolean;
|
|
64
|
-
|
|
65
58
|
/**
|
|
66
59
|
* Skip the DXOS banner.
|
|
67
60
|
*/
|
|
@@ -81,24 +74,17 @@ export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps
|
|
|
81
74
|
(
|
|
82
75
|
{
|
|
83
76
|
children,
|
|
84
|
-
config:
|
|
85
|
-
client:
|
|
86
|
-
services:
|
|
87
|
-
status:
|
|
77
|
+
config: configProp,
|
|
78
|
+
client: clientProp,
|
|
79
|
+
services: servicesProp,
|
|
80
|
+
status: statusProp,
|
|
88
81
|
fallback: Fallback = () => null,
|
|
89
|
-
signalsRuntime = true,
|
|
90
82
|
noBanner,
|
|
91
83
|
onInitialized,
|
|
92
84
|
...options
|
|
93
85
|
},
|
|
94
86
|
forwardedRef,
|
|
95
87
|
) => {
|
|
96
|
-
useEffect(() => {
|
|
97
|
-
// TODO(wittjosiah): Ideally this should be imported asynchronously because it is optional.
|
|
98
|
-
// Unfortunately, async import seemed to break signals React instrumentation.
|
|
99
|
-
signalsRuntime && registerSignalsRuntime();
|
|
100
|
-
}, []);
|
|
101
|
-
|
|
102
88
|
// The client is initialized asynchronously.
|
|
103
89
|
// If an error occurs during initialization, it is caught and the state is set.
|
|
104
90
|
// This allows the error to be thrown in the render method.
|
|
@@ -109,13 +95,13 @@ export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps
|
|
|
109
95
|
throw error;
|
|
110
96
|
}
|
|
111
97
|
|
|
112
|
-
const [client, setClient] = useState(
|
|
98
|
+
const [client, setClient] = useState(clientProp instanceof Client ? clientProp : undefined);
|
|
113
99
|
|
|
114
100
|
// Provide external access.
|
|
115
101
|
useImperativeHandle(forwardedRef, () => client, [client]);
|
|
116
102
|
|
|
117
103
|
// Client status subscription.
|
|
118
|
-
const [status, setStatus] = useControlledState(
|
|
104
|
+
const [status, setStatus] = useControlledState(statusProp);
|
|
119
105
|
useEffect(() => {
|
|
120
106
|
if (!client) {
|
|
121
107
|
return;
|
|
@@ -148,15 +134,15 @@ export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps
|
|
|
148
134
|
|
|
149
135
|
let client: Client;
|
|
150
136
|
try {
|
|
151
|
-
if (
|
|
137
|
+
if (clientProp) {
|
|
152
138
|
// Asynchronously request client.
|
|
153
|
-
client = await getAsyncProviderValue(
|
|
139
|
+
client = await getAsyncProviderValue(clientProp);
|
|
154
140
|
await initialize(client);
|
|
155
141
|
} else {
|
|
156
142
|
// Asynchronously construct client (config may be undefined).
|
|
157
|
-
const config = await getAsyncProviderValue(
|
|
143
|
+
const config = await getAsyncProviderValue(configProp);
|
|
158
144
|
log('resolved config', { config });
|
|
159
|
-
const services = await getAsyncProviderValue(
|
|
145
|
+
const services = await getAsyncProviderValue(servicesProp, config);
|
|
160
146
|
log('created services', { services });
|
|
161
147
|
client = new Client({ config, services, ...options });
|
|
162
148
|
log('created client');
|
|
@@ -172,7 +158,7 @@ export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps
|
|
|
172
158
|
log('clean up');
|
|
173
159
|
disposed = true;
|
|
174
160
|
// Only destroy if the client is not provided by the parent.
|
|
175
|
-
if (!
|
|
161
|
+
if (!clientProp) {
|
|
176
162
|
void client
|
|
177
163
|
?.destroy()
|
|
178
164
|
.then(() => {
|
|
@@ -181,7 +167,7 @@ export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps
|
|
|
181
167
|
.catch((err) => log.catch(err));
|
|
182
168
|
}
|
|
183
169
|
};
|
|
184
|
-
}, [
|
|
170
|
+
}, [configProp, clientProp, servicesProp, noBanner]);
|
|
185
171
|
|
|
186
172
|
if (!client?.initialized || status !== SystemStatus.ACTIVE) {
|
|
187
173
|
return <Fallback client={client} status={status} />;
|
package/src/echo/index.ts
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
export * from '@dxos/client/echo';
|
|
6
|
+
export * from '@dxos/echo-react';
|
|
6
7
|
|
|
7
8
|
export * from './useMembers';
|
|
8
|
-
export * from './useQuery';
|
|
9
9
|
export * from './useQueue';
|
|
10
|
-
export * from './useSchema';
|
|
11
10
|
export * from './useSpaces';
|
|
12
11
|
export * from './useSpaceInvitations';
|
|
12
|
+
export * from './useSpaceProperties';
|
|
13
13
|
export * from './useSubscription';
|
|
14
14
|
export * from './useSyncState';
|
package/src/echo/useMembers.ts
CHANGED
|
@@ -3,16 +3,18 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import { MulticastObservable } from '@dxos/async';
|
|
6
|
-
import { type
|
|
6
|
+
import { PublicKey, type PublicKeyLike } from '@dxos/client';
|
|
7
7
|
import { HaloSpaceMember, type SpaceMember } from '@dxos/client/echo';
|
|
8
8
|
import { useMulticastObservable } from '@dxos/react-hooks';
|
|
9
9
|
|
|
10
10
|
import { useSpaces } from './useSpaces';
|
|
11
11
|
|
|
12
|
-
export const useMembers = (spaceKey:
|
|
12
|
+
export const useMembers = (spaceKey: PublicKeyLike | undefined): SpaceMember[] => {
|
|
13
13
|
// TODO(dmaretskyi): useSpace hook for spaces that are not ready.
|
|
14
14
|
const spaces = useSpaces({ all: true });
|
|
15
|
-
const space = spaceKey
|
|
15
|
+
const space = spaceKey
|
|
16
|
+
? spaces.find((space) => (spaceKey instanceof PublicKey ? space.key.equals(spaceKey) : space.id === spaceKey))
|
|
17
|
+
: undefined;
|
|
16
18
|
|
|
17
19
|
// EMPTY_OBSERVABLE needs to be a stable reference to avoid re-subscribing on every render.
|
|
18
20
|
const members = useMulticastObservable(space?.members ?? MulticastObservable.empty()) ?? [];
|
package/src/echo/useQueue.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { useEffect, useMemo, useRef } from 'react';
|
|
|
6
6
|
|
|
7
7
|
import { type Queue } from '@dxos/client/echo';
|
|
8
8
|
import { raise } from '@dxos/debug';
|
|
9
|
-
import { type
|
|
9
|
+
import { type Entity } from '@dxos/echo';
|
|
10
10
|
import { type DXN } from '@dxos/keys';
|
|
11
11
|
|
|
12
12
|
import { useClient } from '../client';
|
|
@@ -24,7 +24,7 @@ export type UseQueueOptions = {
|
|
|
24
24
|
// TODO(dmaretskyi): Move into client package.
|
|
25
25
|
// TODO(dmaretskyi): Consider passing the space into the hook to support queue DXNs without space id.
|
|
26
26
|
// TODO(ZaymonFC): If queue is unchanged returned object should be refferentially stable on poll.
|
|
27
|
-
export const useQueue = <T extends
|
|
27
|
+
export const useQueue = <T extends Entity.Unknown>(
|
|
28
28
|
queueDxn?: DXN,
|
|
29
29
|
options: UseQueueOptions = {},
|
|
30
30
|
): Queue<T> | undefined => {
|
|
@@ -6,19 +6,24 @@ import { useMemo } from 'react';
|
|
|
6
6
|
|
|
7
7
|
import { MulticastObservable } from '@dxos/async';
|
|
8
8
|
import { type PublicKey } from '@dxos/client';
|
|
9
|
+
import { type SpaceId } from '@dxos/client/echo';
|
|
9
10
|
import { useMulticastObservable } from '@dxos/react-hooks';
|
|
10
11
|
|
|
11
12
|
import { type CancellableInvitationObservable, useInvitationStatus } from '../invitations';
|
|
12
13
|
|
|
13
14
|
import { useSpace } from './useSpaces';
|
|
14
15
|
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
// TODO(wittjosiah): Currently unable to remove `PublicKey` from this api.
|
|
17
|
+
// When initially joining a space that is all that is returned.
|
|
18
|
+
export const useSpaceInvitations = (spaceId?: SpaceId | PublicKey): CancellableInvitationObservable[] => {
|
|
19
|
+
const space = useSpace(spaceId);
|
|
17
20
|
return useMulticastObservable(space?.invitations ?? MulticastObservable.empty()) ?? [];
|
|
18
21
|
};
|
|
19
22
|
|
|
20
|
-
|
|
21
|
-
|
|
23
|
+
// TODO(wittjosiah): Currently unable to remove `PublicKey` from this api.
|
|
24
|
+
// When initially joining a space that is all that is returned.
|
|
25
|
+
export const useSpaceInvitation = (spaceId?: SpaceId | PublicKey, invitationId?: string) => {
|
|
26
|
+
const invitations = useSpaceInvitations(spaceId);
|
|
22
27
|
const invitation = useMemo(
|
|
23
28
|
() => invitations.find((invitation) => invitation.get().invitationId === invitationId),
|
|
24
29
|
[invitations],
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { MulticastObservable } from '@dxos/async';
|
|
6
|
+
import { type SpaceProperties, SpaceState } from '@dxos/client/echo';
|
|
7
|
+
import { type Key, type Obj } from '@dxos/echo';
|
|
8
|
+
import { type ObjectUpdateCallback, useObject } from '@dxos/echo-react';
|
|
9
|
+
import { useMulticastObservable } from '@dxos/react-hooks';
|
|
10
|
+
|
|
11
|
+
import { useSpace } from './useSpaces';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Subscribe to a space's properties with reactive updates.
|
|
15
|
+
* Returns undefined if the space is undefined or not ready yet.
|
|
16
|
+
* Automatically waits for the space to be ready before returning properties.
|
|
17
|
+
*
|
|
18
|
+
* @param spaceId - The space ID to get properties from (can be undefined).
|
|
19
|
+
* @returns A tuple of [snapshot, updateCallback] or [undefined, no-op] if not ready.
|
|
20
|
+
*/
|
|
21
|
+
export const useSpaceProperties = (
|
|
22
|
+
spaceId: Key.SpaceId | undefined,
|
|
23
|
+
): [Obj.Snapshot<SpaceProperties> | undefined, ObjectUpdateCallback<SpaceProperties>] => {
|
|
24
|
+
const space = useSpace(spaceId);
|
|
25
|
+
const spaceState = useMulticastObservable(space?.state ?? MulticastObservable.empty());
|
|
26
|
+
const properties = spaceState === SpaceState.SPACE_READY ? space?.properties : undefined;
|
|
27
|
+
return useObject(properties);
|
|
28
|
+
};
|
|
@@ -47,7 +47,7 @@ describe('useSpace', () => {
|
|
|
47
47
|
test('gets space by key', async () => {
|
|
48
48
|
const { client, space } = await createClient({ createIdentity: true, createSpace: true });
|
|
49
49
|
const wrapper = await createClientContextProvider(client);
|
|
50
|
-
const { result } = renderHook(() => useSpace(space!.
|
|
50
|
+
const { result } = renderHook(() => useSpace(space!.id), { wrapper });
|
|
51
51
|
expect(result.current).to.not.be.undefined;
|
|
52
52
|
});
|
|
53
53
|
});
|
package/src/echo/useSpaces.ts
CHANGED
|
@@ -4,37 +4,45 @@
|
|
|
4
4
|
|
|
5
5
|
import { useState } from 'react';
|
|
6
6
|
|
|
7
|
-
import {
|
|
8
|
-
import { type Space, SpaceState } from '@dxos/client/echo';
|
|
7
|
+
import { PublicKey } from '@dxos/client';
|
|
8
|
+
import { type Space, type SpaceId, SpaceState } from '@dxos/client/echo';
|
|
9
9
|
import { useAsyncEffect, useMulticastObservable } from '@dxos/react-hooks';
|
|
10
10
|
|
|
11
11
|
import { useClient } from '../client';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* Get a specific Space using its
|
|
14
|
+
* Get a specific Space using its id.
|
|
15
15
|
* The space is not guaranteed to be in the ready state.
|
|
16
|
-
* Returns the default space if no
|
|
16
|
+
* Returns the default space if no id is provided.
|
|
17
17
|
* Requires a ClientProvider somewhere in the parent tree.
|
|
18
18
|
*
|
|
19
|
-
* @param
|
|
19
|
+
* @param spaceId the id of the space to look for
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
// TODO(wittjosiah): Currently unable to remove `PublicKey` from this api.
|
|
22
|
+
// When initially joining a space that is all that is returned.
|
|
23
|
+
export const useSpace = (spaceId?: SpaceId | PublicKey): Space | undefined => {
|
|
22
24
|
const client = useClient();
|
|
23
25
|
const spaces = useMulticastObservable<Space[]>(client.spaces);
|
|
24
26
|
const [ready, setReady] = useState(false);
|
|
25
27
|
|
|
26
28
|
useAsyncEffect(async () => {
|
|
27
29
|
// Only wait for ready if looking for the default space.
|
|
28
|
-
if (
|
|
30
|
+
if (spaceId) {
|
|
29
31
|
return;
|
|
30
32
|
}
|
|
31
33
|
|
|
32
34
|
await client.spaces.waitUntilReady();
|
|
33
35
|
setReady(true);
|
|
34
|
-
}, [client,
|
|
36
|
+
}, [client, spaceId]);
|
|
35
37
|
|
|
36
|
-
if (
|
|
37
|
-
return spaces.find((space) =>
|
|
38
|
+
if (spaceId) {
|
|
39
|
+
return spaces.find((space) => {
|
|
40
|
+
if (spaceId instanceof PublicKey) {
|
|
41
|
+
return space.key.equals(spaceId);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
return space.id === spaceId;
|
|
45
|
+
});
|
|
38
46
|
}
|
|
39
47
|
|
|
40
48
|
if (ready && client.halo.identity.get()) {
|
|
@@ -42,7 +50,20 @@ export const useSpace = (spaceKeyLike?: PublicKeyLike): Space | undefined => {
|
|
|
42
50
|
}
|
|
43
51
|
};
|
|
44
52
|
|
|
45
|
-
|
|
53
|
+
/**
|
|
54
|
+
* Get a Space database by the id of the space.
|
|
55
|
+
* The space is not guaranteed to be in the ready state.
|
|
56
|
+
* Returns the default space if no id is provided.
|
|
57
|
+
* Requires a ClientProvider somewhere in the parent tree.
|
|
58
|
+
*
|
|
59
|
+
* @param spaceId the id of the space to look for
|
|
60
|
+
*/
|
|
61
|
+
export const useDatabase = (spaceId?: SpaceId): Space['db'] | undefined => {
|
|
62
|
+
const space = useSpace(spaceId);
|
|
63
|
+
return space?.db;
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
export type UseSpacesProps = {
|
|
46
67
|
/**
|
|
47
68
|
* Return uninitialized spaces as well.
|
|
48
69
|
*/
|
|
@@ -55,7 +76,7 @@ export type UseSpacesParams = {
|
|
|
55
76
|
* By default, only ready spaces are returned.
|
|
56
77
|
* @returns an array of Spaces
|
|
57
78
|
*/
|
|
58
|
-
export const useSpaces = ({ all = false }:
|
|
79
|
+
export const useSpaces = ({ all = false }: UseSpacesProps = {}): Space[] => {
|
|
59
80
|
const client = useClient();
|
|
60
81
|
const spaces = useMulticastObservable<Space[]>(client.spaces);
|
|
61
82
|
|
package/src/echo/useSyncState.ts
CHANGED
|
@@ -30,7 +30,7 @@ export const useSyncState = (): SpaceSyncStateMap => {
|
|
|
30
30
|
}
|
|
31
31
|
|
|
32
32
|
ctx.onDispose(
|
|
33
|
-
space.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
|
|
33
|
+
space.internal.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
|
|
34
34
|
const syncState = peers.find((state) => isEdgePeerId(state.peerId, space.id));
|
|
35
35
|
if (syncState) {
|
|
36
36
|
setSpaceState((spaceState) => ({ ...spaceState, [space.id]: syncState }));
|
|
@@ -62,7 +62,7 @@ export const useSpaceSyncState = (space: Space): PeerSyncState | undefined => {
|
|
|
62
62
|
|
|
63
63
|
useEffect(() => {
|
|
64
64
|
const ctx = new Context();
|
|
65
|
-
space.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
|
|
65
|
+
space.internal.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
|
|
66
66
|
const syncState = peers.find((state) => isEdgePeerId(state.peerId, space.id));
|
|
67
67
|
if (syncState) {
|
|
68
68
|
setSpaceState(syncState);
|
|
@@ -105,7 +105,7 @@ const Test = () => {
|
|
|
105
105
|
|
|
106
106
|
return (
|
|
107
107
|
<>
|
|
108
|
-
<div className='
|
|
108
|
+
<div className='mb-4 flex gap-2'>
|
|
109
109
|
<Button disabled={!!identity} onClick={handleCreateIdentity}>
|
|
110
110
|
Create Identity
|
|
111
111
|
</Button>
|
|
@@ -116,7 +116,7 @@ const Test = () => {
|
|
|
116
116
|
Authenticate with Passkey
|
|
117
117
|
</Button>
|
|
118
118
|
</div>
|
|
119
|
-
<div className='flex flex-col min-w-[28rem] divide-y divide-separator border border-separator rounded'>
|
|
119
|
+
<div className='flex flex-col min-w-[28rem] divide-y divide-separator border border-separator rounded-sm'>
|
|
120
120
|
<SyntaxHighlighter language='json'>
|
|
121
121
|
{JSON.stringify({ identity, credentials: credentials.length }, null, 2)}
|
|
122
122
|
</SyntaxHighlighter>
|
|
@@ -148,7 +148,7 @@ const config = new Config({
|
|
|
148
148
|
const meta = {
|
|
149
149
|
title: 'sdk/react-client/Passkeys',
|
|
150
150
|
render: Test,
|
|
151
|
-
decorators: [withClientProvider({ config }), withTheme],
|
|
151
|
+
decorators: [withClientProvider({ config }), withTheme()],
|
|
152
152
|
} satisfies Meta;
|
|
153
153
|
|
|
154
154
|
export default meta;
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
import { type Meta, type StoryObj } from '@storybook/react-vite';
|
|
6
6
|
import React from 'react';
|
|
7
7
|
|
|
8
|
+
import { Obj } from '@dxos/echo';
|
|
8
9
|
import { Input } from '@dxos/react-ui';
|
|
9
10
|
import { withTheme } from '@dxos/react-ui/testing';
|
|
10
11
|
import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
|
|
@@ -16,7 +17,7 @@ import { type ClientRepeatedComponentProps, ClientRepeater } from './ClientRepea
|
|
|
16
17
|
|
|
17
18
|
const meta = {
|
|
18
19
|
title: 'sdk/react-client/ClientRepeater',
|
|
19
|
-
decorators: [withTheme],
|
|
20
|
+
decorators: [withTheme()],
|
|
20
21
|
} satisfies Meta<typeof Input>;
|
|
21
22
|
|
|
22
23
|
export default meta;
|
|
@@ -32,9 +33,9 @@ const ClientStory = () => {
|
|
|
32
33
|
return <JsonPanel value={client.toJSON()} />;
|
|
33
34
|
};
|
|
34
35
|
|
|
35
|
-
const ClientSpace = ({
|
|
36
|
+
const ClientSpace = ({ spaceId }: ClientRepeatedComponentProps) => {
|
|
36
37
|
const client = useClient();
|
|
37
|
-
const space = useSpace(
|
|
38
|
+
const space = useSpace(spaceId);
|
|
38
39
|
if (!space?.isOpen) {
|
|
39
40
|
return null;
|
|
40
41
|
}
|
|
@@ -45,7 +46,11 @@ const ClientSpace = ({ spaceKey }: ClientRepeatedComponentProps) => {
|
|
|
45
46
|
<Input.TextInput
|
|
46
47
|
placeholder='Name'
|
|
47
48
|
value={space.properties.name}
|
|
48
|
-
onChange={(event) =>
|
|
49
|
+
onChange={(event) =>
|
|
50
|
+
Obj.change(space.properties, (p) => {
|
|
51
|
+
p.name = event.target.value;
|
|
52
|
+
})
|
|
53
|
+
}
|
|
49
54
|
/>
|
|
50
55
|
</Input.Root>
|
|
51
56
|
<JsonPanel value={client.toJSON()} />
|