@dxos/react-client 2.28.6-dev.ca9d0e33 → 2.28.6

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@dxos/react-client",
-  "version": "2.28.6-dev.ca9d0e33",
+  "version": "2.28.6",
   "description": "React client API",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "@dxos/async": "2.28.6-dev.ca9d0e33",
-    "@dxos/bot-factory-client": "2.28.6-dev.ca9d0e33",
-    "@dxos/client": "2.28.6-dev.ca9d0e33",
-    "@dxos/config": "2.28.6-dev.ca9d0e33",
-    "@dxos/credentials": "2.28.6-dev.ca9d0e33",
-    "@dxos/crypto": "2.28.6-dev.ca9d0e33",
-    "@dxos/debug": "2.28.6-dev.ca9d0e33",
-    "@dxos/echo-db": "2.28.6-dev.ca9d0e33",
-    "@dxos/network-manager": "2.28.6-dev.ca9d0e33",
-    "@dxos/util": "2.28.6-dev.ca9d0e33",
+    "@dxos/async": "2.28.6",
+    "@dxos/bot-factory-client": "2.28.6",
+    "@dxos/client": "2.28.6",
+    "@dxos/config": "2.28.6",
+    "@dxos/credentials": "2.28.6",
+    "@dxos/crypto": "2.28.6",
+    "@dxos/debug": "2.28.6",
+    "@dxos/echo-db": "2.28.6",
+    "@dxos/network-manager": "2.28.6",
+    "@dxos/util": "2.28.6",
     "assert": "^2.0.0",
     "debug": "^4.3.3",
     "use-subscription": "^1.4.1"
@@ -24,7 +24,7 @@
   "devDependencies": {
     "@dxos/esbuild-plugins": "~2.28.4",
     "@dxos/eslint-plugin": "~1.0.27",
-    "@dxos/protocols-toolchain": "2.28.5",
+    "@dxos/protocols-toolchain": "2.28.6",
     "@mui/material": "^5.4.2",
     "@testing-library/react": "^11.0.4",
     "@testing-library/react-hooks": "5.1.2",

package/src/banner.ts

@@ -4,9 +4,7 @@
 
 import { Client } from '@dxos/client';
 
-// TODO(burdon): Print version.
 // http://patorjk.com/software/taag/#p=testall&f=Patorjk-HeX&t=DXOS
-
 const BANNER = (client: Client) => '\n' +
   '_/\\/\\/\\/\\/\\____/\\/\\____/\\/\\____/\\/\\/\\/\\______/\\/\\/\\/\\/\\_\n' +
   '_/\\/\\____/\\/\\____/\\/\\/\\/\\____/\\/\\____/\\/\\__/\\/\\_________\n' +

package/src/containers/BotFactoryClientProvider.tsx

@@ -0,0 +1,50 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import React, { ReactNode, useEffect, useState } from 'react';
+
+import { BotFactoryClient } from '@dxos/bot-factory-client';
+import { PublicKey } from '@dxos/crypto';
+import { raise } from '@dxos/debug';
+
+import { BotFactoryClientContext, createBotFactoryClient, useConfig } from '../hooks';
+
+export interface BotFactoryClientProviderProps {
+  children?: ReactNode
+}
+
+/**
+ * BotFactoryClientProvider
+ */
+export const BotFactoryClientProvider = ({
+  children
+}: BotFactoryClientProviderProps) => {
+  const config = useConfig();
+  const [botFactoryClient, setBotFactoryClient] = useState<BotFactoryClient>();
+
+  useEffect(() => {
+    setImmediate(async () => {
+      const botFactoryClient = await createBotFactoryClient(config);
+      setBotFactoryClient(botFactoryClient);
+
+      // TODO(burdon): Rename property: 'runtime.services.bot-factory.topic'
+      const topic = config.get('runtime.services.bot.topic') ?? raise(new Error('Missing Bot factory topic.'));
+      await botFactoryClient.start(PublicKey.from(topic));
+    });
+
+    return () => {
+      void botFactoryClient?.stop();
+    };
+  }, []);
+
+  if (!botFactoryClient) {
+    return null;
+  }
+
+  return (
+    <BotFactoryClientContext.Provider value={botFactoryClient}>
+      {children}
+    </BotFactoryClientContext.Provider>
+  );
+};

package/src/containers/ClientProvider.tsx

@@ -6,7 +6,7 @@ import debug from 'debug';
 import React, { MutableRefObject, ReactNode, useEffect, useState } from 'react';
 
 import { Client, ClientOptions } from '@dxos/client';
-import { Config, ConfigObject } from '@dxos/config';
+import { ConfigProvider } from '@dxos/config';
 import { MaybeFunction, MaybePromise, getAsyncValue } from '@dxos/util';
 
 import { printBanner } from '../banner';
@@ -16,9 +16,6 @@ const log = debug('dxos:react-client');
 
 export type ClientProvider = MaybeFunction<MaybePromise<Client>>
 
-// TODO(burdon): Why defs?
-export type ConfigProvider = MaybeFunction<MaybePromise<Config | ConfigObject>>
-
 export interface ClientProviderProps {
   children?: ReactNode
 
@@ -76,7 +73,6 @@ export const ClientProvider = ({
         printBanner(client);
       };
 
-      // TODO(burdon): Error handling.
       setImmediate(async () => {
         if (clientProvider) {
           // Asynchornously request client.
@@ -93,6 +89,8 @@ export const ClientProvider = ({
     }
   }, []);
 
+  // Console debug access.
+  // TODO(burdon): Debug only.
   useEffect(() => {
     if (client) {
       (window as any).__DXOS__ = client.getDevtoolsContext();

package/src/containers/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2020 DXOS.org
 //
 
+export * from './BotFactoryClientProvider';
 export * from './ClientProvider';

package/src/hooks/bot-factory/useBotFactoryClient.ts

@@ -2,34 +2,30 @@
 // Copyright 2021 DXOS.org
 //
 
-import { useEffect, useState } from 'react';
+import { createContext, useContext } from 'react';
 
 import { BotFactoryClient } from '@dxos/bot-factory-client';
 import { Config } from '@dxos/config';
-import { PublicKey } from '@dxos/crypto';
-import { raise } from '@dxos/debug';
 import { NetworkManager } from '@dxos/network-manager';
 
-export const useBotFactoryClient = (config: Config): BotFactoryClient | undefined => {
-  const [botFactoryClient, setBotFactoryClient] = useState<BotFactoryClient>();
+export const BotFactoryClientContext = createContext<BotFactoryClient | undefined>(undefined);
 
-  useEffect(() => {
-    const networkManager = new NetworkManager({
-      signal: config.get('runtime.services.signal.server') ? [config.get('runtime.services.signal.server')!] : undefined,
-      ice: config.get('runtime.services.ice'),
-      log: true
-    });
-    const botFactoryClient = new BotFactoryClient(networkManager);
-    const topic = config.get('runtime.services.bot.topic') ??
-      raise(new Error('Bot factory topic is not provided'));
-    setImmediate(async () => {
-      await botFactoryClient.start(PublicKey.from(topic));
-      setBotFactoryClient(botFactoryClient);
-    });
-    return () => {
-      void botFactoryClient.stop();
-    };
-  }, []);
+export const useBotFactoryClient = (required = true): BotFactoryClient | undefined => {
+  const client = useContext(BotFactoryClientContext);
+  if (required && !client) {
+    throw new Error('Missing BotFactoryClientContext.');
+  }
 
-  return botFactoryClient;
+  return client;
+};
+
+export const createBotFactoryClient = async (config: Config): Promise<BotFactoryClient> => {
+  const signal = config.get('runtime.services.signal.server');
+  const networkManager = new NetworkManager({
+    signal: signal ? [signal] : undefined,
+    ice: config.get('runtime.services.ice'),
+    log: true
+  });
+
+  return new BotFactoryClient(networkManager);
 };

package/src/hooks/client/context.ts

@@ -10,7 +10,4 @@ interface ClientContextProps {
   client: Client
 }
 
-/**
- * https://reactjs.org/docs/context.html#reactcreatecontext
- */
 export const ClientContext = createContext<ClientContextProps | undefined>(undefined);

package/src/hooks/index.ts

@@ -2,10 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
+export * from './bot-factory';
 export * from './client';
 export * from './echo-queries';
 export * from './echo-selections';
 export * from './invitations';
-export * from './wns';
 export * from './util';
-export * from './bot-factory';
+export * from './wns';

package/stories/halo-invitations.stories.tsx

@@ -4,9 +4,7 @@
 
 import React, { useState } from 'react';
 
-import {
-  Box, Button, Divider, Paper, TextField, Toolbar
-} from '@mui/material';
+import { Box, Button, Divider, Paper, TextField, Toolbar } from '@mui/material';
 
 import { Invitation, InvitationDescriptor } from '@dxos/client';