feat: WIP browser extensions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 51
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-8a6175a75caa75c3de5400edf97a34e526ac3f62c63955375437461581deb0c2.yml
-openapi_spec_hash: 1a880e4ce337a0e44630e6d87ef5162a
-config_hash: 49c2ff978aaa5ccb4ce324a72f116010
+configured_endpoints: 57
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-936db268b3dcae5d64bd5d590506d8134304ffcbf67389eb9b1555b3febfd4cb.yml
+openapi_spec_hash: 145485087adf1b28c052bacb4df68462
+config_hash: 5236f9b34e39dc1930e36a88c714abd4

api.md

@@ -73,6 +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>
 
 ## Replays
 
@@ -177,3 +178,18 @@ Methods:
 - <code title="get /proxies/{id}">client.proxies.<a href="./src/resources/proxies.ts">retrieve</a>(id) -> ProxyRetrieveResponse</code>
 - <code title="get /proxies">client.proxies.<a href="./src/resources/proxies.ts">list</a>() -> ProxyListResponse</code>
 - <code title="delete /proxies/{id}">client.proxies.<a href="./src/resources/proxies.ts">delete</a>(id) -> void</code>
+
+# Extensions
+
+Types:
+
+- <code><a href="./src/resources/extensions.ts">ExtensionListResponse</a></code>
+- <code><a href="./src/resources/extensions.ts">ExtensionUploadResponse</a></code>
+
+Methods:
+
+- <code title="get /extensions">client.extensions.<a href="./src/resources/extensions.ts">list</a>() -> ExtensionListResponse</code>
+- <code title="delete /extensions/{id_or_name}">client.extensions.<a href="./src/resources/extensions.ts">delete</a>(idOrName) -> void</code>
+- <code title="get /extensions/{id_or_name}">client.extensions.<a href="./src/resources/extensions.ts">download</a>(idOrName) -> Response</code>
+- <code title="get /extensions/from_chrome_store">client.extensions.<a href="./src/resources/extensions.ts">downloadFromChromeStore</a>({ ...params }) -> Response</code>
+- <code title="post /extensions">client.extensions.<a href="./src/resources/extensions.ts">upload</a>({ ...params }) -> ExtensionUploadResponse</code>

src/client.ts

@@ -32,6 +32,13 @@ import {
   Deployments,
 } from './resources/deployments';
 import { KernelApp } from './core/app-framework';
+import {
+  ExtensionDownloadFromChromeStoreParams,
+  ExtensionListResponse,
+  ExtensionUploadParams,
+  ExtensionUploadResponse,
+  Extensions,
+} from './resources/extensions';
 import {
   InvocationCreateParams,
   InvocationCreateResponse,
@@ -61,6 +68,7 @@ import {
   BrowserListResponse,
   BrowserPersistence,
   BrowserRetrieveResponse,
+  BrowserUploadExtensionsParams,
   Browsers,
   Profile,
 } from './resources/browsers/browsers';
@@ -832,6 +840,7 @@ export class Kernel {
   browsers: API.Browsers = new API.Browsers(this);
   profiles: API.Profiles = new API.Profiles(this);
   proxies: API.Proxies = new API.Proxies(this);
+  extensions: API.Extensions = new API.Extensions(this);
 }
 
 Kernel.Deployments = Deployments;
@@ -840,6 +849,7 @@ Kernel.Invocations = Invocations;
 Kernel.Browsers = Browsers;
 Kernel.Profiles = Profiles;
 Kernel.Proxies = Proxies;
+Kernel.Extensions = Extensions;
 
 export declare namespace Kernel {
   export type RequestOptions = Opts.RequestOptions;
@@ -889,6 +899,7 @@ export declare namespace Kernel {
     type BrowserListResponse as BrowserListResponse,
     type BrowserCreateParams as BrowserCreateParams,
     type BrowserDeleteParams as BrowserDeleteParams,
+    type BrowserUploadExtensionsParams as BrowserUploadExtensionsParams,
   };
 
   export {
@@ -905,6 +916,14 @@ export declare namespace Kernel {
     type ProxyCreateParams as ProxyCreateParams,
   };
 
+  export {
+    Extensions as Extensions,
+    type ExtensionListResponse as ExtensionListResponse,
+    type ExtensionUploadResponse as ExtensionUploadResponse,
+    type ExtensionDownloadFromChromeStoreParams as ExtensionDownloadFromChromeStoreParams,
+    type ExtensionUploadParams as ExtensionUploadParams,
+  };
+
   export type AppAction = API.AppAction;
   export type ErrorDetail = API.ErrorDetail;
   export type ErrorEvent = API.ErrorEvent;

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,36 @@ 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.uploadExtensions('id', {
+   *   extensions: [
+   *     {
+   *       name: 'name',
+   *       zip_file: fs.createReadStream('path/to/file'),
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  uploadExtensions(
+    id: string,
+    body: BrowserUploadExtensionsParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(
+      path`/browsers/${id}/extensions`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
 }
 
 /**
@@ -340,6 +372,11 @@ export namespace BrowserListResponse {
 }
 
 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.
@@ -387,6 +424,23 @@ export interface BrowserCreateParams {
 }
 
 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.
@@ -419,6 +473,28 @@ export interface BrowserDeleteParams {
   persistent_id: string;
 }
 
+export interface BrowserUploadExtensionsParams {
+  /**
+   * List of extensions to upload and activate
+   */
+  extensions: Array<BrowserUploadExtensionsParams.Extension>;
+}
+
+export namespace BrowserUploadExtensionsParams {
+  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 +509,7 @@ export declare namespace Browsers {
     type BrowserListResponse as BrowserListResponse,
     type BrowserCreateParams as BrowserCreateParams,
     type BrowserDeleteParams as BrowserDeleteParams,
+    type BrowserUploadExtensionsParams as BrowserUploadExtensionsParams,
   };
 
   export {

src/resources/browsers/index.ts

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