@dxos/plugin-assistant 0.8.4-main.67995b8 → 0.8.4-main.69d29f4

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 is-full max-is-proseMaxWidth'
+      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({ 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,90 +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 { 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';
-import { isNotFalsy } from '@dxos/util';
+  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 = ({ 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,
+          slots: { content: { className: '!pie-4' } },
         }),
-
-        // https://github.com/xiechao/lang-handlebars
-        new LanguageSupport(handlebarsLanguage, syntaxHighlighting(handlebarsHighlightStyle)),
-      ].filter(isNotFalsy),
+        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,27 +2,27 @@
 // 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 { 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}},
 `;
 
@@ -30,33 +30,46 @@ 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 }),
+      }),
+    );
   });
 
+  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 id={blueprint.id} template={blueprint.instructions} />
+    <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,30 +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 = ({ id, 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>
@@ -35,7 +71,9 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
               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>
@@ -53,9 +91,7 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
               <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>
@@ -67,6 +103,7 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
                           </Select.Option>
                         ))}
                       </Select.Viewport>
+                      <Select.Arrow />
                     </Select.Content>
                   </Select.Portal>
                 </Select.Root>
@@ -80,9 +117,7 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
                         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>
@@ -134,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]));
 
@@ -159,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]);
 };