@onkernel/sdk 0.13.0 → 0.14.1

package/src/resources/browsers/browsers.ts

@@ -48,8 +48,10 @@ import {
   Fs,
 } from './fs/fs';
 import { APIPromise } from '../../core/api-promise';
+import { type Uploadable } from '../../core/uploads';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
 export class Browsers extends APIResource {
@@ -134,6 +136,32 @@ export class Browsers extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Loads one or more unpacked extensions and restarts Chromium on the browser
+   * instance.
+   *
+   * @example
+   * ```ts
+   * await client.browsers.loadExtensions('id', {
+   *   extensions: [
+   *     {
+   *       name: 'name',
+   *       zip_file: fs.createReadStream('path/to/file'),
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  loadExtensions(id: string, body: BrowserLoadExtensionsParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(
+      path`/browsers/${id}/extensions`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
 }
 
 /**
@@ -227,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 {
@@ -280,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>;
@@ -336,10 +448,57 @@ 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;
+    }
   }
 }
 
 export interface BrowserCreateParams {
+  /**
+   * List of browser extensions to load into the session. Provide each by id or name.
+   */
+  extensions?: Array<BrowserCreateParams.Extension>;
+
   /**
    * If true, launches the browser using a headless image (no VNC/GUI). Defaults to
    * false.
@@ -384,9 +543,38 @@ 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 {
+  /**
+   * Extension selection for the browser session. Provide either id or name of an
+   * extension uploaded to Kernel.
+   */
+  export interface Extension {
+    /**
+     * Extension ID to load for this browser session
+     */
+    id?: string;
+
+    /**
+     * Extension name to load for this browser session (instead of id). Must be 1-255
+     * characters, using letters, numbers, dots, underscores, or hyphens.
+     */
+    name?: string;
+  }
+
   /**
    * Profile selection for the browser session. Provide either id or name. If
    * specified, the matching profile will be loaded into the browser session.
@@ -410,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 {
@@ -419,6 +635,28 @@ export interface BrowserDeleteParams {
   persistent_id: string;
 }
 
+export interface BrowserLoadExtensionsParams {
+  /**
+   * List of extensions to upload and activate
+   */
+  extensions: Array<BrowserLoadExtensionsParams.Extension>;
+}
+
+export namespace BrowserLoadExtensionsParams {
+  export interface Extension {
+    /**
+     * Folder name to place the extension under /home/kernel/extensions/<name>
+     */
+    name: string;
+
+    /**
+     * Zip archive containing an unpacked Chromium extension (must include
+     * manifest.json)
+     */
+    zip_file: Uploadable;
+  }
+}
+
 Browsers.Replays = Replays;
 Browsers.Fs = Fs;
 Browsers.Process = Process;
@@ -433,6 +671,7 @@ export declare namespace Browsers {
     type BrowserListResponse as BrowserListResponse,
     type BrowserCreateParams as BrowserCreateParams,
     type BrowserDeleteParams as BrowserDeleteParams,
+    type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
   };
 
   export {

package/src/resources/browsers/index.ts

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

package/src/resources/extensions.ts

@@ -0,0 +1,200 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { type Uploadable } from '../core/uploads';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+import { path } from '../internal/utils/path';
+
+export class Extensions extends APIResource {
+  /**
+   * List extensions owned by the caller's organization.
+   *
+   * @example
+   * ```ts
+   * const extensions = await client.extensions.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ExtensionListResponse> {
+    return this._client.get('/extensions', options);
+  }
+
+  /**
+   * Delete an extension by its ID or by its name.
+   *
+   * @example
+   * ```ts
+   * await client.extensions.delete('id_or_name');
+   * ```
+   */
+  delete(idOrName: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/extensions/${idOrName}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Download the extension as a ZIP archive by ID or name.
+   *
+   * @example
+   * ```ts
+   * const response = await client.extensions.download(
+   *   'id_or_name',
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  download(idOrName: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/extensions/${idOrName}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
+  /**
+   * Returns a ZIP archive containing the unpacked extension fetched from the Chrome
+   * Web Store.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.extensions.downloadFromChromeStore({
+   *     url: 'url',
+   *   });
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  downloadFromChromeStore(
+    query: ExtensionDownloadFromChromeStoreParams,
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    return this._client.get('/extensions/from_chrome_store', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
+  /**
+   * Upload a zip file containing an unpacked browser extension. Optionally provide a
+   * unique name for later reference.
+   *
+   * @example
+   * ```ts
+   * const response = await client.extensions.upload({
+   *   file: fs.createReadStream('path/to/file'),
+   * });
+   * ```
+   */
+  upload(body: ExtensionUploadParams, options?: RequestOptions): APIPromise<ExtensionUploadResponse> {
+    return this._client.post('/extensions', multipartFormRequestOptions({ body, ...options }, this._client));
+  }
+}
+
+export type ExtensionListResponse = Array<ExtensionListResponse.ExtensionListResponseItem>;
+
+export namespace ExtensionListResponse {
+  /**
+   * A browser extension uploaded to Kernel.
+   */
+  export interface ExtensionListResponseItem {
+    /**
+     * Unique identifier for the extension
+     */
+    id: string;
+
+    /**
+     * Timestamp when the extension was created
+     */
+    created_at: string;
+
+    /**
+     * Size of the extension archive in bytes
+     */
+    size_bytes: number;
+
+    /**
+     * Timestamp when the extension was last used
+     */
+    last_used_at?: string | null;
+
+    /**
+     * Optional, easier-to-reference name for the extension. Must be unique within the
+     * organization.
+     */
+    name?: string | null;
+  }
+}
+
+/**
+ * A browser extension uploaded to Kernel.
+ */
+export interface ExtensionUploadResponse {
+  /**
+   * Unique identifier for the extension
+   */
+  id: string;
+
+  /**
+   * Timestamp when the extension was created
+   */
+  created_at: string;
+
+  /**
+   * Size of the extension archive in bytes
+   */
+  size_bytes: number;
+
+  /**
+   * Timestamp when the extension was last used
+   */
+  last_used_at?: string | null;
+
+  /**
+   * Optional, easier-to-reference name for the extension. Must be unique within the
+   * organization.
+   */
+  name?: string | null;
+}
+
+export interface ExtensionDownloadFromChromeStoreParams {
+  /**
+   * Chrome Web Store URL for the extension.
+   */
+  url: string;
+
+  /**
+   * Target operating system for the extension package. Defaults to linux.
+   */
+  os?: 'win' | 'mac' | 'linux';
+}
+
+export interface ExtensionUploadParams {
+  /**
+   * ZIP file containing the browser extension.
+   */
+  file: Uploadable;
+
+  /**
+   * Optional unique name within the organization to reference this extension.
+   */
+  name?: string;
+}
+
+export declare namespace Extensions {
+  export {
+    type ExtensionListResponse as ExtensionListResponse,
+    type ExtensionUploadResponse as ExtensionUploadResponse,
+    type ExtensionDownloadFromChromeStoreParams as ExtensionDownloadFromChromeStoreParams,
+    type ExtensionUploadParams as ExtensionUploadParams,
+  };
+}

package/src/resources/index.ts

@@ -11,6 +11,7 @@ export {
   type BrowserListResponse,
   type BrowserCreateParams,
   type BrowserDeleteParams,
+  type BrowserLoadExtensionsParams,
 } from './browsers/browsers';
 export {
   Deployments,
@@ -24,6 +25,13 @@ export {
   type DeploymentFollowParams,
   type DeploymentListResponsesOffsetPagination,
 } from './deployments';
+export {
+  Extensions,
+  type ExtensionListResponse,
+  type ExtensionUploadResponse,
+  type ExtensionDownloadFromChromeStoreParams,
+  type ExtensionUploadParams,
+} from './extensions';
 export {
   Invocations,
   type InvocationStateEvent,

package/src/resources/proxies.ts

@@ -88,7 +88,7 @@ export namespace ProxyCreateResponse {
    */
   export interface DatacenterProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -98,7 +98,7 @@ export namespace ProxyCreateResponse {
    */
   export interface IspProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -119,13 +119,12 @@ export namespace ProxyCreateResponse {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code.
      */
     country?: string;
 
     /**
-     * Operating system of the residential device.
+     * @deprecated Operating system of the residential device.
      */
     os?: 'windows' | 'macos' | 'android';
 
@@ -219,8 +218,7 @@ export namespace ProxyCreateResponse {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code
      */
     country?: string;
 
@@ -310,7 +308,7 @@ export namespace ProxyRetrieveResponse {
    */
   export interface DatacenterProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -320,7 +318,7 @@ export namespace ProxyRetrieveResponse {
    */
   export interface IspProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -341,13 +339,12 @@ export namespace ProxyRetrieveResponse {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code.
      */
     country?: string;
 
     /**
-     * Operating system of the residential device.
+     * @deprecated Operating system of the residential device.
      */
     os?: 'windows' | 'macos' | 'android';
 
@@ -441,8 +438,7 @@ export namespace ProxyRetrieveResponse {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code
      */
     country?: string;
 
@@ -535,7 +531,7 @@ export namespace ProxyListResponse {
      */
     export interface DatacenterProxyConfig {
       /**
-       * ISO 3166 country code or EU for the proxy exit node.
+       * ISO 3166 country code.
        */
       country: string;
     }
@@ -545,7 +541,7 @@ export namespace ProxyListResponse {
      */
     export interface IspProxyConfig {
       /**
-       * ISO 3166 country code or EU for the proxy exit node.
+       * ISO 3166 country code.
        */
       country: string;
     }
@@ -566,13 +562,12 @@ export namespace ProxyListResponse {
       city?: string;
 
       /**
-       * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-       * provided.
+       * ISO 3166 country code.
        */
       country?: string;
 
       /**
-       * Operating system of the residential device.
+       * @deprecated Operating system of the residential device.
        */
       os?: 'windows' | 'macos' | 'android';
 
@@ -666,8 +661,7 @@ export namespace ProxyListResponse {
       city?: string;
 
       /**
-       * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-       * provided.
+       * ISO 3166 country code
        */
       country?: string;
 
@@ -743,7 +737,7 @@ export namespace ProxyCreateParams {
    */
   export interface DatacenterProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -753,7 +747,7 @@ export namespace ProxyCreateParams {
    */
   export interface IspProxyConfig {
     /**
-     * ISO 3166 country code or EU for the proxy exit node.
+     * ISO 3166 country code.
      */
     country: string;
   }
@@ -774,13 +768,12 @@ export namespace ProxyCreateParams {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code.
      */
     country?: string;
 
     /**
-     * Operating system of the residential device.
+     * @deprecated Operating system of the residential device.
      */
     os?: 'windows' | 'macos' | 'android';
 
@@ -874,8 +867,7 @@ export namespace ProxyCreateParams {
     city?: string;
 
     /**
-     * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
-     * provided.
+     * ISO 3166 country code
      */
     country?: string;