feat: add WebSocket process attach and PTY support

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-8e4a29d23d2882fcb0864606091790fd58bffa4f5d5c8d081052b72ad47b215b.yml
-openapi_spec_hash: fc82d930dad739ac01e3c2bddba7bf61
-config_hash: d0585c44724cd7deecea60a5ffae69df
+configured_endpoints: 90
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-6a44c851ec955b997558a8524eb641355ff3097474f40772b8ea2fef5bee4134.yml
+openapi_spec_hash: 155ee005a1b43e1c11e843de91e9f509
+config_hash: 6cbbf855a29bc675f35ddb1106ea9083

api.md

@@ -133,6 +133,7 @@ Types:
 
 - <code><a href="./src/resources/browsers/process.ts">ProcessExecResponse</a></code>
 - <code><a href="./src/resources/browsers/process.ts">ProcessKillResponse</a></code>
+- <code><a href="./src/resources/browsers/process.ts">ProcessResizeResponse</a></code>
 - <code><a href="./src/resources/browsers/process.ts">ProcessSpawnResponse</a></code>
 - <code><a href="./src/resources/browsers/process.ts">ProcessStatusResponse</a></code>
 - <code><a href="./src/resources/browsers/process.ts">ProcessStdinResponse</a></code>
@@ -142,6 +143,7 @@ Methods:
 
 - <code title="post /browsers/{id}/process/exec">client.browsers.process.<a href="./src/resources/browsers/process.ts">exec</a>(id, { ...params }) -> ProcessExecResponse</code>
 - <code title="post /browsers/{id}/process/{process_id}/kill">client.browsers.process.<a href="./src/resources/browsers/process.ts">kill</a>(processID, { ...params }) -> ProcessKillResponse</code>
+- <code title="post /browsers/{id}/process/{process_id}/resize">client.browsers.process.<a href="./src/resources/browsers/process.ts">resize</a>(processID, { ...params }) -> ProcessResizeResponse</code>
 - <code title="post /browsers/{id}/process/spawn">client.browsers.process.<a href="./src/resources/browsers/process.ts">spawn</a>(id, { ...params }) -> ProcessSpawnResponse</code>
 - <code title="get /browsers/{id}/process/{process_id}/status">client.browsers.process.<a href="./src/resources/browsers/process.ts">status</a>(processID, { ...params }) -> ProcessStatusResponse</code>
 - <code title="post /browsers/{id}/process/{process_id}/stdin">client.browsers.process.<a href="./src/resources/browsers/process.ts">stdin</a>(processID, { ...params }) -> ProcessStdinResponse</code>

src/resources/browsers/browsers.ts

@@ -26,6 +26,8 @@ import {
   ProcessExecResponse,
   ProcessKillParams,
   ProcessKillResponse,
+  ProcessResizeParams,
+  ProcessResizeResponse,
   ProcessSpawnParams,
   ProcessSpawnResponse,
   ProcessStatusParams,
@@ -615,12 +617,14 @@ export declare namespace Browsers {
     Process as Process,
     type ProcessExecResponse as ProcessExecResponse,
     type ProcessKillResponse as ProcessKillResponse,
+    type ProcessResizeResponse as ProcessResizeResponse,
     type ProcessSpawnResponse as ProcessSpawnResponse,
     type ProcessStatusResponse as ProcessStatusResponse,
     type ProcessStdinResponse as ProcessStdinResponse,
     type ProcessStdoutStreamResponse as ProcessStdoutStreamResponse,
     type ProcessExecParams as ProcessExecParams,
     type ProcessKillParams as ProcessKillParams,
+    type ProcessResizeParams as ProcessResizeParams,
     type ProcessSpawnParams as ProcessSpawnParams,
     type ProcessStatusParams as ProcessStatusParams,
     type ProcessStdinParams as ProcessStdinParams,

src/resources/browsers/index.ts

@@ -48,12 +48,14 @@ export {
   Process,
   type ProcessExecResponse,
   type ProcessKillResponse,
+  type ProcessResizeResponse,
   type ProcessSpawnResponse,
   type ProcessStatusResponse,
   type ProcessStdinResponse,
   type ProcessStdoutStreamResponse,
   type ProcessExecParams,
   type ProcessKillParams,
+  type ProcessResizeParams,
   type ProcessSpawnParams,
   type ProcessStatusParams,
   type ProcessStdinParams,

src/resources/browsers/process.ts

@@ -42,6 +42,30 @@ export class Process extends APIResource {
     return this._client.post(path`/browsers/${id}/process/${processID}/kill`, { body, ...options });
   }
 
+  /**
+   * Resize a PTY-backed process terminal
+   *
+   * @example
+   * ```ts
+   * const response = await client.browsers.process.resize(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     id: 'id',
+   *     cols: 1,
+   *     rows: 1,
+   *   },
+   * );
+   * ```
+   */
+  resize(
+    processID: string,
+    params: ProcessResizeParams,
+    options?: RequestOptions,
+  ): APIPromise<ProcessResizeResponse> {
+    const { id, ...body } = params;
+    return this._client.post(path`/browsers/${id}/process/${processID}/resize`, { body, ...options });
+  }
+
   /**
    * Execute a command asynchronously
    *
@@ -156,6 +180,16 @@ export interface ProcessKillResponse {
   ok: boolean;
 }
 
+/**
+ * Generic OK response.
+ */
+export interface ProcessResizeResponse {
+  /**
+   * Indicates success.
+   */
+  ok: boolean;
+}
+
 /**
  * Information about a spawned process.
  */
@@ -285,12 +319,34 @@ export interface ProcessKillParams {
   signal: 'TERM' | 'KILL' | 'INT' | 'HUP';
 }
 
+export interface ProcessResizeParams {
+  /**
+   * Path param: Browser session ID
+   */
+  id: string;
+
+  /**
+   * Body param: New terminal columns.
+   */
+  cols: number;
+
+  /**
+   * Body param: New terminal rows.
+   */
+  rows: number;
+}
+
 export interface ProcessSpawnParams {
   /**
    * Executable or shell command to run.
    */
   command: string;
 
+  /**
+   * Allocate a pseudo-terminal (PTY) for interactive shells.
+   */
+  allocate_tty?: boolean;
+
   /**
    * Command arguments.
    */
@@ -306,6 +362,11 @@ export interface ProcessSpawnParams {
    */
   as_user?: string | null;
 
+  /**
+   * Initial terminal columns. Only used when allocate_tty is true.
+   */
+  cols?: number;
+
   /**
    * Working directory (absolute path) to run the command in.
    */
@@ -316,6 +377,11 @@ export interface ProcessSpawnParams {
    */
   env?: { [key: string]: string };
 
+  /**
+   * Initial terminal rows. Only used when allocate_tty is true.
+   */
+  rows?: number;
+
   /**
    * Maximum execution time in seconds.
    */
@@ -352,12 +418,14 @@ export declare namespace Process {
   export {
     type ProcessExecResponse as ProcessExecResponse,
     type ProcessKillResponse as ProcessKillResponse,
+    type ProcessResizeResponse as ProcessResizeResponse,
     type ProcessSpawnResponse as ProcessSpawnResponse,
     type ProcessStatusResponse as ProcessStatusResponse,
     type ProcessStdinResponse as ProcessStdinResponse,
     type ProcessStdoutStreamResponse as ProcessStdoutStreamResponse,
     type ProcessExecParams as ProcessExecParams,
     type ProcessKillParams as ProcessKillParams,
+    type ProcessResizeParams as ProcessResizeParams,
     type ProcessSpawnParams as ProcessSpawnParams,
     type ProcessStatusParams as ProcessStatusParams,
     type ProcessStdinParams as ProcessStdinParams,

tests/api-resources/browsers/process.test.ts

@@ -56,6 +56,31 @@ describe('resource process', () => {
     });
   });
 
+  // Prism tests are disabled
+  test.skip('resize: only required params', async () => {
+    const responsePromise = client.browsers.process.resize('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+      id: 'id',
+      cols: 1,
+      rows: 1,
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  // Prism tests are disabled
+  test.skip('resize: required and optional params', async () => {
+    const response = await client.browsers.process.resize('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+      id: 'id',
+      cols: 1,
+      rows: 1,
+    });
+  });
+
   // Prism tests are disabled
   test.skip('spawn: only required params', async () => {
     const responsePromise = client.browsers.process.spawn('id', { command: 'command' });
@@ -72,11 +97,14 @@ describe('resource process', () => {
   test.skip('spawn: required and optional params', async () => {
     const response = await client.browsers.process.spawn('id', {
       command: 'command',
+      allocate_tty: true,
       args: ['string'],
       as_root: true,
       as_user: 'as_user',
+      cols: 1,
       cwd: '/J!',
       env: { foo: 'string' },
+      rows: 1,
       timeout_sec: 0,
     });
   });