@camerontaylor/paseo-plugin 0.8.0-fork.1

package/dist/server/provider.d.ts

@@ -0,0 +1,610 @@
+import type { JsonValue } from "@camerontaylor/paseo-protocol/agent-types";
+import { z } from "zod";
+export declare const PROVIDER_PROTOCOL_VERSION: 1;
+export declare const PROVIDER_CAPABILITIES: readonly ["prompt.message", "prompt.command", "prompt.image", "prompt.output_schema", "prompt.steer", "session.archive", "session.configure", "session.list", "session.persistence", "session.revert.both", "session.revert.conversation", "session.revert.files", "session.subsession", "session.unarchive", "permission", "permission.tool_policy", "timeline.plugin"];
+export type ProviderCapability = (typeof PROVIDER_CAPABILITIES)[number];
+export interface ProviderRegistration {
+    /** Equal keys share discovery within this provider. Include effective configuration and execution environment. */
+    getCatalogCacheKey?(options: ProviderCatalogOptions): Promise<string | undefined>;
+    id: string;
+    label: string;
+    description?: string;
+    /** Plugin-directory-relative path to a self-contained SVG file. */
+    icon?: string;
+    connect(request: ProviderConnectRequest): Promise<ProviderConnection>;
+}
+export type ProviderCatalogOptions = {
+    scope: "global";
+    force?: boolean;
+} | {
+    scope: "workspace";
+    cwd: string;
+    force?: boolean;
+};
+export interface ProviderConnectRequest {
+    versions: readonly number[];
+    capabilities: readonly string[];
+}
+export interface ProviderConnection {
+    readonly version: number;
+    readonly capabilities: readonly string[];
+    send(input: ProviderInput): Promise<void>;
+    onEvent(listener: (event: ProviderEvent) => void): () => void;
+    close(): Promise<void>;
+}
+export interface ProviderPersistence {
+    version: number;
+    data: JsonValue;
+}
+export type ProviderMcpServerConfig = {
+    type: "stdio";
+    command: string;
+    args?: string[];
+    env?: Record<string, string>;
+    alwaysLoad?: boolean;
+} | {
+    type: "http" | "sse";
+    url: string;
+    headers?: Record<string, string>;
+    alwaysLoad?: boolean;
+};
+export interface ProviderToolPolicy {
+    preapproved: Array<{
+        kind: "mcp";
+        server: string;
+        tool: string;
+    }>;
+}
+export interface ProviderSessionConfig {
+    cwd: string;
+    env: Readonly<Record<string, string>>;
+    systemPrompt?: string;
+    mcpServers: Readonly<Record<string, ProviderMcpServerConfig>>;
+    toolPolicy?: ProviderToolPolicy;
+    model?: string;
+    mode?: string;
+    thinkingOption?: string;
+    settings: Readonly<Record<string, JsonValue>>;
+    providerOptions?: Readonly<Record<string, JsonValue>>;
+    title?: string;
+    persist: boolean;
+}
+export interface ProviderConfigChanges {
+    model?: string | null;
+    mode?: string | null;
+    thinkingOption?: string | null;
+    settings?: Readonly<Record<string, JsonValue>>;
+}
+export interface ProviderPrompt {
+    clientMessageId: string;
+    delivery: "auto" | "steer";
+    input: {
+        type: "message";
+        content: ProviderContent[];
+    } | {
+        type: "command";
+        name: string;
+        arguments: string;
+    };
+    outputSchema?: JsonValue;
+    clearPendingPermissions?: boolean;
+}
+interface ProviderForgeChangeRequestAttachment {
+    type: "forge_change_request";
+    mimeType: "application/paseo-forge-change-request";
+    forge?: string;
+    number: number;
+    title: string;
+    url: string;
+    body?: string | null;
+    projectPath?: string;
+    baseRefName?: string | null;
+    headRefName?: string | null;
+}
+interface ProviderForgeIssueAttachment {
+    type: "forge_issue";
+    mimeType: "application/paseo-forge-issue";
+    forge?: string;
+    number: number;
+    title: string;
+    url: string;
+    body?: string | null;
+    projectPath?: string;
+}
+interface ProviderGitHubPrAttachment {
+    type: "github_pr";
+    mimeType: "application/github-pr";
+    number: number;
+    title: string;
+    url: string;
+    body?: string | null;
+    baseRefName?: string | null;
+    headRefName?: string | null;
+}
+interface ProviderGitHubIssueAttachment {
+    type: "github_issue";
+    mimeType: "application/github-issue";
+    number: number;
+    title: string;
+    url: string;
+    body?: string | null;
+}
+interface ProviderTextAttachment {
+    type: "text";
+    mimeType: "text/plain";
+    contextKind?: string;
+    title?: string | null;
+    text: string;
+    externalResource?: {
+        provider: string;
+        providerLabel: string;
+        resourceType: string;
+        id: string;
+        identifier: string;
+        title: string;
+        url: string;
+    };
+}
+interface ProviderReviewAttachment {
+    type: "review";
+    mimeType: "application/paseo-review";
+    cwd: string;
+    mode: "uncommitted" | "base";
+    baseRef?: string | null;
+    comments: Array<{
+        filePath: string;
+        side: "old" | "new";
+        lineNumber: number;
+        body: string;
+        context: {
+            hunkHeader: string;
+            targetLine: ProviderReviewContextLine;
+            lines: ProviderReviewContextLine[];
+        };
+    }>;
+}
+interface ProviderReviewContextLine {
+    oldLineNumber: number | null;
+    newLineNumber: number | null;
+    type: "add" | "remove" | "context";
+    content: string;
+}
+export type ProviderContent = {
+    type: "text";
+    text: string;
+} | {
+    type: "image";
+    data: string;
+    mimeType: string;
+} | ProviderForgeChangeRequestAttachment | ProviderForgeIssueAttachment | ProviderGitHubPrAttachment | ProviderGitHubIssueAttachment | ProviderTextAttachment | ProviderReviewAttachment | {
+    type: "uploaded_file";
+    id: string;
+    fileName: string;
+    mimeType: string;
+    size: number;
+    path: string;
+};
+export type ProviderInput = {
+    type: "catalog";
+    requestId: string;
+    cwd?: string;
+} | {
+    type: "sessions";
+    requestId: string;
+    query?: string;
+    cwd?: string;
+    limit?: number;
+} | {
+    type: "session.open";
+    requestId: string;
+    sessionId: string;
+    config: ProviderSessionConfig;
+    persistence?: ProviderPersistence;
+    history: "replay" | "skip";
+} | {
+    type: "session.prompt";
+    sessionId: string;
+    prompt: ProviderPrompt;
+} | {
+    type: "session.interrupt";
+    requestId: string;
+    sessionId: string;
+} | {
+    type: "session.permission";
+    sessionId: string;
+    permissionId: string;
+    response: ProviderPermissionResponse;
+} | {
+    type: "session.configure";
+    requestId: string;
+    sessionId: string;
+    changes: ProviderConfigChanges;
+} | {
+    type: "session.revert";
+    requestId: string;
+    sessionId: string;
+    token: JsonValue;
+    scope: "conversation" | "files" | "both";
+} | {
+    type: "session.archive";
+    requestId: string;
+    persistence: ProviderPersistence;
+} | {
+    type: "session.unarchive";
+    requestId: string;
+    persistence: ProviderPersistence;
+} | {
+    type: "session.close";
+    requestId: string;
+    sessionId: string;
+};
+export interface ProviderThinkingOption {
+    id: string;
+    label: string;
+    description?: string;
+    isDefault?: boolean;
+    metadata?: Readonly<Record<string, JsonValue>>;
+}
+export interface ProviderModel {
+    id: string;
+    aliases?: string[];
+    isSelectable?: boolean;
+    label: string;
+    description?: string;
+    isDefault?: boolean;
+    metadata?: Readonly<Record<string, JsonValue>>;
+    contextWindowMaxTokens?: number;
+    thinkingOptions?: ProviderThinkingOption[];
+    defaultThinkingOptionId?: string;
+}
+export interface ProviderMode {
+    id: string;
+    label: string;
+    description?: string;
+    icon?: string;
+    colorTier?: string;
+    isUnattended?: boolean;
+}
+export type ProviderSetting = {
+    type: "toggle";
+    id: string;
+    label: string;
+    description?: string;
+    value: boolean;
+} | {
+    type: "select";
+    id: string;
+    label: string;
+    description?: string;
+    value: string | null;
+    options: ReadonlyArray<{
+        label: string;
+        value: string;
+    }>;
+};
+export interface ProviderConfigState {
+    model?: string;
+    mode?: string;
+    thinkingOption?: string;
+    models: readonly ProviderModel[];
+    modes: readonly ProviderMode[];
+    thinkingOptions: readonly ProviderThinkingOption[];
+    settings: readonly ProviderSetting[];
+}
+export interface ProviderCatalog {
+    models: readonly ProviderModel[];
+    modes: readonly ProviderMode[];
+    thinkingOptions?: readonly ProviderThinkingOption[];
+    defaultModel?: string;
+    defaultMode?: string;
+    defaultThinkingOption?: string;
+}
+export interface ProviderSessionSummary {
+    persistence: ProviderPersistence;
+    cwd: string;
+    title?: string;
+    description?: string;
+    updatedAt?: string;
+}
+export interface ProviderCommand {
+    name: string;
+    description: string;
+    argumentHint?: string;
+}
+export interface ProviderError {
+    message: string;
+    code?: string;
+    diagnostic?: string;
+}
+export interface ProviderNotice {
+    id: string;
+    severity: "info" | "warning" | "error";
+    title: string;
+    description?: string;
+    dismissed?: boolean;
+}
+export interface ProviderPermissionAction {
+    id: string;
+    label: string;
+    behavior: "allow" | "deny";
+    variant?: "primary" | "secondary" | "danger";
+    intent?: "implement" | "implement_resume" | "dismiss";
+}
+export interface ProviderPermissionRequest {
+    id: string;
+    name: string;
+    kind: "tool" | "plan" | "question" | "mode" | "other";
+    title?: string;
+    description?: string;
+    input?: Readonly<Record<string, JsonValue>>;
+    detail?: ProviderToolCallDetail;
+    suggestions?: Array<Record<string, JsonValue>>;
+    actions?: ProviderPermissionAction[];
+    metadata?: Readonly<Record<string, JsonValue>>;
+}
+export type ProviderPermissionResponse = {
+    behavior: "allow";
+    selectedActionId?: string;
+    updatedInput?: Record<string, JsonValue>;
+    updatedPermissions?: Array<Record<string, JsonValue>>;
+} | {
+    behavior: "deny";
+    selectedActionId?: string;
+    message?: string;
+    interrupt?: boolean;
+};
+export interface ProviderUsage {
+    inputTokens?: number;
+    cachedInputTokens?: number;
+    outputTokens?: number;
+    totalCostUsd?: number;
+    contextWindowMaxTokens?: number;
+    contextWindowUsedTokens?: number;
+}
+interface ProviderTimelineIdentity {
+    id: string;
+    revertToken?: JsonValue;
+}
+export type ProviderToolCallDetail = {
+    type: "shell";
+    command: string;
+    cwd?: string;
+    output?: string;
+    exitCode?: number | null;
+} | {
+    type: "read";
+    filePath: string;
+    content?: string;
+    offset?: number;
+    limit?: number;
+} | {
+    type: "edit";
+    filePath: string;
+    oldString?: string;
+    newString?: string;
+    unifiedDiff?: string;
+} | {
+    type: "write";
+    filePath: string;
+    content?: string;
+} | {
+    type: "search";
+    query: string;
+    toolName?: "search" | "grep" | "glob" | "web_search";
+    content?: string;
+    filePaths?: string[];
+    webResults?: Array<{
+        title: string;
+        url: string;
+    }>;
+    annotations?: string[];
+    numFiles?: number;
+    numMatches?: number;
+    durationMs?: number;
+    durationSeconds?: number;
+    truncated?: boolean;
+    mode?: "content" | "files_with_matches" | "count";
+} | {
+    type: "fetch";
+    url: string;
+    prompt?: string;
+    result?: string;
+    code?: number;
+    codeText?: string;
+    bytes?: number;
+    durationMs?: number;
+} | {
+    type: "worktree_setup";
+    worktreePath: string;
+    branchName: string;
+    log: string;
+    commands: Array<{
+        index: number;
+        command: string;
+        cwd: string;
+        log: string;
+        status: "running" | "completed" | "failed";
+        exitCode: number | null;
+        durationMs?: number;
+    }>;
+    truncated?: boolean;
+} | {
+    type: "sub_agent";
+    subAgentType?: string;
+    description?: string;
+    childSessionId?: string;
+    log: string;
+    actions?: Array<{
+        index: number;
+        toolName: string;
+        summary?: string;
+    }>;
+} | {
+    type: "plain_text";
+    label?: string;
+    text?: string;
+    icon?: "wrench" | "square_terminal" | "eye" | "pencil" | "search" | "bot" | "sparkles" | "brain" | "mic_vocal";
+} | {
+    type: "plan";
+    text: string;
+} | {
+    type: "unknown";
+    input: JsonValue;
+    output: JsonValue;
+};
+type ProviderToolCallItem = ProviderTimelineIdentity & {
+    type: "tool_call";
+    callId: string;
+    name: string;
+    detail: ProviderToolCallDetail;
+    metadata?: Readonly<Record<string, JsonValue>>;
+} & ({
+    status: "running" | "completed" | "canceled";
+    error: null;
+} | {
+    status: "failed";
+    error: JsonValue;
+});
+export type ProviderTimelineItem = (ProviderTimelineIdentity & {
+    type: "user_message";
+    text: string;
+    messageId?: string;
+    clientMessageId?: string;
+}) | (ProviderTimelineIdentity & {
+    type: "assistant_message";
+    text: string;
+    messageId?: string;
+}) | (ProviderTimelineIdentity & {
+    type: "reasoning";
+    text: string;
+}) | ProviderToolCallItem | (ProviderTimelineIdentity & {
+    type: "todo";
+    items: Array<{
+        text: string;
+        completed: boolean;
+        id?: string;
+        status?: "pending" | "in_progress" | "completed";
+        activeForm?: string;
+    }>;
+}) | (ProviderTimelineIdentity & {
+    type: "error";
+    message: string;
+}) | (ProviderTimelineIdentity & {
+    type: "notification";
+    level: "info" | "warning" | "error";
+    message: string;
+}) | (ProviderTimelineIdentity & {
+    type: "compaction";
+    status: "loading" | "completed";
+    trigger?: "auto" | "manual";
+    preTokens?: number;
+}) | (ProviderTimelineIdentity & {
+    type: "plugin";
+    pluginId: string;
+    kind: string;
+    version: number;
+    data: JsonValue;
+});
+export type ProviderEvent = {
+    type: "catalog";
+    requestId: string;
+    catalog: ProviderCatalog;
+} | {
+    type: "sessions";
+    requestId: string;
+    sessions: ProviderSessionSummary[];
+} | {
+    type: "request.completed";
+    requestId: string;
+} | {
+    type: "request.failed";
+    requestId: string;
+    error: ProviderError;
+} | {
+    type: "session.opened";
+    requestId?: string;
+    sessionId: string;
+    parentSessionId?: string;
+    capabilities: readonly string[];
+    restoration: "core" | "parent";
+    persistence?: ProviderPersistence;
+    title?: string;
+    description?: string;
+    cwd: string;
+} | {
+    type: "session.ready";
+    requestId?: string;
+    sessionId: string;
+} | {
+    type: "session.closed";
+    sessionId: string;
+    error?: ProviderError;
+} | {
+    type: "session.runtime_failed";
+    sessionId: string;
+    error: ProviderError;
+} | {
+    type: "session.persistence";
+    sessionId: string;
+    persistence: ProviderPersistence;
+} | {
+    type: "session.prompt_result";
+    sessionId: string;
+    clientMessageId: string;
+    result: {
+        type: "turn";
+        turnId: string;
+    } | {
+        type: "steer";
+        turnId: string;
+    } | {
+        type: "completed";
+    } | {
+        type: "failed";
+        error: ProviderError;
+    };
+} | {
+    type: "session.turn";
+    sessionId: string;
+    turnId: string;
+    state: "started" | "completed" | "failed" | "canceled";
+    error?: ProviderError;
+} | {
+    type: "session.usage";
+    sessionId: string;
+    turnId?: string;
+    usage: ProviderUsage;
+} | {
+    type: "session.config";
+    sessionId: string;
+    config: ProviderConfigState;
+} | {
+    type: "session.commands";
+    sessionId: string;
+    commands: ProviderCommand[];
+} | {
+    type: "session.permission";
+    sessionId: string;
+    request: ProviderPermissionRequest;
+} | {
+    type: "session.permission_resolved";
+    sessionId: string;
+    permissionId: string;
+} | {
+    type: "session.notice";
+    sessionId: string;
+    notice: ProviderNotice;
+} | {
+    type: "timeline.item";
+    sessionId: string;
+    item: ProviderTimelineItem;
+    timestamp?: string;
+};
+export declare function negotiateProviderCapabilities(offered: readonly string[], supported: readonly string[]): readonly ProviderCapability[];
+export declare function isProviderCapability(capability: string): capability is ProviderCapability;
+export declare function requiredProviderCapabilities(input: ProviderInput): readonly ProviderCapability[];
+export declare function requireProviderCapabilities(capabilities: readonly string[], input: ProviderInput): void;
+export declare const ProviderInputSchema: z.ZodType<ProviderInput>;
+export declare const ProviderEventSchema: z.ZodType<ProviderEvent>;
+export {};
+//# sourceMappingURL=provider.d.ts.map