@dxos/plugin-routine 0.0.0

package/src/components/Schedule/types.ts

@@ -0,0 +1,124 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+export const MinutelySpec = Schema.Struct({
+  frequency: Schema.Literal('minutely').annotations({ title: 'Frequency' }),
+  interval: Schema.Number.pipe(Schema.int(), Schema.between(1, 59)).annotations({
+    title: 'Every (minutes)',
+    description: '1–59',
+  }),
+});
+
+export const HourlySpec = Schema.Struct({
+  frequency: Schema.Literal('hourly').annotations({ title: 'Frequency' }),
+  interval: Schema.Number.pipe(Schema.int(), Schema.between(1, 23)).annotations({
+    title: 'Every (hours)',
+    description: '1–23',
+  }),
+  minute: Schema.Number.pipe(Schema.int(), Schema.between(0, 59)).annotations({
+    title: 'At minute',
+    description: '0–59',
+  }),
+});
+
+export const DailySpec = Schema.Struct({
+  frequency: Schema.Literal('daily').annotations({ title: 'Frequency' }),
+  hour: Schema.Number.pipe(Schema.int(), Schema.between(0, 23)).annotations({
+    title: 'Hour',
+    description: '0–23',
+  }),
+  minute: Schema.Number.pipe(Schema.int(), Schema.between(0, 59)).annotations({
+    title: 'Minute',
+    description: '0–59',
+  }),
+});
+
+// Named day-of-week literals for UX clarity; cron.ts maps them to numeric DOW values.
+export const DayOfWeek = Schema.Literal('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
+export type DayOfWeek = Schema.Schema.Type<typeof DayOfWeek>;
+
+export const WeeklySpec = Schema.Struct({
+  frequency: Schema.Literal('weekly').annotations({ title: 'Frequency' }),
+  daysOfWeek: Schema.Array(DayOfWeek.annotations({ title: 'Day' })).annotations({ title: 'Days of week' }),
+  hour: Schema.Number.pipe(Schema.int(), Schema.between(0, 23)).annotations({
+    title: 'Hour',
+    description: '0–23',
+  }),
+  minute: Schema.Number.pipe(Schema.int(), Schema.between(0, 59)).annotations({
+    title: 'Minute',
+    description: '0–59',
+  }),
+});
+
+export const MonthlySpec = Schema.Struct({
+  frequency: Schema.Literal('monthly').annotations({ title: 'Frequency' }),
+  daysOfMonth: Schema.Array(
+    Schema.Number.pipe(Schema.int(), Schema.between(1, 31)).annotations({ title: 'Day' }),
+  ).annotations({
+    title: 'Days of month',
+  }),
+  hour: Schema.Number.pipe(Schema.int(), Schema.between(0, 23)).annotations({
+    title: 'Hour',
+    description: '0–23',
+  }),
+  minute: Schema.Number.pipe(Schema.int(), Schema.between(0, 59)).annotations({
+    title: 'Minute',
+    description: '0–59',
+  }),
+});
+
+export const CustomSpec = Schema.Struct({
+  frequency: Schema.Literal('custom').annotations({ title: 'Frequency' }),
+  cronExpression: Schema.String.annotations({
+    title: 'Cron expression',
+    description: 'e.g. 0 9 * * MON-FRI',
+  }),
+});
+
+export const CronSpec = Schema.Union(
+  MinutelySpec,
+  HourlySpec,
+  DailySpec,
+  WeeklySpec,
+  MonthlySpec,
+  CustomSpec,
+).annotations({ title: '' });
+
+export type CronSpecType = Schema.Schema.Type<typeof CronSpec>;
+export type Frequency = CronSpecType['frequency'];
+
+export const FrequencyDefaults: { [K in Frequency]: Extract<CronSpecType, { frequency: K }> } = {
+  minutely: {
+    frequency: 'minutely',
+    interval: 15,
+  },
+  hourly: {
+    frequency: 'hourly',
+    interval: 1,
+    minute: 0,
+  },
+  daily: {
+    frequency: 'daily',
+    hour: 9,
+    minute: 0,
+  },
+  weekly: {
+    frequency: 'weekly',
+    daysOfWeek: ['mon'],
+    hour: 9,
+    minute: 0,
+  },
+  monthly: {
+    frequency: 'monthly',
+    daysOfMonth: [1],
+    hour: 9,
+    minute: 0,
+  },
+  custom: {
+    frequency: 'custom',
+    cronExpression: '* * * * *',
+  },
+};

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

@@ -0,0 +1,93 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useState } from 'react';
+
+import { createSystemPrompt } from '@dxos/assistant';
+import { Skill, Template } from '@dxos/compute';
+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 { TemplateEditor, type TemplateEditorProps } from './TemplateEditor';
+
+const FENCE = '```';
+
+const TEMPLATE = trim`
+  {{! System Prompt }}
+  
+  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}}
+  {{/each}}
+
+  Reponse in the format: <suggestion>SUGGESTION</suggestion>
+
+  @echo://B6INSIBY3CBEF4M5VZRYBCMAHQMPYK5AJ/01K24XPK464FSCKVQJAB2H662M
+
+  ---
+
+  ${FENCE}ts
+  const x = 100;
+  ${FENCE}
+
+  {{input}}
+`;
+
+const DefaultStory = ({ source }: TemplateEditorProps & { source: string }) => {
+  const client = useClient();
+  const [skill] = useState(() => {
+    const space = client.spaces.get()[0];
+    return space.db.add(
+      Skill.make({
+        key: 'com.example.skill.test',
+        name: 'Test',
+        instructions: Template.make({ source }),
+      }),
+    );
+  });
+
+  return <TemplateEditor classNames='dx-document bg-base-surface' id={skill.id} source={skill.instructions.source} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-routine/components/TemplateEditor',
+  component: TemplateEditor as any,
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withClientProvider({
+      types: [Skill.Skill],
+      createIdentity: true,
+      createSpace: true,
+    }),
+  ],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    source: TEMPLATE,
+  },
+};
+
+export const System: Story = {
+  args: {
+    source: createSystemPrompt({}),
+  },
+};

package/src/components/TemplateEditor/TemplateEditor.tsx

@@ -0,0 +1,77 @@
+//
+// 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 { Doc } from '@dxos/echo-doc';
+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: Doc.createAccessor(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

@@ -0,0 +1,76 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta } from '@storybook/react-vite';
+import React, { useCallback, useState } from 'react';
+
+import { Skill, 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 [skill] = useState(() => {
+    const space = client.spaces.get()[0];
+    invariant(space, 'TemplateForm story requires at least one space');
+    return space.db.add(
+      Skill.make({
+        key: 'com.example.skill.test',
+        name: 'Test',
+        instructions: Template.make({ source: TEMPLATE }),
+      }),
+    );
+  });
+
+  const handleChange: TemplateChangeCallback = useCallback(
+    (mutate) => {
+      Obj.update(skill, (skill) => mutate(skill.instructions));
+    },
+    [skill],
+  );
+
+  return <TemplateForm id={skill.id} template={skill.instructions} onChange={handleChange} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-routine/components/TemplateForm',
+  component: TemplateForm,
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withClientProvider({
+      types: [Skill.Skill],
+      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

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