@dxos/plugin-assistant 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/src/components/ChatThread/ChatThread.stories.tsx

@@ -2,142 +2,149 @@
 // Copyright 2025 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type StoryObj, type Meta } from '@storybook/react-vite';
-import React, { useEffect, useState } from 'react';
-
-import { Obj } from '@dxos/echo';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as Layer from 'effect/Layer';
+import React, { type CSSProperties, useEffect, useMemo, useState } from 'react';
+
+import { Database } from '@dxos/echo';
+import { runAndForwardErrors } from '@dxos/effect';
+import { ContextQueueService } from '@dxos/functions';
 import { faker } from '@dxos/random';
+import { useQueue, useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
-import { DataType, type ContentBlock } from '@dxos/schema';
-import { ColumnContainer, withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { ChatThread } from './ChatThread';
+import { Popover } from '@dxos/react-ui';
+import { Card } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { MarkdownStream } from '@dxos/react-ui-components';
+import { EditorPreviewProvider, useEditorPreview } from '@dxos/react-ui-editor';
+import { render } from '@dxos/storybook-utils';
+import { type Message, Organization, Person } from '@dxos/types';
+
+import { createMessageGenerator } from '../../testing';
 import { translations } from '../../translations';
 
+import { ChatThread, type ChatThreadProps } from './ChatThread';
+import { componentRegistry } from './registry';
+import TEXT from './testing/thread.md?raw';
+
 faker.seed(1);
 
-const createMessage = (role: DataType.ActorRole, blocks: ContentBlock.Any[]): DataType.Message => {
-  return Obj.make(DataType.Message, {
-    created: new Date().toISOString(),
-    sender: { role },
-    blocks,
-  });
+type MessageGenerator = Effect.Effect<void, never, Database.Service | ContextQueueService>;
+
+type StoryProps = { generator?: MessageGenerator[]; delay?: number; wait?: boolean } & ChatThreadProps;
+
+const DefaultStory = ({ generator = [], delay = 0, wait, ...props }: StoryProps) => {
+  const space = useSpace();
+  const queueDxn = useMemo(() => space?.queues.create().dxn, [space]);
+  const queue = useQueue<Message.Message>(queueDxn);
+  const [done, setDone] = useState(false);
+
+  // Generate messages.
+  useEffect(() => {
+    if (!space || !queue) {
+      return;
+    }
+
+    const fiber = Effect.runFork(
+      Effect.gen(function* () {
+        for (const step of generator) {
+          yield* step;
+          if (delay) {
+            yield* Effect.sleep(delay);
+          }
+        }
+        setDone(true);
+      }).pipe(Effect.provide(Layer.mergeAll(Database.layer(space.db), ContextQueueService.layer(queue)))),
+    );
+
+    return () => {
+      void runAndForwardErrors(Fiber.interrupt(fiber));
+    };
+  }, [space, queue, generator]);
+
+  if (wait && !done) {
+    return null;
+  }
+
+  return (
+    <EditorPreviewProvider onLookup={async ({ dxn, label }) => ({ label, text: dxn })}>
+      <ChatThread {...props} messages={queue?.objects} />
+      <PreviewCard />
+    </EditorPreviewProvider>
+  );
 };
 
-const TEST_MESSAGES: DataType.Message[] = [
-  createMessage('user', [
-    {
-      _tag: 'text',
-      text: faker.lorem.sentence(5),
-    } satisfies ContentBlock.Text,
-  ]),
-
-  createMessage('assistant', [
-    {
-      _tag: 'text',
-      disposition: 'cot',
-      text: Array.from({ length: faker.number.int({ min: 3, max: 5 }) })
-        .map((_, idx) => `${idx + 1}. ${faker.lorem.paragraph()}`)
-        .join('\n'),
-    },
-    {
-      _tag: 'text',
-      text: Array.from({ length: faker.number.int({ min: 2, max: 5 }) })
-        .map(() => faker.lorem.paragraphs())
-        .join('\n\n'),
-    },
-    {
-      _tag: 'toolCall',
-      toolCallId: '1234',
-      name: 'search',
-      input: {},
-    } satisfies ContentBlock.ToolCall,
-  ]),
-
-  createMessage('user', [
-    {
-      _tag: 'toolResult',
-      toolCallId: '1234',
-      name: 'search',
-      result: 'This is a tool result.',
-    } satisfies ContentBlock.ToolResult,
-  ]),
-
-  createMessage('assistant', [
-    {
-      _tag: 'toolCall',
-      toolCallId: '4567',
-      name: 'create',
-      input: {},
-    } satisfies ContentBlock.ToolCall,
-  ]),
-
-  createMessage('user', [
-    {
-      _tag: 'toolResult',
-      toolCallId: '4567',
-      name: 'create',
-      result: 'This is a tool result.',
-    } satisfies ContentBlock.ToolResult,
-  ]),
-
-  createMessage('assistant', [
-    {
-      _tag: 'text',
-      text: faker.lorem.paragraphs(1),
-    } satisfies ContentBlock.Text,
-  ]),
-
-  createMessage('assistant', [
-    {
-      _tag: 'json',
-      disposition: 'suggest',
-      data: JSON.stringify({ text: 'Search...' }),
-    },
-    {
-      _tag: 'json',
-      disposition: 'suggest',
-      data: JSON.stringify({ text: faker.lorem.paragraphs(1) }),
-    } satisfies ContentBlock.Json,
-  ]),
-];
+const PreviewCard = () => {
+  const { target } = useEditorPreview('PreviewCard');
+
+  return (
+    <Popover.Portal>
+      <Popover.Content onOpenAutoFocus={(event) => event.preventDefault()}>
+        <Popover.Viewport>
+          <Card.Root>
+            <Card.Heading>{target?.label}</Card.Heading>
+            {target && <Card.Text classNames='truncate line-clamp-3'>{target.text}</Card.Text>}
+          </Card.Root>
+        </Popover.Viewport>
+        <Popover.Arrow />
+      </Popover.Content>
+    </Popover.Portal>
+  );
+};
 
 const meta = {
-  title: 'plugins/plugin-assistant/ChatThread',
+  title: 'plugins/plugin-assistant/components/ChatThread',
   component: ChatThread,
-  decorators: [withClientProvider({ createIdentity: true }), withTheme, withLayout({ Container: ColumnContainer })],
+  render: render(DefaultStory),
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withClientProvider({
+      createIdentity: true,
+      createSpace: true,
+      types: [Organization.Organization, Person.Person],
+    }),
+  ],
   parameters: {
+    layout: 'fullscreen',
     translations,
   },
-} satisfies Meta<typeof ChatThread>;
+} satisfies Meta<StoryProps>;
 
 export default meta;
 
-type Story = StoryObj<typeof meta>;
+type Story = StoryObj<StoryProps>;
 
-export const Default = {
+export const Default: Story = {
   args: {
-    messages: TEST_MESSAGES,
+    generator: createMessageGenerator(),
+    wait: true,
   },
-} satisfies Story;
-
-export const Incremental = {
-  render: () => {
-    const [messages, setMessages] = useState<DataType.Message[]>([]);
-    useEffect(() => {
-      let i = 0;
-      const interval = setInterval(() => {
-        setMessages((messages) => [...messages, TEST_MESSAGES[i++]]);
-        if (i >= TEST_MESSAGES.length) {
-          clearInterval(interval);
-        }
-      }, 2_000);
-
-      return () => clearInterval(interval);
-    }, []);
+};
 
-    return <ChatThread messages={messages} collapse />;
+export const Delayed: Story = {
+  args: {
+    generator: createMessageGenerator(),
+    delay: 1_000,
+    fadeIn: true,
+    cursor: false,
   },
-} satisfies Story;
+};
+
+export const Raw: Story = {
+  render: () => (
+    <div className='contents' style={{ '--user-fill': 'var(--color-amber-fill)' } as CSSProperties}>
+      <MarkdownStream content={TEXT} />
+    </div>
+  ),
+};
+
+export const Static: Story = {
+  render: () => (
+    <div className='contents' style={{ '--user-fill': 'var(--color-amber-fill)' } as CSSProperties}>
+      <MarkdownStream content={TEXT} registry={componentRegistry} />
+    </div>
+  ),
+};

package/src/components/ChatThread/ChatThread.tsx

@@ -2,56 +2,95 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { type CSSProperties, forwardRef, useMemo } from 'react';
+import React, { type CSSProperties, forwardRef, useCallback, useEffect, useMemo, useState } from 'react';
 
 import { PublicKey } from '@dxos/keys';
 import { type Identity } from '@dxos/react-client/halo';
-import { type ThemedClassName } from '@dxos/react-ui';
-import { ScrollContainer, type ScrollController } from '@dxos/react-ui-components';
-import { mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
+import { type ThemedClassName, useForwardedRef } from '@dxos/react-ui';
+import { MarkdownStream, type MarkdownStreamController, type MarkdownStreamProps } from '@dxos/react-ui-components';
+import { type Message } from '@dxos/types';
+import { mx } from '@dxos/ui-theme';
 import { keyToFallback } from '@dxos/util';
 
-import { ChatMessage, type ChatMessageProps } from './ChatMessage';
-import { messageReducer } from './reducer';
+import { type ChatEvent } from '../Chat';
+
+import { blockToMarkdown, componentRegistry } from './registry';
+import { MessageSyncer } from './sync';
 
 export type ChatThreadProps = ThemedClassName<
   {
     identity?: Identity;
-    messages?: DataType.Message[];
-    collapse?: boolean;
-  } & Pick<ChatMessageProps, 'debug' | 'space' | 'processor' | 'tools' | 'onEvent'>
+    messages?: Message.Message[];
+    error?: Error;
+    onEvent?: (event: ChatEvent) => void;
+  } & Pick<MarkdownStreamProps, 'cursor' | 'fadeIn' | 'debug'>
 >;
 
-export const ChatThread = forwardRef<ScrollController, ChatThreadProps>(
-  ({ classNames, identity, messages, collapse = true, ...props }, forwardedRef) => {
-    const userHue = useMemo(() => {
-      return identity?.profile?.data?.hue || keyToFallback(identity?.identityKey ?? PublicKey.random()).hue;
-    }, [identity]);
-
-    // TODO(dmaretskyi): This needs to be a separate type: `id` is not a valid ObjectId, this needs to accommodate messageId for deletion.
-    const { messages: filteredMessages = [] } = useMemo(() => {
-      if (collapse) {
-        return (messages ?? []).reduce<{ messages: DataType.Message[]; current?: DataType.Message }>(messageReducer, {
-          messages: [],
-        });
-      } else {
-        return { messages: messages ?? [] };
+// TODO(burdon): Memo thread position.
+export const ChatThread = forwardRef<MarkdownStreamController | null, ChatThreadProps>(
+  (
+    { classNames, identity, messages = [], error, cursor = false, fadeIn = true, debug = false, onEvent },
+    forwardedRef,
+  ) => {
+    const controllerRef = useForwardedRef(forwardedRef);
+    const [controller, setController] = useState<MarkdownStreamController | null>(null);
+
+    // Callback ref to capture when MarkdownStream is mounted and trigger re-render.
+    const refCallback = useCallback(
+      (node: MarkdownStreamController | null) => {
+        controllerRef.current = node;
+        setController(node);
+      },
+      [controllerRef],
+    );
+
+    const userHue = useMemo(
+      () => identity?.profile?.data?.hue || keyToFallback(identity?.identityKey ?? PublicKey.random()).hue,
+      [identity],
+    );
+
+    // Show error.
+    useEffect(() => {
+      controller?.scrollToBottom();
+    }, [controller, error]);
+
+    // Update document.
+    const syncer = useMemo(() => controller && new MessageSyncer(controller, blockToMarkdown), [controller]);
+    useEffect(() => {
+      const reset = syncer?.append(messages, true);
+      if (reset) {
+        controller?.scrollToBottom('instant');
       }
-    }, [messages, collapse]);
+    }, [syncer, messages]);
+
+    // Event adapter.
+    const handleEvent = useCallback<NonNullable<MarkdownStreamProps['onEvent']>>(
+      ({ type, value }) => {
+        switch (type) {
+          case 'submit': {
+            value && onEvent?.({ type, text: value });
+            break;
+          }
+        }
+      },
+      [onEvent],
+    );
 
     return (
-      <ScrollContainer ref={forwardedRef} classNames={classNames} fade>
-        <div
-          role='none'
-          className={mx(filteredMessages.length > 0 && 'pbs-4 pbe-4')}
-          style={{ '--user-fill': `var(--dx-${userHue}Fill)` } as CSSProperties}
-        >
-          {filteredMessages.map((message) => (
-            <ChatMessage key={message.id} message={message} {...props} />
-          ))}
-        </div>
-      </ScrollContainer>
+      <div
+        role='none'
+        className={mx('flex h-full w-full justify-center overflow-hidden', classNames)}
+        style={{ '--user-fill': `var(--color-${userHue}-fill)` } as CSSProperties}
+      >
+        <MarkdownStream
+          ref={refCallback}
+          registry={componentRegistry}
+          cursor={cursor}
+          fadeIn={fadeIn}
+          debug={debug}
+          onEvent={handleEvent}
+        />
+      </div>
     );
   },
 );

package/src/components/ChatThread/Link.tsx

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { type Space } from '@dxos/client/echo';
+import { Entity } from '@dxos/echo';
+import { type DXN } from '@dxos/keys';
+import { DxAnchor } from '@dxos/lit-ui/react';
+
+export type ObjectLinkProps = {
+  space: Space;
+  dxn: DXN;
+};
+
+export const ObjectLink = ({ space, dxn }: ObjectLinkProps) => {
+  const ref = useMemo(() => space.db.makeRef(dxn), [space, dxn.toString()]);
+
+  const title = (ref.target && Entity.getLabel(ref.target)) ?? ref.target?.id ?? ref.dxn.toString();
+  return (
+    <DxAnchor rootclassname='dx-tag--anchor' dxn={dxn.toString()}>
+      {title}
+    </DxAnchor>
+  );
+};

package/src/components/ChatThread/registry.tsx

@@ -0,0 +1,207 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { log } from '@dxos/log';
+import { ToggleContainer } from '@dxos/react-ui-components';
+import {
+  PromptWidget,
+  ReasoningWidget,
+  ReferenceWidget,
+  SelectWidget,
+  SuggestionWidget,
+  SummaryWidget,
+} from '@dxos/react-ui-components';
+import { Json } from '@dxos/react-ui-syntax-highlighter';
+import { ContentBlock, type Message } from '@dxos/types';
+import { type XmlWidgetProps, type XmlWidgetRegistry, getXmlTextChild } from '@dxos/ui-editor';
+
+import { ToolBlock } from '../ToolBlock';
+
+import { type BlockRenderer, type MessageThreadContext } from './sync';
+
+const Fallback = ({ _tag, ...props }: XmlWidgetProps<MessageThreadContext>) => {
+  return (
+    <ToggleContainer.Root classNames='rounded-xs'>
+      <ToggleContainer.Header classNames='bg-group-surface'>{_tag}</ToggleContainer.Header>
+      <ToggleContainer.Content classNames='bg-modal-surface'>
+        <Json classNames='p-2! text-sm' data={props} />
+      </ToggleContainer.Content>
+    </ToggleContainer.Root>
+  );
+};
+
+const Summary = ({ text }: { text: string }) => {
+  return (
+    <ToggleContainer.Root classNames='rounded-sm'>
+      <ToggleContainer.Header classNames='bg-group-surface'>Conversation summarized</ToggleContainer.Header>
+      <ToggleContainer.Content classNames='bg-modal-surface'>{text}</ToggleContainer.Content>
+    </ToggleContainer.Root>
+  );
+};
+
+/**
+ * Custom XML tags registry.
+ */
+export const componentRegistry: XmlWidgetRegistry = {
+  //
+  // Widgets
+  //
+
+  prompt: {
+    block: true,
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
+      return text ? new PromptWidget(text) : null;
+    },
+  },
+  reasoning: {
+    block: true,
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
+      return text ? new ReasoningWidget(text) : null;
+    },
+  },
+  reference: {
+    block: false,
+    factory: ({ children, ref }) => {
+      const text = getXmlTextChild(children);
+      return text && ref ? new ReferenceWidget(text, ref) : null;
+    },
+  },
+  select: {
+    block: true,
+    factory: ({ children }) => {
+      const options = children
+        ?.map((option: any) => option._tag === 'option' && getXmlTextChild(option.children))
+        .filter(Boolean);
+      return options?.length ? new SelectWidget(options) : null;
+    },
+  },
+  suggestion: {
+    block: true,
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
+      return text ? new SuggestionWidget(text) : null;
+    },
+  },
+  stats: {
+    block: true,
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
+      return text ? new SummaryWidget(text) : null;
+    },
+  },
+
+  //
+  // React
+  //
+
+  toolCall: {
+    block: true,
+    Component: ToolBlock,
+  },
+  toolResult: {
+    block: true,
+    Component: Fallback,
+  },
+  toolkit: {
+    block: true,
+    Component: Fallback,
+  },
+  summary: {
+    block: true,
+    Component: Summary,
+  },
+
+  //
+  // Fallback
+  //
+
+  json: {
+    block: true,
+    Component: Fallback,
+  },
+};
+
+/**
+ * Convert block to markdown.
+ */
+export const blockToMarkdown: BlockRenderer = (
+  context: MessageThreadContext,
+  message: Message.Message,
+  block: ContentBlock.Any,
+) => {
+  let str = blockToMarkdownImpl(context, message, block);
+  if (str && !block.pending) {
+    return (str += '\n');
+  }
+
+  return str;
+};
+
+const blockToMarkdownImpl = (context: MessageThreadContext, message: Message.Message, block: ContentBlock.Any) => {
+  log('blockToMarkdown', { block: JSON.stringify(block) });
+  switch (block._tag) {
+    case 'text': {
+      if (message.sender.role === 'user') {
+        return `<prompt>${block.text}</prompt>`;
+      } else {
+        const text = block.text.trim();
+        if (text.length > 0) {
+          return text;
+        }
+      }
+      break;
+    }
+    case 'reference': {
+      const dxn = block.reference.dxn;
+      return `<reference ref="${dxn.toString()}">${context.getObjectLabel(dxn)}</reference>`;
+    }
+    case 'suggestion': {
+      if (block.pending) {
+        return;
+      }
+      return `<suggestion>${block.text}</suggestion>`;
+    }
+    case 'select': {
+      if (block.pending || block.options.length === 0) {
+        return;
+      }
+      return `<select>${block.options.map((option) => `<option>${option}</option>`).join('')}</select>`;
+    }
+    case 'toolCall': {
+      context.updateWidget<{ blocks: ContentBlock.Any[] }>(block.toolCallId, {
+        blocks: [block],
+      });
+      return `<toolCall id="${block.toolCallId}" />`;
+    }
+    case 'toolResult': {
+      // TODO(dmaretskyi): the parameter could be undefined, perhaps tool blocks are not arriving in order.
+      context.updateWidget<{ blocks: ContentBlock.Any[] }>(block.toolCallId, ({ blocks = [] } = { blocks: [] }) => ({
+        blocks: [...blocks, block],
+      }));
+      break;
+    }
+    case 'stats': {
+      return `<stats>${ContentBlock.createStatsMessage(block)}</stats>`;
+    }
+    case 'reasoning': {
+      const text = block.reasoningText ?? block.redactedText;
+      if (!text) {
+        return;
+      }
+      // TODO(dmaretskyi): The mixed Markdown/XML parser does not support parsing multi-line XML tags.
+      return `<reasoning>${text.replace(/\n/g, ' ').trim()}</reasoning>`;
+    }
+    case 'summary': {
+      return `<summary>${block.content}</summary>`;
+    }
+    default: {
+      // TODO(burdon): Needs stable ID.
+      return `<json id="${message.id}">\n${JSON.stringify(block)}\n</json>`;
+    }
+  }
+};