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

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

@@ -0,0 +1,99 @@
+// @vitest-environment jsdom
+
+//
+// Copyright 2025 DXOS.org
+//
+
+import { EditorView } from '@codemirror/view';
+import { describe, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { Obj } from '@dxos/echo';
+import { type Mutable } from '@dxos/echo/internal';
+import { type ContentBlock } from '@dxos/types';
+
+import { createMessage } from '../../testing';
+
+import { blockToMarkdown } from './registry';
+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 },
+    });
+  }
+
+  async append(text: string) {
+    this._view.dispatch({
+      changes: { from: this._view.state.doc.length, insert: text },
+    });
+  }
+
+  updateWidget(_id: string, _value: any) {}
+}
+
+describe('reducers', () => {
+  it.effect(
+    'basic sync',
+    Effect.fn(function* ({ expect }) {
+      const doc = new TestDocument();
+      const syncer = new MessageSyncer(doc, blockToMarkdown);
+
+      const messages = [
+        createMessage('user', [{ _tag: 'text', text: 'Hello' }]),
+        createMessage('assistant', [{ _tag: 'text', text: 'Hi there!' }]),
+      ];
+
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!', ''].join('\n'));
+
+      Obj.change(messages[1], (m) => {
+        m.blocks.push({ _tag: 'text', text: 'How can I help?' });
+      });
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!', 'How can I help?', ''].join('\n'));
+    }),
+  );
+
+  it.effect(
+    'sync with partial updates',
+    Effect.fn(function* ({ expect }) {
+      const doc = new TestDocument();
+      const syncer = new MessageSyncer(doc, blockToMarkdown);
+
+      const messages = [
+        createMessage('user', [{ _tag: 'text', text: 'Hello' }]),
+        createMessage('assistant', [{ _tag: 'text', text: 'Hi there!', pending: true }]),
+      ];
+
+      syncer.append(messages);
+      expect(doc.content).toEqual(['<prompt>Hello</prompt>', 'Hi there!'].join('\n'));
+
+      Obj.change(messages[1], (m) => {
+        const block = m.blocks[0] as Mutable<ContentBlock.Text>;
+        block.text = 'Hi there! How are you?';
+        block.pending = false;
+      });
+      syncer.append(messages);
+
+      Obj.change(messages[1], (m) => {
+        m.blocks.push({ _tag: 'text', text: 'How can I help?' });
+      });
+      syncer.append(messages);
+      expect(doc.content).toEqual(
+        ['<prompt>Hello</prompt>', 'Hi there! How are you?', 'How can I help?', ''].join('\n'),
+      );
+    }),
+  );
+});

package/src/components/ChatThread/sync.ts

@@ -0,0 +1,160 @@
+//
+// 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 ContentBlock, type Message } from '@dxos/types';
+import { type StateDispatch, type XmlWidgetStateManager } from '@dxos/ui-editor';
+
+/**
+ * Update document.
+ */
+export type TextModel = Pick<MarkdownStreamController, 'view' | 'reset' | 'append' | 'updateWidget'>;
+
+/**
+ * Thread context passed to renderer.
+ */
+export class MessageThreadContext implements Pick<MarkdownStreamController, 'updateWidget'> {
+  constructor(private readonly _widgetState?: XmlWidgetStateManager) {}
+
+  updateWidget<T>(id: string, value: StateDispatch<T>) {
+    this._widgetState?.updateWidget(id, value);
+  }
+
+  // TODO(burdon): Resolve from hypergraph.
+  getObjectLabel(_id: DXN) {
+    return 'Object';
+  }
+}
+
+/**
+ * Renders a block to markdown.
+ */
+export type BlockRenderer = (
+  context: MessageThreadContext,
+  message: Message.Message,
+  block: ContentBlock.Any,
+) => string | undefined;
+
+/**
+ * Syncs messages with the editor.
+ */
+export class MessageSyncer {
+  private _initialMessageId?: string;
+  private _currentMessageIndex = 0;
+  private _currentBlockIndex = 0;
+  private _currentBlockContent?: string;
+
+  private readonly _context: MessageThreadContext;
+
+  constructor(
+    private readonly _model: TextModel,
+    private readonly _blockRenderer: BlockRenderer,
+  ) {
+    this._context = new MessageThreadContext(this._model);
+  }
+
+  get context() {
+    return this._context;
+  }
+
+  reset() {
+    log('reset');
+    this._initialMessageId = undefined;
+    this._currentMessageIndex = 0;
+    this._currentBlockIndex = 0;
+    this._currentBlockContent = undefined;
+    void this._model.reset('');
+  }
+
+  /**
+   * Syncs messages with the editor.
+   */
+  append(messages: Message.Message[], flush = false): boolean {
+    // TODO(dmaretskyi): MarkdownStream currently does not support streaming XML tags, so we need to remove pending non-text blocks.
+    messages = messages.map((message) => ({
+      ...message,
+      blocks: message.blocks.filter((block) => !block.pending || block._tag === 'text'),
+    }));
+
+    // 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) {
+    // console.log('sync', {
+    //   doc: this._model.view?.state.doc.length,
+    //   messages: messages.map((message) => message.blocks.length),
+    //   currentMessageIndex: this._currentMessageIndex,
+    //   currentBlockIndex: this._currentBlockIndex,
+    //   currentBlockContent: this._currentBlockContent,
+    // });
+
+    let i = this._currentMessageIndex;
+    for (const message of messages.slice(this._currentMessageIndex)) {
+      if (i > this._currentMessageIndex) {
+        this._currentBlockIndex = 0;
+      }
+
+      this._currentMessageIndex = i;
+      let j = this._currentBlockIndex;
+      for (const block of message.blocks.slice(this._currentBlockIndex)) {
+        this._currentBlockIndex = j;
+        const currentBlockContent = this._blockRenderer(this._context, message, block);
+        if (currentBlockContent) {
+          let content: string = '';
+          if (this._currentBlockContent && currentBlockContent.startsWith(this._currentBlockContent)) {
+            content = currentBlockContent.slice(this._currentBlockContent.length);
+          } else {
+            content = currentBlockContent;
+          }
+
+          // console.log('append', { message: i, block: j, content });
+          this._currentBlockContent = currentBlockContent;
+          append(content);
+        }
+
+        if (block.pending) {
+          return;
+        } else {
+          this._currentBlockContent = undefined;
+          this._currentBlockIndex++;
+        }
+        j++;
+      }
+      i++;
+    }
+  }
+}

package/src/components/ChatThread/testing/thread.md

@@ -0,0 +1,37 @@
+<prompt>hi</prompt>
+Hi! I'm Kai, your AI assistant powered by DXOS. I see you have a document in your context. Let me take a look at it to see how I can help you.
+<toolCall id="toolu_012MB5XWrQhsyjUBoBCr7jXB" />
+
+<summary>OK (1 tool uses · 2.62k tokens · 4.8s)</summary>
+I can see you have a comprehensive welcome document for Composer by DXOS. This document explains what Composer is - an extensible collaborative application with features like documents, diagrams, tables, and sheets.
+
+Here are some suggestions based on what's available:
+<suggestion>Create a new document</suggestion>
+<suggestion>Edit the welcome document</suggestion>
+<suggestion>Create a table to organize information</suggestion>
+<suggestion>Create a sketch for diagrams</suggestion>
+<suggestion>Learn about collaboration features</suggestion>
+
+Is there something specific you'd like to do with this document or would you like to explore other features of Composer?
+
+<summary>OK (3.91k tokens · 7.0s)</summary>
+<prompt>Create a table to organize information</prompt>
+I'll help you create a table to organize information. Let me check what table creation tools are available.
+<toolCall id="toolu_01Gk8ZNGYQEczAjGkbDZ9n1D" />
+<summary>OK (1 tool uses · 3.99k tokens · 3.4s)</summary>
+I need to check what artifact definitions are available for creating tables. Based on the blueprint instructions, I should first query for available artifact definitions to see what table-related tools I can use.
+
+However, I notice that the function definitions provided don't include the artifact-related tools mentioned in the blueprint (like `require_artifact_definitions` or table creation tools). The available functions are focused on document operations (open, diff, add-to-context, open-item) and analysis mode.
+
+Let me work with what's available. Since I can't directly create a table artifact with the current tools, I can help you create a table structure within a markdown document instead.
+
+Would you like me to:
+
+1. Create a simple markdown table structure in a new document that you can use to organize your information?
+2. Or would you prefer to use Composer's built-in Tables plugin (as mentioned in the welcome document) by creating one through the Composer interface?
+
+What kind of information are you looking to organize? This will help me suggest the best table structure for your needs.
+<toolCall id="toolu_01CQXUsyLw2uoV3k1mPLqFee" />
+
+<summary>OK (1 tool uses · 4.28k tokens · 11.1s)</summary>
+<summary>OK (4.30k tokens · 1.6s)</summary>

package/src/components/TemplateEditor/TemplateEditor.stories.tsx

@@ -2,68 +2,89 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { createSystemPrompt } from '@dxos/assistant';
-import { Template } from '@dxos/blueprints';
+import { Blueprint, Template } from '@dxos/blueprints';
 import { useClient } from '@dxos/react-client';
 import { withClientProvider } from '@dxos/react-client/testing';
-import { ColumnContainer, withLayout, withTheme } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 import { trim } from '@dxos/util';
 
-import { TemplateEditor, type TemplateEditorProps } from './TemplateEditor';
 import { translations } from '../../translations';
 
+import { TemplateEditor, type TemplateEditorProps } from './TemplateEditor';
+
+const FENCE = '```';
+
 const TEMPLATE = trim`
   {{! System Prompt }}
   
-  You are a machine that is an expert chess player.
-  The move history of the current game is: {{history}}
+  You are an expert chess player.
+  The move history of the current game is: {{history}}.
   If asked to suggest a move explain why it is a good move.
 
   {{#each artifacts}}
-  - {{this}}
+    {{this}}
   {{/each}}
 
+  Reponse in the format: <suggestion>SUGGESTION</suggestion>
+
+  @dxn:queue:data:B6INSIBY3CBEF4M5VZRYBCMAHQMPYK5AJ:01K24XMVHSZHS97SG1VTVQDM5Z:01K24XPK464FSCKVQJAB2H662M
+
   ---
 
+  ${FENCE}ts
+  const x = 100;
+  ${FENCE}
+
   {{input}}
 `;
 
 const DefaultStory = ({ source }: TemplateEditorProps & { source: string }) => {
   const client = useClient();
-  const [template] = useState(() => {
+  const [blueprint] = useState(() => {
     const space = client.spaces.default;
-    return space.db.add(Template.make({ source }));
+    return space.db.add(
+      Blueprint.make({
+        key: 'example.com/blueprint/test',
+        name: 'Test',
+        instructions: Template.make({ source }),
+      }),
+    );
   });
 
-  return <TemplateEditor template={template} />;
+  return (
+    <TemplateEditor
+      classNames='bg-base-surface w-full max-w-prose-max-width'
+      id={blueprint.id}
+      template={blueprint.instructions}
+    />
+  );
 };
 
-const meta: Meta<typeof DefaultStory> = {
-  title: 'plugins/plugin-assistant/TemplateEditor',
-  component: TemplateEditor,
+const meta = {
+  title: 'plugins/plugin-assistant/components/TemplateEditor',
+  component: TemplateEditor as any,
   render: DefaultStory,
   decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
     withClientProvider({
+      types: [Blueprint.Blueprint],
       createIdentity: true,
       createSpace: true,
-      types: [Template.Template],
     }),
-    withLayout({ fullscreen: true, Container: ColumnContainer }),
-    withTheme,
   ],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = Meta<typeof DefaultStory>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
   args: {

package/src/components/TemplateEditor/TemplateEditor.tsx

@@ -2,88 +2,69 @@
 // Copyright 2025 DXOS.org
 //
 
-import { HighlightStyle, LanguageSupport, syntaxHighlighting } from '@codemirror/language';
-import { styleTags, tags } from '@lezer/highlight';
-import { handlebarsLanguage } from '@xiechao/codemirror-lang-handlebars';
+import { defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
 import React from 'react';
 
 import { type Template } from '@dxos/blueprints';
-import { invariant } from '@dxos/invariant';
-import { createDocAccessor } from '@dxos/react-client/echo';
-import { useThemeContext, useTranslation, type ThemedClassName } from '@dxos/react-ui';
+import { createDocAccessor } from '@dxos/echo-db';
+import { type ThemedClassName, useThemeContext, useTranslation } from '@dxos/react-ui';
+import { useTextEditor } from '@dxos/react-ui-editor';
 import {
   createBasicExtensions,
   createDataExtensions,
+  createMarkdownExtensions,
   createThemeExtensions,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { mx } from '@dxos/react-ui-theme';
+  decorateMarkdown,
+} from '@dxos/ui-editor';
+import { mx } from '@dxos/ui-theme';
+import { isNonNullable } from '@dxos/util';
 
 import { meta } from '../../meta';
 
-handlebarsLanguage.configure({
-  props: [
-    styleTags({
-      '---': tags.lineComment,
-    }),
-  ],
-});
+import { handlebars, xmlDecorator } from './extensions';
 
 export type TemplateEditorProps = ThemedClassName<{
+  id: string;
   template: Template.Template;
+  lineNumbers?: boolean;
 }>;
 
-export const TemplateEditor = ({ classNames, template }: TemplateEditorProps) => {
+export const TemplateEditor = ({ id, classNames, template, lineNumbers = true }: TemplateEditorProps) => {
   const { t } = useTranslation(meta.id);
   const { themeMode } = useThemeContext();
   const { parentRef } = useTextEditor(() => {
-    invariant(template.source.target);
+    const text = template.source?.target;
+    if (!text) {
+      return {};
+    }
+
     return {
-      initialValue: template.source.target.content,
+      initialValue: text.content ?? '',
       extensions: [
         createDataExtensions({
-          id: template.id,
-          text: createDocAccessor(template.source.target, ['content']),
+          id,
+          text: createDocAccessor(text, ['content']),
         }),
         createBasicExtensions({
           bracketMatching: false,
-          lineNumbers: true,
+          lineNumbers,
           lineWrapping: true,
-          monospace: true,
           placeholder: t('template placeholder'),
         }),
         createThemeExtensions({
           themeMode,
+          slots: { content: { className: '!pe-4' } },
         }),
-
-        // https://github.com/xiechao/lang-handlebars
-        new LanguageSupport(handlebarsLanguage, syntaxHighlighting(handlebarsHighlightStyle)),
-      ],
+        createMarkdownExtensions(),
+        decorateMarkdown(),
+        handlebars(),
+        // xml(),
+        // NOTE: Since we're using markdown only HTML nodes are parsed.
+        xmlDecorator(),
+        syntaxHighlighting(defaultHighlightStyle),
+      ].filter(isNonNullable),
     };
-  }, [themeMode, template]);
+  }, [themeMode, template.source?.target, lineNumbers]);
 
-  return <div ref={parentRef} className={mx('h-full', classNames)} />;
+  return <div ref={parentRef} className={mx('h-full overflow-hidden', classNames)} />;
 };
-
-/**
- * https://github.com/xiechao/lang-handlebars/blob/direct/src/highlight.js
- */
-export const handlebarsHighlightStyle = HighlightStyle.define([
-  {
-    // Braces.
-    tag: tags.tagName,
-    class: 'text-redText',
-  },
-  {
-    tag: tags.variableName,
-    class: 'text-blueText',
-  },
-  {
-    tag: tags.keyword,
-    class: 'text-greenText',
-  },
-  {
-    tag: tags.comment,
-    class: 'text-subdued',
-  },
-]);

package/src/components/TemplateEditor/TemplateForm.stories.tsx

@@ -2,61 +2,74 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta } from '@storybook/react-vite';
-import React, { useState } from 'react';
+import React, { useCallback, useState } from 'react';
 
-import { Template } from '@dxos/blueprints';
+import { Blueprint, Template } from '@dxos/blueprints';
+import { Obj } from '@dxos/echo';
 import { useClient } from '@dxos/react-client';
 import { withClientProvider } from '@dxos/react-client/testing';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 import { trim } from '@dxos/util';
 
-import { TemplateForm } from './TemplateForm';
 import { translations } from '../../translations';
 
+import { type TemplateChangeCallback, TemplateForm } from './TemplateForm';
+
 const TEMPLATE = trim`
   You are a machine that is an expert chess player.
   The move history of the current game is: {{history}}
   If asked to suggest a move explain why it is a good move.
-  
+
   ---
- 
+
   {{input}},
 `;
 
 const DefaultStory = () => {
   const client = useClient();
-  const [template] = useState(() => {
+  const [blueprint] = useState(() => {
     const space = client.spaces.default;
-    return space.db.add(Template.make({ source: TEMPLATE }));
+    return space.db.add(
+      Blueprint.make({
+        key: 'example.com/blueprint/test',
+        name: 'Test',
+        instructions: Template.make({ source: TEMPLATE }),
+      }),
+    );
   });
 
+  const handleChange: TemplateChangeCallback = useCallback(
+    (mutate) => {
+      Obj.change(blueprint, (b) => mutate(b.instructions));
+    },
+    [blueprint],
+  );
+
   return (
     <div role='none' className='flex w-[40rem] border border-separator overflow-hidden'>
-      <TemplateForm template={template} />
+      <TemplateForm id={blueprint.id} template={blueprint.instructions} onChange={handleChange} />
     </div>
   );
 };
 
-const meta: Meta<typeof TemplateForm> = {
-  title: 'plugins/plugin-assistant/TemplateForm',
+const meta = {
+  title: 'plugins/plugin-assistant/components/TemplateForm',
   component: TemplateForm,
   render: DefaultStory,
   decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
     withClientProvider({
+      types: [Blueprint.Blueprint],
       createIdentity: true,
       createSpace: true,
-      types: [Template.Template],
     }),
-    withLayout({ fullscreen: true, classNames: 'flex justify-center' }),
-    withTheme,
   ],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof TemplateForm>;
 
 export default meta;