toolhome 0.5.0

package/dist/server/control/control-service.d.ts

@@ -0,0 +1,713 @@
+import { type ApiKeyKind } from '../domain/models.js';
+import type { AuthService } from '../security/auth-service.js';
+import type { Store } from '../storage/store.js';
+import type { UpstreamManager } from '../upstream/manager.js';
+import type { UpstreamOAuthService } from '../upstream/oauth-service.js';
+export declare class ControlService {
+    #private;
+    constructor(store: Store, upstreams: UpstreamManager, auth: AuthService, publicUrl: URL, onServerRemoved: (slug: string) => Promise<void>, onRegistryChanged: () => void, upstreamOAuth: UpstreamOAuthService);
+    listServers(): {
+        id: string;
+        slug: string;
+        name: string;
+        kind: "home" | "remote";
+        transport: {
+            type: "streamable-http";
+            url: string;
+            protocolMode: "auto" | "legacy" | "modern";
+            allowSseFallback: boolean;
+            headers: Record<string, string>;
+        } | {
+            type: "stdio";
+            command: string;
+            args: string[];
+            cwd?: string | undefined;
+            env: Record<string, string>;
+            protocolMode: "auto" | "legacy" | "modern";
+        };
+        credentialId: string | null;
+        enabled: boolean;
+        settings: {
+            connectTimeoutMs: number;
+            requestTimeoutMs: number;
+            maxTotalTimeoutMs: number;
+            maxConcurrency: number;
+            restart: "always" | "never" | "on-failure";
+            urlClientId?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+        runtime: {
+            serverId: string;
+            status: "auth-required" | "connecting" | "degraded" | "disabled" | "ready" | "start-failed" | "unknown" | "unreachable";
+            protocolVersion: string | null;
+            protocolEra: "legacy" | "modern" | null;
+            processId: number | null;
+            restartCount: number;
+            lastSuccessAt: string | null;
+            lastError: string | null;
+            updatedAt: string;
+        } | null;
+    }[];
+    createServer(value: unknown): Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        kind: "home" | "remote";
+        transport: {
+            type: "streamable-http";
+            url: string;
+            protocolMode: "auto" | "legacy" | "modern";
+            allowSseFallback: boolean;
+            headers: Record<string, string>;
+        } | {
+            type: "stdio";
+            command: string;
+            args: string[];
+            cwd?: string | undefined;
+            env: Record<string, string>;
+            protocolMode: "auto" | "legacy" | "modern";
+        };
+        credentialId: string | null;
+        enabled: boolean;
+        settings: {
+            connectTimeoutMs: number;
+            requestTimeoutMs: number;
+            maxTotalTimeoutMs: number;
+            maxConcurrency: number;
+            restart: "always" | "never" | "on-failure";
+            urlClientId?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    getServer(id: string): {
+        id: string;
+        slug: string;
+        name: string;
+        kind: "home" | "remote";
+        transport: {
+            type: "streamable-http";
+            url: string;
+            protocolMode: "auto" | "legacy" | "modern";
+            allowSseFallback: boolean;
+            headers: Record<string, string>;
+        } | {
+            type: "stdio";
+            command: string;
+            args: string[];
+            cwd?: string | undefined;
+            env: Record<string, string>;
+            protocolMode: "auto" | "legacy" | "modern";
+        };
+        credentialId: string | null;
+        enabled: boolean;
+        settings: {
+            connectTimeoutMs: number;
+            requestTimeoutMs: number;
+            maxTotalTimeoutMs: number;
+            maxConcurrency: number;
+            restart: "always" | "never" | "on-failure";
+            urlClientId?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+        runtime: {
+            serverId: string;
+            status: "auth-required" | "connecting" | "degraded" | "disabled" | "ready" | "start-failed" | "unknown" | "unreachable";
+            protocolVersion: string | null;
+            protocolEra: "legacy" | "modern" | null;
+            processId: number | null;
+            restartCount: number;
+            lastSuccessAt: string | null;
+            lastError: string | null;
+            updatedAt: string;
+        } | null;
+    };
+    updateServer(id: string, value: unknown): Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        kind: "home" | "remote";
+        transport: {
+            type: "streamable-http";
+            url: string;
+            protocolMode: "auto" | "legacy" | "modern";
+            allowSseFallback: boolean;
+            headers: Record<string, string>;
+        } | {
+            type: "stdio";
+            command: string;
+            args: string[];
+            cwd?: string | undefined;
+            env: Record<string, string>;
+            protocolMode: "auto" | "legacy" | "modern";
+        };
+        credentialId: string | null;
+        enabled: boolean;
+        settings: {
+            connectTimeoutMs: number;
+            requestTimeoutMs: number;
+            maxTotalTimeoutMs: number;
+            maxConcurrency: number;
+            restart: "always" | "never" | "on-failure";
+            urlClientId?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    deleteServer(id: string): Promise<void>;
+    enableServer(id: string): Promise<{
+        server: {
+            id: string;
+            slug: string;
+            name: string;
+            kind: "home" | "remote";
+            transport: {
+                type: "streamable-http";
+                url: string;
+                protocolMode: "auto" | "legacy" | "modern";
+                allowSseFallback: boolean;
+                headers: Record<string, string>;
+            } | {
+                type: "stdio";
+                command: string;
+                args: string[];
+                cwd?: string | undefined;
+                env: Record<string, string>;
+                protocolMode: "auto" | "legacy" | "modern";
+            };
+            credentialId: string | null;
+            enabled: boolean;
+            settings: {
+                connectTimeoutMs: number;
+                requestTimeoutMs: number;
+                maxTotalTimeoutMs: number;
+                maxConcurrency: number;
+                restart: "always" | "never" | "on-failure";
+                urlClientId?: boolean | undefined;
+            };
+            createdAt: string;
+            updatedAt: string;
+        };
+        snapshot: import("../domain/models.js").CapabilitySnapshot;
+    }>;
+    disableServer(id: string): Promise<{
+        id: string;
+        slug: string;
+        name: string;
+        kind: "home" | "remote";
+        transport: {
+            type: "streamable-http";
+            url: string;
+            protocolMode: "auto" | "legacy" | "modern";
+            allowSseFallback: boolean;
+            headers: Record<string, string>;
+        } | {
+            type: "stdio";
+            command: string;
+            args: string[];
+            cwd?: string | undefined;
+            env: Record<string, string>;
+            protocolMode: "auto" | "legacy" | "modern";
+        };
+        credentialId: string | null;
+        enabled: boolean;
+        settings: {
+            connectTimeoutMs: number;
+            requestTimeoutMs: number;
+            maxTotalTimeoutMs: number;
+            maxConcurrency: number;
+            restart: "always" | "never" | "on-failure";
+            urlClientId?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    testServer(id: string): Promise<import("../domain/models.js").CapabilitySnapshot>;
+    refreshServer(id: string): Promise<import("../domain/models.js").CapabilitySnapshot>;
+    restartServer(id: string): Promise<import("../domain/models.js").CapabilitySnapshot>;
+    serverCapabilities(id: string): import("../domain/models.js").CapabilitySnapshot;
+    serverStatus(id: string): {
+        server: {
+            id: string;
+            slug: string;
+            name: string;
+            kind: "home" | "remote";
+            transport: {
+                type: "streamable-http";
+                url: string;
+                protocolMode: "auto" | "legacy" | "modern";
+                allowSseFallback: boolean;
+                headers: Record<string, string>;
+            } | {
+                type: "stdio";
+                command: string;
+                args: string[];
+                cwd?: string | undefined;
+                env: Record<string, string>;
+                protocolMode: "auto" | "legacy" | "modern";
+            };
+            credentialId: string | null;
+            enabled: boolean;
+            settings: {
+                connectTimeoutMs: number;
+                requestTimeoutMs: number;
+                maxTotalTimeoutMs: number;
+                maxConcurrency: number;
+                restart: "always" | "never" | "on-failure";
+                urlClientId?: boolean | undefined;
+            };
+            createdAt: string;
+            updatedAt: string;
+            runtime: {
+                serverId: string;
+                status: "auth-required" | "connecting" | "degraded" | "disabled" | "ready" | "start-failed" | "unknown" | "unreachable";
+                protocolVersion: string | null;
+                protocolEra: "legacy" | "modern" | null;
+                processId: number | null;
+                restartCount: number;
+                lastSuccessAt: string | null;
+                lastError: string | null;
+                updatedAt: string;
+            } | null;
+        };
+        runtime: {
+            serverId: string;
+            status: "auth-required" | "connecting" | "degraded" | "disabled" | "ready" | "start-failed" | "unknown" | "unreachable";
+            protocolVersion: string | null;
+            protocolEra: "legacy" | "modern" | null;
+            processId: number | null;
+            restartCount: number;
+            lastSuccessAt: string | null;
+            lastError: string | null;
+            updatedAt: string;
+        } | null;
+        snapshot: import("../domain/models.js").CapabilitySnapshot | null;
+    };
+    serverLogs(id: string, limit?: number): import("../domain/models.js").EventRecord[];
+    serverEndpoint(id: string): {
+        aggregateUrl: string;
+        individualUrl: string;
+        authorization: {
+            type: string;
+            credential: string;
+        };
+    };
+    aggregateEndpoint(): {
+        url: string;
+        authorization: {
+            type: string;
+            credential: string;
+        };
+    };
+    listCredentials(): {
+        id: string;
+        name: string;
+        type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+        status: "expired" | "invalid" | "pending" | "ready";
+        expiresAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+    createCredential(value: unknown): {
+        id: string;
+        name: string;
+        type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+        status: "expired" | "invalid" | "pending" | "ready";
+        expiresAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+    getCredential(id: string): {
+        id: string;
+        name: string;
+        type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+        status: "expired" | "invalid" | "pending" | "ready";
+        expiresAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+    updateCredential(id: string, value: unknown): Promise<{
+        id: string;
+        name: string;
+        type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+        status: "expired" | "invalid" | "pending" | "ready";
+        expiresAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    deleteCredential(id: string): Promise<void>;
+    testCredential(id: string): Promise<{
+        credential: {
+            id: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            status: "expired" | "invalid" | "pending" | "ready";
+            expiresAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        };
+        valid: boolean;
+        requiresAuthorization: boolean;
+        verifiedAgainstUpstream: boolean;
+        servers: ({
+            id: string;
+            slug: string;
+            ok: boolean;
+        } | {
+            id: string;
+            slug: string;
+            ok: boolean;
+            error: string;
+        })[];
+    }>;
+    authorizeCredential(id: string, value: unknown): Promise<{
+        status: string;
+        credential: {
+            id: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            status: "expired" | "invalid" | "pending" | "ready";
+            expiresAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+        serverId: string;
+        connection: {
+            refreshed: boolean;
+            reason: string;
+        } | {
+            reason?: undefined;
+            refreshed: boolean;
+        };
+        authorizationUrl?: undefined;
+        callbackUrl?: undefined;
+    } | {
+        connection?: undefined;
+        status: string;
+        credential: {
+            id: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            status: "expired" | "invalid" | "pending" | "ready";
+            expiresAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+        serverId: string;
+        authorizationUrl: string;
+        callbackUrl: string;
+    }>;
+    revokeCredential(id: string): Promise<{
+        revoked: boolean;
+        remoteRevocationSupported: boolean;
+        remoteRevoked: boolean;
+        attempts: {
+            tokenType: 'refresh_token' | 'access_token';
+            ok: boolean;
+            status?: number;
+        }[];
+        credential: {
+            id: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            status: "expired" | "invalid" | "pending" | "ready";
+            expiresAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+    }>;
+    listKeys(kind: ApiKeyKind): {
+        id: string;
+        kind: "access" | "control";
+        name: string;
+        prefix: string;
+        scope: "admin" | "agent" | null;
+        createdAt: string;
+        lastUsedAt: string | null;
+        revokedAt: string | null;
+    }[];
+    createKey(kind: ApiKeyKind, name: string, scope?: 'admin' | 'agent'): import("../security/auth-service.js").IssuedApiKey;
+    revokeKey(kind: ApiKeyKind, id: string): void;
+    overview(): {
+        servers: {
+            total: number;
+            enabled: number;
+            remote: number;
+            home: number;
+            ready: number;
+            unhealthy: number;
+        };
+        clis: {
+            total: number;
+            enabled: number;
+        };
+        credentials: number;
+        accessKeys: number;
+        controlKeys: number;
+        ok: boolean;
+        endpoints: {
+            aggregate: string;
+            individual: {
+                [k: string]: string;
+            };
+        };
+    };
+    diagnostics(): {
+        ok: boolean;
+        database: string;
+        servers: {
+            id: string;
+            slug: string;
+            enabled: boolean;
+            status: "auth-required" | "connecting" | "degraded" | "disabled" | "ready" | "start-failed" | "unknown" | "unreachable";
+            hasSnapshot: boolean;
+        }[];
+        clis: {
+            id: string;
+            slug: string;
+            enabled: boolean;
+            status: string;
+        }[];
+    };
+    exportConfig(includeSecrets?: boolean): {
+        version: number;
+        secretsIncluded: boolean;
+        exportedAt: string;
+        credentials: {
+            ref: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            payload?: {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "api-key";
+                headerName: string;
+                value: string;
+            } | {
+                type: "headers";
+                headers: Record<string, string>;
+            } | {
+                type: "env";
+                variables: Record<string, string>;
+            } | {
+                type: "oauth";
+                accessToken?: string | undefined;
+                refreshToken?: string | undefined;
+                idToken?: string | undefined;
+                tokenType: string;
+                expiresAt?: string | undefined;
+                expiresIn?: number | undefined;
+                clientId?: string | undefined;
+                clientSecret?: string | undefined;
+                scope?: string | undefined;
+                issuer?: string | undefined;
+                resourceUrl?: string | undefined;
+                authorizationServerUrl?: string | undefined;
+                authorizationUrl?: string | undefined;
+                pendingExpiresAt?: string | undefined;
+                state?: string | undefined;
+                codeVerifier?: string | undefined;
+                clientInformation?: import("@modelcontextprotocol/server").StoredOAuthClientInformation | undefined;
+                discoveryState?: import("@modelcontextprotocol/client").OAuthDiscoveryState | undefined;
+            } | undefined;
+        }[];
+        servers: {
+            slug: string;
+            name: string;
+            kind: "home" | "remote";
+            transport: {
+                type: "streamable-http";
+                url: string;
+                protocolMode: "auto" | "legacy" | "modern";
+                allowSseFallback: boolean;
+                headers: Record<string, string>;
+            } | {
+                type: "stdio";
+                command: string;
+                args: string[];
+                cwd?: string | undefined;
+                env: Record<string, string>;
+                protocolMode: "auto" | "legacy" | "modern";
+            };
+            credentialRef: string | null;
+            enabled: boolean;
+            settings: {
+                connectTimeoutMs: number;
+                requestTimeoutMs: number;
+                maxTotalTimeoutMs: number;
+                maxConcurrency: number;
+                restart: "always" | "never" | "on-failure";
+                urlClientId?: boolean | undefined;
+            };
+        }[];
+    };
+    importConfig(value: unknown): {
+        credentials: {
+            id: string;
+            name: string;
+            type: "api-key" | "bearer" | "env" | "headers" | "oauth";
+            status: "expired" | "invalid" | "pending" | "ready";
+            expiresAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+        servers: {
+            id: string;
+            slug: string;
+            name: string;
+            kind: "home" | "remote";
+            transport: {
+                type: "streamable-http";
+                url: string;
+                protocolMode: "auto" | "legacy" | "modern";
+                allowSseFallback: boolean;
+                headers: Record<string, string>;
+            } | {
+                type: "stdio";
+                command: string;
+                args: string[];
+                cwd?: string | undefined;
+                env: Record<string, string>;
+                protocolMode: "auto" | "legacy" | "modern";
+            };
+            credentialId: string | null;
+            enabled: boolean;
+            settings: {
+                connectTimeoutMs: number;
+                requestTimeoutMs: number;
+                maxTotalTimeoutMs: number;
+                maxConcurrency: number;
+                restart: "always" | "never" | "on-failure";
+                urlClientId?: boolean | undefined;
+            };
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    };
+    importHarnessConfig(value: unknown, preview?: boolean, mode?: 'create' | 'upsert'): Promise<{
+        preview: boolean;
+        entries: ({
+            name: string;
+            slug: string;
+            kind: 'remote' | 'home';
+            transportSummary: string;
+            credential: {
+                name: string;
+                type: string;
+                fields: {
+                    name: string;
+                    masked: boolean;
+                }[];
+            } | null;
+            warnings: string[];
+            status: string;
+            changes: string[];
+        } | {
+            name: string;
+            slug: string;
+            kind: 'remote' | 'home';
+            transportSummary: string;
+            credential: {
+                name: string;
+                type: string;
+                fields: {
+                    name: string;
+                    masked: boolean;
+                }[];
+            } | null;
+            warnings: string[];
+            status: string;
+            changes: string[];
+            message: string;
+        })[];
+    } | {
+        preview: boolean;
+        entries: ({
+            name: string;
+            slug: string;
+            status: string;
+            message: string;
+            warnings: string[];
+            serverId?: undefined;
+            credentialId?: undefined;
+        } | {
+            message?: undefined;
+            name: string;
+            slug: string;
+            status: string;
+            warnings: string[];
+            serverId?: undefined;
+            credentialId?: undefined;
+        } | {
+            message?: undefined;
+            name: string;
+            slug: string;
+            status: string;
+            serverId: string;
+            credentialId: string | null;
+            warnings: string[];
+        } | {
+            name: string;
+            slug: string;
+            status: string;
+            serverId: string;
+            changes: string[];
+            warnings: string[];
+        })[];
+    }>;
+    getProjection(serverId: string): {
+        serverId: string;
+        defaultVisibility: "hidden" | "visible";
+        overrides: {
+            [k: string]: "hidden" | "inherit" | "visible";
+        };
+        tools: {
+            name: string;
+            description: string;
+            visible: boolean;
+        }[];
+    };
+    setProjection(serverId: string, value: unknown): {
+        serverId: string;
+        defaultVisibility: "hidden" | "visible";
+        overrides: {
+            [k: string]: "hidden" | "inherit" | "visible";
+        };
+        tools: {
+            name: string;
+            description: string;
+            visible: boolean;
+        }[];
+    };
+    listCalls(value: Record<string, unknown>): {
+        items: {
+            id: string;
+            endpointType: "aggregate" | "cli" | "individual" | "management";
+            principalKind: "access_key" | "cli" | "control_key" | "oauth_client";
+            principalId: string;
+            serverId: string | null;
+            exposedToolName: string;
+            upstreamToolName: string;
+            status: "cancelled" | "protocol_error" | "rejected" | "success" | "timeout" | "tool_error";
+            errorType: string | null;
+            startedAt: string;
+            completedAt: string;
+            durationMs: number;
+        }[];
+        total: number;
+    };
+    callStats(value: Record<string, unknown>): import("../domain/models.js").ToolCallStats;
+    callSeries(value: Record<string, unknown>): {
+        bucketSeconds: number;
+        points: {
+            bucket: string;
+            total: number;
+            success: number;
+            error: number;
+        }[];
+    };
+}
+//# sourceMappingURL=control-service.d.ts.map