@agentorg/computer 0.0.0-stage → 0.0.2

package/dist/types/generated/schema.d.ts

@@ -0,0 +1,479 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/v1/info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** What this service is and how it isolates its computers. */
+        get: operations["getInfo"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List the computers. */
+        get: operations["listComputers"];
+        put?: never;
+        /** Create a computer. It answers once the computer is running. */
+        post: operations["createComputer"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers/{computerID}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        /** One computer, with how long it has run and the tools it offers. */
+        get: operations["getComputer"];
+        put?: never;
+        post?: never;
+        /** Stop it for good and remove what the service made. A folder someone named stays. */
+        delete: operations["killComputer"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers/{computerID}/timeout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** It now stops this many seconds from now, replacing any earlier timeout. */
+        post: operations["setComputerTimeout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers/{computerID}/stop": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Stop what it is running. Its folder and its token stay, and it can start again. */
+        post: operations["stopComputer"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers/{computerID}/start": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Start a stopped computer again, with the same token and folder. */
+        post: operations["startComputer"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/computers/{computerID}/logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        /** What its servers wrote, and each request it was sent. */
+        get: operations["getComputerLogs"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Error: {
+            code: number;
+            message: string;
+        };
+        /**
+         * @description How far it reaches into files and commands, each level containing the one before: `read` has read, list and search; `files` adds edit; `terminal` adds exec_command and write_stdin. Below terminal, the browser's code-running tool is hidden.
+         * @enum {string}
+         */
+        Access: "none" | "read" | "files" | "terminal";
+        /** @enum {string} */
+        ComputerState: "running" | "stopped" | "failed";
+        /** @description Seconds from now until the computer stops. */
+        Timeout: number;
+        /** @description Your own labels, kept and returned as given. */
+        Metadata: {
+            [key: string]: string;
+        };
+        NewComputer: {
+            name?: string;
+            access: components["schemas"]["Access"];
+            /**
+             * @description Whether it has a browser. With access none, it must.
+             * @default false
+             */
+            browser: boolean;
+            /** @description The full path of a folder that exists, on the service's machine. With none, the service makes a folder, which goes when the computer is killed. A folder named here never does. */
+            workspace?: string;
+            timeout?: components["schemas"]["Timeout"];
+            metadata?: components["schemas"]["Metadata"];
+        };
+        /** @description MCP over Streamable HTTP, each taking the computer's access token as a bearer. */
+        Endpoints: {
+            /** @description The terminal and files. */
+            computer: string | null;
+            /** @description The browser. */
+            browser: string | null;
+        };
+        Computer: {
+            computerID: string;
+            name: string;
+            state: components["schemas"]["ComputerState"];
+            access: components["schemas"]["Access"];
+            browser: boolean;
+            workspace: string | null;
+            /**
+             * Format: date-time
+             * @description When it last started.
+             */
+            startedAt: string;
+            /**
+             * Format: date-time
+             * @description When it will stop; null if it has no timeout.
+             */
+            endAt: string | null;
+            metadata: components["schemas"]["Metadata"];
+            endpoints: components["schemas"]["Endpoints"];
+        };
+        CreatedComputer: components["schemas"]["Computer"] & {
+            /** @description Good only for this computer's endpoints. Shown only now. */
+            accessToken: string;
+        };
+        ComputerDetail: components["schemas"]["Computer"] & {
+            uptimeSeconds: number;
+            tools: {
+                computer: string[];
+                browser: string[];
+            };
+        };
+        ComputerLogs: {
+            logs: {
+                /** Format: date-time */
+                timestamp: string;
+                line: string;
+            }[];
+        };
+        ServiceInfo: {
+            version: string;
+            /**
+             * @description How this service isolates its computers, chosen when it is started.
+             * @enum {string}
+             */
+            isolation: "none" | "container";
+        };
+    };
+    responses: {
+        /** @description It was refused. */
+        Error: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description No valid token. */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: {
+        computerID: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getInfo: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The service. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ServiceInfo"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    listComputers: {
+        parameters: {
+            query?: {
+                /** @description Only computers in this state. */
+                state?: components["schemas"]["ComputerState"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The computers, newest first. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Computer"][];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    createComputer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NewComputer"];
+            };
+        };
+        responses: {
+            /** @description The computer, with its access token, shown only now. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreatedComputer"];
+                };
+            };
+            400: components["responses"]["Error"];
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    getComputer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The computer. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ComputerDetail"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+        };
+    };
+    killComputer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Gone. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+        };
+    };
+    setComputerTimeout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    timeout: components["schemas"]["Timeout"];
+                };
+            };
+        };
+        responses: {
+            /** @description The computer. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Computer"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+            409: components["responses"]["Error"];
+        };
+    };
+    stopComputer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The computer. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Computer"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+        };
+    };
+    startComputer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    timeout?: components["schemas"]["Timeout"];
+                };
+            };
+        };
+        responses: {
+            /** @description The computer. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Computer"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+        };
+    };
+    getComputerLogs: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                computerID: components["parameters"]["computerID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The logs. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ComputerLogs"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["Error"];
+        };
+    };
+}

package/dist/types/sdk.d.ts

@@ -0,0 +1,189 @@
+import type { components } from "./generated/schema.js";
+type Schemas = components["schemas"];
+export type ComputerInfo = Schemas["Computer"];
+export type ComputerDetail = Schemas["ComputerDetail"];
+export type ServiceInfo = Schemas["ServiceInfo"];
+export type ComputerLog = Schemas["ComputerLogs"]["logs"][number];
+export interface ConnectionOpts {
+    /** The control token; `AGENTCOMPUTER_API_KEY` by default. */
+    apiKey?: string;
+    /** The service's address; `AGENTCOMPUTER_API_URL`, else `http://127.0.0.1:7878`. */
+    apiUrl?: string;
+}
+export interface CreateOpts extends ConnectionOpts {
+    access: Schemas["Access"];
+    browser?: boolean;
+    workspace?: string;
+    name?: string;
+    /** How long until it stops, in milliseconds. By default it doesn't. */
+    timeoutMs?: number;
+    metadata?: Record<string, string>;
+}
+export interface CommandResult {
+    exitCode: number;
+    output: string;
+    seconds: number;
+}
+export interface RunningCommand {
+    sessionId: string;
+    output: string;
+}
+/** The service refused, or a computer's tool failed. */
+export declare class ComputerError extends Error {
+    readonly code: number;
+    constructor(code: number, message: string);
+}
+/** What the command tools answer. */
+interface CommandAnswer {
+    exit_code: number | null;
+    seconds: number;
+    session_id: string | null;
+    text: string;
+}
+/** An MCP client for one endpoint, connected when first used. */
+declare class Endpoint {
+    #private;
+    constructor(url: string | null, token: string);
+    text(name: string, args: Record<string, unknown>): Promise<string>;
+    command(name: string, args: Record<string, unknown>): Promise<CommandAnswer>;
+    close(): Promise<void>;
+}
+/** Commands on a computer with the terminal level. */
+declare class Commands {
+    #private;
+    constructor(endpoint: Endpoint);
+    /** Run a command to its end. */
+    run(cmd: string, opts?: {
+        cwd?: string;
+    }): Promise<CommandResult>;
+    /** Start a command and return while it runs, unless it ends at once. */
+    run(cmd: string, opts: {
+        cwd?: string;
+        background: true;
+    }): Promise<RunningCommand | CommandResult>;
+    /** Type into a running command, and return what it wrote since. */
+    sendStdin(sessionId: string, data: string): Promise<string>;
+}
+/** Files in a computer's workspace. */
+declare class Files {
+    #private;
+    constructor(endpoint: Endpoint);
+    /** A text file's content, whole: a line too long for the tool to return is an error. */
+    read(path: string): Promise<string>;
+    /** Make a new file, or fill an empty one. */
+    write(path: string, content: string): Promise<void>;
+    /** Replace exact text, and return the unified diff. */
+    edit(path: string, oldText: string, newText: string, opts?: {
+        replaceAll?: boolean;
+    }): Promise<string>;
+    /** A folder's entries, the first thousand. */
+    list(path?: string): Promise<({
+        name: string;
+        type: "dir";
+        size?: undefined;
+    } | {
+        name: string;
+        type: "file";
+        size: number;
+    })[]>;
+    /** Lines matching text under a folder, as `path:line:text`. */
+    search(pattern: string, opts?: {
+        path?: string;
+        regex?: boolean;
+    }): Promise<string[]>;
+}
+/** One computer. Make one with `Computer.create`. */
+export declare class Computer {
+    #private;
+    readonly computerID: string;
+    readonly commands: Commands;
+    readonly files: Files;
+    private constructor();
+    static create(opts: CreateOpts): Promise<Computer>;
+    /** A computer made earlier. Its token was shown when it was made, and only then. */
+    static connect(computerID: string, opts: ConnectionOpts & {
+        accessToken: string;
+    }): Promise<Computer>;
+    static list(opts?: ConnectionOpts & {
+        state?: Schemas["ComputerState"];
+    }): Promise<ComputerInfo[]>;
+    static serviceInfo(opts?: ConnectionOpts): Promise<ServiceInfo>;
+    static getInfo(computerID: string, opts?: ConnectionOpts): Promise<ComputerDetail>;
+    /** It now stops this long from now, replacing any earlier timeout. */
+    static setTimeout(computerID: string, timeoutMs: number, opts?: ConnectionOpts): Promise<ComputerInfo>;
+    static stop(computerID: string, opts?: ConnectionOpts): Promise<ComputerInfo>;
+    static start(computerID: string, opts?: ConnectionOpts & {
+        timeoutMs?: number;
+    }): Promise<ComputerInfo>;
+    static getLogs(computerID: string, opts?: ConnectionOpts): Promise<ComputerLog[]>;
+    static kill(computerID: string, opts?: ConnectionOpts): Promise<void>;
+    /** The endpoint to give an MCP client. */
+    getMcpUrl(endpoint?: "computer" | "browser"): string;
+    /** The token for those endpoints. */
+    getMcpToken(): string;
+    getInfo(): Promise<{
+        computerID: string;
+        name: string;
+        state: components["schemas"]["ComputerState"];
+        access: components["schemas"]["Access"];
+        browser: boolean;
+        workspace: string | null;
+        startedAt: string;
+        endAt: string | null;
+        metadata: components["schemas"]["Metadata"];
+        endpoints: components["schemas"]["Endpoints"];
+    } & {
+        uptimeSeconds: number;
+        tools: {
+            computer: string[];
+            browser: string[];
+        };
+    }>;
+    isRunning(): Promise<boolean>;
+    setTimeout(timeoutMs: number): Promise<{
+        computerID: string;
+        name: string;
+        state: components["schemas"]["ComputerState"];
+        access: components["schemas"]["Access"];
+        browser: boolean;
+        workspace: string | null;
+        startedAt: string;
+        endAt: string | null;
+        metadata: components["schemas"]["Metadata"];
+        endpoints: components["schemas"]["Endpoints"];
+    }>;
+    stop(): Promise<{
+        computerID: string;
+        name: string;
+        state: components["schemas"]["ComputerState"];
+        access: components["schemas"]["Access"];
+        browser: boolean;
+        workspace: string | null;
+        startedAt: string;
+        endAt: string | null;
+        metadata: components["schemas"]["Metadata"];
+        endpoints: components["schemas"]["Endpoints"];
+    }>;
+    start(opts?: {
+        timeoutMs?: number;
+    }): Promise<{
+        computerID: string;
+        name: string;
+        state: components["schemas"]["ComputerState"];
+        access: components["schemas"]["Access"];
+        browser: boolean;
+        workspace: string | null;
+        startedAt: string;
+        endAt: string | null;
+        metadata: components["schemas"]["Metadata"];
+        endpoints: components["schemas"]["Endpoints"];
+    }>;
+    getLogs(): Promise<{
+        timestamp: string;
+        line: string;
+    }[]>;
+    kill(): Promise<void>;
+    /** Close this object's connection. The computer keeps running. */
+    close(): Promise<void>;
+}
+export {};