@easonwumac/computer-linker 0.1.2

package/dist/tunnels.d.ts

@@ -0,0 +1,161 @@
+import { type ChildProcess } from "node:child_process";
+export type TunnelProviderName = "cloudflare" | "tailscale" | "openai";
+export type TailscaleMode = "serve" | "funnel";
+export type TunnelProviderMode = TailscaleMode | "quick-tunnel" | "secure-mcp-tunnel";
+export interface TunnelOptions {
+    provider: TunnelProviderName;
+    localPort: number;
+    tailscaleMode?: TailscaleMode;
+    openaiTunnelId?: string;
+    openaiClientPath?: string;
+    ownerToken?: string;
+}
+export interface TunnelCommand {
+    provider: TunnelProviderName;
+    mode?: TunnelProviderMode;
+    command: string;
+    args: string[];
+    display: string;
+    env?: Record<string, string>;
+}
+export interface TunnelToolStatus {
+    name: "cloudflared" | "tailscale" | "tunnel-client";
+    available: boolean;
+    version?: string;
+    status?: string;
+    error?: string;
+}
+export interface TunnelDiagnostics {
+    tools: TunnelToolStatus[];
+    commands: TunnelCommand[];
+    providerContracts: TunnelProviderContract[];
+    providers: TunnelProviderStatus[];
+    publicBaseUrlConfigured: boolean;
+    publicBaseUrl?: string;
+    effectivePublicUrl?: string;
+    effectivePublicUrlSource?: "configured" | "running-tunnel";
+}
+export interface TunnelProviderContract {
+    provider: TunnelProviderName;
+    modes: TunnelProviderMode[];
+    commands: TunnelCommand[];
+    lifecycle: {
+        detect: true;
+        status: true;
+        expose: true;
+        getPublicUrl: true;
+        stop: true;
+    };
+    publicUrlSources: Array<"configured" | "running-tunnel">;
+}
+export interface TunnelProviderStatus {
+    provider: TunnelProviderName;
+    available: boolean;
+    publicUrl?: string;
+    publicUrlSource?: "configured" | "running-tunnel";
+    running: boolean;
+    runningProcessId?: string;
+    runningMode?: TunnelProviderMode;
+    status?: string;
+    error?: string;
+    commands: TunnelCommand[];
+}
+interface TunnelProviderStatusInput {
+    localPort: number;
+    publicBaseUrl?: string;
+    tunnels?: TunnelProcessSnapshot[];
+    openaiTunnelId?: string;
+    openaiClientPath?: string;
+    ownerToken?: string;
+}
+export interface TunnelProvider {
+    name: TunnelProviderName;
+    detect(): TunnelToolStatus;
+    status(input: TunnelProviderStatusInput): TunnelProviderStatus;
+    command(options: TunnelOptions): TunnelCommand;
+    expose(options: TunnelOptions): ChildProcess;
+    getPublicUrl(input: TunnelProviderStatusInput): string | undefined;
+    stop(process: ChildProcess, signal?: NodeJS.Signals): void;
+}
+export declare function exposeWithTunnel(options: TunnelOptions): Promise<void>;
+export declare function tunnelCommand(options: TunnelOptions): TunnelCommand;
+export declare function tunnelDiagnostics(input: {
+    localPort: number;
+    publicBaseUrl?: string;
+    tunnels?: TunnelProcessSnapshot[];
+    openaiTunnelId?: string;
+    openaiClientPath?: string;
+    ownerToken?: string;
+}): TunnelDiagnostics;
+export declare function getTunnelProviders(): TunnelProvider[];
+export declare function getTunnelProvider(name: TunnelProviderName): TunnelProvider;
+export declare function tunnelProviderContracts(localPort: number): TunnelProviderContract[];
+export interface OpenAiTunnelClientInstallInfo {
+    path: string;
+    source: "managed" | "downloaded" | "override";
+    version?: string;
+    releaseTag?: string;
+    releaseUrl?: string;
+    assetName?: string;
+    sha256?: string;
+}
+export declare function ensureOpenAiTunnelClientInstalled(options?: {
+    clientPath?: string;
+}): Promise<OpenAiTunnelClientInstallInfo>;
+export declare function openAiTunnelClientManagedPath(): string;
+export declare function configuredOpenAiTunnelId(): string | undefined;
+export declare function openAiTunnelHealthUrlFile(tunnelId: string): string;
+export interface TunnelProcessSnapshot {
+    id: string;
+    provider: TunnelProviderName;
+    mode?: TunnelProviderMode;
+    localPort: number;
+    command: string;
+    args: string[];
+    display: string;
+    pid?: number;
+    startedAt: string;
+    endedAt?: string;
+    status: "running" | "exited";
+    exitCode: number | null;
+    signal?: string;
+    stdout: string;
+    stderr: string;
+    publicUrl?: string;
+    events?: TunnelRuntimeEvent[];
+    lastError?: string;
+    lastRecoveryAt?: string;
+}
+export type TunnelRuntimeEventKind = "process_started" | "process_exited" | "dispatcher_forwarded" | "dispatcher_acknowledged" | "mcp_upstream_error" | "controlplane_poll_failed" | "controlplane_recovered";
+export interface TunnelRuntimeEvent {
+    timestamp: string;
+    provider: TunnelProviderName;
+    tunnelId: string;
+    localPort?: number;
+    pid?: number;
+    severity: "info" | "warn" | "error";
+    kind: TunnelRuntimeEventKind;
+    message: string;
+    detail?: string;
+    statusCode?: number;
+    status?: string;
+    rpcMethod?: string;
+    requestId?: string;
+    cmdRequestId?: string;
+    rpcRequestId?: string;
+    sessionId?: string;
+    tunnelRequestId?: string;
+}
+export declare function startTunnelProcess(options: TunnelOptions): TunnelProcessSnapshot;
+export declare function stopTunnelProcess(id: string, signal?: string): Promise<TunnelProcessSnapshot>;
+export declare function listTunnelProcesses(): TunnelProcessSnapshot[];
+export declare function refreshTunnelPublicUrl(id: string): TunnelProcessSnapshot | undefined;
+export declare function stopAllTunnelProcesses(signal?: string): Promise<TunnelProcessSnapshot[]>;
+export declare function tunnelRuntimeEvents(snapshots?: TunnelProcessSnapshot[], options?: {
+    limit?: number;
+    includeInfo?: boolean;
+}): TunnelRuntimeEvent[];
+export declare function detectTailscalePublicUrl(): string | undefined;
+export declare function tailscalePublicUrlFromFunnelStatus(output: string): string | undefined;
+export declare function tailscalePublicUrlFromStatusJson(output: string): string | undefined;
+export {};