@dxos/plugin-assistant 0.8.3-staging.0fa589b → 0.8.4-main.1da679c

package/src/components/TemplateEditor/TemplateEditor.tsx

@@ -2,75 +2,57 @@
 // 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 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 { 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 { ASSISTANT_PLUGIN } from '../../meta';
-import { type TemplateType } from '../../types';
+import { meta } from '../../meta';
 
-handlebarsLanguage.configure({
-  props: [
-    styleTags({
-      '---': tags.lineComment,
-    }),
-  ],
-});
+import { handlebars } from './handlebars-extension';
 
 export type TemplateEditorProps = ThemedClassName<{
-  template: TemplateType;
+  id: string;
+  template: Template.Template;
 }>;
 
-export const TemplateEditor = ({ classNames, template }: TemplateEditorProps) => {
-  const { t } = useTranslation(ASSISTANT_PLUGIN);
+export const TemplateEditor = ({ id, classNames, template }: TemplateEditorProps) => {
+  const { t } = useTranslation(meta.id);
   const { themeMode } = useThemeContext();
-  const { parentRef } = useTextEditor(
-    () => ({
-      initialValue: template.source,
+  const { parentRef } = useTextEditor(() => {
+    const text = template.source?.target;
+    if (!text) {
+      return {};
+    }
+
+    return {
+      initialValue: text.content ?? '',
       extensions: [
-        createDataExtensions({
-          id: template.id,
-          text: template.source !== undefined ? createDocAccessor(template, ['template']) : undefined,
-        }),
+        createDataExtensions({ id, text: createDocAccessor(text, ['content']) }),
         createBasicExtensions({
           bracketMatching: false,
+          lineNumbers: true,
           lineWrapping: true,
           placeholder: t('template placeholder'),
         }),
-        createThemeExtensions({
-          themeMode,
-          slots: {
-            content: { className: '!p-3' },
-          },
-        }),
-
-        // https://github.com/xiechao/lang-handlebars
-        new LanguageSupport(handlebarsLanguage, syntaxHighlighting(handlebarsHighlightStyle)),
-      ],
-    }),
-    [themeMode, prompt],
-  );
-
-  return <div ref={parentRef} className={mx(classNames)} />;
+        createThemeExtensions({ themeMode }),
+        createMarkdownExtensions(),
+        decorateMarkdown(),
+        handlebars(),
+      ].filter(isNotFalsy),
+    };
+  }, [themeMode, template.source?.target]);
+
+  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([
-  { tag: tags.tagName, class: 'text-redText' }, // Braces.
-  { 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

@@ -4,51 +4,58 @@
 
 import '@dxos-theme';
 
-import { type Meta } from '@storybook/react';
+import { type Meta } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
-import { Obj } from '@dxos/echo';
+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 { trim } from '@dxos/util';
+
+import { translations } from '../../translations';
 
 import { TemplateForm } from './TemplateForm';
-import translations from '../../translations';
-import { TemplateType } from '../../types';
 
-const TEMPLATE = [
-  '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}}',
-].join('\n');
+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(Obj.make(TemplateType, { source: TEMPLATE, kind: { include: 'manual' } }));
+    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'>
-      <TemplateForm template={template} />
+      <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: [
     withClientProvider({
+      types: [Blueprint.Blueprint],
       createIdentity: true,
       createSpace: true,
-      types: [TemplateType],
     }),
     withLayout({ fullscreen: true, classNames: 'flex justify-center' }),
     withTheme,
@@ -56,7 +63,7 @@ const meta: Meta<typeof TemplateForm> = {
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof TemplateForm>;
 
 export default meta;
 

package/src/components/TemplateEditor/TemplateForm.tsx

@@ -5,34 +5,35 @@
 import { type Schema } from 'effect';
 import React, { Fragment, useEffect } from 'react';
 
+import { type Template } from '@dxos/blueprints';
 import { Input, Select, useTranslation } from '@dxos/react-ui';
 import { attentionSurface, groupBorder, mx } from '@dxos/react-ui-theme';
 import { isNonNullable } from '@dxos/util';
 
+import { meta } from '../../meta';
+
 import { TemplateEditor } from './TemplateEditor';
-import { ASSISTANT_PLUGIN } from '../../meta';
-import { type TemplateInput, TemplateInputType, type TemplateType } from '../../types';
 
 export type TemplateFormProps = {
-  template: TemplateType;
+  id: string;
+  template: Template.Template;
   schema?: Schema.Schema<any, any, any>;
   commandEditable?: boolean;
 };
 
-export const TemplateForm = ({ template, commandEditable = true }: TemplateFormProps) => {
-  const { t } = useTranslation(ASSISTANT_PLUGIN);
-
+export const TemplateForm = ({ id, template, commandEditable = true }: TemplateFormProps) => {
+  const { t } = useTranslation(meta.id);
   usePromptInputs(template);
 
   return (
     <div className={mx('flex flex-col w-full overflow-hidden gap-4', groupBorder)}>
-      {commandEditable && (
+      {/* {commandEditable && (
         <div className='flex items-center pl-4'>
           <span className='text-neutral-500'>/</span>
           <Input.Root>
             <Input.TextInput
               placeholder={t('command placeholder')}
-              classNames={mx('is-full bg-transparent m-2')}
+              classNames='is-full bg-transparent m-2'
               value={template.command ?? ''}
               onChange={(event) => {
                 template.command = event.target.value.replace(/\w/g, '');
@@ -40,9 +41,9 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
             />
           </Input.Root>
         </div>
-      )}
+      )} */}
 
-      <TemplateEditor template={template} classNames={[attentionSurface, 'min-h-[120px]']} />
+      <TemplateEditor id={id} template={template} classNames={[attentionSurface, 'min-h-[120px]']} />
 
       {(template.inputs?.length ?? 0) > 0 && (
         <div className='grid grid-cols-[10rem_10rem_1fr] gap-1 items-center'>
@@ -52,47 +53,42 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
 
               <Input.Root>
                 <Select.Root
-                  value={String(input.type)}
-                  onValueChange={(type) => {
-                    input.type = getInputType(type) ?? TemplateInputType.VALUE;
+                  value={input.kind}
+                  onValueChange={(kind) => {
+                    input.kind = kind as Template.InputKind;
                   }}
                 >
                   <Select.TriggerButton placeholder='Type' classNames='is-full' />
                   <Select.Portal>
                     <Select.Content>
                       <Select.Viewport>
-                        {inputTypes.map(({ value, label }) => (
-                          <Select.Option key={value} value={String(value)}>
+                        {inputs.map(({ kind, label }) => (
+                          <Select.Option key={kind} value={kind}>
                             {label}
                           </Select.Option>
                         ))}
                       </Select.Viewport>
+                      <Select.Arrow />
                     </Select.Content>
                   </Select.Portal>
                 </Select.Root>
               </Input.Root>
 
               <div>
-                {input.type !== undefined &&
-                  [
-                    TemplateInputType.VALUE,
-                    TemplateInputType.CONTEXT,
-                    TemplateInputType.RESOLVER,
-                    TemplateInputType.SCHEMA,
-                  ].includes(input.type) && (
-                    <div>
-                      <Input.Root>
-                        <Input.TextInput
-                          placeholder={t('command placeholder')}
-                          classNames={mx('is-full bg-transparent')}
-                          value={input.value ?? ''}
-                          onChange={(event) => {
-                            input.value = event.target.value;
-                          }}
-                        />
-                      </Input.Root>
-                    </div>
-                  )}
+                {input.kind !== undefined && ['value', 'context', 'resolver', 'schema'].includes(input.kind) && (
+                  <div>
+                    <Input.Root>
+                      <Input.TextInput
+                        placeholder={t('command placeholder')}
+                        classNames='is-full bg-transparent'
+                        value={input.default ?? ''}
+                        onChange={(event) => {
+                          input.default = event.target.value;
+                        }}
+                      />
+                    </Input.Root>
+                  </div>
+                )}
               </div>
             </Fragment>
           ))}
@@ -102,57 +98,56 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
   );
 };
 
-const inputTypes = [
+// TODO(burdon): Translations.
+const inputs: { kind: Template.InputKind; label: string }[] = [
   {
-    value: TemplateInputType.VALUE,
+    kind: 'value',
     label: 'Value',
   },
   {
-    value: TemplateInputType.PASS_THROUGH,
+    kind: 'pass-through',
     label: 'Pass through',
   },
   {
-    value: TemplateInputType.RETRIEVER,
+    kind: 'retriever',
     label: 'Retriever',
   },
-  // {
-  //   value: TemplateInputType.FUNCTION,
-  //   label: 'Function',
-  // },
-  // {
-  //   value: TemplateInputType.QUERY,
-  //   label: 'Query',
-  // },
   {
-    value: TemplateInputType.RESOLVER,
+    kind: 'function',
+    label: 'Function',
+  },
+  {
+    kind: 'query',
+    label: 'Query',
+  },
+  {
+    kind: 'resolver',
     label: 'Resolver',
   },
   {
-    value: TemplateInputType.CONTEXT,
+    kind: 'context',
     label: 'Context',
   },
   {
-    value: TemplateInputType.SCHEMA,
+    kind: 'schema',
     label: 'Schema',
   },
 ];
 
-export const nameRegex = /\{\{([\w-]+)\}\}/;
-
-const getInputType = (type: string) => inputTypes.find(({ value }) => String(value) === type)?.value;
+export const NAME_REGEXP = /\{\{([\w-]+)\}\}/;
 
-const usePromptInputs = (template: TemplateType) => {
+const usePromptInputs = (template: Template.Template) => {
   useEffect(() => {
     const text = template.source ?? '';
     if (!template.inputs) {
       template.inputs = []; // TODO(burdon): Required?
     }
 
-    const regex = new RegExp(nameRegex, 'g');
-    const variables = new Set<string>([...text.matchAll(regex)].map((m) => m[1]));
+    const regex = new RegExp(NAME_REGEXP, 'g');
+    const variables = new Set<string>([...(text.target?.content.matchAll(regex) ?? [])].map((m) => m[1]));
 
     // Create map of unclaimed inputs.
-    const unclaimed = new Map<string, TemplateInput>(
+    const unclaimed = new Map<string, Template.Input>(
       template.inputs?.filter(isNonNullable).map((input) => [input.name, input]),
     );
     const missing: string[] = [];

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

@@ -0,0 +1,165 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import {
+  type CompletionContext,
+  type CompletionResult,
+  autocompletion,
+  completionKeymap,
+} from '@codemirror/autocomplete';
+import { type Extension } from '@codemirror/state';
+import { Decoration, type DecorationSet, type EditorView, ViewPlugin, type ViewUpdate, keymap } from '@codemirror/view';
+
+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: /\{\{!\s*[^}]*\}\}/g,
+  brackets: /\{\{[^}]*\}\}/g,
+  command: /\{\{[#/]([^}]+)\}\}/g,
+  var: /\{\{(?!\s*!)(\w[^}]*)\}\}/g,
+};
+
+/**
+ * ViewPlugin that decorates Handlebars syntax.
+ */
+const handlebarsHighlightPlugin = ViewPlugin.fromClass(
+  class {
+    decorations: DecorationSet;
+
+    constructor(view: EditorView) {
+      this.decorations = this.buildDecorations(view);
+    }
+
+    buildDecorations(view: EditorView) {
+      const widgets: any[] = [];
+
+      for (const { from, to } of view.visibleRanges) {
+        const text = view.state.doc.sliceString(from, to);
+
+        // Match comments: {{! comment }}
+        {
+          let match;
+          while ((match = regex.comment.exec(text)) !== null) {
+            const start = from + match.index;
+            const end = start + match[0].length;
+            widgets.push(Decoration.mark({ class: 'text-subdued' }).range(start, end));
+          }
+        }
+
+        // Match brackets: {{ and }}
+        {
+          let match;
+          while ((match = regex.brackets.exec(text)) !== null) {
+            const start = from + match.index;
+            const end = start + match[0].length;
+            widgets.push(Decoration.mark({ class: 'text-subdued' }).range(start, end));
+          }
+        }
+
+        // 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;
+              widgets.push(Decoration.mark({ class: 'text-greenText' }).range(idx, end));
+              end = idx;
+            }
+            widgets.push(Decoration.mark({ class: 'text-blueText' }).range(start, end));
+          }
+        }
+
+        // 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;
+            widgets.push(Decoration.mark({ class: 'text-greenText' }).range(start, end));
+          }
+        }
+      }
+
+      // Sort decorations by position to avoid "Ranges must be added sorted" error.
+      widgets.sort((a, b) => a.from - b.from || a.startSide - b.startSide);
+      return Decoration.set(widgets);
+    }
+
+    update(update: ViewUpdate) {
+      if (update.docChanged || update.viewportChanged) {
+        this.decorations = this.buildDecorations(update.view);
+      }
+    }
+  },
+  {
+    decorations: (v) => v.decorations,
+  },
+);
+
+// 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,
+  };
+}