@dxos/react-client 0.8.3 → 0.8.4-main.1068cf700f

package/src/testing/withClientProvider.tsx

@@ -2,27 +2,28 @@
 // Copyright 2024 DXOS.org
 //
 
-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';
+import { type Decorator, type StoryContext } from '@storybook/react';
+import React, { type PropsWithChildren, useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { type FallbackProps, ErrorBoundary as NaturalErrorBoundary } from 'react-error-boundary';
 
 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 { type Space, type SpaceId } from '@dxos/client/echo';
+import { TestBuilder, performInvitation } from '@dxos/client/testing';
 import { log } from '@dxos/log';
 import { type MaybePromise } from '@dxos/util';
 
-import { ClientStory } from './context';
 import { ClientProvider, type ClientProviderProps } from '../client';
 
+import { ClientStory } from './context';
+
 type InitializeProps = {
   createIdentity?: boolean;
   createSpace?: boolean;
   onInitialized?: (client: Client) => MaybePromise<void>;
-  onIdentityCreated?: (props: { client: Client }) => MaybePromise<void>;
+  onCreateIdentity?: (props: { client: Client }, context: StoryContext | any) => MaybePromise<void>;
   // NOTE: context must be untyped until ClientRepeater is removed.
-  onSpaceCreated?: (props: { client: Client; space: Space }, context: StoryContext | any) => MaybePromise<void>;
+  onCreateSpace?: (props: { client: Client; space: Space }, context: StoryContext | any) => MaybePromise<void>;
 };
 
 /**
@@ -30,7 +31,7 @@ type InitializeProps = {
  */
 const initializeClient = async (
   client: Client,
-  { createIdentity, createSpace, onSpaceCreated, onIdentityCreated, onInitialized }: InitializeProps,
+  { createIdentity, createSpace, onCreateIdentity, onCreateSpace, onInitialized }: InitializeProps,
   context: StoryContext,
 ): Promise<ClientStory> => {
   await onInitialized?.(client);
@@ -38,17 +39,20 @@ const initializeClient = async (
   if (createIdentity || createSpace) {
     if (!client.halo.identity.get()) {
       await client.halo.createIdentity();
-      await onIdentityCreated?.({ client });
+      await client.spaces.waitUntilReady();
+      await client.spaces.default.waitUntilReady();
+      await onCreateIdentity?.({ client }, context);
     }
   }
 
   let space: Space | undefined;
   if (createSpace) {
     space = await client.spaces.create({ name: 'Test Space' });
-    await onSpaceCreated?.({ client, space }, context);
+    await space.waitUntilReady(); // Is this required?
+    await onCreateSpace?.({ client, space }, context);
   }
 
-  return { space };
+  return { space, spaceId: space?.id };
 };
 
 export type WithClientProviderProps = InitializeProps & Omit<ClientProviderProps, 'onInitialized'>;
@@ -59,8 +63,8 @@ export type WithClientProviderProps = InitializeProps & Omit<ClientProviderProps
 export const withClientProvider = ({
   createIdentity,
   createSpace,
-  onSpaceCreated,
-  onIdentityCreated,
+  onCreateSpace,
+  onCreateIdentity,
   onInitialized,
   ...props
 }: WithClientProviderProps = {}): Decorator => {
@@ -72,8 +76,8 @@ export const withClientProvider = ({
         {
           createIdentity,
           createSpace,
-          onSpaceCreated,
-          onIdentityCreated,
+          onCreateSpace,
+          onCreateIdentity,
           onInitialized,
         },
         context,
@@ -100,75 +104,87 @@ export const withClientProvider = ({
 export type WithMultiClientProviderProps = InitializeProps &
   Omit<ClientProviderProps, 'onInitialized'> & { numClients?: number };
 
-const MultiClientContext = createContext<{ id: number }>({ id: 0 });
-
-export const useMultiClient = () => useContext(MultiClientContext);
-
 /**
  * Decorator that creates a scaffold for multiple clients.
  * Orchestrates invitations between a randomly selected host and the remaining clients.
- * NOTE: Should come before withLayout.
  */
 export const withMultiClientProvider = ({
   numClients = 2,
   createIdentity,
   createSpace,
-  onSpaceCreated,
-  onIdentityCreated,
+  onCreateSpace,
+  onCreateIdentity,
   onInitialized,
   ...props
 }: WithMultiClientProviderProps): Decorator => {
   return (Story, context) => {
-    const builder = useRef(new TestBuilder());
-    const hostRef = useRef<Client>();
     const spaceReady = useRef(new Trigger<Space | undefined>());
+    const [spaceId, setSpaceId] = useState<SpaceId>();
+
+    const clients = useMemo(() => {
+      const buidler = new TestBuilder();
+      return Array.from({ length: numClients }).map(() => {
+        return {
+          services: buidler.createLocalClientServices(),
+        };
+      });
+    }, [numClients]);
 
     // Handle invitations.
     // NOTE: The zeroth client isn't necessarily the first to be initialized.
-    const handleInitialized = async (client: Client, index: number) => {
-      log.info('initialized', { index });
-      if (createSpace) {
-        if (!hostRef.current) {
-          hostRef.current = client;
-          const { space } = await initializeClient(
-            client,
-            {
-              createIdentity,
-              createSpace,
-              onSpaceCreated,
-              onIdentityCreated,
-              onInitialized,
-            },
-            context,
+    const handleInitialized = useCallback(async (client: Client, index: number) => {
+      if (index === 0) {
+        // Initialize host.
+        const { space } = await initializeClient(
+          client,
+          {
+            createIdentity,
+            createSpace,
+            onCreateSpace,
+            onCreateIdentity,
+            onInitialized,
+          },
+          context,
+        );
+
+        log.info('inviting', { index, spaceId: space?.id });
+        setSpaceId(space?.id);
+        spaceReady.current.wake(space);
+      } else {
+        // Initialize guest.
+        await initializeClient(client, { createIdentity, onInitialized }, context);
+
+        log.info('waiting', { index });
+        const space = await spaceReady.current.wait();
+        if (space) {
+          log.info('joining', { index, spaceId: space.id });
+          await Promise.all(
+            performInvitation({
+              host: space,
+              guest: client.spaces,
+            }),
           );
-
-          spaceReady.current.wake(space);
-          log.info('inviting', { index });
-        } else {
-          await initializeClient(client, { createIdentity, onInitialized }, context);
-          const space = await spaceReady.current.wait();
-          if (space) {
-            log.info('joining', { index });
-            await Promise.all(performInvitation({ host: space, guest: client.spaces }));
-          }
         }
       }
-    };
+    }, []);
 
     return (
-      <ErrorBoundary>
-        {Array.from({ length: numClients }).map((_, index) => (
-          <MultiClientContext.Provider key={index} value={{ id: index }}>
-            <ClientProvider
-              services={builder.current.createLocalClientServices()}
-              onInitialized={(client) => handleInitialized(client, index)}
-              {...props}
-            >
-              <Story />
-            </ClientProvider>
-          </MultiClientContext.Provider>
+      <div className='absolute inset-0 grid grid-flow-col auto-cols-fr gap-4 overflow-hidden'>
+        {clients.map((client, index) => (
+          <ClientProvider
+            key={index}
+            services={client.services}
+            onInitialized={(client) => handleInitialized(client, index)}
+            {...props}
+          >
+            <ClientStory.Provider value={{ index, spaceId }}>
+              <ErrorBoundary>
+                <Story />
+              </ErrorBoundary>
+            </ClientStory.Provider>
+          </ClientProvider>
         ))}
-      </ErrorBoundary>
+      </div>
     );
   };
 };
@@ -188,12 +204,13 @@ const ErrorBoundary = ({ children }: PropsWithChildren) => {
     return <ErrorFallback error={error} resetErrorBoundary={() => setError(undefined)} />;
   }
 
-  return <NativeErrorBoundary FallbackComponent={ErrorFallback}>{children}</NativeErrorBoundary>;
+  return <NaturalErrorBoundary FallbackComponent={ErrorFallback}>{children}</NaturalErrorBoundary>;
 };
 
 const ErrorFallback = ({ error }: FallbackProps) => {
   const { name, message, stack } =
     error instanceof Error ? error : { name: 'Error', message: String(error), stack: undefined };
+
   return (
     <div role='alert' className='flex flex-col p-4 gap-4 overflow-auto'>
       <h1 className='text-xl text-red-500'>{name}</h1>

package/tsconfig.json

@@ -45,16 +45,13 @@
       "path": "../../core/echo/echo"
     },
     {
-      "path": "../../core/echo/echo-schema"
-    },
-    {
-      "path": "../../core/echo/echo-signals"
+      "path": "../../core/echo/echo-react"
     },
     {
       "path": "../../core/protocols"
     },
     {
-      "path": "../../ui/primitives/react-hooks"
+      "path": "../../ui/react-primitives/react-hooks"
     },
     {
       "path": "../../ui/react-ui"
@@ -63,7 +60,7 @@
       "path": "../../ui/react-ui-syntax-highlighter"
     },
     {
-      "path": "../../ui/react-ui-theme"
+      "path": "../../ui/ui-theme"
     },
     {
       "path": "../client"

package/vitest.config.ts

@@ -2,21 +2,17 @@
 // Copyright 2024 DXOS.org
 //
 
-import { defineConfig, mergeConfig } from 'vitest/config';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-import { baseConfig } from '../../../vitest.shared';
+import { createConfig } from '../../../vitest.base.config';
 
-// TODO(wittjosiah): Factor out to shared config as an option.
-const specifiedEnv = (process.env.VITEST_ENV ?? 'node').toLowerCase();
-const environment = specifiedEnv === 'node' ? 'jsdom' : undefined;
-
-export default mergeConfig(
-  baseConfig({ cwd: __dirname }),
-  defineConfig({
-    test: {
-      environment,
-      // TODO(dmaretskyi): Enabled because client tests were flaky. Remove when that's not the case.
-      retry: 2,
-    },
-  }),
-);
+export default createConfig({
+  dirname: typeof __dirname !== 'undefined' ? __dirname : path.dirname(fileURLToPath(import.meta.url)),
+  node: {
+    environment: 'happy-dom',
+    // TODO(dmaretskyi): Enabled because client tests were flaky. Remove when that's not the case.
+    retry: 2,
+  },
+  storybook: true,
+});

package/.eslintrc.cjs

@@ -1,12 +0,0 @@
-module.exports = {
-  "extends": [
-    "../../../.eslintrc.js"
-  ],
-  "parserOptions": {
-    "project": "tsconfig.json",
-    "tsconfigRootDir": __dirname,
-  },
-  "ignorePatterns": [
-    "**/*.d.ts"
-  ]
-}

package/README.yml

@@ -1,33 +0,0 @@
-usage: |
-  The snippet below illustrates a self-contained DXOS application that uses providers to create the client and instantiate a user profile.
-
-  ```javascript
-
-  import React from 'react';
-  import { useClient, ClientProvider } from '@dxos/react-client';
-  import { createRoot } from 'react-dom/client';
-
-  const App = () => {
-    const client = useClient();
-    const space = useSpaces();
-    return (
-      <pre>{JSON.stringify(client.info())}</pre>
-    );
-  };
-
-  const Root = () => (
-    <ClientProvider>
-      <App />
-    </ClientProvider>
-  );
-
-  createRoot(document.getElementById('root')!)
-    .render(<Root/>);
-  
-  ```
-storybooks:
-  - "The [HALO Invitation Story](./stories/halo-invitations.stories.tsx) demonstrates multiple clients (devices) joining the same HALO. [Demo video](https://user-images.githubusercontent.com/3523355/137532718-a21f1f27-9854-4c0b-831a-e9ff92feac49.mov)."
-  - "The [Space Invitation Story](./stories/space-invitations.stories.tsx) demonstrates multiple clients creating and sharing spaces. [Demo video](https://user-images.githubusercontent.com/3523355/137532717-e77395dc-96f9-4e4b-8f67-e6bd026a3abe.mov)."
-quickStartUrl: https://docs.dxos.org/guide/quick-start
-guideUrl: https://docs.dxos.org/guide/echo/react
-apiReferenceUrl: true

package/dist/lib/browser/chunk-72QD3PXL.mjs

@@ -1,312 +0,0 @@
-// packages/sdk/react-client/src/client/AgentHostingProvider.tsx
-import React2, { createContext as createContext2, useContext as useContext4, useState as useState4 } from "react";
-import { AgentManagerClient, FakeAgentHostingProvider } from "@dxos/client";
-import { log as log2 } from "@dxos/log";
-
-// packages/sdk/react-client/src/client/ClientProvider.tsx
-import React, { forwardRef, useEffect, useImperativeHandle, useState } from "react";
-import { Client, SystemStatus } from "@dxos/client";
-import { registerSignalsRuntime } from "@dxos/echo-signals/react";
-import { log } from "@dxos/log";
-import { useControlledState } from "@dxos/react-hooks";
-import { getAsyncProviderValue } from "@dxos/util";
-
-// packages/sdk/react-client/src/client/context.ts
-import { createContext } from "react";
-var ClientContext = createContext(void 0);
-
-// packages/sdk/react-client/src/banner.ts
-var BANNER = (client) => {
-  const commitHash = client.config.get("runtime.app.build.commitHash");
-  const hash = commitHash ? ` App Commit ${commitHash} 
-` : "";
-  return `
-_/\\/\\/\\/\\/\\____/\\/\\____/\\/\\____/\\/\\/\\/\\______/\\/\\/\\/\\/\\_
-_/\\/\\____/\\/\\____/\\/\\/\\/\\____/\\/\\____/\\/\\__/\\/\\_________
-_/\\/\\____/\\/\\______/\\/\\______/\\/\\____/\\/\\____/\\/\\/\\/\\___
-_/\\/\\____/\\/\\____/\\/\\/\\/\\____/\\/\\____/\\/\\__________/\\/\\_
-_/\\/\\/\\/\\/\\____/\\/\\____/\\/\\____/\\/\\/\\/\\____/\\/\\/\\/\\/\\___
-
- DXOS Client ${client.version} 
-${hash}`;
-};
-var bannerPrinted = false;
-var printBanner = (client) => {
-  if (bannerPrinted || window.location.hostname === "localhost") {
-    return;
-  }
-  bannerPrinted = true;
-  console.log(`%c${BANNER(client)}`, "font-family: monospace;");
-};
-
-// packages/sdk/react-client/src/client/ClientProvider.tsx
-var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/react-client/src/client/ClientProvider.tsx";
-var ClientProvider = /* @__PURE__ */ forwardRef(({ children, config: configProvider, client: clientProvider, services: servicesProvider, status: controlledStatus, fallback: Fallback = () => null, signalsRuntime = true, noBanner, onInitialized, ...options }, forwardedRef) => {
-  useEffect(() => {
-    signalsRuntime && registerSignalsRuntime();
-  }, []);
-  const [error, setError] = useState();
-  if (error) {
-    throw error;
-  }
-  const [client, setClient] = useState(clientProvider instanceof Client ? clientProvider : void 0);
-  useImperativeHandle(forwardedRef, () => client, [
-    client
-  ]);
-  const [status, setStatus] = useControlledState(controlledStatus);
-  useEffect(() => {
-    if (!client) {
-      return;
-    }
-    const subscription = client.status.subscribe((status2) => setStatus(status2));
-    return () => subscription.unsubscribe();
-  }, [
-    client
-  ]);
-  useEffect(() => {
-    let disposed = false;
-    const initialize = async (client3) => {
-      if (!client3.initialized) {
-        await client3.initialize().catch((err) => {
-          if (!disposed) {
-            setError(err);
-          }
-        });
-        log("client ready", void 0, {
-          F: __dxlog_file,
-          L: 137,
-          S: void 0,
-          C: (f, a) => f(...a)
-        });
-        await onInitialized?.(client3);
-        log("initialization complete", void 0, {
-          F: __dxlog_file,
-          L: 139,
-          S: void 0,
-          C: (f, a) => f(...a)
-        });
-      }
-      setClient(client3);
-      if (!noBanner) {
-        printBanner(client3);
-      }
-    };
-    let client2;
-    const t = setTimeout(async () => {
-      try {
-        if (clientProvider) {
-          client2 = await getAsyncProviderValue(clientProvider);
-          await initialize(client2);
-        } else {
-          const config = await getAsyncProviderValue(configProvider);
-          log("resolved config", {
-            config
-          }, {
-            F: __dxlog_file,
-            L: 159,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-          const services = await getAsyncProviderValue(servicesProvider, config);
-          log("created services", {
-            services
-          }, {
-            F: __dxlog_file,
-            L: 161,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-          client2 = new Client({
-            config,
-            services,
-            ...options
-          });
-          log("created client", void 0, {
-            F: __dxlog_file,
-            L: 163,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-          await initialize(client2);
-        }
-      } catch (err) {
-        if (!disposed) {
-          log.catch(err, void 0, {
-            F: __dxlog_file,
-            L: 168,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-        }
-      }
-    });
-    return () => {
-      log("clean up", void 0, {
-        F: __dxlog_file,
-        L: 174,
-        S: void 0,
-        C: (f, a) => f(...a)
-      });
-      disposed = true;
-      clearTimeout(t);
-      if (!clientProvider) {
-        void client2?.destroy().then(() => {
-          log("destroyed", void 0, {
-            F: __dxlog_file,
-            L: 182,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-        }).catch((err) => log.catch(err, void 0, {
-          F: __dxlog_file,
-          L: 184,
-          S: void 0,
-          C: (f, a) => f(...a)
-        }));
-      }
-    };
-  }, [
-    configProvider,
-    clientProvider,
-    servicesProvider,
-    noBanner
-  ]);
-  if (!client?.initialized || status !== SystemStatus.ACTIVE) {
-    return /* @__PURE__ */ React.createElement(Fallback, {
-      client,
-      status
-    });
-  }
-  return /* @__PURE__ */ React.createElement(ClientContext.Provider, {
-    value: {
-      client,
-      status
-    }
-  }, children);
-});
-
-// packages/sdk/react-client/src/client/useClient.ts
-import { useContext } from "react";
-import { raise } from "@dxos/debug";
-var useClient = () => {
-  const { client } = useContext(ClientContext) ?? raise(new Error("Missing ClientContext."));
-  return client;
-};
-
-// packages/sdk/react-client/src/client/useClientStatus.ts
-import { useEffect as useEffect2, useState as useState2 } from "react";
-var useClientStatus = (client) => {
-  const [status, setStatus] = useState2();
-  useEffect2(() => {
-    if (!client) {
-      return;
-    }
-    const subscription = client.status.subscribe((status2) => setStatus(status2));
-    return () => subscription.unsubscribe();
-  }, [
-    client,
-    setStatus
-  ]);
-  return status;
-};
-
-// packages/sdk/react-client/src/client/useConfig.ts
-import { useContext as useContext2 } from "react";
-import { raise as raise2 } from "@dxos/debug";
-var useConfig = () => {
-  const { client } = useContext2(ClientContext) ?? raise2(new Error("Missing ClientContext."));
-  return client.config;
-};
-
-// packages/sdk/react-client/src/client/useShell.ts
-import { useEffect as useEffect3, useState as useState3 } from "react";
-var useShell = () => {
-  const client = useClient();
-  return client.shell;
-};
-var useShellDisplay = () => {
-  const client = useClient();
-  const [display, setDisplay] = useState3(client.shell.display);
-  useEffect3(() => client.shell.onDisplayChange(setDisplay), [
-    client
-  ]);
-  return display;
-};
-
-// packages/sdk/react-client/src/client/useStatus.ts
-import { useContext as useContext3 } from "react";
-import { raise as raise3 } from "@dxos/debug";
-var useStatus = () => {
-  const { status } = useContext3(ClientContext) ?? raise3(new Error("Missing ClientContext."));
-  return status;
-};
-
-// packages/sdk/react-client/src/client/AgentHostingProvider.tsx
-var __dxlog_file2 = "/home/runner/work/dxos/dxos/packages/sdk/react-client/src/client/AgentHostingProvider.tsx";
-var AgentHostingContext = /* @__PURE__ */ createContext2(null);
-var AgentHostingProvider = (props) => {
-  const client = useClient();
-  const [agentHostingProviderClient] = useState4(makeClient(client));
-  return /* @__PURE__ */ React2.createElement(AgentHostingContext.Provider, {
-    value: agentHostingProviderClient
-  }, " ", props.children);
-};
-var useAgentHostingClient = () => {
-  return useContext4(AgentHostingContext);
-};
-var makeClient = ({ config, halo }) => {
-  const agentHostingConfig = config.get("runtime.services.agentHosting");
-  if (!agentHostingConfig) {
-    log2("no agent hosting configured", void 0, {
-      F: __dxlog_file2,
-      L: 39,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    return null;
-  }
-  let agentHostingProviderClient = null;
-  switch (agentHostingConfig.type) {
-    case "LOCAL_TESTING": {
-      log2("using FakeAgentHostingProvider", void 0, {
-        F: __dxlog_file2,
-        L: 47,
-        S: void 0,
-        C: (f, a) => f(...a)
-      });
-      return new FakeAgentHostingProvider();
-    }
-    case "AGENTHOSTING_API": {
-      agentHostingProviderClient = new AgentManagerClient(config, halo);
-      if (agentHostingProviderClient.init()) {
-        return agentHostingProviderClient;
-      } else {
-        return null;
-      }
-    }
-    default: {
-      log2.error("Unknown agent hosting provider type: " + agentHostingConfig.type, void 0, {
-        F: __dxlog_file2,
-        L: 62,
-        S: void 0,
-        C: (f, a) => f(...a)
-      });
-      return null;
-    }
-  }
-};
-
-export {
-  AgentHostingContext,
-  AgentHostingProvider,
-  useAgentHostingClient,
-  ClientContext,
-  ClientProvider,
-  useClient,
-  useClientStatus,
-  useConfig,
-  useShell,
-  useShellDisplay,
-  useStatus
-};
-//# sourceMappingURL=chunk-72QD3PXL.mjs.map