@dxos/plugin-assistant 0.8.3 → 0.8.4-main.1f223c7

package/src/components/Chat/Chat.tsx

@@ -0,0 +1,389 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Extension, Prec } from '@codemirror/state';
+import { keymap } from '@codemirror/view';
+import { useRxValue } from '@effect-rx/rx-react';
+import { createContext } from '@radix-ui/react-context';
+import { Array, Option } from 'effect';
+import React, { type PropsWithChildren, useCallback, useEffect, useMemo, useRef, useState } from 'react';
+
+import { Event } from '@dxos/async';
+import { Obj } from '@dxos/echo';
+import { useVoiceInput } from '@dxos/plugin-transcription';
+import { type Space, getSpace, useQueue } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Input, type ThemedClassName, useDynamicRef, useTranslation } from '@dxos/react-ui';
+import { ChatEditor, type ChatEditorController, type ChatEditorProps, references } from '@dxos/react-ui-chat';
+import { mx } from '@dxos/react-ui-theme';
+import { DataType } from '@dxos/schema';
+import { isNotFalsy } from '@dxos/util';
+
+import { useReferencesProvider } from '../../hooks';
+import { meta } from '../../meta';
+import { type AiChatProcessor } from '../../processor';
+import { type Assistant } from '../../types';
+import {
+  ChatActions,
+  type ChatActionsProps,
+  ChatOptions,
+  type ChatPresetsProps,
+  ChatReferences,
+  ChatStatusIndicator,
+} from '../ChatPrompt';
+import {
+  type ChatThreadController,
+  ChatThread as NaturalChatThread,
+  type ChatThreadProps as NaturalChatThreadProps,
+} from '../ChatThread';
+
+import { type ChatEvent } from './events';
+
+//
+// Context
+// NOTE: The context should not be exported. It is only used internally.
+// Components outside of this Radix-style group shuld define their own APIs.
+//
+
+type ChatContextValue = {
+  debug?: boolean;
+  event: Event<ChatEvent>;
+  space: Space;
+  chat: Assistant.Chat;
+  messages: DataType.Message[];
+  processor: AiChatProcessor;
+};
+
+export const [ChatContextProvider, useChatContext] = createContext<ChatContextValue>('Chat');
+
+//
+// Root
+//
+
+type ChatRootProps = ThemedClassName<
+  PropsWithChildren<
+    Pick<ChatContextValue, 'chat' | 'processor'> & {
+      onEvent?: (event: ChatEvent) => void;
+    }
+  >
+>;
+
+const ChatRoot = ({ classNames, children, chat, processor, onEvent, ...props }: ChatRootProps) => {
+  const [debug, setDebug] = useState(false);
+  const space = getSpace(chat);
+
+  // Messages.
+  const queue = useQueue<DataType.Message>(chat?.queue.dxn);
+  const pending = useRxValue(processor.messages);
+  const streaming = useRxValue(processor.streaming);
+  const lastPrompt = useRef<string | undefined>(undefined);
+
+  const messages = useMemo(() => {
+    const queueMessages = queue?.objects?.filter(Obj.instanceOf(DataType.Message)) ?? [];
+    return Array.dedupeWith([...queueMessages, ...pending], (a, b) => a.id === b.id);
+  }, [queue?.objects, pending]);
+
+  // Events.
+  const event = useMemo(() => new Event<ChatEvent>(), []);
+  useEffect(() => {
+    return event.on((ev) => {
+      switch (ev.type) {
+        case 'toggle-debug': {
+          setDebug((current) => !current);
+          break;
+        }
+
+        case 'submit': {
+          const text = ev.text.trim();
+          if (!streaming && text.length) {
+            lastPrompt.current = ev.text;
+            void processor.request({ message: text });
+          }
+          break;
+        }
+
+        case 'retry': {
+          if (!streaming) {
+            void processor.retry();
+          }
+          break;
+        }
+
+        case 'cancel': {
+          if (streaming) {
+            void processor.cancel();
+            if (lastPrompt.current) {
+              event.emit({ type: 'update-prompt', text: lastPrompt.current });
+            }
+          }
+          break;
+        }
+
+        default: {
+          onEvent?.(ev);
+        }
+      }
+    });
+  }, [event, processor, streaming, onEvent]);
+
+  if (!space) {
+    return null;
+  }
+
+  return (
+    <ChatContextProvider
+      debug={debug}
+      event={event}
+      chat={chat}
+      space={space}
+      messages={messages}
+      processor={processor}
+      {...props}
+    >
+      <div role='none' className={mx('flex flex-col h-full overflow-hidden', classNames)}>
+        {children}
+      </div>
+    </ChatContextProvider>
+  );
+};
+
+ChatRoot.displayName = 'Chat.Root';
+
+//
+// Prompt
+//
+
+type ChatPromptProps = ThemedClassName<
+  {
+    outline?: boolean;
+  } & Pick<ChatEditorProps, 'placeholder'> &
+    Omit<ChatPresetsProps, 'onChange'> & {
+      expandable?: boolean;
+      online?: boolean;
+      onOnlineChange?: (online: boolean) => void;
+      onPresetChange?: ChatPresetsProps['onChange'];
+    }
+>;
+
+const ChatPrompt = ({
+  classNames,
+  outline,
+  placeholder,
+  expandable,
+  online,
+  presets,
+  preset,
+  onPresetChange,
+  onOnlineChange,
+}: ChatPromptProps) => {
+  const { t } = useTranslation(meta.id);
+  const { space, event, processor } = useChatContext(ChatPrompt.displayName);
+
+  const error = useRxValue(processor.error).pipe(Option.getOrUndefined);
+  const streaming = useRxValue(processor.streaming);
+  const active = useRxValue(processor.active);
+  const activeRef = useDynamicRef(active);
+
+  const editorRef = useRef<ChatEditorController>(null);
+  const [recordingState, setRecordingState] = useState(false);
+  useEffect(() => {
+    return event.on((event) => {
+      switch (event.type) {
+        case 'update-prompt':
+          if (!editorRef.current?.getText()?.length) {
+            editorRef.current?.setText(event.text);
+            editorRef.current?.focus();
+          }
+          break;
+        case 'record-start':
+          setRecordingState(true);
+          break;
+        case 'record-stop':
+          setRecordingState(false);
+          break;
+      }
+    });
+  }, [event]);
+
+  // TODO(burdon): Configure capability in TranscriptionPlugin.
+  const { recording } = useVoiceInput({
+    active: recordingState,
+    onUpdate: (text) => {
+      editorRef.current?.setText(text);
+      editorRef.current?.focus();
+    },
+  });
+
+  // TODO(burdon): Reconcile with object tags.
+  const referencesProvider = useReferencesProvider(space);
+  const extensions = useMemo<Extension[]>(() => {
+    return [
+      referencesProvider && references({ provider: referencesProvider }),
+      Prec.highest(
+        keymap.of(
+          [
+            {
+              key: 'cmd-d',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'toggle-debug' });
+                return true;
+              },
+            },
+            expandable && {
+              key: 'cmd-ArrowUp',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'thread-open' });
+                return true;
+              },
+            },
+            expandable && {
+              key: 'cmd-ArrowDown',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'thread-close' });
+                return true;
+              },
+            },
+          ].filter(isNotFalsy),
+        ),
+      ),
+    ].filter(isNotFalsy);
+  }, [event, expandable, referencesProvider]);
+
+  const handleSubmit = useCallback<NonNullable<ChatEditorProps['onSubmit']>>(
+    (text) => {
+      if (!activeRef.current) {
+        event.emit({ type: 'submit', text });
+        return true;
+      }
+    },
+    [event],
+  );
+
+  const handleEvent = useCallback<NonNullable<ChatActionsProps['onEvent']>>(
+    (ev) => {
+      event.emit(ev);
+    },
+    [event],
+  );
+
+  return (
+    <div
+      className={mx(
+        'is-full flex flex-col density-fine',
+        outline && [
+          'p-2 bg-groupSurface border border-subduedSeparator transition transition-border [&:has(.cm-content:focus)]:border-separator rounded',
+        ],
+        classNames,
+      )}
+    >
+      <div className='flex gap-2'>
+        <ChatStatusIndicator classNames='p-1' preset={preset} error={error} processing={streaming} />
+
+        <ChatEditor
+          ref={editorRef}
+          autoFocus
+          lineWrapping
+          classNames='col-span-2 pbs-0.5'
+          placeholder={placeholder ?? t('prompt placeholder')}
+          extensions={extensions}
+          onSubmit={handleSubmit}
+        />
+      </div>
+
+      <div className='flex pbs-2 items-center'>
+        <ChatOptions
+          space={space}
+          blueprintRegistry={processor.blueprintRegistry}
+          context={processor.context}
+          preset={preset}
+          presets={presets}
+          onPresetChange={onPresetChange}
+        />
+
+        <div role='none' className='pli-cardSpacingChrome grow'>
+          <ChatReferences space={space} context={processor.context} />
+        </div>
+
+        <ChatActions
+          classNames='col-span-2'
+          microphone={true}
+          recording={recording}
+          processing={streaming}
+          onEvent={handleEvent}
+        >
+          {online !== undefined && (
+            <Input.Root>
+              <Input.Switch classNames='mis-2 mie-2' checked={online} onCheckedChange={onOnlineChange} />
+            </Input.Root>
+          )}
+        </ChatActions>
+      </div>
+    </div>
+  );
+};
+
+ChatPrompt.displayName = 'Chat.Prompt';
+
+//
+// Thread
+//
+
+type ChatThreadProps = Omit<NaturalChatThreadProps, 'identity' | 'messages' | 'tools'>;
+
+const ChatThread = (props: ChatThreadProps) => {
+  const { event, messages, processor } = useChatContext(ChatThread.displayName);
+  const identity = useIdentity();
+  const error = useRxValue(processor.error).pipe(Option.getOrUndefined);
+
+  const scrollerRef = useRef<ChatThreadController | null>(null);
+  useEffect(() => {
+    return event.on((event) => {
+      switch (event.type) {
+        case 'submit':
+        case 'scroll-to-bottom':
+          scrollerRef.current?.scrollToBottom();
+          break;
+      }
+    });
+  }, [event]);
+
+  const handleEvent = useCallback<NonNullable<NaturalChatThreadProps['onEvent']>>(
+    (ev) => {
+      event.emit(ev);
+    },
+    [event],
+  );
+
+  if (!identity) {
+    return null;
+  }
+
+  return (
+    <NaturalChatThread
+      {...props}
+      ref={scrollerRef}
+      identity={identity}
+      messages={messages}
+      error={error}
+      onEvent={handleEvent}
+    />
+  );
+};
+
+ChatThread.displayName = 'Chat.Thread';
+
+//
+// Chat
+//
+
+export const Chat = {
+  Root: ChatRoot,
+  Prompt: ChatPrompt,
+  Thread: ChatThread,
+};
+
+export type { ChatRootProps, ChatThreadProps, ChatPromptProps, ChatEvent };

package/src/components/Chat/events.ts

@@ -0,0 +1,57 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Obj } from '@dxos/echo';
+
+/**
+ * The main `ChatRoot` manages the `ChatContextValue` which contains an `event` property that subcomponents
+ * can subscribe to and submit events. Unhandled events are passed to the external `onEvent` callback.
+ */
+export type ChatEvent =
+  | {
+      type: 'toggle-debug';
+    }
+  //
+  // Thread
+  //
+  | {
+      type: 'submit';
+      text: string;
+    }
+  | {
+      type: 'retry';
+    }
+  | {
+      type: 'cancel';
+    }
+  | {
+      type: 'delete';
+      id: string;
+    }
+  | {
+      type: 'add';
+      object: Obj.Any;
+    }
+  //
+  // UX
+  //
+  | {
+      type: 'update-prompt';
+      text: string;
+    }
+  | {
+      type: 'scroll-to-bottom';
+    }
+  | {
+      type: 'thread-open';
+    }
+  | {
+      type: 'thread-close';
+    }
+  | {
+      type: 'record-start';
+    }
+  | {
+      type: 'record-stop';
+    };

package/src/components/Chat/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './events';
+
+export * from './Chat';

package/src/components/ChatCompanion.tsx

@@ -0,0 +1,111 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Array, Effect, Option, pipe } from 'effect';
+import React, { useMemo } from 'react';
+
+import { Capabilities, createIntent, useCapabilities, useIntentDispatcher } from '@dxos/app-framework';
+import { Blueprint } from '@dxos/blueprints';
+import { getSpace } from '@dxos/client/echo';
+import { Filter, Obj, Query, Ref } from '@dxos/echo';
+import { DatabaseService } from '@dxos/functions';
+import { SpaceAction } from '@dxos/plugin-space/types';
+import { useQuery } from '@dxos/react-client/echo';
+import { useAsyncEffect } from '@dxos/react-ui';
+
+import { ChatContainer } from '../components';
+import { useContextBinder } from '../hooks';
+import { Assistant, AssistantAction } from '../types';
+
+export type ChatCompanionProps = {
+  role?: string;
+  data: { companionTo: Obj.Any; subject: Assistant.Chat | 'assistant-chat' };
+};
+
+export const ChatCompanion = ({ role, data }: ChatCompanionProps) => {
+  const companionTo = data.companionTo;
+  const space = getSpace(companionTo);
+  const chat = data.subject === 'assistant-chat' ? undefined : data.subject;
+  const binder = useContextBinder(chat);
+  const { dispatch } = useIntentDispatcher();
+
+  // Initialize companion chat if it doesn't exist.
+  useAsyncEffect(async () => {
+    if (chat || !space) {
+      return;
+    }
+
+    // TODO(burdon): Garbage collection of queues?
+    // TODO(wittjosiah): Figure out how to prevent companion chats from showing up in the navtree.
+    await Effect.gen(function* () {
+      const { objects } = yield* DatabaseService.runQuery(
+        Query.select(Filter.ids(companionTo.id)).targetOf(Assistant.CompanionTo).source(),
+      );
+
+      // TODO(wittjosiah): This should be the default sort order.
+      let nextChat = objects.toSorted((a, b) => a.id.localeCompare(b.id)).at(-1);
+      if (!nextChat) {
+        const { object } = yield* dispatch(createIntent(AssistantAction.CreateChat, { space }));
+        nextChat = object;
+        yield* dispatch(createIntent(SpaceAction.AddObject, { object: nextChat, target: space, hidden: true }));
+        yield* dispatch(
+          createIntent(SpaceAction.AddRelation, {
+            space,
+            schema: Assistant.CompanionTo,
+            source: nextChat,
+            target: data.companionTo,
+          }),
+        );
+      }
+
+      yield* dispatch(createIntent(AssistantAction.SetCurrentChat, { companionTo, chat: nextChat }));
+    }).pipe(Effect.provide(DatabaseService.layer(space.db)), Effect.runPromise);
+  }, [space, chat, companionTo]);
+
+  const metadata = useCapabilities(Capabilities.Metadata);
+  const blueprintKeys = useMemo(
+    () =>
+      pipe(
+        metadata,
+        Array.findFirst(
+          (capability): capability is { id: string; metadata: { blueprints?: string[] } } =>
+            capability.id === Obj.getTypename(companionTo),
+        ),
+        Option.flatMap((c) => Option.fromNullable(c.metadata.blueprints)),
+        Option.getOrElse(() => [] as string[]),
+      ),
+    [metadata, companionTo],
+  );
+  const allBlueprints = useQuery(space, Filter.type(Blueprint.Blueprint));
+  const pluginBlueprints = useMemo(
+    () => allBlueprints.filter((blueprint) => blueprintKeys.includes(blueprint.key)),
+    [allBlueprints, blueprintKeys],
+  );
+
+  // TODO(wittjosiah): Occasionally this fails to bind but seems to be an upstream issue.
+  //   It seems like the queue object signal emits as an empty array after previously emitting a non-empty array.
+  useAsyncEffect(async () => {
+    if (!binder) {
+      return;
+    }
+
+    if (pluginBlueprints.length > 0) {
+      await binder.bind({ blueprints: pluginBlueprints.map((blueprint) => Ref.make(blueprint)) });
+    }
+
+    if (Obj.instanceOf(Blueprint.Blueprint, companionTo)) {
+      await binder.bind({ blueprints: [Ref.make(companionTo)] });
+    } else {
+      await binder.bind({ objects: [Ref.make(companionTo)] });
+    }
+  }, [binder, companionTo, pluginBlueprints]);
+
+  if (!chat) {
+    return null;
+  }
+
+  return <ChatContainer role={role} chat={chat} companionTo={companionTo} />;
+};
+
+export default ChatCompanion;

package/src/components/ChatContainer.tsx

@@ -2,36 +2,48 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { type FC } from 'react';
+import React from 'react';
 
-import { Capabilities, useCapabilities, useCapability } from '@dxos/app-framework';
-import { type AssociatedArtifact } from '@dxos/artifact';
-import { TranscriptionCapabilities } from '@dxos/plugin-transcription';
+import { Capabilities, useCapability } from '@dxos/app-framework';
+import { getSpace } from '@dxos/client/echo';
+import { type Obj } from '@dxos/echo';
 import { StackItem } from '@dxos/react-ui-stack';
 
-import { ThreadContainer } from './Thread';
-import { ASSISTANT_PLUGIN } from '../meta';
-import { type AssistantSettingsProps, type AIChatType } from '../types';
+import { useBlueprintRegistry, useChatProcessor, useChatServices, useOnline, usePresets } from '../hooks';
+import { meta } from '../meta';
+import { type Assistant } from '../types';
+
+import { Chat } from './Chat';
+import { Toolbar } from './Toolbar';
 
 export type ChatContainerProps = {
-  role: string;
-  chat: AIChatType;
-  associatedArtifact?: AssociatedArtifact;
+  chat: Assistant.Chat;
+  companionTo?: Obj.Any;
+  role?: string;
 };
 
-// TODO(burdon): Attention.
-export const ChatContainer: FC<ChatContainerProps> = ({ role, chat, associatedArtifact }) => {
-  const transcription = useCapabilities(TranscriptionCapabilities.Transcriber).length > 0;
-  const settings = useCapability(Capabilities.SettingsStore).getStore<AssistantSettingsProps>(ASSISTANT_PLUGIN)?.value;
+export const ChatContainer = ({ chat, companionTo }: ChatContainerProps) => {
+  const space = getSpace(chat);
+  const settings = useCapability(Capabilities.SettingsStore).getStore<Assistant.Settings>(meta.id)?.value;
+  const services = useChatServices({ space, chat });
+  const [online, setOnline] = useOnline();
+  const { preset, ...chatProps } = usePresets(online);
+  const blueprintRegistry = useBlueprintRegistry();
+  const processor = useChatProcessor({ chat, preset, services, blueprintRegistry, settings });
+
+  if (!processor) {
+    return null;
+  }
 
   return (
-    <StackItem.Content role={role} classNames='container-max-width'>
-      <ThreadContainer
-        chat={chat}
-        settings={settings}
-        transcription={transcription}
-        associatedArtifact={associatedArtifact}
-      />
+    <StackItem.Content toolbar={!!companionTo} classNames='container-max-width'>
+      {!!companionTo && <Toolbar chat={chat} companionTo={companionTo} />}
+      <Chat.Root chat={chat} processor={processor}>
+        <Chat.Thread />
+        <div className='p-2'>
+          <Chat.Prompt {...chatProps} outline preset={preset?.id} online={online} onOnlineChange={setOnline} />
+        </div>
+      </Chat.Root>
     </StackItem.Content>
   );
 };

package/src/components/ChatDialog.tsx

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback, useState } from 'react';
+
+import { Capabilities, useCapability } from '@dxos/app-framework';
+import { getSpace } from '@dxos/client/echo';
+import { useTranslation } from '@dxos/react-ui';
+import { ChatDialog as NaturalChatDialog } from '@dxos/react-ui-chat';
+
+import { useBlueprintRegistry, useChatProcessor, useChatServices, useOnline, usePresets } from '../hooks';
+import { meta } from '../meta';
+import { type Assistant } from '../types';
+
+import { Chat, type ChatRootProps } from './Chat';
+
+export type ChatDialogProps = {
+  chat?: Assistant.Chat;
+};
+
+export const ChatDialog = ({ chat }: ChatDialogProps) => {
+  const { t } = useTranslation(meta.id);
+
+  const space = getSpace(chat);
+  const settings = useCapability(Capabilities.SettingsStore).getStore<Assistant.Settings>(meta.id)?.value;
+  const services = useChatServices({ space, chat });
+  const [online, setOnline] = useOnline();
+  const { preset, ...chatProps } = usePresets(online);
+  const blueprintRegistry = useBlueprintRegistry();
+  const processor = useChatProcessor({ chat, preset, services, blueprintRegistry, settings });
+
+  // TODO(burdon): Refocus when open.
+  const [open, setOpen] = useState(true);
+  const [expanded, setExpanded] = useState(false);
+  const handleEvent = useCallback<NonNullable<ChatRootProps['onEvent']>>((event) => {
+    switch (event.type) {
+      case 'submit':
+      case 'thread-open':
+        setOpen(true);
+        setExpanded(true);
+        break;
+      case 'thread-close':
+        setOpen(false);
+        break;
+    }
+  }, []);
+
+  if (!chat || !processor) {
+    return null;
+  }
+
+  return (
+    <Chat.Root chat={chat} processor={processor} onEvent={handleEvent}>
+      <NaturalChatDialog.Root open={open} expanded={expanded} onOpenChange={setOpen}>
+        <NaturalChatDialog.Header title={t('assistant dialog title')} />
+        <NaturalChatDialog.Content>
+          <Chat.Thread />
+        </NaturalChatDialog.Content>
+        <NaturalChatDialog.Footer classNames='p-1.5'>
+          <Chat.Prompt {...chatProps} preset={preset?.id} online={online} onOnlineChange={setOnline} expandable />
+        </NaturalChatDialog.Footer>
+      </NaturalChatDialog.Root>
+    </Chat.Root>
+  );
+};
+
+export default ChatDialog;