@dxos/plugin-assistant 0.9.1-main.c7dcc2e112 → 0.10.0

package/src/components/TemplateEditor/TemplateEditor.tsx

@@ -1,80 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defaultHighlightStyle, syntaxHighlighting } from '@codemirror/language';
-import { composeRefs } from '@radix-ui/react-compose-refs';
-import React from 'react';
-
-import { type Ref } from '@dxos/echo';
-import { createDocAccessor } from '@dxos/echo-client';
-import { useThemeContext, useTranslation } from '@dxos/react-ui';
-import { composable, composableProps } from '@dxos/react-ui';
-import { useTextEditor } from '@dxos/react-ui-editor';
-import { type Text } from '@dxos/schema';
-import {
-  createBasicExtensions,
-  createDataExtensions,
-  createMarkdownExtensions,
-  createThemeExtensions,
-  decorateMarkdown,
-} from '@dxos/ui-editor';
-import { isNonNullable } from '@dxos/util';
-
-import { meta } from '#meta';
-
-import { handlebars, xmlDecorator } from './extensions';
-
-export type TemplateEditorProps = {
-  id: string;
-  /** Markdown + Handlebars source text. */
-  source?: Ref.Ref<Text.Text>;
-  lineNumbers?: boolean;
-};
-
-export const TemplateEditor = composable<HTMLDivElement, TemplateEditorProps>(
-  ({ classNames, id, source, lineNumbers = true, ...props }, forwardedRef) => {
-    const { t } = useTranslation(meta.profile.key);
-    const { themeMode } = useThemeContext();
-    const { parentRef } = useTextEditor(() => {
-      const target = 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, 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

@@ -1,76 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta } from '@storybook/react-vite';
-import React, { useCallback, useState } from 'react';
-
-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 { 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.get()[0];
-    invariant(space, 'TemplateForm story requires at least one space');
-    return space.db.add(
-      Blueprint.make({
-        key: 'com.example.blueprint.test',
-        name: 'Test',
-        instructions: Template.make({ source: TEMPLATE }),
-      }),
-    );
-  });
-
-  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/components/TemplateForm',
-  component: TemplateForm,
-  render: DefaultStory,
-  decorators: [
-    withTheme(),
-    withLayout({ layout: 'column' }),
-    withClientProvider({
-      types: [Blueprint.Blueprint],
-      createIdentity: true,
-      createSpace: true,
-    }),
-  ],
-  parameters: {
-    translations,
-  },
-} satisfies Meta<typeof TemplateForm>;
-
-export default meta;
-
-type Story = Meta<typeof TemplateForm>;
-
-export const Default: Story = {};

package/src/components/TemplateEditor/TemplateForm.tsx

@@ -1,204 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-import React, { Fragment, useCallback, useEffect } from 'react';
-
-import { type Template } from '@dxos/compute';
-import { type Obj } from '@dxos/echo';
-import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { isNonNullable } from '@dxos/util';
-
-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>;
-  /**
-   * 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, onChange }: TemplateFormProps) => {
-  const { t } = useTranslation(meta.profile.key);
-  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],
-  );
-
-  const handleInputDefaultChange = useCallback(
-    (inputName: string, value: string) => {
-      onChange?.((draft) => {
-        const input = draft.inputs?.find((i) => i?.name === inputName);
-        if (input) {
-          input.default = value;
-        }
-      });
-    },
-    [onChange],
-  );
-
-  return (
-    <div className='flex flex-col w-full overflow-hidden gap-4'>
-      <TemplateEditor id={id} source={template.source} 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='ps-3 text-blue-text'>{input.name}</div>
-
-              <Input.Root>
-                <Select.Root
-                  value={input.kind}
-                  onValueChange={(kind) => handleInputKindChange(input.name, kind as Template.InputKind)}
-                >
-                  <Select.TriggerButton placeholder='Type' classNames='w-full' />
-                  <Select.Portal>
-                    <Select.Content>
-                      <Select.Viewport>
-                        {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.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>
-          ))}
-        </div>
-      )}
-    </div>
-  );
-};
-
-// TODO(burdon): Translations.
-const inputs: { kind: Template.InputKind; label: string }[] = [
-  {
-    kind: 'value',
-    label: 'Value',
-  },
-  {
-    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, onChange?: TemplateChangeCallback) => {
-  useEffect(() => {
-    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]));
-
-    // Create map of unclaimed inputs.
-    const unclaimed = new Map<string, Template.Input>(
-      template.inputs?.filter(isNonNullable).map((input) => [input.name, input]),
-    );
-    const missing: string[] = [];
-    Array.from(variables.values()).forEach((name) => {
-      if (unclaimed.has(name)) {
-        unclaimed.delete(name);
-      } else {
-        missing.push(name);
-      }
-    });
-
-    // Match or create new inputs.
-    const values = unclaimed.values();
-    onChange((draft) => {
-      if (!draft.inputs) {
-        draft.inputs = [];
-      }
-
-      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]);
-};

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

@@ -1,274 +0,0 @@
-//
-// 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,
-
-  // @echo://space/id or @dxn:nsid
-  dxn: /@?(?:echo:\/{1,3}[\w/]+|dxn:[\w.-]+)/g,
-
-  // example.com/path/xxx
-  url: /[\w.-]+\.[\w.-]+\/[\w/]+/g,
-};
-
-const tagPadding = 'mx-0.5 px-1 rounded-xs';
-
-/**
- * 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-green-text' }),
-              });
-              end = idx;
-            }
-            decorations.push({
-              from: start,
-              to: end,
-              decoration: Decoration.mark({ class: 'text-blue-text' }),
-            });
-          }
-        }
-
-        // 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-green-text' }),
-            });
-          }
-        }
-      }
-
-      // 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

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

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

@@ -1,64 +0,0 @@
-//
-// 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,
-  },
-);