feat: WIP: Configurable Viewport

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 57
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-592ab7a96084f7241d77b4cc1ce2a074795b0dc40d8247e1a0129fe3f89c1ed4.yml
-openapi_spec_hash: 3a23b4c9c05946251be45c5c4e7a415d
-config_hash: 15cd063f8e308686ac71bf9ee9634625
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-1cd328ccf61f0e888d6df27b091c30b38c392ab9ca8ce7fd0ead8f10aaf71ffa.yml
+openapi_spec_hash: af761c48d1955f11822f3b95f9c46750
+config_hash: deadfc4d2b0a947673bcf559b5db6e1b

api.md

@@ -73,7 +73,7 @@ Methods:
 - <code title="get /browsers">client.browsers.<a href="./src/resources/browsers/browsers.ts">list</a>() -> BrowserListResponse</code>
 - <code title="delete /browsers">client.browsers.<a href="./src/resources/browsers/browsers.ts">delete</a>({ ...params }) -> void</code>
 - <code title="delete /browsers/{id}">client.browsers.<a href="./src/resources/browsers/browsers.ts">deleteByID</a>(id) -> void</code>
-- <code title="post /browsers/{id}/extensions">client.browsers.<a href="./src/resources/browsers/browsers.ts">uploadExtensions</a>(id, { ...params }) -> void</code>
+- <code title="post /browsers/{id}/extensions">client.browsers.<a href="./src/resources/browsers/browsers.ts">loadExtensions</a>(id, { ...params }) -> void</code>
 
 ## Replays
 

src/client.ts

@@ -66,9 +66,9 @@ import {
   BrowserCreateResponse,
   BrowserDeleteParams,
   BrowserListResponse,
+  BrowserLoadExtensionsParams,
   BrowserPersistence,
   BrowserRetrieveResponse,
-  BrowserUploadExtensionsParams,
   Browsers,
   Profile,
 } from './resources/browsers/browsers';
@@ -899,7 +899,7 @@ export declare namespace Kernel {
     type BrowserListResponse as BrowserListResponse,
     type BrowserCreateParams as BrowserCreateParams,
     type BrowserDeleteParams as BrowserDeleteParams,
-    type BrowserUploadExtensionsParams as BrowserUploadExtensionsParams,
+    type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
   };
 
   export {

src/resources/browsers/browsers.ts

@@ -143,7 +143,7 @@ export class Browsers extends APIResource {
    *
    * @example
    * ```ts
-   * await client.browsers.uploadExtensions('id', {
+   * await client.browsers.loadExtensions('id', {
    *   extensions: [
    *     {
    *       name: 'name',
@@ -153,11 +153,7 @@ export class Browsers extends APIResource {
    * });
    * ```
    */
-  uploadExtensions(
-    id: string,
-    body: BrowserUploadExtensionsParams,
-    options?: RequestOptions,
-  ): APIPromise<void> {
+  loadExtensions(id: string, body: BrowserLoadExtensionsParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(
       path`/browsers/${id}/extensions`,
       multipartFormRequestOptions(
@@ -259,6 +255,48 @@ export interface BrowserCreateResponse {
    * ID of the proxy associated with this browser session, if any.
    */
   proxy_id?: string;
+
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  viewport?: BrowserCreateResponse.Viewport;
+}
+
+export namespace BrowserCreateResponse {
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  export interface Viewport {
+    /**
+     * Browser window height in pixels.
+     */
+    height: number;
+
+    /**
+     * Browser window width in pixels.
+     */
+    width: number;
+
+    /**
+     * Display refresh rate in Hz. If omitted, automatically determined from width and
+     * height.
+     */
+    refresh_rate?: number;
+  }
 }
 
 export interface BrowserRetrieveResponse {
@@ -312,6 +350,48 @@ export interface BrowserRetrieveResponse {
    * ID of the proxy associated with this browser session, if any.
    */
   proxy_id?: string;
+
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  viewport?: BrowserRetrieveResponse.Viewport;
+}
+
+export namespace BrowserRetrieveResponse {
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  export interface Viewport {
+    /**
+     * Browser window height in pixels.
+     */
+    height: number;
+
+    /**
+     * Browser window width in pixels.
+     */
+    width: number;
+
+    /**
+     * Display refresh rate in Hz. If omitted, automatically determined from width and
+     * height.
+     */
+    refresh_rate?: number;
+  }
 }
 
 export type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseItem>;
@@ -368,6 +448,48 @@ export namespace BrowserListResponse {
      * ID of the proxy associated with this browser session, if any.
      */
     proxy_id?: string;
+
+    /**
+     * Initial browser window size in pixels with optional refresh rate. If omitted,
+     * image defaults apply (commonly 1024x768@60). Only specific viewport
+     * configurations are supported. The server will reject unsupported combinations.
+     * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+     * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+     * automatically determined from the width and height if they match a supported
+     * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+     * live view browser
+     */
+    viewport?: BrowserListResponseItem.Viewport;
+  }
+
+  export namespace BrowserListResponseItem {
+    /**
+     * Initial browser window size in pixels with optional refresh rate. If omitted,
+     * image defaults apply (commonly 1024x768@60). Only specific viewport
+     * configurations are supported. The server will reject unsupported combinations.
+     * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+     * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+     * automatically determined from the width and height if they match a supported
+     * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+     * live view browser
+     */
+    export interface Viewport {
+      /**
+       * Browser window height in pixels.
+       */
+      height: number;
+
+      /**
+       * Browser window width in pixels.
+       */
+      width: number;
+
+      /**
+       * Display refresh rate in Hz. If omitted, automatically determined from width and
+       * height.
+       */
+      refresh_rate?: number;
+    }
   }
 }
 
@@ -421,6 +543,18 @@ export interface BrowserCreateParams {
    * specified value.
    */
   timeout_seconds?: number;
+
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  viewport?: BrowserCreateParams.Viewport;
 }
 
 export namespace BrowserCreateParams {
@@ -464,6 +598,34 @@ export namespace BrowserCreateParams {
      */
     save_changes?: boolean;
   }
+
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+   * automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  export interface Viewport {
+    /**
+     * Browser window height in pixels.
+     */
+    height: number;
+
+    /**
+     * Browser window width in pixels.
+     */
+    width: number;
+
+    /**
+     * Display refresh rate in Hz. If omitted, automatically determined from width and
+     * height.
+     */
+    refresh_rate?: number;
+  }
 }
 
 export interface BrowserDeleteParams {
@@ -473,14 +635,14 @@ export interface BrowserDeleteParams {
   persistent_id: string;
 }
 
-export interface BrowserUploadExtensionsParams {
+export interface BrowserLoadExtensionsParams {
   /**
    * List of extensions to upload and activate
    */
-  extensions: Array<BrowserUploadExtensionsParams.Extension>;
+  extensions: Array<BrowserLoadExtensionsParams.Extension>;
 }
 
-export namespace BrowserUploadExtensionsParams {
+export namespace BrowserLoadExtensionsParams {
   export interface Extension {
     /**
      * Folder name to place the extension under /home/kernel/extensions/<name>
@@ -509,7 +671,7 @@ export declare namespace Browsers {
     type BrowserListResponse as BrowserListResponse,
     type BrowserCreateParams as BrowserCreateParams,
     type BrowserDeleteParams as BrowserDeleteParams,
-    type BrowserUploadExtensionsParams as BrowserUploadExtensionsParams,
+    type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
   };
 
   export {

src/resources/browsers/index.ts

@@ -9,7 +9,7 @@ export {
   type BrowserListResponse,
   type BrowserCreateParams,
   type BrowserDeleteParams,
-  type BrowserUploadExtensionsParams,
+  type BrowserLoadExtensionsParams,
 } from './browsers';
 export {
   Fs,

src/resources/index.ts

@@ -11,7 +11,7 @@ export {
   type BrowserListResponse,
   type BrowserCreateParams,
   type BrowserDeleteParams,
-  type BrowserUploadExtensionsParams,
+  type BrowserLoadExtensionsParams,
 } from './browsers/browsers';
 export {
   Deployments,

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

@@ -34,6 +34,7 @@ describe('resource browsers', () => {
           proxy_id: 'proxy_id',
           stealth: true,
           timeout_seconds: 10,
+          viewport: { height: 800, width: 1280, refresh_rate: 60 },
         },
         { path: '/_stainless_unknown_path' },
       ),
@@ -94,8 +95,8 @@ describe('resource browsers', () => {
   });
 
   // Prism tests are disabled
-  test.skip('uploadExtensions: only required params', async () => {
-    const responsePromise = client.browsers.uploadExtensions('id', {
+  test.skip('loadExtensions: only required params', async () => {
+    const responsePromise = client.browsers.loadExtensions('id', {
       extensions: [{ name: 'name', zip_file: await toFile(Buffer.from('# my file contents'), 'README.md') }],
     });
     const rawResponse = await responsePromise.asResponse();
@@ -108,8 +109,8 @@ describe('resource browsers', () => {
   });
 
   // Prism tests are disabled
-  test.skip('uploadExtensions: required and optional params', async () => {
-    const response = await client.browsers.uploadExtensions('id', {
+  test.skip('loadExtensions: required and optional params', async () => {
+    const response = await client.browsers.loadExtensions('id', {
       extensions: [{ name: 'name', zip_file: await toFile(Buffer.from('# my file contents'), 'README.md') }],
     });
   });