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

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

@@ -2,34 +2,43 @@
 // 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 { 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}}
 `;
 
@@ -37,33 +46,45 @@ const DefaultStory = ({ source }: TemplateEditorProps & { source: string }) => {
   const client = useClient();
   const [blueprint] = useState(() => {
     const space = client.spaces.default;
-    return space.db.add(Blueprint.make({ name: 'Test', instructions: { source } }));
+    return space.db.add(
+      Blueprint.make({
+        key: 'example.com/blueprint/test',
+        name: 'Test',
+        instructions: Template.make({ source }),
+      }),
+    );
   });
 
-  return <TemplateEditor id={blueprint.id} template={blueprint.instructions} />;
+  return (
+    <TemplateEditor
+      classNames='bg-baseSurface max-is-prose is-full'
+      id={blueprint.id}
+      template={blueprint.instructions}
+    />
+  );
 };
 
-const meta: Meta<typeof DefaultStory> = {
+const meta = {
   title: 'plugins/plugin-assistant/TemplateEditor',
-  component: TemplateEditor,
+  component: TemplateEditor as any,
   render: DefaultStory,
   decorators: [
+    withTheme,
+    withLayout({ container: '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,90 +2,66 @@
 // 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 { 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 {
   createBasicExtensions,
   createDataExtensions,
+  createMarkdownExtensions,
   createThemeExtensions,
+  decorateMarkdown,
   useTextEditor,
 } from '@dxos/react-ui-editor';
 import { mx } from '@dxos/react-ui-theme';
-import { isNotFalsy } from '@dxos/util';
+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 = ({ id, classNames, template }: TemplateEditorProps) => {
+export const TemplateEditor = ({ id, classNames, template, lineNumbers = true }: TemplateEditorProps) => {
   const { t } = useTranslation(meta.id);
   const { themeMode } = useThemeContext();
   const { parentRef } = useTextEditor(() => {
     const text = template.source?.target;
+    if (!text) {
+      return {};
+    }
+
     return {
-      initialValue: text?.content ?? '',
+      initialValue: text.content ?? '',
       extensions: [
-        text &&
-          createDataExtensions({
-            id,
-            text: createDocAccessor(text, ['content']),
-          }),
+        createDataExtensions({
+          id,
+          text: createDocAccessor(text, ['content']),
+        }),
         createBasicExtensions({
           bracketMatching: false,
-          lineNumbers: true,
+          lineNumbers,
           lineWrapping: true,
-          monospace: true,
           placeholder: t('template placeholder'),
         }),
-        createThemeExtensions({
-          themeMode,
-        }),
-
-        // https://github.com/xiechao/lang-handlebars
-        new LanguageSupport(handlebarsLanguage, syntaxHighlighting(handlebarsHighlightStyle)),
-      ].filter(isNotFalsy),
+        createThemeExtensions({ themeMode, slots: { content: { className: '!pie-4' } } }),
+        createMarkdownExtensions(),
+        decorateMarkdown(),
+        handlebars(),
+        // xml(),
+        // NOTE: Since we're using markdown only HTML nodes are parsed.
+        xmlDecorator(),
+        syntaxHighlighting(defaultHighlightStyle),
+      ].filter(isNonNullable),
     };
-  }, [themeMode, template.source?.target]);
+  }, [themeMode, template.source?.target, lineNumbers]);
 
-  return <div ref={parentRef} className={mx('h-full', classNames)} />;
+  return <div ref={parentRef} className={mx('bs-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,20 +2,19 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { Blueprint, Template } from '@dxos/blueprints';
 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 { 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}}
@@ -30,33 +29,39 @@ const DefaultStory = () => {
   const client = useClient();
   const [blueprint] = useState(() => {
     const space = client.spaces.default;
-    return space.db.add(Blueprint.make({ name: 'Test', instructions: { source: TEMPLATE } }));
+    return space.db.add(
+      Blueprint.make({
+        key: 'example.com/blueprint/test',
+        name: 'Test',
+        instructions: Template.make({ source: TEMPLATE }),
+      }),
+    );
   });
 
   return (
-    <div role='none' className='flex w-[40rem] border border-separator overflow-hidden'>
+    <div role='none' className='flex is-[40rem] border border-separator overflow-hidden'>
       <TemplateForm id={blueprint.id} template={blueprint.instructions} />
     </div>
   );
 };
 
-const meta: Meta<typeof TemplateForm> = {
+const meta = {
   title: 'plugins/plugin-assistant/TemplateForm',
   component: TemplateForm,
   render: DefaultStory,
   decorators: [
+    withTheme,
+    withLayout({ container: '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;
 

package/src/components/TemplateEditor/TemplateForm.tsx

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Schema } from 'effect';
+import type * as Schema from 'effect/Schema';
 import React, { Fragment, useEffect } from 'react';
 
 import { type Template } from '@dxos/blueprints';
@@ -10,9 +10,10 @@ import { Input, Select, useTranslation } from '@dxos/react-ui';
 import { attentionSurface, groupBorder, mx } from '@dxos/react-ui-theme';
 import { isNonNullable } from '@dxos/util';
 
-import { TemplateEditor } from './TemplateEditor';
 import { meta } from '../../meta';
 
+import { TemplateEditor } from './TemplateEditor';
+
 export type TemplateFormProps = {
   id: string;
   template: Template.Template;
@@ -25,7 +26,7 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
   usePromptInputs(template);
 
   return (
-    <div className={mx('flex flex-col w-full overflow-hidden gap-4', groupBorder)}>
+    <div className={mx('flex flex-col is-full overflow-hidden gap-4', groupBorder)}>
       {/* {commandEditable && (
         <div className='flex items-center pl-4'>
           <span className='text-neutral-500'>/</span>
@@ -67,6 +68,7 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
                           </Select.Option>
                         ))}
                       </Select.Viewport>
+                      <Select.Arrow />
                     </Select.Content>
                   </Select.Portal>
                 </Select.Root>

package/src/components/TemplateEditor/extensions/handlebars-extension.ts

@@ -0,0 +1,269 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import {
+  type CompletionContext,
+  type CompletionResult,
+  autocompletion,
+  completionKeymap,
+} from '@codemirror/autocomplete';
+import { type Extension, RangeSetBuilder } from '@codemirror/state';
+import {
+  Decoration,
+  type DecorationSet,
+  type EditorView,
+  ViewPlugin,
+  type ViewUpdate,
+  WidgetType,
+  keymap,
+} from '@codemirror/view';
+
+import { Domino } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+export type HandlebarsOptions = {};
+
+/**
+ * Simple Handlebars plugin for CodeMirror.
+ * Supports:
+ * - Comments: {{! comment }}
+ * - Commands: {{#command}} {{/command}}
+ * - Variables: {{var}}
+ * - Commands with variables: {{#each items}} {{/each}}
+ */
+export const handlebars = (_: HandlebarsOptions = {}): Extension => {
+  return [
+    handlebarsHighlightPlugin,
+    autocompletion({
+      activateOnTyping: true,
+      aboveCursor: true,
+      closeOnBlur: true,
+      override: [handlebarsCompletions],
+    }),
+    keymap.of(completionKeymap),
+  ];
+};
+
+const regex = {
+  // {{! comment }}
+  comment: /\{\{!\s*[^}]*\}\}/g,
+
+  // {{var}}
+  brackets: /\{\{[^}]*\}\}/g,
+
+  // {{#command}} {{/command}}
+  command: /\{\{[#/]([^}]+)\}\}/g,
+
+  // {{var}}
+  var: /\{\{(?!\s*!)(\w[^}]*)\}\}/g,
+
+  // @dxn:queue:data:xxx
+  dxn: /@?dxn:[\w@:]+/g,
+
+  // dxos.org/type/xxx
+  url: /[\w.-]+\.[\w.-]+\/[\w/]+/g,
+};
+
+const tagPadding = 'mli-0.5 pli-1 rounded-sm';
+
+/**
+ * ViewPlugin that decorates Handlebars syntax.
+ */
+const handlebarsHighlightPlugin = ViewPlugin.fromClass(
+  class {
+    decorations: DecorationSet;
+
+    constructor(view: EditorView) {
+      this.decorations = this.buildDecorations(view);
+    }
+
+    update(update: ViewUpdate) {
+      if (update.docChanged || update.viewportChanged || update.selectionSet) {
+        this.decorations = this.buildDecorations(update.view);
+      }
+    }
+
+    // NOTE: Decorations may clash with other extensions (e.g., markdown).
+    buildDecorations(view: EditorView) {
+      const selection = view.state.selection.main;
+      const decorations: Array<{ from: number; to: number; decoration: Decoration }> = [];
+
+      for (const { from, to } of view.visibleRanges) {
+        const text = view.state.doc.sliceString(from, to);
+
+        // Match DXN.
+        {
+          let match;
+          while ((match = regex.dxn.exec(text)) !== null) {
+            const start = from + match.index;
+            const end = start + match[0].length;
+            // Only show widget if selection doesn't overlap with the match range.
+            const overlaps = selection.to > start && selection.from <= end;
+            if (!overlaps) {
+              decorations.push({
+                from: start,
+                to: end,
+                decoration: Decoration.widget({
+                  widget: new DXNWidget(match[0]),
+                }),
+              });
+            }
+          }
+        }
+
+        // Match URLs.
+        {
+          let match;
+          while ((match = regex.url.exec(text)) !== null) {
+            const start = from + match.index;
+            const end = start + match[0].length;
+            decorations.push({
+              from: start,
+              to: end,
+              decoration: Decoration.mark({ class: mx('dx-tag--blue', tagPadding) }),
+            });
+          }
+        }
+
+        // Match brackets: {{ and }}.
+        {
+          let match;
+          while ((match = regex.brackets.exec(text)) !== null) {
+            const start = from + match.index;
+            const end = start + match[0].length;
+            decorations.push({
+              from: start,
+              to: end,
+              decoration: Decoration.mark({ class: 'text-subdued' }),
+            });
+          }
+        }
+
+        // Match commands: {{#command}} and {{/command}}.
+        {
+          let match;
+          while ((match = regex.command.exec(text)) !== null) {
+            const start = from + match.index + 2;
+            let end = start + match[0].length - 4;
+            const text = view.state.doc.sliceString(start, end);
+            const parts = text.split(/\s+/);
+            if (parts.length > 1) {
+              const idx = start + parts[0].length;
+              decorations.push({
+                from: idx,
+                to: end,
+                decoration: Decoration.mark({ class: 'text-greenText' }),
+              });
+              end = idx;
+            }
+            decorations.push({
+              from: start,
+              to: end,
+              decoration: Decoration.mark({ class: 'text-blueText' }),
+            });
+          }
+        }
+
+        // Match variables: {{var}}.
+        {
+          let match;
+          while ((match = regex.var.exec(text)) !== null) {
+            const start = from + match.index + 2;
+            const end = start + match[0].length - 4;
+            decorations.push({
+              from: start,
+              to: end,
+              decoration: Decoration.mark({ class: 'text-greenText' }),
+            });
+          }
+        }
+      }
+
+      // Sort decorations by position to satisfy RangeSetBuilder requirements.
+      decorations.sort((a, b) => a.from - b.from || a.to - b.to);
+
+      // Add sorted decorations to builder.
+      const builder = new RangeSetBuilder<Decoration>();
+      for (const { from, to, decoration } of decorations) {
+        builder.add(from, to, decoration);
+      }
+
+      return builder.finish();
+    }
+  },
+  {
+    decorations: (v) => v.decorations,
+  },
+);
+
+class DXNWidget extends WidgetType {
+  constructor(private readonly _identifier: string) {
+    super();
+  }
+
+  override ignoreEvent() {
+    return false;
+  }
+
+  override eq(other: this) {
+    return this._identifier === other._identifier;
+  }
+
+  override toDOM() {
+    const text = this._identifier
+      .split(':')
+      .map((part) => {
+        const len = 16;
+        const plen = 4;
+        if (part.length > len) {
+          return `[${part.slice(0, plen)}…${part.slice(-plen)}]`;
+        }
+        return part;
+      })
+      .join(':');
+    return Domino.of('span').classNames(['font-mono dx-tag--blue', tagPadding]).text(text).build();
+  }
+}
+
+// TODO(burdon): Pass in variables.
+const variables = ['this'];
+const commands = ['this', 'each', 'if', 'unless', 'with'];
+
+/**
+ * Provides completions for Handlebars variables.
+ */
+function handlebarsCompletions(context: CompletionContext): CompletionResult | null {
+  const match = context.matchBefore(/\{\{[^}]*/);
+  if (!match || match.from === match.to) {
+    return null;
+  }
+
+  let type = 'variable';
+  let text = match.text.slice(2);
+  let from = match.from + 2;
+  let matches = [];
+  if (text.startsWith('#') || text.startsWith('/')) {
+    const idx = text.lastIndexOf(' ');
+    if (idx !== -1) {
+      type = 'variable';
+      matches = variables;
+      text = text.slice(idx + 1);
+      from += idx + 1;
+    } else {
+      type = 'command';
+      text = text.slice(1);
+      matches = commands;
+      from += 1;
+    }
+  } else {
+    type = 'variable';
+    matches = variables;
+  }
+
+  const options = matches.filter((name) => name.startsWith(text)).map((name) => ({ type, label: name }));
+  return {
+    from,
+    options,
+  };
+}

package/src/components/TemplateEditor/extensions/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './handlebars-extension';
+export * from './xml-extension';

package/src/components/TemplateEditor/extensions/xml-extension.ts

@@ -0,0 +1,64 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { syntaxTree } from '@codemirror/language';
+import { type Extension, RangeSetBuilder } from '@codemirror/state';
+import { Decoration, type DecorationSet, type EditorView, ViewPlugin, type ViewUpdate } from '@codemirror/view';
+
+export type XmlOptions = {};
+
+/**
+ * XML decorator plugin for CodeMirror.
+ * Decorates XML tags with monospace font using the XML language grammar.
+ */
+export const xmlDecorator = (_: XmlOptions = {}): Extension => {
+  return [xmlDecoratorPlugin];
+};
+
+/**
+ * ViewPlugin that decorates XML tags using syntax tree.
+ */
+const xmlDecoratorPlugin = ViewPlugin.fromClass(
+  class {
+    decorations: DecorationSet;
+
+    constructor(view: EditorView) {
+      this.decorations = this.buildDecorations(view);
+    }
+
+    update(update: ViewUpdate) {
+      if (update.docChanged || update.viewportChanged) {
+        this.decorations = this.buildDecorations(update.view);
+      }
+    }
+
+    buildDecorations(view: EditorView) {
+      const builder = new RangeSetBuilder<Decoration>();
+
+      for (const { from, to } of view.visibleRanges) {
+        syntaxTree(view.state).iterate({
+          from,
+          to,
+          enter: (node) => {
+            // Decorate XML elements (opening tags, closing tags, self-closing tags).
+            if (
+              node.name === 'HTMLTag' ||
+              node.name === 'OpenTag' ||
+              node.name === 'CloseTag' ||
+              node.name === 'SelfClosingTag' ||
+              node.name === 'Element'
+            ) {
+              builder.add(node.from, node.to, Decoration.mark({ class: 'font-mono text-subdued' }));
+            }
+          },
+        });
+      }
+
+      return builder.finish();
+    }
+  },
+  {
+    decorations: (v) => v.decorations,
+  },
+);