@dxos/plugin-assistant 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/src/templates/research-brief.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type AutomationCapabilities } from '@dxos/plugin-automation';
+
+import { makeScheduledRoutineAutomation } from './scaffold';
+
+/** The research blueprint drives the brief; web-search, markdown, and database tools support it. */
+const BLUEPRINT_KEYS = [
+  'org.dxos.blueprint.research',
+  'org.dxos.blueprint.webSearch',
+  'org.dxos.blueprint.markdown',
+  'org.dxos.blueprint.database',
+] as const;
+
+/** Runs weekly by default; the user edits the schedule and the topic by opening the trigger and routine. */
+const DEFAULT_CRON = '0 9 * * 1';
+
+const DEFAULT_INSTRUCTIONS = `\
+Research the topic below and write a concise brief to a new markdown document.
+
+Topic: (replace with the topic you want tracked)
+
+Gather current information with the web-search and research tools. Summarize the key developments, link the
+sources you used, and create a markdown document titled with the topic and the current date.
+`;
+
+export const researchBrief: AutomationCapabilities.Template = {
+  id: 'org.dxos.automation.researchBrief',
+  label: 'Research Brief',
+  icon: 'ph--newspaper--regular',
+  scaffold: ({ name }) =>
+    makeScheduledRoutineAutomation({
+      name: name ?? 'Research Brief',
+      instructions: DEFAULT_INSTRUCTIONS,
+      blueprintKeys: BLUEPRINT_KEYS,
+      cron: DEFAULT_CRON,
+    }),
+};

package/src/templates/scaffold.ts

@@ -0,0 +1,74 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { AgentPrompt } from '@dxos/assistant-toolkit';
+import { Blueprint, Operation, Routine, Trigger } from '@dxos/compute';
+import { Database, Filter, Obj, Ref } from '@dxos/echo';
+import { Automation } from '@dxos/plugin-automation';
+
+/** Registry key of the persisted AgentPrompt ("Run Routine") operation a routine trigger dispatches. */
+const AGENT_PROMPT_KEY = 'org.dxos.function.prompt';
+
+export type ScheduledRoutineOptions = {
+  name: string;
+  instructions: string;
+  blueprintKeys: readonly string[];
+  cron: string;
+};
+
+/**
+ * Scaffold a timer-driven automation: a Routine (instructions + blueprints) run by the shared AgentPrompt
+ * operation on a cron schedule. The trigger starts disabled so the user can review the schedule and
+ * instructions before activating, and is owned by the automation (cascade-deletes with it); the routine
+ * stays independent, since it is edited separately and may be reused.
+ */
+export const makeScheduledRoutineAutomation = ({
+  name,
+  instructions,
+  blueprintKeys,
+  cron,
+}: ScheduledRoutineOptions): Effect.Effect<Automation.Automation, Error, Database.Service> =>
+  Effect.gen(function* () {
+    const blueprints = blueprintKeys.map((key) => Ref.fromURI(Blueprint.registryURI(key)));
+    const routine = yield* Database.add(
+      Routine.make({
+        name,
+        instructions,
+        // No per-run input; the task lives in the instructions. Unknown (not Void) so the empty trigger
+        // input still validates.
+        input: Schema.Unknown,
+        output: Schema.Void,
+        blueprints,
+        context: [],
+      }),
+    );
+
+    // The trigger's `function` must reference an in-space PersistentOperation; reuse the space's AgentPrompt
+    // or persist it on first use.
+    const existingFns = yield* Database.query(
+      Filter.and(Filter.type(Operation.PersistentOperation), Filter.key(AGENT_PROMPT_KEY)),
+    ).run;
+    const agentPromptFn = existingFns[0] ?? (yield* Database.add(Operation.serialize(AgentPrompt)));
+
+    const trigger = yield* Database.add(
+      Obj.make(Trigger.Trigger, {
+        enabled: false,
+        function: Ref.make(agentPromptFn),
+        spec: Trigger.specTimer(cron),
+        input: { prompt: Ref.make(routine), input: {} },
+        concurrency: 1,
+      }),
+    );
+
+    const automation = Automation.make({
+      name,
+      runnable: Ref.make(agentPromptFn),
+      triggers: [Ref.make(trigger)],
+    });
+    Obj.setParent(trigger, automation);
+    return automation;
+  });