@dxos/plugin-assistant 0.8.4-main.dedc0f3 → 0.8.4-main.e8ec1fe

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

@@ -2,37 +2,42 @@
 // Copyright 2025 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import { Effect, Fiber, Layer } from 'effect';
-import React, { useEffect, useMemo, useState } from 'react';
+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 { ContextQueueService, DatabaseService } from '@dxos/functions';
 import { faker } from '@dxos/random';
 import { useQueue, useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { Popover } from '@dxos/react-ui';
-import { PreviewProvider, useRefPopover } from '@dxos/react-ui-editor';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { MarkdownStream } from '@dxos/react-ui-components';
+import { EditorPreviewProvider, useEditorPreview } from '@dxos/react-ui-editor';
 import { Card } from '@dxos/react-ui-stack';
-import { DataType } from '@dxos/schema';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+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 ChatThreadController, type ChatThreadProps } from './ChatThread';
+import { ChatThread, type ChatThreadProps } from './ChatThread';
+import { componentRegistry } from './registry';
+import TEXT from './testing/thread.md?raw';
 
 faker.seed(1);
 
 type MessageGenerator = Effect.Effect<void, never, DatabaseService | ContextQueueService>;
 
-type StoryProps = ChatThreadProps & { generator?: MessageGenerator[]; delay?: number };
+type StoryProps = { generator?: MessageGenerator[]; delay?: number; wait?: boolean } & ChatThreadProps;
 
-const DefaultStory = ({ generator = [], delay = 0, ...props }: StoryProps) => {
+const DefaultStory = ({ generator = [], delay = 0, wait, ...props }: StoryProps) => {
   const space = useSpace();
   const queueDxn = useMemo(() => space?.queues.create().dxn, [space]);
-  const queue = useQueue<DataType.Message>(queueDxn);
+  const queue = useQueue<Message.Message>(queueDxn);
+  const [done, setDone] = useState(false);
 
   // Generate messages.
   useEffect(() => {
@@ -48,6 +53,7 @@ const DefaultStory = ({ generator = [], delay = 0, ...props }: StoryProps) => {
             yield* Effect.sleep(delay);
           }
         }
+        setDone(true);
       }).pipe(Effect.provide(Layer.mergeAll(DatabaseService.layer(space.db), ContextQueueService.layer(queue)))),
     );
 
@@ -56,29 +62,20 @@ const DefaultStory = ({ generator = [], delay = 0, ...props }: StoryProps) => {
     };
   }, [space, queue, generator]);
 
-  // Set context.
-  const [controller, setController] = useState<ChatThreadController | null>(null);
-  useEffect(() => {
-    // controller?.setContext({ timestamp: Date.now() });
-  }, [controller]);
+  if (wait && !done) {
+    return null;
+  }
 
-  // TODO(burdon): Elsewhere PreviewProvider is implemented via the plugin-preview.
   return (
-    <PreviewProvider
-      onLookup={async ({ label, ref }) => {
-        return { label, text: ref };
-      }}
-    >
-      <ChatThread {...props} messages={queue?.objects ?? []} ref={setController} />
+    <EditorPreviewProvider onLookup={async ({ label, ref }) => ({ label, text: ref })}>
+      <ChatThread {...props} messages={queue?.objects} />
       <PreviewCard />
-    </PreviewProvider>
+    </EditorPreviewProvider>
   );
 };
 
-// TODO(burdon): Factor out.
-// TODO(burdon): Provide renderer for preview extension.
 const PreviewCard = () => {
-  const { target } = useRefPopover('PreviewCard');
+  const { target } = useEditorPreview('PreviewCard');
 
   return (
     <Popover.Portal>
@@ -98,33 +95,54 @@ const PreviewCard = () => {
 const meta = {
   title: 'plugins/plugin-assistant/ChatThread',
   component: ChatThread,
-  render: DefaultStory,
+  render: render(DefaultStory),
   decorators: [
-    withClientProvider({ createIdentity: true, createSpace: true, types: [DataType.Organization, DataType.Person] }),
-    withLayout({ fullscreen: true }),
     withTheme,
+    withLayout({ container: 'column' }),
+    withClientProvider({
+      createIdentity: true,
+      createSpace: true,
+      types: [Organization.Organization, Person.Person],
+    }),
   ],
   parameters: {
-    layout: 'fullscreen', // TODO(burdon): Replace withLayout.
+    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: Story = {
   args: {
     generator: createMessageGenerator(),
+    wait: true,
   },
 };
 
 export const Delayed: Story = {
   args: {
     generator: createMessageGenerator(),
-    delay: 3_000,
+    delay: 1_000,
     fadeIn: true,
     cursor: false,
   },
 };
+
+export const Raw: Story = {
+  render: () => (
+    <div className='contents' style={{ '--user-fill': 'var(--dx-amberFill)' } as CSSProperties}>
+      <MarkdownStream content={TEXT} />
+    </div>
+  ),
+};
+
+export const Static: Story = {
+  render: () => (
+    <div className='contents' style={{ '--user-fill': 'var(--dx-amberFill)' } as CSSProperties}>
+      <MarkdownStream content={TEXT} registry={componentRegistry} />
+    </div>
+  ),
+};

package/src/components/ChatThread/ChatThread.tsx

@@ -2,22 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, {
-  type CSSProperties,
-  forwardRef,
-  useCallback,
-  useEffect,
-  useImperativeHandle,
-  useMemo,
-  useState,
-} from 'react';
+import React, { type CSSProperties, forwardRef, useCallback, useEffect, useMemo } from 'react';
 
 import { PublicKey } from '@dxos/keys';
 import { type Identity } from '@dxos/react-client/halo';
-import { type ThemedClassName } from '@dxos/react-ui';
+import { type ThemedClassName, useForwardedRef } from '@dxos/react-ui';
 import { MarkdownStream, type MarkdownStreamController, type MarkdownStreamProps } from '@dxos/react-ui-components';
 import { mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
+import { type Message } from '@dxos/types';
 import { keyToFallback } from '@dxos/util';
 
 import { type ChatEvent } from '../Chat';
@@ -25,26 +17,28 @@ import { type ChatEvent } from '../Chat';
 import { blockToMarkdown, componentRegistry } from './registry';
 import { MessageSyncer } from './sync';
 
-export type ChatThreadController = Pick<MarkdownStreamController, 'setContext' | 'scrollToBottom'>;
-
 export type ChatThreadProps = ThemedClassName<
   {
     identity?: Identity;
-    messages?: DataType.Message[];
+    messages?: Message.Message[];
     error?: Error;
     onEvent?: (event: ChatEvent) => void;
-  } & Pick<MarkdownStreamProps, 'cursor' | 'fadeIn'>
+  } & Pick<MarkdownStreamProps, 'cursor' | 'fadeIn' | 'debug'>
 >;
 
-export const ChatThread = forwardRef<ChatThreadController | null, ChatThreadProps>(
-  ({ classNames, identity, messages = [], error, cursor = false, fadeIn = true, onEvent }, forwardedRef) => {
-    const userHue = useMemo(() => {
-      return identity?.profile?.data?.hue || keyToFallback(identity?.identityKey ?? PublicKey.random()).hue;
-    }, [identity]);
+// TODO(burdon): Memo thread position.
+export const ChatThread = forwardRef<MarkdownStreamController, ChatThreadProps>(
+  (
+    { classNames, identity, messages = [], error, cursor = false, fadeIn = true, debug = false, onEvent },
+    forwardedRef,
+  ) => {
+    const controllerRef = useForwardedRef(forwardedRef);
+    const controller = controllerRef.current;
 
-    // Expose controller.
-    const [controller, setController] = useState<MarkdownStreamController | null>(null);
-    useImperativeHandle(forwardedRef, () => (controller ? controller : (null as any)), [controller]);
+    const userHue = useMemo(
+      () => identity?.profile?.data?.hue || keyToFallback(identity?.identityKey ?? PublicKey.random()).hue,
+      [identity],
+    );
 
     // Show error.
     useEffect(() => {
@@ -54,19 +48,18 @@ export const ChatThread = forwardRef<ChatThreadController | null, ChatThreadProp
     // Update document.
     const syncer = useMemo(() => controller && new MessageSyncer(controller, blockToMarkdown), [controller]);
     useEffect(() => {
-      syncer?.sync(messages);
+      const reset = syncer?.append(messages, true);
+      if (reset) {
+        controller?.scrollToBottom('instant');
+      }
     }, [syncer, messages]);
 
-    // Event handler.
+    // Event adapter.
     const handleEvent = useCallback<NonNullable<MarkdownStreamProps['onEvent']>>(
-      (ev) => {
-        switch (ev.type) {
+      ({ type, value }) => {
+        switch (type) {
           case 'submit': {
-            ev.value &&
-              onEvent?.({
-                type: 'submit',
-                text: ev.value,
-              });
+            value && onEvent?.({ type, text: value });
             break;
           }
         }
@@ -76,15 +69,16 @@ export const ChatThread = forwardRef<ChatThreadController | null, ChatThreadProp
 
     return (
       <div
+        role='none'
         className={mx('flex bs-full is-full justify-center overflow-hidden', classNames)}
         style={{ '--user-fill': `var(--dx-${userHue}Fill)` } as CSSProperties}
       >
         <MarkdownStream
-          ref={setController}
-          classNames='bs-full max-is-prose overflow-hidden'
+          ref={controllerRef}
           registry={componentRegistry}
           cursor={cursor}
           fadeIn={fadeIn}
+          debug={debug}
           onEvent={handleEvent}
         />
       </div>

package/src/components/ChatThread/reducers.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type ContentBlock, type DataType } from '@dxos/schema';
+import { type ContentBlock, type Message } from '@dxos/types';
 
 type Reducer<R, I> = (acc: R, value: I, idx: number) => R;
 
@@ -38,12 +38,12 @@ type Reducer<R, I> = (acc: R, value: I, idx: number) => R;
  */
 export const reduceMessages: Reducer<
   {
-    messages: DataType.Message[];
-    current?: DataType.Message;
+    messages: Message.Message[];
+    current?: Message.Message;
     toolBlock?: boolean;
-    assistantMessages?: DataType.Message[];
+    assistantMessages?: Message.Message[];
   },
-  DataType.Message
+  Message.Message
 > = ({ messages, current, toolBlock, assistantMessages = [] }, message) => {
   // Treat tool calls as assistant messages.
   let assistant = message?.sender.role === 'assistant';
@@ -111,7 +111,7 @@ export const reduceMessages: Reducer<
 /**
  * Accumulate token counts from all summary blocks in pending messages.
  */
-const reduceSummary = (messages: DataType.Message[]): ContentBlock.Summary => {
+const reduceSummary = (messages: Message.Message[]): ContentBlock.Summary => {
   let start: number | undefined;
   return messages.reduce<ContentBlock.Summary>(
     (acc, msg) => {

package/src/components/ChatThread/registry.tsx

@@ -13,9 +13,9 @@ import {
   SummaryWidget,
   ToggleContainer,
 } from '@dxos/react-ui-components';
-import { type XmlWidgetProps, type XmlWidgetRegistry } from '@dxos/react-ui-editor';
+import { type XmlWidgetProps, type XmlWidgetRegistry, getXmlTextChild } from '@dxos/react-ui-editor';
 import { Json } from '@dxos/react-ui-syntax-highlighter';
-import { ContentBlock, type DataType } from '@dxos/schema';
+import { ContentBlock, type Message } from '@dxos/types';
 
 import { ToolBlock } from '../ToolBlock';
 
@@ -32,11 +32,6 @@ const Fallback = ({ _tag, ...props }: XmlWidgetProps<MessageThreadContext>) => {
   );
 };
 
-const getTextChild = (children: any[]): string | null => {
-  const child = children?.[0];
-  return typeof child === 'string' ? child : null;
-};
-
 /**
  * Custom XML tags registry.
  */
@@ -47,38 +42,38 @@ export const componentRegistry: XmlWidgetRegistry = {
 
   ['prompt' as const]: {
     block: true,
-    factory: (props) => {
-      const text = getTextChild(props.children);
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
       return text ? new PromptWidget(text) : null;
     },
   },
   ['reference' as const]: {
     block: false,
-    factory: (props) => {
-      const text = getTextChild(props.children);
-      return text && props.ref ? new ReferenceWidget(text, props.ref) : null;
+    factory: ({ children, ref }) => {
+      const text = getXmlTextChild(children);
+      return text && ref ? new ReferenceWidget(text, ref) : null;
     },
   },
   ['select' as const]: {
     block: true,
-    factory: (props) => {
-      const options = props.children
-        ?.map((option: any) => option._tag === 'option' && getTextChild(option.children))
+    factory: ({ children }) => {
+      const options = children
+        ?.map((option: any) => option._tag === 'option' && getXmlTextChild(option.children))
         .filter(Boolean);
       return options?.length ? new SelectWidget(options) : null;
     },
   },
   ['suggestion' as const]: {
     block: true,
-    factory: (props) => {
-      const text = getTextChild(props.children);
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
       return text ? new SuggestionWidget(text) : null;
     },
   },
   ['summary' as const]: {
     block: true,
-    factory: (props) => {
-      const text = getTextChild(props.children);
+    factory: ({ children }) => {
+      const text = getXmlTextChild(children);
       return text ? new SummaryWidget(text) : null;
     },
   },
@@ -115,10 +110,10 @@ export const componentRegistry: XmlWidgetRegistry = {
  */
 export const blockToMarkdown: BlockRenderer = (
   context: MessageThreadContext,
-  message: DataType.Message,
+  message: Message.Message,
   block: ContentBlock.Any,
 ) => {
-  let str = _blockToMarkdown(context, message, block);
+  let str = blockToMarkdownImpl(context, message, block);
   if (str && !block.pending) {
     return (str += '\n');
   }
@@ -126,12 +121,12 @@ export const blockToMarkdown: BlockRenderer = (
   return str;
 };
 
-const _blockToMarkdown = (context: MessageThreadContext, message: DataType.Message, block: ContentBlock.Any) => {
+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 `\n<prompt>${block.text}</prompt>\n`;
+        return `<prompt>${block.text}</prompt>`;
       } else {
         const text = block.text.trim();
         if (text.length > 0) {
@@ -140,7 +135,10 @@ const _blockToMarkdown = (context: MessageThreadContext, message: DataType.Messa
       }
       break;
     }
-
+    case 'reference': {
+      const dxn = block.reference.dxn;
+      return `<reference ref="${dxn.toString()}">${context.getObjectLabel(dxn)}</reference>`;
+    }
     case 'suggestion': {
       if (block.pending) {
         return;
@@ -151,38 +149,25 @@ const _blockToMarkdown = (context: MessageThreadContext, message: DataType.Messa
       if (block.pending || block.options.length === 0) {
         return;
       }
-
       return `<select>${block.options.map((option) => `<option>${option}</option>`).join('')}</select>`;
     }
-
-    // TODO(burdon): Need label.
-    case 'reference': {
-      return `<reference ref="${block.reference.dxn.toString()}">Ref</reference>`;
-    }
-
-    // case 'toolkit': {
-    //   return `<toolkit />`;
-    // }
-
     case 'toolCall': {
-      context.updateWidget(block.toolCallId, {
+      context.updateWidget<{ blocks: ContentBlock.Any[] }>(block.toolCallId, {
         blocks: [block],
       });
       return `<toolCall id="${block.toolCallId}" />`;
     }
     case 'toolResult': {
-      context.updateWidget(block.toolCallId, ({ blocks = [] }: { blocks: ContentBlock.Any[] }) => ({
+      context.updateWidget<{ blocks: ContentBlock.Any[] }>(block.toolCallId, ({ blocks = [] }) => ({
         blocks: [...blocks, block],
       }));
       break;
     }
-
     case 'summary': {
       return `<summary>${ContentBlock.createSummaryMessage(block)}</summary>`;
     }
-
-    // TODO(burdon): Need stable ID.
     default: {
+      // TODO(burdon): Needs stable ID.
       return `<json id="${message.id}">\n${JSON.stringify(block)}\n</json>`;
     }
   }

package/src/components/ChatThread/sync.test.ts

@@ -4,9 +4,9 @@
 
 import { EditorView } from '@codemirror/view';
 import { describe, it } from '@effect/vitest';
-import { Effect } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { type ContentBlock } from '@dxos/schema';
+import { type ContentBlock } from '@dxos/types';
 
 import { createMessage } from '../../testing';
 
@@ -16,16 +16,24 @@ import { MessageSyncer, type TextModel } from './sync';
 class TestDocument implements TextModel {
   private readonly _view = new EditorView({ extensions: [] });
 
+  get view() {
+    return this._view;
+  }
+
   get content() {
     return this._view.state.doc.toString();
   }
 
   async reset(text: string) {
-    this._view.dispatch({ changes: { from: 0, to: this._view.state.doc.length, insert: text } });
+    this._view.dispatch({
+      changes: { from: 0, to: this._view.state.doc.length, insert: text },
+    });
   }
 
   async append(text: string) {
-    this._view.dispatch({ changes: { from: this._view.state.doc.length, insert: text } });
+    this._view.dispatch({
+      changes: { from: this._view.state.doc.length, insert: text },
+    });
   }
 
   updateWidget(_id: string, _value: any) {}
@@ -43,12 +51,12 @@ describe('reducers', () => {
         createMessage('assistant', [{ _tag: 'text', text: 'Hi there!' }]),
       ];
 
-      syncer.sync(messages);
-      expect(doc.content).toEqual(['\n<prompt>Hello</prompt>\n', 'Hi there!', ''].join('\n'));
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!', ''].join('\n'));
 
       messages[1].blocks.push({ _tag: 'text', text: 'How can I help?' });
-      syncer.sync(messages);
-      expect(doc.content).toEqual(['\n<prompt>Hello</prompt>\n', 'Hi there!', 'How can I help?', ''].join('\n'));
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!', 'How can I help?', ''].join('\n'));
     }),
   );
 
@@ -63,18 +71,18 @@ describe('reducers', () => {
         createMessage('assistant', [{ _tag: 'text', text: 'Hi there!', pending: true }]),
       ];
 
-      syncer.sync(messages);
-      expect(doc.content).toEqual(['\n<prompt>Hello</prompt>\n', 'Hi there!'].join('\n'));
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!'].join('\n'));
 
       const block = messages[1].blocks[0] as ContentBlock.Text;
       block.text = 'Hi there! How are you?';
       block.pending = false;
-      syncer.sync(messages);
+      syncer.append(messages);
 
       messages[1].blocks.push({ _tag: 'text', text: 'How can I help?' });
-      syncer.sync(messages);
+      syncer.append(messages);
       expect(doc.content).toEqual(
-        ['\n<prompt>Hello</prompt>\n', 'Hi there! How are you?', 'How can I help?', ''].join('\n'),
+        ['<prompt>Hello</prompt>', 'Hi there! How are you?', 'How can I help?', ''].join('\n'),
       );
     }),
   );

package/src/components/ChatThread/sync.ts

@@ -2,15 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
+import { type DXN } from '@dxos/echo';
 import { log } from '@dxos/log';
 import { type MarkdownStreamController } from '@dxos/react-ui-components';
-import { type XmlWidgetStateManager } from '@dxos/react-ui-editor';
-import { type ContentBlock, type DataType } from '@dxos/schema';
+import { type StateDispatch, type XmlWidgetStateManager } from '@dxos/react-ui-editor';
+import { type ContentBlock, type Message } from '@dxos/types';
 
 /**
  * Update document.
  */
-export type TextModel = Pick<MarkdownStreamController, 'reset' | 'append' | 'updateWidget'>;
+export type TextModel = Pick<MarkdownStreamController, 'view' | 'reset' | 'append' | 'updateWidget'>;
 
 /**
  * Thread context passed to renderer.
@@ -18,9 +19,14 @@ export type TextModel = Pick<MarkdownStreamController, 'reset' | 'append' | 'upd
 export class MessageThreadContext implements Pick<MarkdownStreamController, 'updateWidget'> {
   constructor(private readonly _widgetState?: XmlWidgetStateManager) {}
 
-  updateWidget<T>(id: string, value: T) {
+  updateWidget<T>(id: string, value: StateDispatch<T>) {
     this._widgetState?.updateWidget(id, value);
   }
+
+  // TODO(burdon): Resolve from hypergraph.
+  getObjectLabel(_id: DXN) {
+    return 'Object';
+  }
 }
 
 /**
@@ -28,7 +34,7 @@ export class MessageThreadContext implements Pick<MarkdownStreamController, 'upd
  */
 export type BlockRenderer = (
   context: MessageThreadContext,
-  message: DataType.Message,
+  message: Message.Message,
   block: ContentBlock.Any,
 ) => string | undefined;
 
@@ -63,17 +69,46 @@ export class MessageSyncer {
     void this._model.reset('');
   }
 
-  sync(messages: DataType.Message[]) {
+  /**
+   * Syncs messages with the editor.
+   */
+  append(messages: Message.Message[], flush = false): boolean {
+    // Check if new set of messages.
+    if (this._initialMessageId !== messages[0]?.id) {
+      this.reset();
+      this._initialMessageId = messages[0]?.id;
+    }
+
+    if (flush && this._model.view?.state.doc.length === 0) {
+      const buffer: string[] = [];
+      this.process(messages, (content) => {
+        buffer.push(content);
+      });
+
+      const content = buffer.join('');
+      this._model.view?.dispatch({
+        changes: [{ from: 0, to: this._model.view?.state.doc.length ?? 0, insert: content }],
+        selection: { anchor: content.length },
+      });
+
+      return true;
+    } else {
+      this.process(messages, (content) => {
+        void this._model.append(content);
+      });
+
+      return false;
+    }
+  }
+
+  private process(messages: Message.Message[], append: (content: string) => void) {
     log('sync', {
-      messages: messages.map((m) => m.blocks.length),
+      doc: this._model.view?.state.doc.length,
+      messages: messages.map((message) => message.blocks.length),
       currentMessageIndex: this._currentMessageIndex,
       currentBlockIndex: this._currentBlockIndex,
       currentBlockContent: this._currentBlockContent,
     });
-    if (this._initialMessageId !== messages[0]?.id) {
-      this.reset();
-      this._initialMessageId = messages[0]?.id;
-    }
 
     let i = this._currentMessageIndex;
     for (const message of messages.slice(this._currentMessageIndex)) {
@@ -94,9 +129,9 @@ export class MessageSyncer {
             content = currentBlockContent;
           }
 
-          void this._model.append(content);
-          this._currentBlockContent = currentBlockContent;
           log('append', { message: i, block: j, content });
+          this._currentBlockContent = currentBlockContent;
+          append(content);
         }
 
         if (block.pending) {