@dxos/plugin-assistant 0.8.4-main.ead640a → 0.8.4-main.effb148878

package/src/components/TemplateEditor/TemplateEditor.tsx

@@ -2,61 +2,77 @@
 // Copyright 2025 DXOS.org
 //
 
-import { xml } from '@codemirror/lang-xml';
 import { defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
+import { composeRefs } from '@radix-ui/react-compose-refs';
 import React from 'react';
 
-import { type Template } from '@dxos/blueprints';
-import { createDocAccessor } from '@dxos/react-client/echo';
-import { type ThemedClassName, useThemeContext, useTranslation } from '@dxos/react-ui';
+import { type Template } from '@dxos/compute';
+import { createDocAccessor } from '@dxos/echo-db';
+import { useThemeContext, useTranslation } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/react-ui';
+import { useTextEditor } from '@dxos/react-ui-editor';
 import {
   createBasicExtensions,
   createDataExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   decorateMarkdown,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { mx } from '@dxos/react-ui-theme';
+} from '@dxos/ui-editor';
 import { isNonNullable } from '@dxos/util';
 
-import { meta } from '../../meta';
+import { meta } from '#meta';
 
-import { handlebars } from './handlebars-extension';
+import { handlebars, xmlDecorator } from './extensions';
 
-export type TemplateEditorProps = ThemedClassName<{
+export type TemplateEditorProps = {
   id: string;
   template: Template.Template;
-}>;
-
-export const TemplateEditor = ({ id, classNames, template }: TemplateEditorProps) => {
-  const { t } = useTranslation(meta.id);
-  const { themeMode } = useThemeContext();
-  const { parentRef } = useTextEditor(() => {
-    const text = template.source?.target;
-    if (!text) {
-      return {};
-    }
-
-    return {
-      initialValue: text.content ?? '',
-      extensions: [
-        createDataExtensions({ id, text: createDocAccessor(text, ['content']) }),
-        createBasicExtensions({
-          bracketMatching: false,
-          lineNumbers: true,
-          lineWrapping: true,
-          placeholder: t('template placeholder'),
-        }),
-        createThemeExtensions({ themeMode }),
-        createMarkdownExtensions(),
-        decorateMarkdown(), // TODO(burdon): Move into bundle.
-        xml(),
-        handlebars(),
-        syntaxHighlighting(defaultHighlightStyle),
-      ].filter(isNonNullable),
-    };
-  }, [themeMode, template.source?.target]);
-
-  return <div ref={parentRef} className={mx('bs-full overflow-hidden', classNames)} />;
+  lineNumbers?: boolean;
 };
+
+export const TemplateEditor = composable<HTMLDivElement, TemplateEditorProps>(
+  ({ classNames, id, template, lineNumbers = true, ...props }, forwardedRef) => {
+    const { t } = useTranslation(meta.id);
+    const { themeMode } = useThemeContext();
+    const { parentRef } = useTextEditor(() => {
+      const target = template.source?.target;
+      if (!target) {
+        return {};
+      }
+
+      return {
+        initialValue: target.content ?? '',
+        extensions: [
+          createDataExtensions({
+            id,
+            text: createDocAccessor(target, ['content']),
+          }),
+          createBasicExtensions({
+            bracketMatching: false,
+            lineNumbers,
+            lineWrapping: true,
+            placeholder: t('template.placeholder'),
+          }),
+          createThemeExtensions({ themeMode }),
+          createMarkdownExtensions(),
+          decorateMarkdown(),
+          handlebars(),
+          // xml(),
+          // NOTE: Since we're using markdown only HTML nodes are parsed.
+          xmlDecorator(),
+          syntaxHighlighting(defaultHighlightStyle),
+        ].filter(isNonNullable),
+      };
+    }, [themeMode, template.source?.target, lineNumbers]);
+
+    return (
+      <div
+        {...composableProps(props, {
+          role: 'none',
+          classNames: ['h-full overflow-hidden', classNames],
+        })}
+        ref={composeRefs(parentRef, forwardedRef)}
+      />
+    );
+  },
+);

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

@@ -3,55 +3,61 @@
 //
 
 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 { Blueprint, Template } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
 import { useClient } from '@dxos/react-client';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { withLayout, withTheme } from '@dxos/react-ui/testing';
 import { trim } from '@dxos/util';
 
-import { translations } from '../../translations';
+import { translations } from '#translations';
 
-import { TemplateForm } from './TemplateForm';
+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 [blueprint] = useState(() => {
-    const space = client.spaces.default;
+    const space = client.spaces.get()[0];
+    invariant(space, 'TemplateForm story requires at least one space');
     return space.db.add(
       Blueprint.make({
-        key: 'example.com/blueprint/test',
+        key: 'com.example.blueprint.test',
         name: 'Test',
         instructions: Template.make({ source: TEMPLATE }),
       }),
     );
   });
 
-  return (
-    <div role='none' className='flex w-[40rem] border border-separator overflow-hidden'>
-      <TemplateForm id={blueprint.id} template={blueprint.instructions} />
-    </div>
+  const handleChange: TemplateChangeCallback = useCallback(
+    (mutate) => {
+      Obj.update(blueprint, (blueprint) => mutate(blueprint.instructions));
+    },
+    [blueprint],
   );
+
+  return <TemplateForm id={blueprint.id} template={blueprint.instructions} onChange={handleChange} />;
 };
 
 const meta = {
-  title: 'plugins/plugin-assistant/TemplateForm',
+  title: 'plugins/plugin-assistant/components/TemplateForm',
   component: TemplateForm,
   render: DefaultStory,
   decorators: [
-    withTheme,
-    withLayout({ container: 'column' }),
+    withTheme(),
+    withLayout({ layout: 'column' }),
     withClientProvider({
       types: [Blueprint.Blueprint],
       createIdentity: true,

package/src/components/TemplateEditor/TemplateForm.tsx

@@ -3,62 +3,77 @@
 //
 
 import type * as Schema from 'effect/Schema';
-import React, { Fragment, useEffect } from 'react';
+import React, { Fragment, useCallback, useEffect } from 'react';
 
-import { type Template } from '@dxos/blueprints';
+import { type Template } from '@dxos/compute';
+import { type Obj } from '@dxos/echo';
 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 { meta } from '#meta';
 
 import { TemplateEditor } from './TemplateEditor';
 
+/**
+ * Callback type for mutating template within a parent object's Obj.update 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.update.
+   * If not provided, the component is read-only.
+   */
+  onChange?: TemplateChangeCallback;
 };
 
-export const TemplateForm = ({ id, template, commandEditable = true }: TemplateFormProps) => {
+export const TemplateForm = ({ id, template, onChange }: TemplateFormProps) => {
   const { t } = useTranslation(meta.id);
-  usePromptInputs(template);
+  usePromptInputs(template, onChange);
+
+  const handleInputKindChange = useCallback(
+    (inputName: string, kind: Template.InputKind) => {
+      onChange?.((draft) => {
+        const input = draft.inputs?.find((i) => i?.name === inputName);
+        if (input) {
+          input.kind = kind;
+        }
+      });
+    },
+    [onChange],
+  );
 
-  return (
-    <div className={mx('flex flex-col w-full overflow-hidden gap-4', groupBorder)}>
-      {/* {commandEditable && (
-        <div className='flex items-center pl-4'>
-          <span className='text-neutral-500'>/</span>
-          <Input.Root>
-            <Input.TextInput
-              placeholder={t('command placeholder')}
-              classNames='is-full bg-transparent m-2'
-              value={template.command ?? ''}
-              onChange={(event) => {
-                template.command = event.target.value.replace(/\w/g, '');
-              }}
-            />
-          </Input.Root>
-        </div>
-      )} */}
+  const handleInputDefaultChange = useCallback(
+    (inputName: string, value: string) => {
+      onChange?.((draft) => {
+        const input = draft.inputs?.find((i) => i?.name === inputName);
+        if (input) {
+          input.default = value;
+        }
+      });
+    },
+    [onChange],
+  );
 
-      <TemplateEditor id={id} template={template} classNames={[attentionSurface, 'min-h-[120px]']} />
+  return (
+    <div className='flex flex-col w-full overflow-hidden gap-4'>
+      <TemplateEditor id={id} template={template} classNames='bg-base-surface min-h-[120px]' />
 
       {(template.inputs?.length ?? 0) > 0 && (
         <div className='grid grid-cols-[10rem_10rem_1fr] gap-1 items-center'>
           {template.inputs?.filter(isNonNullable).map((input) => (
             <Fragment key={input.name}>
-              <div className='pis-3 text-blueText'>{input.name}</div>
+              <div className='ps-3 text-blue-text'>{input.name}</div>
 
               <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.TriggerButton placeholder='Type' classNames='w-full' />
                   <Select.Portal>
                     <Select.Content>
                       <Select.Viewport>
@@ -75,19 +90,15 @@ export const TemplateForm = ({ id, template, commandEditable = true }: TemplateF
               </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>
+                {input.kind === 'value' && (
+                  <Input.Root>
+                    <Input.TextInput
+                      placeholder={t('command.placeholder')}
+                      classNames='w-full bg-transparent'
+                      value={input.default ?? ''}
+                      onChange={(event) => handleInputDefaultChange(input.name, event.target.value)}
+                    />
+                  </Input.Root>
                 )}
               </div>
             </Fragment>
@@ -105,44 +116,45 @@ const inputs: { kind: Template.InputKind; label: string }[] = [
     label: 'Value',
   },
   {
-    kind: 'pass-through',
-    label: 'Pass through',
-  },
-  {
-    kind: 'retriever',
-    label: 'Retriever',
-  },
-  {
-    kind: 'function',
-    label: 'Function',
-  },
-  {
-    kind: 'query',
-    label: 'Query',
-  },
-  {
-    kind: 'resolver',
-    label: 'Resolver',
-  },
-  {
-    kind: 'context',
-    label: 'Context',
-  },
-  {
-    kind: 'schema',
-    label: 'Schema',
+    kind: 'operation',
+    label: 'Operation',
   },
+  // {
+  //   kind: 'pass-through',
+  //   label: 'Pass through',
+  // },
+  // {
+  //   kind: 'retriever',
+  //   label: 'Retriever',
+  // },
+  // {
+  //   kind: 'query',
+  //   label: 'Query',
+  // },
+  // {
+  //   kind: 'resolver',
+  //   label: 'Resolver',
+  // },
+  // {
+  //   kind: 'context',
+  //   label: 'Context',
+  // },
+  // {
+  //   kind: 'schema',
+  //   label: 'Schema',
+  // },
 ];
 
 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]));
 
@@ -161,19 +173,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((draft) => {
+      if (!draft.inputs) {
+        draft.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 = draft.inputs!.findIndex((i) => i?.name === next.name);
+          if (inputIndex !== -1) {
+            draft.inputs![inputIndex].name = name;
+          }
+        } else {
+          draft.inputs!.push({ name, kind: 'value' });
+        }
+      });
+
+      // 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 = draft.inputs!.findIndex((i) => i?.name === input.name);
+        if (inputIndex !== -1) {
+          draft.inputs!.splice(inputIndex, 1);
+        }
+      }
+    });
+  }, [template.source, onChange]);
 };