@dxos/plugin-assistant 0.8.4-main.2e9d522 → 0.8.4-main.3eb6e50203

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} />
+    <div role='none' className='flex is-[40rem] border border-separator overflow-hidden'>
+      <TemplateForm id={blueprint.id} template={blueprint.instructions} onChange={handleChange} />
     </div>
   );
 };
 
-const meta: Meta<typeof TemplateForm> = {
+const meta = {
   title: 'plugins/plugin-assistant/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;
 

package/src/components/TemplateEditor/TemplateForm.tsx

@@ -2,29 +2,66 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Schema } from 'effect';
-import React, { Fragment, useEffect } from 'react';
+import type * as Schema from 'effect/Schema';
+import React, { Fragment, useCallback, useEffect } from 'react';
 
 import { type Template } from '@dxos/blueprints';
+import { type Obj } from '@dxos/echo';
 import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { attentionSurface, groupBorder, mx } from '@dxos/react-ui-theme';
+import { attentionSurface, groupBorder, mx } from '@dxos/ui-theme';
 import { isNonNullable } from '@dxos/util';
 
-import { TemplateEditor } from './TemplateEditor';
 import { meta } from '../../meta';
 
+import { TemplateEditor } from './TemplateEditor';
+
+/**
+ * Callback type for mutating template within a parent object's Obj.change context.
+ */
+export type TemplateChangeCallback = (mutate: (template: Obj.Mutable<Template.Template>) => void) => void;
+
 export type TemplateFormProps = {
+  id: string;
   template: Template.Template;
   schema?: Schema.Schema<any, any, any>;
   commandEditable?: boolean;
+  /**
+   * Callback to mutate the template. Should wrap mutations in parent's Obj.change.
+   * If not provided, the component is read-only.
+   */
+  onChange?: TemplateChangeCallback;
 };
 
-export const TemplateForm = ({ template, commandEditable = true }: TemplateFormProps) => {
+export const TemplateForm = ({ id, template, commandEditable = true, onChange }: TemplateFormProps) => {
   const { t } = useTranslation(meta.id);
-  usePromptInputs(template);
+  usePromptInputs(template, onChange);
+
+  const handleInputKindChange = useCallback(
+    (inputName: string, kind: Template.InputKind) => {
+      onChange?.((t) => {
+        const input = t.inputs?.find((i) => i?.name === inputName);
+        if (input) {
+          input.kind = kind;
+        }
+      });
+    },
+    [onChange],
+  );
+
+  const handleInputDefaultChange = useCallback(
+    (inputName: string, value: string) => {
+      onChange?.((t) => {
+        const input = t.inputs?.find((i) => i?.name === inputName);
+        if (input) {
+          input.default = value;
+        }
+      });
+    },
+    [onChange],
+  );
 
   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>
@@ -34,14 +71,16 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
               classNames='is-full bg-transparent m-2'
               value={template.command ?? ''}
               onChange={(event) => {
-                template.command = event.target.value.replace(/\w/g, '');
+                onChange?.((t) => {
+                  t.command = event.target.value.replace(/\w/g, '');
+                });
               }}
             />
           </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,9 +91,7 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
               <Input.Root>
                 <Select.Root
                   value={input.kind}
-                  onValueChange={(kind) => {
-                    input.kind = kind as Template.InputKind;
-                  }}
+                  onValueChange={(kind) => handleInputKindChange(input.name, kind as Template.InputKind)}
                 >
                   <Select.TriggerButton placeholder='Type' classNames='is-full' />
                   <Select.Portal>
@@ -66,6 +103,7 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
                           </Select.Option>
                         ))}
                       </Select.Viewport>
+                      <Select.Arrow />
                     </Select.Content>
                   </Select.Portal>
                 </Select.Root>
@@ -79,9 +117,7 @@ export const TemplateForm = ({ template, commandEditable = true }: TemplateFormP
                         placeholder={t('command placeholder')}
                         classNames='is-full bg-transparent'
                         value={input.default ?? ''}
-                        onChange={(event) => {
-                          input.default = event.target.value;
-                        }}
+                        onChange={(event) => handleInputDefaultChange(input.name, event.target.value)}
                       />
                     </Input.Root>
                   </div>
@@ -133,13 +169,14 @@ const inputs: { kind: Template.InputKind; label: string }[] = [
 
 export const NAME_REGEXP = /\{\{([\w-]+)\}\}/;
 
-const usePromptInputs = (template: Template.Template) => {
+const usePromptInputs = (template: Template.Template, onChange?: TemplateChangeCallback) => {
   useEffect(() => {
-    const text = template.source ?? '';
-    if (!template.inputs) {
-      template.inputs = []; // TODO(burdon): Required?
+    if (!onChange) {
+      return;
     }
 
+    const text = template.source ?? '';
+
     const regex = new RegExp(NAME_REGEXP, 'g');
     const variables = new Set<string>([...(text.target?.content.matchAll(regex) ?? [])].map((m) => m[1]));
 
@@ -158,19 +195,32 @@ const usePromptInputs = (template: Template.Template) => {
 
     // Match or create new inputs.
     const values = unclaimed.values();
-    missing.forEach((name) => {
-      const next = values.next().value;
-      if (next) {
-        next.name = name;
-      } else {
-        template.inputs?.push({ name });
+    onChange((t) => {
+      if (!t.inputs) {
+        t.inputs = [];
       }
-    });
 
-    // Remove unclaimed (deleted) inputs.
-    // TODO(burdon): If user types incorrect name value, it will be deleted. Garbage collect?
-    for (const input of values) {
-      template.inputs.splice(template.inputs.indexOf(input), 1);
-    }
-  }, [template.source]);
+      missing.forEach((name) => {
+        const next = values.next().value;
+        if (next) {
+          // Find the input in the mutable draft and update it.
+          const inputIndex = t.inputs!.findIndex((i) => i?.name === next.name);
+          if (inputIndex !== -1) {
+            t.inputs![inputIndex].name = name;
+          }
+        } else {
+          t.inputs!.push({ name });
+        }
+      });
+
+      // Remove unclaimed (deleted) inputs.
+      // TODO(burdon): If user types incorrect name value, it will be deleted. Garbage collect?
+      for (const input of values) {
+        const inputIndex = t.inputs!.findIndex((i) => i?.name === input.name);
+        if (inputIndex !== -1) {
+          t.inputs!.splice(inputIndex, 1);
+        }
+      }
+    });
+  }, [template.source, onChange]);
 };

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

@@ -0,0 +1,274 @@
+//
+// 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, mx } from '@dxos/ui';
+
+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(mx('font-mono dx-tag--blue', tagPadding)).text(text).root;
+  }
+}
+
+// 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,
+  },
+);