@dxos/plugin-assistant 0.8.3 → 0.8.4-main.5acf9ea

package/src/components/Chat/Chat.tsx

@@ -0,0 +1,388 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Extension, Prec } from '@codemirror/state';
+import { keymap } from '@codemirror/view';
+import { createContext } from '@radix-ui/react-context';
+import { dedupeWith } from 'effect/Array';
+import React, { type PropsWithChildren, useCallback, useEffect, useMemo, useRef, useState } from 'react';
+
+import { CollaborationActions, createIntent, useIntentDispatcher } from '@dxos/app-framework';
+import { Event } from '@dxos/async';
+import { DXN, Obj, Ref } from '@dxos/echo';
+import { log } from '@dxos/log';
+import { useVoiceInput } from '@dxos/plugin-transcription';
+import { type Expando, getSpace, useQueue, type Space } from '@dxos/react-client/echo';
+import { useIdentity } from '@dxos/react-client/halo';
+import { Input, useTranslation, type ThemedClassName } from '@dxos/react-ui';
+import { ChatEditor, type ChatEditorController, type ChatEditorProps, references } from '@dxos/react-ui-chat';
+import { type ScrollController } from '@dxos/react-ui-components';
+import { mx } from '@dxos/react-ui-theme';
+import { DataType } from '@dxos/schema';
+import { isNotFalsy } from '@dxos/util';
+
+import { type ChatEvent } from './events';
+import { type ChatProcessor, useBlueprints, useReferencesProvider } from '../../hooks';
+import { meta } from '../../meta';
+import { type Assistant } from '../../types';
+import {
+  ChatActions,
+  type ChatActionsProps,
+  ChatOptionsMenu,
+  ChatPresets,
+  type ChatPresetsProps,
+  ChatReferences,
+  type ChatReferencesProps,
+  ChatStatusIndicator,
+} from '../ChatPrompt';
+import { ChatThread as NativeChatThread, type ChatThreadProps as NativeChatThreadProps } from '../ChatThread';
+
+// TODO(burdon): Factor out.
+const Endcap = ({ children }: PropsWithChildren) => {
+  return (
+    <div className='grid w-[var(--rail-action)] h-[var(--rail-action)] items-center justify-center'>{children}</div>
+  );
+};
+
+//
+// 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.
+//
+
+// TODO(burdon): Inject via effect layer.
+type ChatContextValue = {
+  debug?: boolean;
+  event: Event<ChatEvent>;
+  space: Space;
+  chat: Assistant.Chat;
+  processor: ChatProcessor;
+  messages: DataType.Message[];
+
+  /** @deprecated Remove and replace with context. */
+  artifact?: Expando;
+};
+
+// NOTE: Do not export.
+const [ChatContextProvider, useChatContext] = createContext<ChatContextValue>('Chat');
+
+//
+// Root
+//
+
+type ChatRootProps = ThemedClassName<
+  PropsWithChildren<
+    Pick<ChatContextValue, 'chat' | 'processor' | 'artifact'> & {
+      onEvent?: (event: ChatEvent) => void;
+    }
+  >
+>;
+
+const ChatRoot = ({ classNames, children, chat, processor, artifact, onEvent, ...props }: ChatRootProps) => {
+  const [debug, setDebug] = useState(false);
+  const space = getSpace(chat);
+
+  // Messages.
+  const queue = useQueue<DataType.Message>(chat?.queue.dxn);
+  const messages = useMemo(
+    () =>
+      dedupeWith(
+        [...(queue?.objects?.filter(Obj.instanceOf(DataType.Message)) ?? []), ...(processor?.messages.value ?? [])],
+        (a, b) => a.id === b.id,
+      ),
+    [queue?.objects, processor?.messages.value],
+  );
+
+  // TODO(burdon): Replace with tool.
+  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  useEffect(() => {
+    if (!processor?.streaming.value && queue?.objects && artifact) {
+      const message = queue.objects[queue.objects.length - 1];
+      if (dispatch && space && chat && message) {
+        void dispatch(
+          createIntent(CollaborationActions.InsertContent, {
+            target: artifact,
+            object: Ref.fromDXN(new DXN(DXN.kind.QUEUE, [...chat.queue.dxn.parts, message.id])),
+            label: 'View proposal',
+          }),
+        );
+      }
+    }
+  }, [queue, processor?.streaming.value]);
+
+  // Events.
+  const event = useMemo(() => new Event<ChatEvent>(), []);
+  useEffect(() => {
+    return event.on((event) => {
+      switch (event.type) {
+        case 'toggle-debug': {
+          setDebug((debug) => !debug);
+          break;
+        }
+
+        case 'submit': {
+          if (!processor.streaming.value) {
+            void processor.request(event.text);
+          }
+          break;
+        }
+
+        case 'cancel': {
+          void processor.cancel();
+          break;
+        }
+
+        default: {
+          onEvent?.(event);
+        }
+      }
+    });
+  }, [event, onEvent]);
+
+  if (!space) {
+    return null;
+  }
+
+  return (
+    <ChatContextProvider
+      debug={debug}
+      event={event}
+      chat={chat}
+      space={space}
+      processor={processor}
+      messages={messages}
+      {...props}
+    >
+      <div role='none' className={mx('flex flex-col h-full overflow-hidden', classNames)}>
+        {children}
+      </div>
+    </ChatContextProvider>
+  );
+};
+
+ChatRoot.displayName = 'Chat.Root';
+
+//
+// Thread
+//
+
+type ChatThreadProps = Omit<NativeChatThreadProps, 'identity' | 'space' | 'messages' | 'tools' | 'onEvent'>;
+
+const ChatThread = (props: ChatThreadProps) => {
+  const { debug, event, space, processor, messages } = useChatContext(ChatThread.displayName);
+  const identity = useIdentity();
+
+  const scrollerRef = useRef<ScrollController>(null);
+  useEffect(() => {
+    return event.on((event) => {
+      switch (event.type) {
+        case 'submit':
+        case 'scroll-to-bottom':
+          scrollerRef.current?.scrollToBottom('smooth');
+          break;
+      }
+    });
+  }, [event]);
+
+  if (!identity) {
+    return null;
+  }
+
+  return (
+    <NativeChatThread
+      {...props}
+      ref={scrollerRef}
+      debug={debug}
+      identity={identity}
+      space={space}
+      messages={messages}
+      tools={processor?.tools}
+      onEvent={(ev) => event.emit(ev)}
+    />
+  );
+};
+
+ChatThread.displayName = 'Chat.Thread';
+
+//
+// Prompt
+//
+
+type ChatPromptProps = ThemedClassName<
+  Pick<ChatEditorProps, 'placeholder'> &
+    Omit<ChatPresetsProps, 'onChange'> & {
+      expandable?: boolean;
+      online?: boolean;
+      onChangeOnline?: (online: boolean) => void;
+      onChangePreset?: ChatPresetsProps['onChange'];
+    }
+>;
+
+const ChatPrompt = ({
+  classNames,
+  placeholder,
+  expandable,
+  online,
+  presets,
+  preset,
+  onChangePreset,
+  onChangeOnline,
+}: ChatPromptProps) => {
+  const { t } = useTranslation(meta.id);
+  const { space, event, processor } = useChatContext(ChatPrompt.displayName);
+
+  const [active, setActive] = useState(false);
+  useEffect(() => {
+    return event.on((event) => {
+      switch (event.type) {
+        case 'record-start':
+          setActive(true);
+          break;
+        case 'record-stop':
+          setActive(false);
+          break;
+      }
+    });
+  }, [event]);
+
+  const editorRef = useRef<ChatEditorController>(null);
+
+  // TODO(burdon): Configure capability in TranscriptionPlugin.
+  const { recording } = useVoiceInput({
+    active,
+    onUpdate: (text) => {
+      editorRef.current?.setText(text);
+      editorRef.current?.focus();
+    },
+  });
+
+  const [blueprints, handleUpdateBlueprints] = useBlueprints(space, processor.context, processor.blueprintRegistry);
+
+  // TODO(burdon): Reconcile with object tags.
+  const contextProvider = useReferencesProvider(space);
+  const extensions = useMemo<Extension[]>(() => {
+    return [
+      contextProvider && references({ provider: contextProvider }),
+      expandable &&
+        Prec.highest(
+          keymap.of([
+            {
+              key: 'cmd-d',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'toggle-debug' });
+                return true;
+              },
+            },
+            {
+              key: 'cmd-ArrowUp',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'thread-open' });
+                return true;
+              },
+            },
+            {
+              key: 'cmd-ArrowDown',
+              preventDefault: true,
+              run: () => {
+                event.emit({ type: 'thread-close' });
+                return true;
+              },
+            },
+          ]),
+        ),
+    ].filter(isNotFalsy);
+  }, [event, expandable, contextProvider]);
+
+  const handleSubmit = useCallback<NonNullable<ChatEditorProps['onSubmit']>>(
+    (text) => {
+      if (!processor.streaming.value) {
+        event.emit({ type: 'submit', text });
+        return true;
+      }
+    },
+    [processor, event],
+  );
+
+  const handleEvent = useCallback<NonNullable<ChatActionsProps['onEvent']>>(
+    (ev) => {
+      event.emit(ev);
+    },
+    [event],
+  );
+
+  // TODO(burdon): Update context.
+  const handleUpdateReferences = useCallback<NonNullable<ChatReferencesProps['onUpdate']>>((ids) => {
+    log.info('update', { ids });
+  }, []);
+
+  return (
+    <div
+      className={mx(
+        'is-full grid grid-cols-[var(--rail-action)_1fr_var(--rail-action)] grid-rows-[min-content_min-content_min-content]',
+        classNames,
+      )}
+    >
+      <Endcap>
+        <ChatStatusIndicator preset={preset} error={processor.error.value} processing={processor.streaming.value} />
+      </Endcap>
+
+      <ChatEditor
+        ref={editorRef}
+        autoFocus
+        lineWrapping
+        classNames='col-span-2 pis-1 pbs-2'
+        placeholder={placeholder ?? t('prompt placeholder')}
+        extensions={extensions}
+        onSubmit={handleSubmit}
+      />
+
+      <div />
+      <ChatReferences
+        classNames='col-span-2 flex pis-1 items-center'
+        space={space}
+        context={processor.context}
+        onUpdate={handleUpdateReferences}
+      />
+
+      <ChatOptionsMenu
+        blueprintRegistry={processor.blueprintRegistry}
+        blueprints={blueprints}
+        onChange={handleUpdateBlueprints}
+      />
+      <ChatActions
+        classNames='col-span-2'
+        microphone={true}
+        recording={recording}
+        processing={processor.streaming.value}
+        onEvent={handleEvent}
+      >
+        <>
+          <div className='grow' />
+          {presets && <ChatPresets preset={preset} presets={presets} onChange={onChangePreset} />}
+          {online !== undefined && (
+            <Input.Root>
+              <Input.Switch classNames='mis-2 mie-2' checked={online} onCheckedChange={onChangeOnline} />
+            </Input.Root>
+          )}
+        </>
+      </ChatActions>
+    </div>
+  );
+};
+
+ChatPrompt.displayName = 'Chat.Prompt';
+
+//
+// Chat
+//
+
+export const Chat = {
+  Root: ChatRoot,
+  Thread: ChatThread,
+  Prompt: ChatPrompt,
+};
+
+export type { ChatRootProps, ChatThreadProps, ChatPromptProps, ChatEvent };

package/src/components/Chat/events.ts

@@ -0,0 +1,50 @@
+//
+// 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: 'cancel';
+    }
+  | {
+      type: 'delete';
+      id: string;
+    }
+  | {
+      type: 'add';
+      object: Obj.Any;
+    }
+  //
+  // UX
+  //
+  | {
+      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/ChatContainer.tsx

@@ -2,36 +2,42 @@
 // 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 { type AssociatedArtifact } from '@dxos/blueprints';
+import { getSpace } from '@dxos/client/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 { Chat } from './Chat';
+import { useChatProcessor, useChatServices } from '../hooks';
+import { meta } from '../meta';
+import { type Assistant } from '../types';
 
 export type ChatContainerProps = {
   role: string;
-  chat: AIChatType;
-  associatedArtifact?: AssociatedArtifact;
+  chat: Assistant.Chat;
+  artifact?: AssociatedArtifact;
 };
 
-// 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 = ({ role, chat, artifact }: ChatContainerProps) => {
+  const space = getSpace(chat);
+  const settings = useCapability(Capabilities.SettingsStore).getStore<Assistant.Settings>(meta.id)?.value;
+  const services = useChatServices({ space });
+  const processor = useChatProcessor({ chat, services, settings });
+  if (!processor) {
+    return null;
+  }
 
+  // TODO(burdon): Add attention attributes.
   return (
-    <StackItem.Content role={role} classNames='container-max-width'>
-      <ThreadContainer
-        chat={chat}
-        settings={settings}
-        transcription={transcription}
-        associatedArtifact={associatedArtifact}
-      />
+    <StackItem.Content classNames='container-max-width'>
+      <Chat.Root chat={chat} processor={processor} artifact={artifact}>
+        <Chat.Thread />
+        <div className='pbe-4 pis-2 pie-2'>
+          <Chat.Prompt classNames='border border-subduedSeparator rounded-md' />
+        </div>
+      </Chat.Root>
     </StackItem.Content>
   );
 };

package/src/components/ChatDialog.tsx

@@ -0,0 +1,64 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback, useState } from 'react';
+
+import { useCapability, Capabilities } from '@dxos/app-framework';
+import { getSpace } from '@dxos/client/echo';
+import { useTranslation } from '@dxos/react-ui';
+import { ChatDialog as NativeChatDialog } from '@dxos/react-ui-chat';
+
+import { Chat, type ChatRootProps } from './Chat';
+import { useChatProcessor, useChatServices } from '../hooks';
+import { meta } from '../meta';
+import { type Assistant } from '../types';
+
+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 });
+  const processor = useChatProcessor({ chat, services, 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}>
+      <NativeChatDialog.Root open={open} expanded={expanded} onOpenChange={setOpen}>
+        <NativeChatDialog.Header title={t('assistant dialog title')} />
+        <NativeChatDialog.Content>
+          <Chat.Thread />
+        </NativeChatDialog.Content>
+        <NativeChatDialog.Footer>
+          <Chat.Prompt expandable />
+        </NativeChatDialog.Footer>
+      </NativeChatDialog.Root>
+    </Chat.Root>
+  );
+};
+
+export default ChatDialog;

package/src/components/ChatPrompt/ChatActions.tsx

@@ -0,0 +1,71 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { type PropsWithChildren } from 'react';
+
+import { IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+import { meta } from '../../meta';
+import { type ChatEvent } from '../Chat';
+
+export type ChatActionsProps = ThemedClassName<
+  PropsWithChildren<{
+    microphone?: boolean;
+    recording?: boolean;
+    processing?: boolean;
+    onEvent?: (event: ChatEvent) => void;
+  }>
+>;
+
+export const ChatActions = ({ classNames, children, microphone, recording, processing, onEvent }: ChatActionsProps) => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <div className={mx('flex items-center mie-1', classNames)}>
+      {children}
+
+      {(processing && (
+        <IconButton
+          disabled={!processing}
+          classNames='px-1.5'
+          variant='ghost'
+          size={5}
+          icon='ph--x--regular'
+          iconOnly
+          label={t('button cancel processing')}
+          onClick={() => onEvent?.({ type: 'cancel' })}
+        />
+      )) || (
+        <IconButton
+          disabled
+          classNames='px-1.5'
+          variant='ghost'
+          size={5}
+          icon='ph--arrow-down--regular'
+          iconOnly
+          label={t('button scroll down')}
+          onClick={() => onEvent?.({ type: 'scroll-to-bottom' })}
+        />
+      )}
+
+      {microphone && (
+        <IconButton
+          disabled={!processing}
+          classNames={mx('px-1.5', recording && 'bg-primary-500')}
+          variant='ghost'
+          size={5}
+          icon='ph--microphone--regular'
+          iconOnly
+          noTooltip
+          label={t('button microphone')}
+          onMouseDown={() => onEvent?.({ type: 'record-start' })}
+          onMouseUp={() => onEvent?.({ type: 'record-stop' })}
+          onTouchStart={() => onEvent?.({ type: 'record-start' })}
+          onTouchEnd={() => onEvent?.({ type: 'record-stop' })}
+        />
+      )}
+    </div>
+  );
+};

package/src/components/ChatPrompt/ChatOptionsMenu.tsx

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { type Blueprint } from '@dxos/blueprints';
+import { DropdownMenu, IconButton, Input, useTranslation } from '@dxos/react-ui';
+
+import { meta } from '../../meta';
+
+export type ChatOptionsMenuProps = {
+  blueprintRegistry?: Blueprint.Registry;
+  blueprints?: Blueprint.Blueprint[];
+  onChange?: (key: string, active: boolean) => void;
+};
+
+export const ChatOptionsMenu = ({ blueprintRegistry, blueprints, onChange }: ChatOptionsMenuProps) => {
+  const { t } = useTranslation(meta.id);
+  const blueprintOptions = useMemo(
+    () => blueprintRegistry?.query().map((blueprint) => ({ key: blueprint.key, label: blueprint.name })),
+    [blueprintRegistry],
+  );
+
+  return (
+    <DropdownMenu.Root>
+      <DropdownMenu.Trigger asChild disabled={!blueprintOptions?.length}>
+        <IconButton icon='ph--plus--regular' variant='ghost' size={5} iconOnly label={t('button add blueprint')} />
+      </DropdownMenu.Trigger>
+      <DropdownMenu.Portal>
+        <DropdownMenu.Content side='left'>
+          <DropdownMenu.Viewport>
+            {blueprintOptions?.map((option) => (
+              <DropdownMenu.Item key={option.key}>
+                <Input.Root>
+                  <Input.Checkbox
+                    checked={!!blueprints?.find((blueprint) => blueprint.key === option.key)}
+                    onCheckedChange={(checked) => onChange?.(option.key, !!checked)}
+                  />
+                  {/* TODO(burdon): Remove need for custom margin. */}
+                  {/* TODO(burdon): Clicking on label doesn't toggle checkbox. */}
+                  <Input.Label classNames='m-0'>{option.label}</Input.Label>
+                </Input.Root>
+              </DropdownMenu.Item>
+            ))}
+          </DropdownMenu.Viewport>
+          <DropdownMenu.Arrow />
+        </DropdownMenu.Content>
+      </DropdownMenu.Portal>
+    </DropdownMenu.Root>
+  );
+};