runwork 0.15.1 → 0.16.0

package/dist/agents/registry-data.d.ts

@@ -1,192 +0,0 @@
-/**
- * Unified agent registry (types + data + browser-safe lookups).
- *
- * This file is the SINGLE SOURCE OF TRUTH for every agent Runwork knows about:
- * CLI adapters read from here (via `./registry.js`), and the desktop app
- * re-exports from here (via the `@cli-agent-registry` path alias).
- *
- * Keep this file browser-safe: no `os`, `path`, `fs`, or other Node-only
- * imports. Node-only path resolvers live next to this file in `./registry.ts`.
- */
-export type AgentCategory = 'cli' | 'ide' | 'desktop' | 'extension' | 'web';
-export type { PlatformString, Detection, InstallableTool } from '../tools/types.js';
-import type { InstallableTool, Detection, PlatformString } from '../tools/types.js';
-/** @deprecated use `Detection` from ../tools/types — kept as alias for back-compat. */
-export type AgentDetection = Detection;
-export interface AgentLaunch {
-    app?: {
-        macos?: string;
-        windows?: string;
-        linux?: string;
-    };
-    cli?: string;
-    cliAcceptsPrompt?: boolean;
-    /**
-     * Web/URL launch target opened in the default browser. `{prompt}` is
-     * substituted with a URL-encoded prompt (e.g. ChatGPT's `?prompt=`), or
-     * stripped when no prompt is supplied. Used by web-only agents and as the
-     * fallback for desktop agents whose app is not installed.
-     */
-    url?: string;
-}
-export interface AgentQuickStart {
-    launchHint?: string;
-    panelHint?: string;
-    skillCommand?: string;
-    examplePrompts?: string[];
-}
-export interface ManualSetupStep {
-    id: string;
-    label: string;
-}
-/**
- * Optional downloadable artifact generated inline during a manual setup step
- * (e.g. a plugin zip the user uploads into the agent).
- */
-export interface AgentManualSetupArtifact {
-    label: string;
-    filename: string;
-    /** CLI subcommand that generates the artifact, e.g. "build-plugin" */
-    command: string;
-}
-/** Where a manual-setup step is inserted in the onboarding journey. */
-export type ManualSetupSlot = 'installation' | 'connecting' | 'try-it';
-/**
- * A plan-conditional variant of a manual-setup checklist. When an agent's
- * connector setup differs by account plan (e.g. ChatGPT Team vs Personal),
- * each variant carries its own steps; the onboarding UI selects the variant
- * matching the workspace's stored plan. Agents without plan branching omit
- * `variants` and use the flat `steps`.
- */
-export interface AgentManualSetupVariant {
-    key: 'team' | 'personal';
-    label: string;
-    title?: string;
-    steps: ManualSetupStep[];
-}
-/**
- * A copy-to-clipboard value surfaced alongside the manual-setup steps. The
- * onboarding UI substitutes `token` with a real value (e.g. `{mcpUrl}` →
- * the workspace MCP URL) before rendering the copy control.
- */
-export interface AgentManualSetupCopyValue {
-    label: string;
-    token: '{mcpUrl}';
-}
-export interface AgentManualSetup {
-    title: string;
-    steps: ManualSetupStep[];
-    opensAgent?: boolean;
-    /** Where in the journey to show this step. Defaults to 'try-it'. */
-    showAfter?: ManualSetupSlot;
-    downloadArtifact?: AgentManualSetupArtifact;
-    /** Plan-conditional step lists. When present, the UI renders the variant matching the workspace plan instead of `steps`. */
-    variants?: AgentManualSetupVariant[];
-    /** A value the user copies into the agent during setup (e.g. the workspace MCP URL). */
-    copyValue?: AgentManualSetupCopyValue;
-}
-/**
- * How a recipient can resume a shared conversation locally in this agent.
- *
- * Consumed by `runwork resume <share-id>` and by the desktop UI's
- * "Resume in <agent>" button. The CLI's resume command branches on `mode`:
- *
- *   - 'cli-resume'      Place the bundle on disk, then exec `cliResumeCommand`
- *                       with {uuid} substituted. The agent opens directly
- *                       into the resumed session (Claude Code, Codex CLI,
- *                       Gemini CLI, Cline CLI).
- *
- *   - 'file-drop-only'  Place the bundle on disk in a location the agent's
- *                       UI will surface (e.g., Codex Desktop's recent threads).
- *                       The CLI prints `manualOpenHint` so the user knows how
- *                       to pick up the session inside the agent.
- *
- *   - 'unsupported'     No native resume. The CLI falls back to the universal
- *                       paste-prompt path. Used for walled-garden agents like
- *                       Microsoft Copilot or Claude Desktop Chat mode.
- *
- *   - 'url-prompt'      Open the agent's `launch.url` (or app) with a prefilled
- *                       prompt that instructs the agent to fetch and continue
- *                       the shared conversation via Runwork's MCP tools. Used by
- *                       connect-only agents (ChatGPT) that have MCP access but no
- *                       local session files to drop into.
- *
- * Bundle placement logic (which directory, which filename) is per-agent and
- * lives in the resume command implementation, not here. This data field stays
- * declarative.
- */
-export interface AgentResumeCapability {
-    mode: 'cli-resume' | 'file-drop-only' | 'unsupported' | 'url-prompt';
-    /** Bundle format this agent reads natively (must match a bundle's `format`). */
-    nativeBundleFormat?: 'claude-jsonl' | 'codex-rollout' | string;
-    /** Template for the resume command (cli-resume only). `{uuid}` is substituted with the share's session id. */
-    cliResumeCommand?: string;
-    /** Hint text shown to the user when the bundle was dropped but the agent must be opened manually. */
-    manualOpenHint?: string;
-}
-export interface AgentDefinition extends InstallableTool {
-    aliases?: string[];
-    category: AgentCategory;
-    /**
-     * Family identifier grouping multiple entries that share one account/
-     * connector/OAuth identity (e.g. `chatgpt` + `chatgpt-app` → 'chatgpt').
-     * Drives the shared plan toggle, connect-step dedup, and family-level
-     * adoption. Undefined for standalone agents.
-     */
-    family?: string;
-    /** Desktop launch hints (GUI app name, CLI command) */
-    launch?: AgentLaunch;
-    /** Whether the CLI knows how to auto-install this agent */
-    autoInstallable?: boolean;
-    /** Skill file directories relative to $HOME (global) or project root (project) */
-    skillsPaths?: {
-        global?: PlatformString;
-        project?: PlatformString;
-    };
-    /** MCP config file path relative to $HOME */
-    mcpConfigPath?: PlatformString;
-    /** MCP config JSON key where servers are stored (default: 'mcpServers') */
-    mcpConfigKey?: string;
-    /** First-class agent = full Runwork support (custom adapter or rich desktop onboarding) */
-    firstClass?: boolean;
-    /** Instruction file path relative to $HOME (global) or project root (project) */
-    instructionFile?: {
-        global?: PlatformString;
-        project?: PlatformString;
-    };
-    /** Skill file format */
-    skillFormat?: 'skill-md' | 'mdc' | 'windsurf-md' | 'gemini-flat';
-    /** Desktop onboarding hint copy */
-    quickStart?: AgentQuickStart;
-    /** Manual setup steps required after installation (desktop onboarding) */
-    manualSetup?: AgentManualSetup;
-    /** How `runwork resume` should hand this agent a shared conversation. Undefined = paste-prompt fallback only. */
-    resumeCapability?: AgentResumeCapability;
-}
-export declare function getAgent(slug: string): AgentDefinition | undefined;
-export declare function getAgentByName(name: string): AgentDefinition | undefined;
-export declare function getAgents(): AgentDefinition[];
-export declare function getDetectableAgents(): AgentDefinition[];
-export declare function getLaunchableAgents(): AgentDefinition[];
-export declare function getFirstClassAgents(): AgentDefinition[];
-export declare function getAgentsByCategory(category: AgentCategory): AgentDefinition[];
-export declare function isCLIAgent(slug: string): boolean;
-export declare function isIDEAgent(slug: string): boolean;
-export declare function isDesktopAgent(slug: string): boolean;
-export declare function isWebAgent(slug: string): boolean;
-/**
- * Connect-only agents have no local footprint to write: no skills directory,
- * no MCP config file, no instruction file. The connector lives in the user's
- * account (e.g. ChatGPT). `runwork sync` skips these for all local writes.
- */
-export declare function isConnectOnlyAgent(agent: AgentDefinition | undefined): boolean;
-/** Family identifier for an agent (e.g. 'chatgpt' for both ChatGPT entries), or its slug when standalone. */
-export declare function getAgentFamily(slug: string): string | undefined;
-/** All agents sharing the given family identifier. */
-export declare function getFamilyAgents(family: string): AgentDefinition[];
-/** Alias of {@link getAgent} kept for backward compatibility with CLI callers. */
-export declare const getRegistryAgent: typeof getAgent;
-/** Alias of {@link getAgents} kept for backward compatibility with CLI callers. */
-export declare const getRegistryAgents: typeof getAgents;
-export declare function getFirstClassSlugs(): string[];
-export declare function getCustomAdapterSlugs(): Set<string>;