@dxos/react-client 0.7.4 → 0.7.5-main.499c70c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-client",
-  "version": "0.7.4",
+  "version": "0.7.5-main.499c70c",
   "description": "React client API",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -77,40 +77,40 @@
   },
   "dependencies": {
     "react-error-boundary": "^4.0.13",
-    "@dxos/async": "0.7.4",
-    "@dxos/client": "0.7.4",
-    "@dxos/codec-protobuf": "0.7.4",
-    "@dxos/debug": "0.7.4",
-    "@dxos/echo-schema": "0.7.4",
-    "@dxos/config": "0.7.4",
-    "@dxos/echo-signals": "0.7.4",
-    "@dxos/invariant": "0.7.4",
-    "@dxos/node-std": "0.7.4",
-    "@dxos/log": "0.7.4",
-    "@dxos/protocols": "0.7.4",
-    "@dxos/react-hooks": "0.7.4",
-    "@dxos/util": "0.7.4"
+    "@dxos/async": "0.7.5-main.499c70c",
+    "@dxos/codec-protobuf": "0.7.5-main.499c70c",
+    "@dxos/client": "0.7.5-main.499c70c",
+    "@dxos/config": "0.7.5-main.499c70c",
+    "@dxos/debug": "0.7.5-main.499c70c",
+    "@dxos/echo-schema": "0.7.5-main.499c70c",
+    "@dxos/echo-signals": "0.7.5-main.499c70c",
+    "@dxos/invariant": "0.7.5-main.499c70c",
+    "@dxos/node-std": "0.7.5-main.499c70c",
+    "@dxos/log": "0.7.5-main.499c70c",
+    "@dxos/protocols": "0.7.5-main.499c70c",
+    "@dxos/react-hooks": "0.7.5-main.499c70c",
+    "@dxos/util": "0.7.5-main.499c70c"
   },
   "devDependencies": {
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.7.4",
-    "@dxos/random": "0.7.4",
-    "@dxos/storybook-utils": "0.7.4",
-    "@dxos/react-ui-syntax-highlighter": "0.7.4",
-    "@dxos/test-utils": "0.7.4",
-    "@dxos/react-ui-theme": "0.7.4"
+    "@dxos/random": "0.7.5-main.499c70c",
+    "@dxos/react-ui": "0.7.5-main.499c70c",
+    "@dxos/react-ui-syntax-highlighter": "0.7.5-main.499c70c",
+    "@dxos/test-utils": "0.7.5-main.499c70c",
+    "@dxos/storybook-utils": "0.7.5-main.499c70c",
+    "@dxos/react-ui-theme": "0.7.5-main.499c70c"
   },
   "peerDependencies": {
     "react": "~18.2.0",
     "react-dom": "~18.2.0"
   },
   "optionalDependencies": {
-    "@dxos/random": "0.7.4",
-    "@dxos/react-ui": "0.7.4",
-    "@dxos/react-ui-theme": "0.7.4"
+    "@dxos/random": "0.7.5-main.499c70c",
+    "@dxos/react-ui": "0.7.5-main.499c70c",
+    "@dxos/react-ui-theme": "0.7.5-main.499c70c"
   },
   "publishConfig": {
     "access": "public"

package/src/testing/ClientRepeater.tsx

@@ -6,7 +6,7 @@ import React, { useState, type FC, useEffect, useRef } from 'react';
 
 import { Client, type PublicKey } from '@dxos/client';
 import { TestBuilder, performInvitation } from '@dxos/client/testing';
-import { type AbstractTypedObject } from '@dxos/echo-schema';
+import { type TypedObject } from '@dxos/echo-schema';
 import { registerSignalsRuntime } from '@dxos/echo-signals/react';
 import { faker } from '@dxos/random';
 
@@ -24,7 +24,7 @@ export type ClientRepeaterProps<P extends ClientRepeatedComponentProps> = {
   controls?: FC<ClientRepeaterControlsProps>;
   count?: number;
   clients?: Client[];
-  types?: AbstractTypedObject[];
+  types?: TypedObject[];
   args?: Omit<P, 'id' | 'count'>;
 } & Pick<WithClientProviderProps, 'createIdentity' | 'createSpace' | 'onSpaceCreated'>;
 
@@ -71,7 +71,7 @@ export const ClientRepeater = <P extends ClientRepeatedComponentProps>(props: Cl
         const client = clients[0];
         const space = await client.spaces.create({ name: faker.commerce.productName() });
         setSpaceKey(space.key);
-        await onSpaceCreated?.({ client, space });
+        await onSpaceCreated?.({ client, space }, {});
         await Promise.all(
           clients.slice(1).flatMap((client) => performInvitation({ host: space, guest: client.spaces })),
         );

package/src/testing/context.tsx

@@ -0,0 +1,19 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { createContext, useContext } from 'react';
+
+import { type Space } from '@dxos/client/echo';
+import { raise } from '@dxos/debug';
+
+export type ClientStory = {
+  space?: Space;
+};
+
+// TODO(wittjosiah): Add to multi-client as well.
+export const ClientStory = createContext<ClientStory | undefined>(undefined);
+
+export const useClientProvider = (): ClientStory => {
+  return useContext(ClientStory) ?? raise(new Error('Missing ClientStory'));
+};

package/src/testing/index.ts

@@ -4,5 +4,6 @@
 
 export * from '@dxos/client/testing';
 
+export * from './context';
 export * from './ClientRepeater';
 export * from './withClientProvider';

package/src/testing/withClientProvider.tsx

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type Decorator } from '@storybook/react';
+import { type StoryContext, type Decorator } from '@storybook/react';
 import React, { createContext, type PropsWithChildren, useContext, useEffect, useRef, useState } from 'react';
 import { type FallbackProps, ErrorBoundary as NativeErrorBoundary } from 'react-error-boundary';
 
@@ -10,18 +10,19 @@ import { Trigger } from '@dxos/async';
 import { type Client } from '@dxos/client';
 import { type Space } from '@dxos/client/echo';
 import { performInvitation, TestBuilder } from '@dxos/client/testing';
-import { raise } from '@dxos/debug';
 import { log } from '@dxos/log';
 import { type MaybePromise } from '@dxos/util';
 
+import { ClientStory } from './context';
 import { ClientProvider, type ClientProviderProps } from '../client';
 
 type InitializeProps = {
   createIdentity?: boolean;
   createSpace?: boolean;
-  onInitialized?: (client: Client) => MaybePromise<Record<string, any> | void>;
-  onIdentityCreated?: (props: { client: Client }) => MaybePromise<Record<string, any> | void>;
-  onSpaceCreated?: (props: { client: Client; space: Space }) => MaybePromise<Record<string, any> | void>;
+  onInitialized?: (client: Client) => MaybePromise<void>;
+  onIdentityCreated?: (props: { client: Client }) => MaybePromise<void>;
+  // NOTE: context must be untyped until ClientRepeater is removed.
+  onSpaceCreated?: (props: { client: Client; space: Space }, context: StoryContext | any) => MaybePromise<void>;
 };
 
 /**
@@ -30,35 +31,24 @@ type InitializeProps = {
 const initializeClient = async (
   client: Client,
   { createIdentity, createSpace, onSpaceCreated, onIdentityCreated, onInitialized }: InitializeProps,
-): Promise<StoryClientProps> => {
-  const clientData = await onInitialized?.(client);
+  context: StoryContext,
+): Promise<ClientStory> => {
+  await onInitialized?.(client);
 
-  let identityData: Record<string, any> | void = {};
   if (createIdentity || createSpace) {
     if (!client.halo.identity.get()) {
       await client.halo.createIdentity();
-      identityData = await onIdentityCreated?.({ client });
+      await onIdentityCreated?.({ client });
     }
   }
 
   let space: Space | undefined;
-  let spaceData: Record<string, any> | void = {};
   if (createSpace) {
     space = await client.spaces.create({ name: 'Test Space' });
-    spaceData = await onSpaceCreated?.({ client, space });
+    await onSpaceCreated?.({ client, space }, context);
   }
 
-  return { space, ...clientData, ...identityData, ...spaceData };
-};
-
-type StoryClientProps<T extends Record<string, any> = Record<string, unknown>> = T & { space?: Space };
-
-// TODO(wittjosiah): Add to multi-client as well.
-const StoryClientContext = createContext<StoryClientProps | undefined>(undefined);
-
-export const useStoryClientData = <T extends Record<string, any> = Record<string, unknown>>() => {
-  const data = useContext(StoryClientContext) ?? raise(new Error('Missing withClientProvider decorator.'));
-  return data as StoryClientProps<T>;
+  return { space };
 };
 
 export type WithClientProviderProps = InitializeProps & Omit<ClientProviderProps, 'onInitialized'>;
@@ -74,27 +64,30 @@ export const withClientProvider = ({
   onInitialized,
   ...props
 }: WithClientProviderProps = {}): Decorator => {
-  return (Story) => {
-    const [data, setData] = useState<StoryClientProps>({});
-
+  return (Story, context) => {
+    const [data, setData] = useState<ClientStory>({});
     const handleInitialized = async (client: Client) => {
-      setData(
-        await initializeClient(client, {
+      const data = await initializeClient(
+        client,
+        {
           createIdentity,
           createSpace,
           onSpaceCreated,
           onIdentityCreated,
           onInitialized,
-        }),
+        },
+        context,
       );
+
+      setData(data);
     };
 
     return (
       <ErrorBoundary>
         <ClientProvider onInitialized={handleInitialized} {...props}>
-          <StoryClientContext.Provider value={data}>
+          <ClientStory.Provider value={data}>
             <Story />
-          </StoryClientContext.Provider>
+          </ClientStory.Provider>
         </ClientProvider>
       </ErrorBoundary>
     );
@@ -125,7 +118,7 @@ export const withMultiClientProvider = ({
   onInitialized,
   ...props
 }: WithMultiClientProviderProps): Decorator => {
-  return (Story) => {
+  return (Story, context) => {
     const builder = useRef(new TestBuilder());
     const hostRef = useRef<Client>();
     const spaceReady = useRef(new Trigger<Space | undefined>());
@@ -137,17 +130,22 @@ export const withMultiClientProvider = ({
       if (createSpace) {
         if (!hostRef.current) {
           hostRef.current = client;
-          const { space } = await initializeClient(client, {
-            createIdentity,
-            createSpace,
-            onSpaceCreated,
-            onIdentityCreated,
-            onInitialized,
-          });
+          const { space } = await initializeClient(
+            client,
+            {
+              createIdentity,
+              createSpace,
+              onSpaceCreated,
+              onIdentityCreated,
+              onInitialized,
+            },
+            context,
+          );
+
           spaceReady.current.wake(space);
           log.info('inviting', { index });
         } else {
-          await initializeClient(client, { createIdentity, onInitialized });
+          await initializeClient(client, { createIdentity, onInitialized }, context);
           const space = await spaceReady.current.wait();
           if (space) {
             log.info('joining', { index });

package/tsconfig.json

@@ -12,5 +12,63 @@
     "playwright",
     "src"
   ],
-  "references": []
+  "references": [
+    {
+      "path": "../../common/async"
+    },
+    {
+      "path": "../../common/codec-protobuf"
+    },
+    {
+      "path": "../../common/debug"
+    },
+    {
+      "path": "../../common/invariant"
+    },
+    {
+      "path": "../../common/log"
+    },
+    {
+      "path": "../../common/node-std"
+    },
+    {
+      "path": "../../common/random"
+    },
+    {
+      "path": "../../common/storybook-utils"
+    },
+    {
+      "path": "../../common/test-utils"
+    },
+    {
+      "path": "../../common/util"
+    },
+    {
+      "path": "../../core/echo/echo-schema"
+    },
+    {
+      "path": "../../core/echo/echo-signals"
+    },
+    {
+      "path": "../../core/protocols"
+    },
+    {
+      "path": "../../ui/primitives/react-hooks"
+    },
+    {
+      "path": "../../ui/react-ui"
+    },
+    {
+      "path": "../../ui/react-ui-syntax-highlighter"
+    },
+    {
+      "path": "../../ui/react-ui-theme"
+    },
+    {
+      "path": "../client"
+    },
+    {
+      "path": "../config"
+    }
+  ]
 }