@archildata/api-types 0.0.20 → 0.0.22

package/index.d.ts

@@ -196,8 +196,8 @@ export interface paths {
         /**
          * Execute a command on a disk
          * @description Launches a container with the specified disk mounted, runs the given
-         *     command to completion, and shuts down the container. Returns immediately
-         *     with the container info; poll the container endpoint for completion.
+         *     command to completion, shuts down the container, and returns the command
+         *     result.
          */
         post: operations["execDisk"];
         delete?: never;
@@ -400,17 +400,10 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Create a direct sandbox connection
-         * @description Returns a short-lived WebSocket URL for an interactive shell in a
-         *     running sandbox. Connecting starts `/bin/sh` with a PTY. The connection
-         *     has no stored history or reconnect support.
-         *
-         *     The URL contains a signed token that expires at `expires_at`. An open
-         *     WebSocket can remain connected after the token expires. Clients send
-         *     raw terminal input as binary frames and terminal size changes as text
-         *     frames containing `{"type":"resize","rows":24,"cols":80}`. The server
-         *     returns raw terminal output as binary frames. Closing the WebSocket ends
-         *     the shell. Pausing or stopping the sandbox also closes the connection.
+         * Create a sandbox process connection
+         * @description Returns a short-lived WebSocket URL used by the sandbox process API.
+         *     The URL contains a signed token that expires at `expires_at`; an open
+         *     WebSocket can remain connected after the token expires.
          */
         post: operations["createSandboxConnection"];
         delete?: never;
@@ -419,72 +412,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/sandboxes/{sid}/execs": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * List recent execs
-         * @description The sandbox's most recent execs, newest first.
-         */
-        get: operations["listSandboxExecs"];
-        put?: never;
-        /**
-         * Run a command in a sandbox
-         * @description Submits a shell command to a running sandbox. By default the response
-         *     reports `running` after the runtime accepts it. Set `wait=true` to hold
-         *     for a terminal result; if the wait budget expires, the response remains
-         *     `running` and the result is available from getSandboxExec. Only
-         *     `running` sandboxes accept execs (409 otherwise).
-         */
-        post: operations["execInSandbox"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/api/sandboxes/{sid}/execs/{eid}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Get an exec's status and result */
-        get: operations["getSandboxExec"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/api/sandboxes/{sid}/execs/{eid}/cancel": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Cancel a running exec
-         * @description Aborts a running exec. Idempotent; cancelling an exec that already
-         *     finished returns its terminal result unchanged.
-         */
-        post: operations["cancelSandboxExec"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/sandboxes/{sid}/pause": {
         parameters: {
             query?: never;
@@ -498,8 +425,9 @@ export interface paths {
          * Pause a sandbox
          * @description Snapshot the CPU & memory state, then stop the VM. The sandbox reports
          *     `pausing` until the snapshot commit marker is durable and the VM exits,
-         *     then reports `paused`. Any in-flight execs are cancelled. A sandbox
-         *     that is still `pending` must reach `running` before it can be paused.
+         *     then reports `paused`. Attached process connections close, while
+         *     agent-owned processes remain available for reattachment after resume.
+         *     A sandbox that is still `pending` must reach `running` before it can be paused.
          *     To restore the snapshot, call `/resume`.
          */
         post: operations["pauseSandbox"];
@@ -595,7 +523,7 @@ export interface paths {
          * @description Gracefully shuts down the guest, then checkpoints its disk before
          *     entering `stopped`. The sandbox and any forks from it cold-boot from
          *     disk state. Stopping a paused sandbox reuses its existing disk
-         *     checkpoint. In-flight execs receive the guest shutdown signal.
+         *     checkpoint. In-flight processes receive the guest shutdown signal.
          */
         post: operations["stopSandbox"];
         delete?: never;
@@ -660,6 +588,20 @@ export interface components {
         };
         /** @enum {string} */
         SandboxState: "pending" | "running" | "pausing" | "paused" | "stopping" | "stopped" | "exited" | "failed" | "deleting" | "deleted";
+        /** @enum {string} */
+        SandboxNetworkAction: "allow" | "deny";
+        /** @description Deny targets take precedence when an address matches both lists. */
+        SandboxEgressPolicy: {
+            default: components["schemas"]["SandboxNetworkAction"];
+            /** @description Allowed IPv4 addresses or CIDR ranges. */
+            allow?: string[];
+            /** @description Denied IPv4 addresses or CIDR ranges. */
+            deny?: string[];
+        };
+        /** @description Sandbox network policy. Egress is unrestricted when omitted. */
+        SandboxNetwork: {
+            egress?: components["schemas"]["SandboxEgressPolicy"];
+        };
         Sandbox: {
             /** Format: uuid */
             sandbox_id: string;
@@ -670,7 +612,7 @@ export interface components {
             mem_size_mib: number;
             /** @description Full lifetime budget applied independently to each powered-on session. */
             max_ttl_seconds: number;
-            /** @description Maximum number of concurrently attached exec sessions. Detached processes and one-shot process controls do not count. */
+            /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
             max_concurrent_execs: number;
             /** @description OCI reference requested when the sandbox was created. */
             base_image: string;
@@ -680,6 +622,7 @@ export interface components {
              */
             platform?: "arm64" | "amd64";
             endpoints?: components["schemas"]["SandboxEndpoint"][];
+            network?: components["schemas"]["SandboxNetwork"];
             /** Format: date-time */
             created_at: string;
             /** Format: date-time */
@@ -720,26 +663,6 @@ export interface components {
             success: boolean;
             data: components["schemas"]["Sandbox"];
         };
-        /** @enum {string} */
-        SandboxExecState: "running" | "completed" | "failed" | "cancelled" | "timed_out";
-        SandboxExec: {
-            /** Format: uuid */
-            sandbox_id: string;
-            /** Format: uuid */
-            exec_id: string;
-            command: string;
-            status: components["schemas"]["SandboxExecState"];
-            exit_code?: number;
-            stdout?: string;
-            stderr?: string;
-            exit_reason?: string;
-            /** Format: int64 */
-            execute_time_ms?: number;
-            /** Format: date-time */
-            started_at: string;
-            /** Format: date-time */
-            finished_at?: string;
-        };
         CreateSandboxRequest: {
             /** @description Sandbox name, unique within the account. A random word-list name is generated when omitted. */
             name?: string;
@@ -753,34 +676,20 @@ export interface components {
              */
             base_image: string;
             port_mappings?: components["schemas"]["SandboxPortMapping"][];
-            /** @description Environment variables applied to every exec */
+            /** @description Environment variables applied to every process */
             env?: {
                 [key: string]: string;
             };
+            network?: components["schemas"]["SandboxNetwork"];
             /** @description Lifetime budget applied independently to each powered-on session */
             max_ttl_seconds?: number;
-            /** @description Maximum number of concurrently attached exec sessions. Detached processes and one-shot process controls do not count. */
+            /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
             max_concurrent_execs?: number;
         };
         ForkSandboxRequest: {
             /** @description Name for the fork. A random word-list name is generated when omitted. */
             name?: string;
         };
-        SandboxExecRequest: {
-            /** @description Shell command, run via `/bin/sh -c` */
-            command: string;
-            /** @description Allocate a TTY for the command */
-            command_tty?: boolean;
-            /** @description Extra environment variables for this command */
-            env?: {
-                [key: string]: string;
-            };
-            /**
-             * Format: int64
-             * @description Server-side execution deadline; the exec reports timed_out past it
-             */
-            timeout_seconds?: number;
-        };
         ApiResponse_SandboxList: {
             /** @example true */
             success: boolean;
@@ -788,18 +697,6 @@ export interface components {
                 sandboxes?: components["schemas"]["Sandbox"][];
             };
         };
-        ApiResponse_SandboxExec: {
-            /** @example true */
-            success: boolean;
-            data: components["schemas"]["SandboxExec"];
-        };
-        ApiResponse_SandboxExecList: {
-            /** @example true */
-            success: boolean;
-            data: {
-                execs?: components["schemas"]["SandboxExec"][];
-            };
-        };
         CreateDiskRequest: {
             /**
              * @description Disk name (alphanumeric, dashes, underscores)
@@ -1657,9 +1554,7 @@ export interface components {
         DiskId: string;
         /** @description Sandbox UUID */
         SandboxId: string;
-        /** @description Exec UUID */
-        ExecId: string;
-        /** @description Hold the request for a completed start or exec result */
+        /** @description Hold the request for a completed sandbox lifecycle transition */
         Wait: boolean;
         /** @description Maximum number of items to return. Omit to return all items in a single unpaginated response; when set, the response may include a nextCursor to fetch the next page. */
         Limit: number;
@@ -2300,7 +2195,7 @@ export interface operations {
     createSandbox: {
         parameters: {
             query?: {
-                /** @description Hold the request for a completed start or exec result */
+                /** @description Hold the request for a completed sandbox lifecycle transition */
                 wait?: components["parameters"]["Wait"];
             };
             header?: never;
@@ -2439,140 +2334,6 @@ export interface operations {
             500: components["responses"]["InternalError"];
         };
     };
-    listSandboxExecs: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description Sandbox UUID */
-                sid: components["parameters"]["SandboxId"];
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Recent execs */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ApiResponse_SandboxExecList"];
-                };
-            };
-            401: components["responses"]["Unauthorized"];
-            404: components["responses"]["NotFound"];
-            500: components["responses"]["InternalError"];
-        };
-    };
-    execInSandbox: {
-        parameters: {
-            query?: {
-                /** @description Hold the request for a completed start or exec result */
-                wait?: components["parameters"]["Wait"];
-            };
-            header?: never;
-            path: {
-                /** @description Sandbox UUID */
-                sid: components["parameters"]["SandboxId"];
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["SandboxExecRequest"];
-            };
-        };
-        responses: {
-            /** @description The exec, terminal (result fields set) or still running */
-            202: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ApiResponse_SandboxExec"];
-                };
-            };
-            400: components["responses"]["ValidationError"];
-            401: components["responses"]["Unauthorized"];
-            404: components["responses"]["NotFound"];
-            /** @description The sandbox is not running */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The sandbox's max_concurrent_execs cap is reached */
-            429: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            500: components["responses"]["InternalError"];
-        };
-    };
-    getSandboxExec: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description Sandbox UUID */
-                sid: components["parameters"]["SandboxId"];
-                /** @description Exec UUID */
-                eid: components["parameters"]["ExecId"];
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description The exec; result fields are set once terminal */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ApiResponse_SandboxExec"];
-                };
-            };
-            401: components["responses"]["Unauthorized"];
-            404: components["responses"]["NotFound"];
-            500: components["responses"]["InternalError"];
-        };
-    };
-    cancelSandboxExec: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description Sandbox UUID */
-                sid: components["parameters"]["SandboxId"];
-                /** @description Exec UUID */
-                eid: components["parameters"]["ExecId"];
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description The exec after the cancel */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ApiResponse_SandboxExec"];
-                };
-            };
-            401: components["responses"]["Unauthorized"];
-            404: components["responses"]["NotFound"];
-            500: components["responses"]["InternalError"];
-        };
-    };
     pauseSandbox: {
         parameters: {
             query?: never;
@@ -2622,7 +2383,7 @@ export interface operations {
     forkSandbox: {
         parameters: {
             query?: {
-                /** @description Hold the request for a completed start or exec result */
+                /** @description Hold the request for a completed sandbox lifecycle transition */
                 wait?: components["parameters"]["Wait"];
             };
             header?: never;
@@ -2666,7 +2427,7 @@ export interface operations {
     resumeSandbox: {
         parameters: {
             query?: {
-                /** @description Hold the request for a completed start or exec result */
+                /** @description Hold the request for a completed sandbox lifecycle transition */
                 wait?: components["parameters"]["Wait"];
             };
             header?: never;
@@ -2715,7 +2476,7 @@ export interface operations {
     startSandbox: {
         parameters: {
             query?: {
-                /** @description Hold the request for a completed start or exec result */
+                /** @description Hold the request for a completed sandbox lifecycle transition */
                 wait?: components["parameters"]["Wait"];
             };
             header?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/api-types",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "API types for the Archil control plane",
   "type": "module",
   "types": "index.d.ts",