@skaile/forge-app-actions 0.0.0-stage → 0.2.0

package/src/runtime/composables/defineForgeAction.ts

@@ -0,0 +1,278 @@
+/**
+ * `defineForgeAction` — one declaration for Cmd+K and the agent.
+ *
+ * Spec: `docs/superpowers/specs/2026-08-22-forge-app-channel-design.md` §2.3,
+ * which adopts the platform's rule verbatim — *"All user-facing functionality is
+ * a command-palette action; register it so it is discoverable via Cmd+K **and**
+ * usable by the AI agent"*.
+ *
+ * ```ts
+ * export const openFile = defineForgeAction({
+ *   id: "workspace.open_file",           // → capability `app.workspace.open_file`
+ *   label: "Open file…",
+ *   description: "Open a file in the user's file viewer.",
+ *   input: z.object({ path: z.string().min(1) }),
+ *   arg: { placeholder: "path/to/file", toInput: (path) => ({ path }) },
+ *   run: async ({ path }) => { await useFileViewer().openFile(path); return { opened: true, path } },
+ * })
+ * ```
+ *
+ * `audience` defaults to `['user', 'llm']`. That default is the whole point:
+ * a new UI feature is agent-controllable unless its author opts out, instead of
+ * agent-controllability being a bespoke per-feature integration.
+ *
+ * ## No third registry
+ *
+ * This does not store anything. It *projects* one declaration into the two
+ * registries forge already had — `useCommandPalette()` (idempotent by id) and
+ * `useAgentCapabilities()` (idempotent by name) — and `useForgeActions()`
+ * writes through to both. Those remain the single sources of truth for "what is
+ * in the palette" and "what may the agent call", so nothing can drift.
+ *
+ * ## The id/name seam
+ *
+ * The palette has always used bare ids (`workspace.open_file`); the platform
+ * **rejects** capability registrations outside the `app.` namespace (spec §2.2).
+ * The rule is therefore: **author the palette id, and the capability name is
+ * `app.<id>`.** An id that already carries the prefix is a mistake and throws,
+ * because otherwise `app.app.workspace.open_file` would ship silently.
+ */
+
+import * as z from "zod";
+import type { ClientCapabilityContext, ClientCapabilityLogger } from "../types/client-capability";
+import type { PaletteAction } from "../types/command-palette";
+import type {
+  DefineForgeActionArgs,
+  ForgeAction,
+  ForgeActionAudience,
+  ForgeActionContext,
+} from "../types/forge-action";
+import { defineClientCapability, deprecatedClientCapabilityAlias } from "./defineClientCapability";
+import { useAgentCapabilities } from "./useAgentCapabilities";
+import { useCommandPalette } from "./useCommandPalette";
+
+/** The default when `audience` is omitted: reachable from both surfaces. */
+export const DEFAULT_FORGE_ACTION_AUDIENCE: ForgeActionAudience[] = ["user", "llm"];
+
+/** `<sector>.<verb>`, lowercase — what the derived `app.` name has to look like. */
+const ID_PATTERN = /^[a-z0-9][a-z0-9_-]*(?:\.[a-z0-9][a-z0-9_-]*)+$/;
+
+const defaultLog: ClientCapabilityLogger = {
+  info: (message, ...args) => console.log(message, ...args),
+  warn: (message, ...args) => console.warn(message, ...args),
+  error: (message, ...args) => console.error(message, ...args),
+};
+
+function fail(id: string, message: string): never {
+  throw new Error(`[defineForgeAction] ${id}: ${message}`);
+}
+
+/**
+ * Build a {@link ForgeAction} from one declaration.
+ *
+ * Throws — at define time, i.e. on the first import in dev — for the four
+ * declarations that could only fail later and further away:
+ *  - an `id` that already starts with `app.` (see the id/name seam above),
+ *  - an llm-audience action with no `description` (the model reads nothing),
+ *  - an llm-audience `id` that is not `<sector>.<verb>` (spec §2.2's namespace),
+ *  - a user-audience action whose input needs arguments but declares no `arg`
+ *    (a palette row that exists only to fail on Enter).
+ */
+export function defineForgeAction<T extends z.ZodType = z.ZodObject<Record<string, never>>>(
+  args: DefineForgeActionArgs<T>,
+): ForgeAction {
+  const { id } = args;
+  if (!id || id.trim().length === 0) fail("<empty>", "an action needs a non-empty id.");
+
+  const audience = args.audience ?? DEFAULT_FORGE_ACTION_AUDIENCE;
+  if (audience.length === 0) {
+    fail(id, "audience is empty — an action nobody can trigger is not an action.");
+  }
+  const forUser = audience.includes("user");
+  const forLlm = audience.includes("llm");
+
+  if (id.startsWith("app.")) {
+    fail(
+      id,
+      "the id is the PALETTE id and must not carry the `app.` prefix — it is added " +
+        `automatically to derive the capability name. Use "${id.slice(4)}".`,
+    );
+  }
+
+  const name = args.name ?? `app.${id}`;
+  if (forLlm) {
+    if (!args.description) {
+      fail(id, "an action with audience 'llm' must declare a description — the model reads it.");
+    }
+    if (!args.name && !ID_PATTERN.test(id)) {
+      fail(
+        id,
+        "an agent-visible id must be lowercase `<sector>.<verb>` (spec §2.2), so the " +
+          `derived capability name lands in the platform's \`app.\` namespace as \`app.${id}\`.`,
+      );
+    }
+    if (!name.startsWith("app.")) {
+      fail(
+        id,
+        `capability name "${name}" is outside the \`app.\` namespace, which the platform rejects.`,
+      );
+    }
+  }
+
+  const inputZod: z.ZodType = args.input ?? z.object({});
+
+  // A palette row must be runnable with what the palette can collect. Either
+  // the schema accepts `{}` (no arguments) or the author declared how to get the
+  // one string it needs. Anything else is a row that only ever throws.
+  const acceptsNoArgs = inputZod.safeParse({}).success;
+  if (forUser && !acceptsNoArgs && !args.arg) {
+    fail(
+      id,
+      "the input schema requires arguments but no `arg` was declared, so the Cmd+K entry " +
+        "could never run. Declare `arg: { placeholder, toInput }` (and optionally `options` " +
+        "for a picker), or narrow the audience to ['llm'].",
+    );
+  }
+
+  async function run(rawInput?: unknown, ctxIn?: Partial<ForgeActionContext>): Promise<unknown> {
+    const parsed = inputZod.parse(rawInput ?? {});
+    const ctx: ForgeActionContext = {
+      source: ctxIn?.source ?? "user",
+      name: ctxIn?.name ?? name,
+      sessionKey: ctxIn?.sessionKey ?? "",
+      callId: ctxIn?.callId,
+      log: ctxIn?.log ?? defaultLog,
+    };
+    return await args.run(parsed as z.infer<T>, ctx);
+  }
+
+  // ── The Cmd+K projection ────────────────────────────────────────────────
+  let paletteAction: PaletteAction | undefined;
+  if (forUser) {
+    paletteAction = {
+      id,
+      label: args.label,
+      // The model's description is written to be exhaustive; a palette row is
+      // one line. `hint` is where an action visible on both surfaces says the
+      // short version.
+      description: args.hint ?? args.description,
+      icon: args.icon,
+      keywords: args.keywords,
+      group: args.group,
+      // `arg` carries `toInput`, which is this module's business, not the
+      // palette's — project down to the prompt half the component consumes.
+      arg: args.arg
+        ? {
+            label: args.arg.label,
+            placeholder: args.arg.placeholder,
+            options: args.arg.options,
+            allowCustom: args.arg.allowCustom,
+          }
+        : undefined,
+      handler: async (value?: string) => {
+        const input = args.arg ? args.arg.toInput(value ?? "") : {};
+        // `requiresApproval` deliberately does NOT gate this path: the user is
+        // the actor here, and asking them to confirm the thing they just chose
+        // from Cmd+K is a dialog with no information in it. The gate exists for
+        // invocations the user did not initiate (spec §L7).
+        await run(input, { source: "user" });
+      },
+    };
+  }
+
+  // ── The agent projection ────────────────────────────────────────────────
+  const capability = forLlm
+    ? defineClientCapability({
+        name,
+        displayName: args.label,
+        description: args.description as string,
+        input: inputZod,
+        output: args.output,
+        kind: args.kind,
+        audience,
+        scope: args.scope,
+        requiresApproval: args.requiresApproval,
+        promptFragment: args.promptFragment,
+        callTimeoutMs: args.callTimeoutMs,
+        render: args.render,
+        // Input arrives already parsed by `useCapabilityInvocations`; re-parsing
+        // here would only pay the cost twice.
+        handler: async (input: unknown, capCtx: ClientCapabilityContext) =>
+          await args.run(input as z.infer<T>, {
+            source: "llm",
+            name: capCtx.name,
+            sessionKey: capCtx.sessionKey,
+            callId: capCtx.callId,
+            log: capCtx.log,
+          }),
+      })
+    : undefined;
+
+  const aliases =
+    capability && args.deprecatedNames
+      ? args.deprecatedNames.map((old) => deprecatedClientCapabilityAlias(capability, old))
+      : [];
+
+  return {
+    id,
+    name,
+    label: args.label,
+    audience,
+    inputZod,
+    paletteAction,
+    capability,
+    aliases,
+    run,
+  };
+}
+
+export interface UseForgeActionsReturn {
+  /**
+   * Write one action through to the registries its audience names. Idempotent:
+   * the palette replaces by id and the capability registry replaces by name,
+   * exactly as they already did, so re-registering on HMR or a remount is a
+   * no-op rather than a duplicate.
+   */
+  register(action: ForgeAction): ForgeAction;
+  /** Register several, in order. */
+  registerAll(actions: ForgeAction[]): void;
+  /**
+   * Remove an action from both registries, aliases included. Takes the action
+   * itself rather than an id — the aliases it owns cannot be derived from one.
+   */
+  unregister(action: ForgeAction): void;
+}
+
+/**
+ * Register forge actions into the palette and the agent capability registry.
+ *
+ * ```ts
+ * export default defineNuxtPlugin(() => {
+ *   useForgeActions().registerAll([openFile, toggleSidebar])
+ *   // then announce upward once — see the app-channel wiring
+ * })
+ * ```
+ */
+export function useForgeActions(): UseForgeActionsReturn {
+  const palette = useCommandPalette();
+  const capabilities = useAgentCapabilities();
+
+  function register(action: ForgeAction): ForgeAction {
+    if (action.paletteAction) palette.registerAction(action.paletteAction);
+    if (action.capability) capabilities.register(action.capability);
+    for (const alias of action.aliases) capabilities.register(alias);
+    return action;
+  }
+
+  function registerAll(actions: ForgeAction[]): void {
+    for (const action of actions) register(action);
+  }
+
+  function unregister(action: ForgeAction): void {
+    palette.unregisterAction(action.id);
+    capabilities.unregister(action.name);
+    for (const alias of action.aliases) capabilities.unregister(alias.name);
+  }
+
+  return { register, registerAll, unregister };
+}

package/src/runtime/composables/useAgentCapabilities.ts

@@ -0,0 +1,215 @@
+import { type ShallowRef, shallowRef } from "vue";
+import type {
+  ClientCapabilityAnnouncement,
+  ClientCapabilityDescriptor,
+  DefinedClientCapability,
+} from "../types/client-capability";
+
+// ── Module-level singleton ─────────────────────────────────────────────────
+// Survives component unmounts — same pattern as useCommandPalette / capabilityRegistry.
+//
+// `shallowRef`, not `ref`, deliberately: a DefinedClientCapability holds live
+// Zod schemas and a handler closure. Vue's deep reactive proxy would wrap the
+// Zod instances, and zod v4's internal private fields do not survive being
+// read through a Proxy — `inputZod.parse()` (ticket 04) would break. Only the
+// array identity needs to be reactive, so a shallow ref is both correct and
+// cheaper.
+const _capabilities = shallowRef<DefinedClientCapability[]>([]);
+
+/**
+ * Stable per-tab token, minted once per browser context. The bridge records it
+ * as the announcing session's owner, which is what spec §L4's last-writer-wins
+ * routing compares (implemented in ticket 05).
+ */
+const _subscriberId = mintSubscriberId();
+
+function mintSubscriberId(): string {
+  const c = (globalThis as { crypto?: { randomUUID?: () => string } }).crypto;
+  if (typeof c?.randomUUID === "function") return c.randomUUID();
+  return `sub-${Math.random().toString(36).slice(2)}${Date.now().toString(36)}`;
+}
+
+// ── Public API types ───────────────────────────────────────────────────────
+
+/** Minimal `fetch` shape the announce transport needs. Injectable for tests. */
+export type CapabilityAnnounceFetcher = (
+  url: string,
+  init: { method: string; headers: Record<string, string>; body: string },
+) => Promise<{ ok: boolean; status: number }>;
+
+export interface AnnounceOptions {
+  /**
+   * The upward POST endpoint, e.g. `/api/agent/capabilities`. The consuming app
+   * owns this route (spec §2) — forge-app-actions never assumes a path.
+   */
+  endpoint: string;
+  /**
+   * Extra fields merged into the JSON body. This is where the app supplies
+   * whatever identifies the session to its own route — a single-session app
+   * sends nothing; a multi-user app would send the parts of its
+   * `userId:slug:mode` key. Never send the derived key from the browser if the
+   * server can derive it itself.
+   */
+  body?: Record<string, unknown>;
+  /** Override the fetcher. Defaults to `globalThis.fetch`. */
+  fetcher?: CapabilityAnnounceFetcher;
+}
+
+export interface AnnounceResult {
+  ok: boolean;
+  /** How many capability descriptors were sent. `0` for a withdrawal. */
+  sent: number;
+  /** Present when `ok` is false. */
+  error?: string;
+}
+
+export interface UseAgentCapabilitiesReturn {
+  /** Register a capability. Idempotent by name — replaces an existing entry. */
+  register(capability: DefinedClientCapability): void;
+  /** Register several at once. Idempotent by name, in order. */
+  registerAll(capabilities: DefinedClientCapability[]): void;
+  /** Remove a previously registered capability. No-op if the name is unknown. */
+  unregister(name: string): void;
+  /** Look up one registered capability by name. */
+  get(name: string): DefinedClientCapability | undefined;
+  /** Snapshot of every registered capability (schemas and handlers included). */
+  list(): DefinedClientCapability[];
+  /** The JSON-serialisable projection announced upward. */
+  toWire(): ClientCapabilityDescriptor[];
+  /** Reactive list of registered capabilities. */
+  capabilities: Readonly<ShallowRef<DefinedClientCapability[]>>;
+  /** Stable per-tab token sent with every announcement. */
+  subscriberId: string;
+  /**
+   * POST the whole registry upward. Announcements are never deltas — the bridge
+   * replaces its stored list, so a reconnect re-announce is naturally idempotent
+   * (spec §L5).
+   *
+   * Never throws: a failed announce logs a warning and returns `ok: false`, so a
+   * dead route cannot break app mount.
+   */
+  announce(options: AnnounceOptions): Promise<AnnounceResult>;
+  /**
+   * POST an empty registry upward — the explicit withdrawal seam for spec §L1's
+   * "no browser, no capability". Ticket 05 adds the SSE-disconnect grace period
+   * that calls this from the server side; this is the voluntary client-side path.
+   */
+  withdraw(options: AnnounceOptions): Promise<AnnounceResult>;
+  /** Test-only: empty the singleton. Not for application code. */
+  reset(): void;
+}
+
+// ── Implementation ─────────────────────────────────────────────────────────
+
+/** Project a defined capability down to the fields that cross the wire. */
+function toDescriptor(capability: DefinedClientCapability): ClientCapabilityDescriptor {
+  const {
+    inputZod: _inputZod,
+    outputZod: _outputZod,
+    handler: _handler,
+    ...descriptor
+  } = capability;
+  return descriptor;
+}
+
+async function post(
+  options: AnnounceOptions,
+  payload: ClientCapabilityAnnouncement,
+): Promise<AnnounceResult> {
+  const sent = payload.capabilities.length;
+  const fetcher =
+    options.fetcher ?? (globalThis as { fetch?: CapabilityAnnounceFetcher }).fetch ?? undefined;
+
+  if (!fetcher) {
+    return { ok: false, sent, error: "no fetch implementation available" };
+  }
+
+  try {
+    const res = await fetcher(options.endpoint, {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ ...options.body, ...payload }),
+    });
+    if (!res.ok) {
+      const error = `announce failed: HTTP ${res.status}`;
+      console.warn(`[useAgentCapabilities] ${error}`);
+      return { ok: false, sent, error };
+    }
+    return { ok: true, sent };
+  } catch (err) {
+    const error = err instanceof Error ? err.message : String(err);
+    console.warn(`[useAgentCapabilities] announce failed: ${error}`);
+    return { ok: false, sent, error };
+  }
+}
+
+/**
+ * Browser-side agent capability registry.
+ *
+ * Components and plugins call `register()` to declare what the agent may invoke
+ * in this tab, then `announce()` once on mount so Nitro — and through it the
+ * agent's `capability_register` — reflects that a UI actually exists.
+ */
+export function useAgentCapabilities(): UseAgentCapabilitiesReturn {
+  function register(capability: DefinedClientCapability): void {
+    const idx = _capabilities.value.findIndex((c) => c.name === capability.name);
+    if (idx !== -1) {
+      // Replace existing — idempotent
+      _capabilities.value = [
+        ..._capabilities.value.slice(0, idx),
+        capability,
+        ..._capabilities.value.slice(idx + 1),
+      ];
+    } else {
+      _capabilities.value = [..._capabilities.value, capability];
+    }
+  }
+
+  function registerAll(capabilities: DefinedClientCapability[]): void {
+    for (const capability of capabilities) register(capability);
+  }
+
+  function unregister(name: string): void {
+    const idx = _capabilities.value.findIndex((c) => c.name === name);
+    if (idx === -1) return; // no-op
+    _capabilities.value = _capabilities.value.filter((c) => c.name !== name);
+  }
+
+  function get(name: string): DefinedClientCapability | undefined {
+    return _capabilities.value.find((c) => c.name === name);
+  }
+
+  function list(): DefinedClientCapability[] {
+    return [..._capabilities.value];
+  }
+
+  function toWire(): ClientCapabilityDescriptor[] {
+    return _capabilities.value.map(toDescriptor);
+  }
+
+  function announce(options: AnnounceOptions): Promise<AnnounceResult> {
+    return post(options, { subscriberId: _subscriberId, capabilities: toWire() });
+  }
+
+  function withdraw(options: AnnounceOptions): Promise<AnnounceResult> {
+    return post(options, { subscriberId: _subscriberId, capabilities: [] });
+  }
+
+  function reset(): void {
+    _capabilities.value = [];
+  }
+
+  return {
+    register,
+    registerAll,
+    unregister,
+    get,
+    list,
+    toWire,
+    capabilities: _capabilities,
+    subscriberId: _subscriberId,
+    announce,
+    withdraw,
+    reset,
+  };
+}