@dxos/react-client 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

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.
Files changed (135) hide show
  1. package/.storybook/main.mts +9 -0
  2. package/.storybook/preview.mts +8 -0
  3. package/.swc/plugins/linux_x86_64_19.0.0/727453fb3a62f7f1d952a41e051ca8a6f88cadc45cee43c6a4d1aa45f9b75665.wasmer-v7 +0 -0
  4. package/dist/lib/browser/chunk-5UKA2BMA.mjs +179 -0
  5. package/dist/lib/browser/chunk-5UKA2BMA.mjs.map +7 -0
  6. package/dist/lib/browser/{chunk-O5SEVDJG.mjs → chunk-LO3TU5CK.mjs} +5 -5
  7. package/dist/lib/browser/chunk-LO3TU5CK.mjs.map +7 -0
  8. package/dist/lib/browser/chunk-PFF63FPR.mjs +16 -0
  9. package/dist/lib/browser/chunk-PFF63FPR.mjs.map +7 -0
  10. package/dist/lib/browser/chunk-TSF6Y5VB.mjs +8 -0
  11. package/dist/lib/browser/chunk-TSF6Y5VB.mjs.map +7 -0
  12. package/dist/lib/browser/devtools/index.mjs +3 -2
  13. package/dist/lib/browser/devtools/index.mjs.map +3 -3
  14. package/dist/lib/browser/echo/index.mjs +58 -121
  15. package/dist/lib/browser/echo/index.mjs.map +4 -4
  16. package/dist/lib/browser/halo/index.mjs +5 -3
  17. package/dist/lib/browser/halo/index.mjs.map +3 -3
  18. package/dist/lib/browser/index.mjs +114 -12
  19. package/dist/lib/browser/index.mjs.map +4 -4
  20. package/dist/lib/browser/invitations/index.mjs +1 -1
  21. package/dist/lib/browser/mesh/index.mjs +2 -1
  22. package/dist/lib/browser/mesh/index.mjs.map +1 -1
  23. package/dist/lib/browser/meta.json +1 -1
  24. package/dist/lib/browser/testing/index.mjs +121 -149
  25. package/dist/lib/browser/testing/index.mjs.map +3 -3
  26. package/dist/lib/node-esm/chunk-373DPHEQ.mjs +10 -0
  27. package/dist/lib/node-esm/chunk-373DPHEQ.mjs.map +7 -0
  28. package/dist/lib/node-esm/{chunk-TU2JJLZK.mjs → chunk-AQJH2UNZ.mjs} +5 -5
  29. package/dist/lib/node-esm/chunk-AQJH2UNZ.mjs.map +7 -0
  30. package/dist/lib/node-esm/chunk-NETTSER2.mjs +17 -0
  31. package/dist/lib/node-esm/chunk-NETTSER2.mjs.map +7 -0
  32. package/dist/lib/node-esm/chunk-T3QTQHBD.mjs +180 -0
  33. package/dist/lib/node-esm/chunk-T3QTQHBD.mjs.map +7 -0
  34. package/dist/lib/node-esm/devtools/index.mjs +3 -2
  35. package/dist/lib/node-esm/devtools/index.mjs.map +3 -3
  36. package/dist/lib/node-esm/echo/index.mjs +58 -121
  37. package/dist/lib/node-esm/echo/index.mjs.map +4 -4
  38. package/dist/lib/node-esm/halo/index.mjs +5 -3
  39. package/dist/lib/node-esm/halo/index.mjs.map +3 -3
  40. package/dist/lib/node-esm/index.mjs +114 -12
  41. package/dist/lib/node-esm/index.mjs.map +4 -4
  42. package/dist/lib/node-esm/invitations/index.mjs +1 -1
  43. package/dist/lib/node-esm/mesh/index.mjs +2 -1
  44. package/dist/lib/node-esm/mesh/index.mjs.map +1 -1
  45. package/dist/lib/node-esm/meta.json +1 -1
  46. package/dist/lib/node-esm/testing/index.mjs +121 -149
  47. package/dist/lib/node-esm/testing/index.mjs.map +3 -3
  48. package/dist/types/src/client/AgentHostingProvider.d.ts.map +1 -1
  49. package/dist/types/src/client/ClientProvider.d.ts +0 -10
  50. package/dist/types/src/client/ClientProvider.d.ts.map +1 -1
  51. package/dist/types/src/echo/index.d.ts +2 -2
  52. package/dist/types/src/echo/index.d.ts.map +1 -1
  53. package/dist/types/src/echo/useMembers.d.ts +2 -2
  54. package/dist/types/src/echo/useMembers.d.ts.map +1 -1
  55. package/dist/types/src/echo/useQueue.d.ts +3 -2
  56. package/dist/types/src/echo/useQueue.d.ts.map +1 -1
  57. package/dist/types/src/echo/useSpaceInvitations.d.ts +3 -2
  58. package/dist/types/src/echo/useSpaceInvitations.d.ts.map +1 -1
  59. package/dist/types/src/echo/useSpaceProperties.d.ts +13 -0
  60. package/dist/types/src/echo/useSpaceProperties.d.ts.map +1 -0
  61. package/dist/types/src/echo/useSpaces.d.ts +18 -9
  62. package/dist/types/src/echo/useSpaces.d.ts.map +1 -1
  63. package/dist/types/src/echo/useSubscription.d.ts +1 -1
  64. package/dist/types/src/echo/useSubscription.d.ts.map +1 -1
  65. package/dist/types/src/echo/useSyncState.d.ts +1 -1
  66. package/dist/types/src/echo/useSyncState.d.ts.map +1 -1
  67. package/dist/types/src/halo/Passkey.stories.d.ts +5 -5
  68. package/dist/types/src/halo/Passkey.stories.d.ts.map +1 -1
  69. package/dist/types/src/halo/useHaloInvitations.d.ts.map +1 -1
  70. package/dist/types/src/invitations/useInvitationStatus.d.ts +1 -1
  71. package/dist/types/src/invitations/useInvitationStatus.d.ts.map +1 -1
  72. package/dist/types/src/testing/ClientRepeater.d.ts +6 -5
  73. package/dist/types/src/testing/ClientRepeater.d.ts.map +1 -1
  74. package/dist/types/src/testing/ClientRepeater.stories.d.ts +6 -10
  75. package/dist/types/src/testing/ClientRepeater.stories.d.ts.map +1 -1
  76. package/dist/types/src/testing/context.d.ts +4 -2
  77. package/dist/types/src/testing/context.d.ts.map +1 -1
  78. package/dist/types/src/testing/util.d.ts.map +1 -1
  79. package/dist/types/src/testing/withClientProvider.d.ts +6 -10
  80. package/dist/types/src/testing/withClientProvider.d.ts.map +1 -1
  81. package/dist/types/src/testing/withClientProvider.stories.d.ts +8 -9
  82. package/dist/types/src/testing/withClientProvider.stories.d.ts.map +1 -1
  83. package/dist/types/tsconfig.tsbuildinfo +1 -1
  84. package/docs/README.md +38 -38
  85. package/moon.yml +3 -2
  86. package/package.json +43 -33
  87. package/src/client/AgentHostingProvider.tsx +1 -1
  88. package/src/client/ClientProvider.test.tsx +3 -2
  89. package/src/client/ClientProvider.tsx +33 -50
  90. package/src/client/useConfig.test.tsx +2 -1
  91. package/src/devtools/useStream.ts +1 -1
  92. package/src/echo/index.ts +2 -2
  93. package/src/echo/useMembers.ts +5 -3
  94. package/src/echo/useQueue.ts +3 -2
  95. package/src/echo/useSpaceInvitations.ts +11 -5
  96. package/src/echo/useSpaceProperties.ts +28 -0
  97. package/src/echo/useSpaces.test.tsx +9 -14
  98. package/src/echo/useSpaces.ts +32 -30
  99. package/src/echo/useSubscription.ts +1 -1
  100. package/src/echo/useSyncState.ts +5 -4
  101. package/src/halo/Passkey.stories.tsx +19 -16
  102. package/src/halo/useDevices.test.tsx +2 -1
  103. package/src/halo/useHaloInvitations.ts +1 -1
  104. package/src/invitations/useInvitationStatus.ts +9 -8
  105. package/src/testing/ClientRepeater.stories.tsx +21 -12
  106. package/src/testing/ClientRepeater.tsx +29 -36
  107. package/src/testing/context.tsx +4 -3
  108. package/src/testing/util.tsx +0 -1
  109. package/src/testing/withClientProvider.stories.tsx +32 -17
  110. package/src/testing/withClientProvider.tsx +78 -94
  111. package/tsconfig.json +3 -6
  112. package/typedoc.json +1 -1
  113. package/vitest.config.ts +10 -16
  114. package/.swc/plugins/v7_linux_x86_64_13.0.0/f45bdff002284d9e8f9ef3f0be909de12da36c049cbcf261ac78fc00abb09a2d +0 -0
  115. package/dist/lib/browser/chunk-AAR7V3KL.mjs +0 -312
  116. package/dist/lib/browser/chunk-AAR7V3KL.mjs.map +0 -7
  117. package/dist/lib/browser/chunk-O5SEVDJG.mjs.map +0 -7
  118. package/dist/lib/node-esm/chunk-TU2JJLZK.mjs.map +0 -7
  119. package/dist/lib/node-esm/chunk-ZTD6HPV2.mjs +0 -314
  120. package/dist/lib/node-esm/chunk-ZTD6HPV2.mjs.map +0 -7
  121. package/dist/types/src/echo/useQuery.d.ts +0 -11
  122. package/dist/types/src/echo/useQuery.d.ts.map +0 -1
  123. package/dist/types/src/echo/useQuery.test.d.ts +0 -2
  124. package/dist/types/src/echo/useQuery.test.d.ts.map +0 -1
  125. package/dist/types/src/echo/useSchema.d.ts +0 -8
  126. package/dist/types/src/echo/useSchema.d.ts.map +0 -1
  127. package/dist/types/src/playwright/playwright.config.d.ts +0 -3
  128. package/dist/types/src/playwright/playwright.config.d.ts.map +0 -1
  129. package/dist/types/src/playwright/smoke.spec.d.ts +0 -2
  130. package/dist/types/src/playwright/smoke.spec.d.ts.map +0 -1
  131. package/src/echo/useQuery.test.tsx +0 -128
  132. package/src/echo/useQuery.ts +0 -56
  133. package/src/echo/useSchema.ts +0 -54
  134. package/src/playwright/playwright.config.ts +0 -17
  135. package/src/playwright/smoke.spec.ts +0 -24
@@ -5,19 +5,20 @@
5
5
  import { act, renderHook } from '@testing-library/react';
6
6
  import { describe, expect, test } from 'vitest';
7
7
 
8
- import { useSpace, useSpaces } from './useSpaces';
9
8
  import { createClient, createClientContextProvider } from '../testing/util';
10
9
 
10
+ import { useSpace, useSpaces } from './useSpaces';
11
+
11
12
  describe('useSpaces', () => {
12
13
  test('lists existing spaces', async () => {
13
- const { client } = await createClient({ createIdentity: true });
14
+ const { client } = await createClient({ createIdentity: true, createSpace: true });
14
15
  const wrapper = await createClientContextProvider(client);
15
16
  const { result } = renderHook(() => useSpaces(), { wrapper });
16
17
  expect(result.current.length).to.eq(1);
17
18
  });
18
19
 
19
20
  test('updates when new spaces are created', async () => {
20
- const { client } = await createClient({ createIdentity: true });
21
+ const { client } = await createClient({ createIdentity: true, createSpace: true });
21
22
  const wrapper = await createClientContextProvider(client);
22
23
  const { result, rerender } = renderHook(() => useSpaces(), { wrapper });
23
24
  expect(result.current.length).to.eq(1);
@@ -30,23 +31,17 @@ describe('useSpaces', () => {
30
31
  });
31
32
 
32
33
  describe('useSpace', () => {
33
- test('gets default space', async () => {
34
- const { client } = await createClient();
34
+ test('returns undefined when no id provided', async () => {
35
+ const { client } = await createClient({ createIdentity: true });
35
36
  const wrapper = await createClientContextProvider(client);
36
- const { result, rerender } = renderHook(() => useSpace(), { wrapper });
37
+ const { result } = renderHook(() => useSpace(), { wrapper });
37
38
  expect(result.current).to.be.undefined;
38
- await act(async () => {
39
- await client.halo.createIdentity();
40
- await client.spaces.waitUntilReady();
41
- });
42
- rerender();
43
- expect(result.current).to.not.be.undefined;
44
39
  });
45
40
 
46
- test('gets space by key', async () => {
41
+ test('gets space by id', async () => {
47
42
  const { client, space } = await createClient({ createIdentity: true, createSpace: true });
48
43
  const wrapper = await createClientContextProvider(client);
49
- const { result } = renderHook(() => useSpace(space!.key), { wrapper });
44
+ const { result } = renderHook(() => useSpace(space!.id), { wrapper });
50
45
  expect(result.current).to.not.be.undefined;
51
46
  });
52
47
  });
@@ -2,51 +2,53 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import { useEffect, useState } from 'react';
6
-
7
- import { type PublicKeyLike } from '@dxos/client';
8
- import { type Space, SpaceState } from '@dxos/client/echo';
5
+ import { PublicKey } from '@dxos/client';
6
+ import { type Space, type SpaceId, SpaceState } from '@dxos/client/echo';
9
7
  import { useMulticastObservable } from '@dxos/react-hooks';
10
8
 
11
9
  import { useClient } from '../client';
12
10
 
13
11
  /**
14
- * Get a specific Space using its key.
12
+ * Get a specific Space using its id.
15
13
  * The space is not guaranteed to be in the ready state.
16
- * Returns the default space if no key is provided.
14
+ * Returns undefined if no id is provided.
17
15
  * Requires a ClientProvider somewhere in the parent tree.
18
16
  *
19
- * @param spaceKeyLike the key of the space to look for
17
+ * @param spaceId the id of the space to look for.
20
18
  */
21
- export const useSpace = (spaceKeyLike?: PublicKeyLike): Space | undefined => {
19
+ // TODO(wittjosiah): Currently unable to remove `PublicKey` from this api.
20
+ // When initially joining a space that is all that is returned.
21
+ export const useSpace = (spaceId?: SpaceId | PublicKey): Space | undefined => {
22
22
  const client = useClient();
23
23
  const spaces = useMulticastObservable<Space[]>(client.spaces);
24
- const [ready, setReady] = useState(false);
25
-
26
- useEffect(() => {
27
- // Only wait for ready if looking for the default space.
28
- if (spaceKeyLike) {
29
- return;
30
- }
31
24
 
32
- const timeout = setTimeout(async () => {
33
- await client.spaces.waitUntilReady();
34
- setReady(true);
35
- });
25
+ if (!spaceId) {
26
+ return undefined;
27
+ }
36
28
 
37
- return () => clearTimeout(timeout);
38
- }, [client, spaceKeyLike]);
29
+ return spaces.find((space) => {
30
+ if (spaceId instanceof PublicKey) {
31
+ return space.key.equals(spaceId);
32
+ }
39
33
 
40
- if (spaceKeyLike) {
41
- return spaces.find((space) => space.key.equals(spaceKeyLike) || space.id === spaceKeyLike);
42
- }
34
+ return space.id === spaceId;
35
+ });
36
+ };
43
37
 
44
- if (ready && client.halo.identity.get()) {
45
- return client.spaces.default;
46
- }
38
+ /**
39
+ * Get a Space database by the id of the space.
40
+ * The space is not guaranteed to be in the ready state.
41
+ * Returns undefined if no id is provided.
42
+ * Requires a ClientProvider somewhere in the parent tree.
43
+ *
44
+ * @param spaceId the id of the space to look for.
45
+ */
46
+ export const useDatabase = (spaceId?: SpaceId): Space['db'] | undefined => {
47
+ const space = useSpace(spaceId);
48
+ return space?.db;
47
49
  };
48
50
 
49
- export type UseSpacesParams = {
51
+ export type UseSpacesProps = {
50
52
  /**
51
53
  * Return uninitialized spaces as well.
52
54
  */
@@ -57,9 +59,9 @@ export type UseSpacesParams = {
57
59
  * Get all Spaces available to current user.
58
60
  * Requires a ClientProvider somewhere in the parent tree.
59
61
  * By default, only ready spaces are returned.
60
- * @returns an array of Spaces
62
+ * @returns an array of Spaces.
61
63
  */
62
- export const useSpaces = ({ all = false }: UseSpacesParams = {}): Space[] => {
64
+ export const useSpaces = ({ all = false }: UseSpacesProps = {}): Space[] => {
63
65
  const client = useClient();
64
66
  const spaces = useMulticastObservable<Space[]>(client.spaces);
65
67
 
@@ -18,7 +18,7 @@ export const useSubscription = (cb: () => void, selection: Selection) => {
18
18
  const callbackRef = useRef(cb);
19
19
  callbackRef.current = cb;
20
20
 
21
- const subscriptionRef = useRef<SubscriptionHandle>();
21
+ const subscriptionRef = useRef<SubscriptionHandle>(null);
22
22
 
23
23
  useEffect(() => {
24
24
  subscriptionRef.current = createSubscription(() => {
@@ -4,15 +4,16 @@
4
4
 
5
5
  import { useEffect, useState } from 'react';
6
6
 
7
- import { type PeerSyncState, type SpaceSyncStateMap, type Space } from '@dxos/client/echo';
7
+ import { type PeerSyncState, type Space, type SpaceSyncStateMap } from '@dxos/client/echo';
8
8
  import { Context } from '@dxos/context';
9
9
  import { type SpaceId } from '@dxos/keys';
10
10
  import { EdgeService } from '@dxos/protocols';
11
+ import { compositeKey } from '@dxos/util';
11
12
 
12
13
  import { useClient } from '../client';
13
14
 
14
15
  const isEdgePeerId = (peerId: string, spaceId: SpaceId) =>
15
- peerId.startsWith(`${EdgeService.AUTOMERGE_REPLICATOR}:${spaceId}`);
16
+ peerId.startsWith(compositeKey(EdgeService.AUTOMERGE_REPLICATOR, spaceId));
16
17
 
17
18
  /**
18
19
  * Hook Subscribes to sync state for each space.
@@ -30,7 +31,7 @@ export const useSyncState = (): SpaceSyncStateMap => {
30
31
  }
31
32
 
32
33
  ctx.onDispose(
33
- space.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
34
+ space.internal.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
34
35
  const syncState = peers.find((state) => isEdgePeerId(state.peerId, space.id));
35
36
  if (syncState) {
36
37
  setSpaceState((spaceState) => ({ ...spaceState, [space.id]: syncState }));
@@ -62,7 +63,7 @@ export const useSpaceSyncState = (space: Space): PeerSyncState | undefined => {
62
63
 
63
64
  useEffect(() => {
64
65
  const ctx = new Context();
65
- space.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
66
+ space.internal.db.subscribeToSyncState(ctx, ({ peers = [] }) => {
66
67
  const syncState = peers.find((state) => isEdgePeerId(state.peerId, space.id));
67
68
  if (syncState) {
68
69
  setSpaceState(syncState);
@@ -2,22 +2,22 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import '@dxos-theme';
6
-
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
7
6
  import React, { useCallback } from 'react';
8
7
 
9
8
  import { Config, PublicKey } from '@dxos/client';
10
9
  import { invariant } from '@dxos/invariant';
11
10
  import { log } from '@dxos/log';
12
11
  import { Button } from '@dxos/react-ui';
12
+ import { withTheme } from '@dxos/react-ui/testing';
13
13
  import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
14
- import { withTheme } from '@dxos/storybook-utils';
15
14
 
16
- import { useCredentials } from './useCredentials';
17
- import { useIdentity } from './useIdentity';
18
15
  import { useClient } from '../client';
19
16
  import { withClientProvider } from '../testing';
20
17
 
18
+ import { useCredentials } from './useCredentials';
19
+ import { useIdentity } from './useIdentity';
20
+
21
21
  const getNewChallenge = () => Math.random().toString(36).substring(2);
22
22
 
23
23
  const Test = () => {
@@ -43,7 +43,7 @@ const Test = () => {
43
43
  challenge: new TextEncoder().encode(challenge),
44
44
  rp: { id: location.hostname, name: 'Test' },
45
45
  user: {
46
- id: lookupKey.asUint8Array(),
46
+ id: lookupKey.asUint8Array() as Uint8Array<ArrayBuffer>,
47
47
  name: identity.did,
48
48
  displayName: identity.profile?.displayName ?? '',
49
49
  },
@@ -105,7 +105,7 @@ const Test = () => {
105
105
 
106
106
  return (
107
107
  <>
108
- <div className='mbe-4 flex gap-2'>
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>
@@ -125,11 +125,6 @@ const Test = () => {
125
125
  );
126
126
  };
127
127
 
128
- export default {
129
- title: 'sdk/react-client/Passkeys',
130
- render: Test,
131
- };
132
-
133
128
  const config = new Config({
134
129
  runtime: {
135
130
  client: {
@@ -150,6 +145,14 @@ const config = new Config({
150
145
  },
151
146
  });
152
147
 
153
- export const Default = {
154
- decorators: [withClientProvider({ config }), withTheme],
155
- };
148
+ const meta = {
149
+ title: 'sdk/react-client/Passkeys',
150
+ render: Test,
151
+ decorators: [withClientProvider({ config }), withTheme()],
152
+ } satisfies Meta;
153
+
154
+ export default meta;
155
+
156
+ type Story = StoryObj<typeof meta>;
157
+
158
+ export const Default: Story = {};
@@ -5,9 +5,10 @@
5
5
  import { renderHook } from '@testing-library/react';
6
6
  import { describe, expect, test } from 'vitest';
7
7
 
8
- import { useDevices } from './useDevices';
9
8
  import { createClient, createClientContextProvider } from '../testing/util';
10
9
 
10
+ import { useDevices } from './useDevices';
11
+
11
12
  describe('useDevices', () => {
12
13
  test('lists existing devices', async () => {
13
14
  const { client } = await createClient({ createIdentity: true });
@@ -7,7 +7,7 @@ import { useMemo } from 'react';
7
7
  import { useMulticastObservable } from '@dxos/react-hooks';
8
8
 
9
9
  import { useClient } from '../client';
10
- import { useInvitationStatus, type CancellableInvitationObservable } from '../invitations';
10
+ import { type CancellableInvitationObservable, useInvitationStatus } from '../invitations';
11
11
 
12
12
  export const useHaloInvitations = (): CancellableInvitationObservable[] => {
13
13
  const client = useClient();
@@ -2,7 +2,7 @@
2
2
  // Copyright 2022 DXOS.org
3
3
  //
4
4
 
5
- import { useReducer, type Reducer, useMemo, useCallback, useEffect } from 'react';
5
+ import { useCallback, useEffect, useMemo, useReducer } from 'react';
6
6
 
7
7
  import { type PublicKey } from '@dxos/client';
8
8
  import {
@@ -24,9 +24,10 @@ interface InvitationReducerState {
24
24
  status: Invitation.State; // TODO(burdon): Rename state.
25
25
  haltedAt?: Invitation.State;
26
26
  result: InvitationResult;
27
- error?: number;
27
+ error?: Error;
28
28
  id?: string;
29
29
  multiUse?: boolean;
30
+ shareable?: boolean;
30
31
  invitationCode?: string;
31
32
  authCode?: string;
32
33
  authMethod?: Invitation.AuthMethod;
@@ -72,7 +73,7 @@ export type InvitationStatus = {
72
73
  multiUse?: boolean;
73
74
  shareable?: boolean;
74
75
  result: InvitationResult;
75
- error?: number;
76
+ error?: Error;
76
77
  cancel(): void;
77
78
  // TODO(wittjosiah): Remove?
78
79
  connect(observable: CancellableInvitationObservable): void;
@@ -82,11 +83,11 @@ export type InvitationStatus = {
82
83
  // Without private key, the invitation code cannot be created.
83
84
  // These invitations are only available to be accepted but not shared.
84
85
  const isShareableInvitation = (invitation: Invitation) =>
85
- invitation.authMethod !== Invitation.AuthMethod.KNOWN_PUBLIC_KEY || invitation.guestKeypair?.privateKey;
86
+ invitation.authMethod !== Invitation.AuthMethod.KNOWN_PUBLIC_KEY || !!invitation.guestKeypair?.privateKey;
86
87
 
87
88
  export const useInvitationStatus = (observable?: CancellableInvitationObservable): InvitationStatus => {
88
- const [state, dispatch] = useReducer<Reducer<InvitationReducerState, InvitationAction>, null>(
89
- (prev, action) => {
89
+ const [state, dispatch] = useReducer(
90
+ (prev: InvitationReducerState, action: InvitationAction): InvitationReducerState => {
90
91
  log('useInvitationStatus', { action });
91
92
  const invitationProps =
92
93
  'invitation' in action
@@ -115,10 +116,10 @@ export const useInvitationStatus = (observable?: CancellableInvitationObservable
115
116
  action.status === Invitation.State.TIMEOUT) && {
116
117
  haltedAt: typeof prev.haltedAt === 'undefined' ? action.haltedAt : prev.haltedAt,
117
118
  }),
118
- } as InvitationReducerState;
119
+ };
119
120
  },
120
121
  null,
121
- (_arg: null) => {
122
+ (_arg: null): InvitationReducerState => {
122
123
  const invitation = observable?.get();
123
124
  return {
124
125
  status: Invitation.State.INIT,
@@ -2,22 +2,27 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import '@dxos-theme';
6
-
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
7
6
  import React from 'react';
8
7
 
8
+ import { Obj } from '@dxos/echo';
9
9
  import { Input } from '@dxos/react-ui';
10
+ import { withTheme } from '@dxos/react-ui/testing';
10
11
  import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
11
- import { withTheme } from '@dxos/storybook-utils';
12
12
 
13
- import { ClientRepeater, type ClientRepeatedComponentProps } from './ClientRepeater';
14
13
  import { useClient } from '../client';
15
14
  import { useSpace } from '../echo';
16
15
 
17
- export default {
16
+ import { type ClientRepeatedComponentProps, ClientRepeater } from './ClientRepeater';
17
+
18
+ const meta = {
18
19
  title: 'sdk/react-client/ClientRepeater',
19
- decorators: [withTheme],
20
- };
20
+ decorators: [withTheme()],
21
+ } satisfies Meta<typeof Input>;
22
+
23
+ export default meta;
24
+
25
+ type Story = StoryObj<typeof meta>;
21
26
 
22
27
  const JsonPanel = ({ value }: { value: any }) => (
23
28
  <SyntaxHighlighter language='json'>{JSON.stringify(value, undefined, 2)}</SyntaxHighlighter>
@@ -28,9 +33,9 @@ const ClientStory = () => {
28
33
  return <JsonPanel value={client.toJSON()} />;
29
34
  };
30
35
 
31
- const ClientSpace = ({ spaceKey }: ClientRepeatedComponentProps) => {
36
+ const ClientSpace = ({ spaceId }: ClientRepeatedComponentProps) => {
32
37
  const client = useClient();
33
- const space = useSpace(spaceKey);
38
+ const space = useSpace(spaceId);
34
39
  if (!space?.isOpen) {
35
40
  return null;
36
41
  }
@@ -41,7 +46,11 @@ const ClientSpace = ({ spaceKey }: ClientRepeatedComponentProps) => {
41
46
  <Input.TextInput
42
47
  placeholder='Name'
43
48
  value={space.properties.name}
44
- onChange={(event) => (space.properties.name = event.target.value)}
49
+ onChange={(event) =>
50
+ Obj.change(space.properties, (obj) => {
51
+ obj.name = event.target.value;
52
+ })
53
+ }
45
54
  />
46
55
  </Input.Root>
47
56
  <JsonPanel value={client.toJSON()} />
@@ -49,10 +58,10 @@ const ClientSpace = ({ spaceKey }: ClientRepeatedComponentProps) => {
49
58
  );
50
59
  };
51
60
 
52
- export const Default = {
61
+ export const Default: Story = {
53
62
  render: () => <ClientRepeater component={ClientStory} count={2} />,
54
63
  };
55
64
 
56
- export const Space = {
65
+ export const Space: Story = {
57
66
  render: () => <ClientRepeater component={ClientSpace} count={2} createSpace />,
58
67
  };
@@ -2,18 +2,20 @@
2
2
  // Copyright 2022 DXOS.org
3
3
  //
4
4
 
5
- import React, { useState, type FC, useEffect, useRef } from 'react';
5
+ import React, { type FC, useRef, useState } from 'react';
6
6
 
7
- import { Client, type PublicKey } from '@dxos/client';
7
+ import { Client } from '@dxos/client';
8
8
  import { TestBuilder, performInvitation } from '@dxos/client/testing';
9
- import { type TypedObject } from '@dxos/echo-schema';
10
- import { registerSignalsRuntime } from '@dxos/echo-signals/react';
9
+ import { type Type } from '@dxos/echo';
11
10
  import { faker } from '@dxos/random';
11
+ import { useAsyncEffect } from '@dxos/react-hooks';
12
12
 
13
- import { type WithClientProviderProps } from './withClientProvider';
14
13
  import { ClientProvider } from '../client';
14
+ import { type SpaceId } from '../echo';
15
+
16
+ import { type WithClientProviderProps } from './withClientProvider';
15
17
 
16
- export type ClientRepeatedComponentProps = { id: number; count: number; spaceKey?: PublicKey };
18
+ export type ClientRepeatedComponentProps = { id: number; count: number; spaceId?: SpaceId };
17
19
 
18
20
  export type ClientRepeaterControlsProps = { clients: Client[] };
19
21
 
@@ -24,9 +26,9 @@ export type ClientRepeaterProps<P extends ClientRepeatedComponentProps> = {
24
26
  controls?: FC<ClientRepeaterControlsProps>;
25
27
  count?: number;
26
28
  clients?: Client[];
27
- types?: TypedObject[];
29
+ types?: Type.AnyObj[];
28
30
  args?: Omit<P, 'id' | 'count'>;
29
- } & Pick<WithClientProviderProps, 'createIdentity' | 'createSpace' | 'onSpaceCreated'>;
31
+ } & Pick<WithClientProviderProps, 'createIdentity' | 'createSpace' | 'onCreateSpace'>;
30
32
 
31
33
  /**
32
34
  * Utility component for Storybook stories which sets up clients for n peers.
@@ -46,41 +48,32 @@ export const ClientRepeater = <P extends ClientRepeatedComponentProps>(props: Cl
46
48
  types,
47
49
  createIdentity,
48
50
  createSpace,
49
- onSpaceCreated,
51
+ onCreateSpace,
50
52
  } = props;
51
- useEffect(() => {
52
- registerSignalsRuntime();
53
- }, []);
54
53
 
55
54
  const [clients, setClients] = useState(props.clients ?? []);
56
- const [spaceKey, setSpaceKey] = useState<PublicKey>();
55
+ const [spaceId, setSpaceId] = useState<SpaceId>();
57
56
 
58
57
  const testBuilder = useRef(new TestBuilder());
59
- useEffect(() => {
60
- const timeout = setTimeout(async () => {
61
- const clients = [...Array(count)].map(
62
- (_) => new Client({ services: testBuilder.current.createLocalClientServices(), types }),
63
- );
64
-
65
- await Promise.all(clients.map((client) => client.initialize()));
66
- if (createIdentity || createSpace) {
67
- await Promise.all(clients.map((client) => client.halo.createIdentity()));
68
- }
58
+ useAsyncEffect(async () => {
59
+ const clients = [...Array(count)].map(
60
+ (_) => new Client({ services: testBuilder.current.createLocalClientServices(), types }),
61
+ );
69
62
 
70
- if (createSpace) {
71
- const client = clients[0];
72
- const space = await client.spaces.create({ name: faker.commerce.productName() });
73
- setSpaceKey(space.key);
74
- await onSpaceCreated?.({ client, space }, {});
75
- await Promise.all(
76
- clients.slice(1).flatMap((client) => performInvitation({ host: space, guest: client.spaces })),
77
- );
78
- }
63
+ await Promise.all(clients.map((client) => client.initialize()));
64
+ if (createIdentity || createSpace) {
65
+ await Promise.all(clients.map((client) => client.halo.createIdentity()));
66
+ }
79
67
 
80
- setClients(clients);
81
- });
68
+ if (createSpace) {
69
+ const client = clients[0];
70
+ const space = await client.spaces.create({ name: faker.commerce.productName() });
71
+ setSpaceId(space.id);
72
+ await onCreateSpace?.({ client, space }, {});
73
+ await Promise.all(clients.slice(1).flatMap((client) => performInvitation({ host: space, guest: client.spaces })));
74
+ }
82
75
 
83
- return () => clearTimeout(timeout);
76
+ setClients(clients);
84
77
  }, []);
85
78
 
86
79
  if (clients.length === 0) {
@@ -92,7 +85,7 @@ export const ClientRepeater = <P extends ClientRepeatedComponentProps>(props: Cl
92
85
  {Controls && <Controls clients={clients} />}
93
86
  {clients.map((client, index) => (
94
87
  <ClientProvider key={index} client={client}>
95
- <Component id={index} count={clients.length} spaceKey={spaceKey} {...{ ...props.args }} />
88
+ <Component id={index} count={clients.length} spaceId={spaceId} {...{ ...props.args }} />
96
89
  </ClientProvider>
97
90
  ))}
98
91
  </>
@@ -4,16 +4,17 @@
4
4
 
5
5
  import { createContext, useContext } from 'react';
6
6
 
7
- import { type Space } from '@dxos/client/echo';
7
+ import { type Space, type SpaceId } from '@dxos/client/echo';
8
8
  import { raise } from '@dxos/debug';
9
9
 
10
10
  export type ClientStory = {
11
+ index?: number;
12
+ spaceId?: SpaceId;
11
13
  space?: Space;
12
14
  };
13
15
 
14
- // TODO(wittjosiah): Add to multi-client as well.
15
16
  export const ClientStory = createContext<ClientStory | undefined>(undefined);
16
17
 
17
- export const useClientProvider = (): ClientStory => {
18
+ export const useClientStory = (): ClientStory => {
18
19
  return useContext(ClientStory) ?? raise(new Error('Missing ClientStory'));
19
20
  };
@@ -24,7 +24,6 @@ export const createClient = async ({
24
24
  let space: Space | undefined;
25
25
  if (createSpace) {
26
26
  space = await client.spaces.create();
27
- await client.spaces.waitUntilReady();
28
27
  }
29
28
 
30
29
  return { client, space };
@@ -2,32 +2,33 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import '@dxos-theme';
6
-
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
7
6
  import React from 'react';
7
+ import { expect, within } from 'storybook/test';
8
8
 
9
9
  import { log } from '@dxos/log';
10
+ import { withLayout, withTheme, Loading } from '@dxos/react-ui/testing';
10
11
  import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
11
- import { withLayout, withTheme } from '@dxos/storybook-utils';
12
12
 
13
- import { withClientProvider, type WithClientProviderProps, withMultiClientProvider } from './withClientProvider';
14
13
  import { useClient } from '../client';
15
14
  import { type Space, useSpaces } from '../echo';
16
15
 
16
+ import { type WithClientProviderProps, withClientProvider, withMultiClientProvider } from './withClientProvider';
17
+
17
18
  const SpaceInfo = ({ space }: { space: Space }) => {
18
19
  const name = space.isOpen ? space.properties.name : '';
19
20
  return <SyntaxHighlighter language='json'>{JSON.stringify({ id: space.id, name }, null, 2)}</SyntaxHighlighter>;
20
21
  };
21
22
 
22
- const Test = () => {
23
+ const DefaultStory = () => {
23
24
  const client = useClient();
24
25
  const spaces = useSpaces();
25
26
  if (!client) {
26
- return null;
27
+ return <Loading data={{ client: !!client }} />;
27
28
  }
28
29
 
29
30
  return (
30
- <div className='flex flex-col min-w-[28rem] divide-y divide-separator border border-separator rounded'>
31
+ <div className='flex flex-col divide-y divide-separator border border-separator'>
31
32
  <SyntaxHighlighter language='json'>{JSON.stringify(client.toJSON(), null, 2)}</SyntaxHighlighter>
32
33
  {spaces.map((space) => (
33
34
  <SpaceInfo key={space.id} space={space} />
@@ -36,10 +37,16 @@ const Test = () => {
36
37
  );
37
38
  };
38
39
 
39
- export default {
40
+ const meta = {
40
41
  title: 'sdk/react-client/withClientProvider',
41
- render: Test,
42
- };
42
+ render: DefaultStory,
43
+ decorators: [withTheme()],
44
+ tags: ['test'],
45
+ } satisfies Meta<typeof DefaultStory>;
46
+
47
+ export default meta;
48
+
49
+ type Story = StoryObj<typeof meta>;
43
50
 
44
51
  const clientProps: WithClientProviderProps = {
45
52
  createIdentity: true,
@@ -47,19 +54,27 @@ const clientProps: WithClientProviderProps = {
47
54
  onInitialized: async (client) => {
48
55
  log.info('onInitialized', { client });
49
56
  },
50
- onSpaceCreated: async ({ client, space }) => {
51
- log.info('onSpaceCreated', { client, space });
57
+ onCreateSpace: async ({ client, space }) => {
58
+ log.info('onCreateSpace', { client, space });
52
59
  },
53
60
  };
54
61
 
55
- export const Default = {
56
- decorators: [withClientProvider(clientProps), withTheme, withLayout({ classNames: ['flex gap-2'] })],
62
+ export const Default: Story = {
63
+ decorators: [withClientProvider(clientProps)],
64
+ parameters: {
65
+ layout: 'centered',
66
+ },
67
+ play: async ({ canvasElement }) => {
68
+ const canvas = within(canvasElement);
69
+ const initializedText = await canvas.findByText(/"initialized": true/i, {}, { timeout: 30_000 });
70
+ await expect(initializedText).toBeVisible();
71
+ },
57
72
  };
58
73
 
59
- export const Multiple = {
74
+ export const Multiple: Story = {
60
75
  decorators: [
76
+ withTheme(),
77
+ withLayout({ classNames: 'grid grid-cols-3' }),
61
78
  withMultiClientProvider({ ...clientProps, numClients: 3 }),
62
- withTheme,
63
- withLayout({ classNames: ['flex gap-2'] }),
64
79
  ],
65
80
  };