feat: [kernel-1028] add api clipboard support

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 101
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-a935c8aae21f8ddb83ea5e289034df12cbde88d432fa2b287629814bb3f58bb6.yml
-openapi_spec_hash: df3189b9728372f01662a19c060bcbc5
-config_hash: 81f143f4bee47ae7b0b8357551babadf
+configured_endpoints: 103
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-f05b888046776a18dbffc1264a27c0256839d132066ef5f6e09ccf1bc505a8f7.yml
+openapi_spec_hash: 646fce3982d3efbdb38004b0e4ac4d17
+config_hash: cff4d43372b6fa66b64e2d4150f6aa76

api.md

@@ -167,6 +167,7 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/browsers/computer.ts">ComputerGetMousePositionResponse</a></code>
+- <code><a href="./src/resources/browsers/computer.ts">ComputerReadClipboardResponse</a></code>
 - <code><a href="./src/resources/browsers/computer.ts">ComputerSetCursorVisibilityResponse</a></code>
 
 Methods:
@@ -178,9 +179,11 @@ Methods:
 - <code title="post /browsers/{id}/computer/get_mouse_position">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">getMousePosition</a>(id) -> ComputerGetMousePositionResponse</code>
 - <code title="post /browsers/{id}/computer/move_mouse">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">moveMouse</a>(id, { ...params }) -> void</code>
 - <code title="post /browsers/{id}/computer/press_key">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">pressKey</a>(id, { ...params }) -> void</code>
+- <code title="post /browsers/{id}/computer/clipboard/read">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">readClipboard</a>(id) -> ComputerReadClipboardResponse</code>
 - <code title="post /browsers/{id}/computer/scroll">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">scroll</a>(id, { ...params }) -> void</code>
 - <code title="post /browsers/{id}/computer/cursor">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">setCursorVisibility</a>(id, { ...params }) -> ComputerSetCursorVisibilityResponse</code>
 - <code title="post /browsers/{id}/computer/type">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">typeText</a>(id, { ...params }) -> void</code>
+- <code title="post /browsers/{id}/computer/clipboard/write">client.browsers.computer.<a href="./src/resources/browsers/computer.ts">writeClipboard</a>(id, { ...params }) -> void</code>
 
 ## Playwright
 

src/resources/browsers/browsers.ts

@@ -12,10 +12,12 @@ import {
   ComputerGetMousePositionResponse,
   ComputerMoveMouseParams,
   ComputerPressKeyParams,
+  ComputerReadClipboardResponse,
   ComputerScrollParams,
   ComputerSetCursorVisibilityParams,
   ComputerSetCursorVisibilityResponse,
   ComputerTypeTextParams,
+  ComputerWriteClipboardParams,
 } from './computer';
 import * as LogsAPI from './logs';
 import { LogStreamParams, Logs } from './logs';
@@ -870,6 +872,7 @@ export declare namespace Browsers {
   export {
     Computer as Computer,
     type ComputerGetMousePositionResponse as ComputerGetMousePositionResponse,
+    type ComputerReadClipboardResponse as ComputerReadClipboardResponse,
     type ComputerSetCursorVisibilityResponse as ComputerSetCursorVisibilityResponse,
     type ComputerBatchParams as ComputerBatchParams,
     type ComputerCaptureScreenshotParams as ComputerCaptureScreenshotParams,
@@ -880,6 +883,7 @@ export declare namespace Browsers {
     type ComputerScrollParams as ComputerScrollParams,
     type ComputerSetCursorVisibilityParams as ComputerSetCursorVisibilityParams,
     type ComputerTypeTextParams as ComputerTypeTextParams,
+    type ComputerWriteClipboardParams as ComputerWriteClipboardParams,
   };
 
   export {

src/resources/browsers/computer.ts

@@ -142,6 +142,19 @@ export class Computer extends APIResource {
     });
   }
 
+  /**
+   * Read text from the clipboard on the browser instance
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.browsers.computer.readClipboard('id');
+   * ```
+   */
+  readClipboard(id: string, options?: RequestOptions): APIPromise<ComputerReadClipboardResponse> {
+    return this._client.post(path`/browsers/${id}/computer/clipboard/read`, options);
+  }
+
   /**
    * Scroll the mouse wheel at a position on the host computer
    *
@@ -194,6 +207,24 @@ export class Computer extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Write text to the clipboard on the browser instance
+   *
+   * @example
+   * ```ts
+   * await client.browsers.computer.writeClipboard('id', {
+   *   text: 'text',
+   * });
+   * ```
+   */
+  writeClipboard(id: string, body: ComputerWriteClipboardParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/browsers/${id}/computer/clipboard/write`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export interface ComputerGetMousePositionResponse {
@@ -208,6 +239,13 @@ export interface ComputerGetMousePositionResponse {
   y: number;
 }
 
+export interface ComputerReadClipboardResponse {
+  /**
+   * Current clipboard text content
+   */
+  text: string;
+}
+
 /**
  * Generic OK response.
  */
@@ -606,9 +644,17 @@ export interface ComputerTypeTextParams {
   delay?: number;
 }
 
+export interface ComputerWriteClipboardParams {
+  /**
+   * Text to write to the system clipboard
+   */
+  text: string;
+}
+
 export declare namespace Computer {
   export {
     type ComputerGetMousePositionResponse as ComputerGetMousePositionResponse,
+    type ComputerReadClipboardResponse as ComputerReadClipboardResponse,
     type ComputerSetCursorVisibilityResponse as ComputerSetCursorVisibilityResponse,
     type ComputerBatchParams as ComputerBatchParams,
     type ComputerCaptureScreenshotParams as ComputerCaptureScreenshotParams,
@@ -619,5 +665,6 @@ export declare namespace Computer {
     type ComputerScrollParams as ComputerScrollParams,
     type ComputerSetCursorVisibilityParams as ComputerSetCursorVisibilityParams,
     type ComputerTypeTextParams as ComputerTypeTextParams,
+    type ComputerWriteClipboardParams as ComputerWriteClipboardParams,
   };
 }

src/resources/browsers/index.ts

@@ -22,6 +22,7 @@ export {
 export {
   Computer,
   type ComputerGetMousePositionResponse,
+  type ComputerReadClipboardResponse,
   type ComputerSetCursorVisibilityResponse,
   type ComputerBatchParams,
   type ComputerCaptureScreenshotParams,
@@ -32,6 +33,7 @@ export {
   type ComputerScrollParams,
   type ComputerSetCursorVisibilityParams,
   type ComputerTypeTextParams,
+  type ComputerWriteClipboardParams,
 } from './computer';
 export {
   Fs,

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

@@ -199,6 +199,18 @@ describe('resource computer', () => {
     });
   });
 
+  // Mock server tests are disabled
+  test.skip('readClipboard', async () => {
+    const responsePromise = client.browsers.computer.readClipboard('id');
+    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);
+  });
+
   // Mock server tests are disabled
   test.skip('scroll: only required params', async () => {
     const responsePromise = client.browsers.computer.scroll('id', { x: 0, y: 0 });
@@ -255,4 +267,21 @@ describe('resource computer', () => {
   test.skip('typeText: required and optional params', async () => {
     const response = await client.browsers.computer.typeText('id', { text: 'text', delay: 0 });
   });
+
+  // Mock server tests are disabled
+  test.skip('writeClipboard: only required params', async () => {
+    const responsePromise = client.browsers.computer.writeClipboard('id', { text: 'text' });
+    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);
+  });
+
+  // Mock server tests are disabled
+  test.skip('writeClipboard: required and optional params', async () => {
+    const response = await client.browsers.computer.writeClipboard('id', { text: 'text' });
+  });
 });