@onkernel/sdk 0.6.5 → 0.7.1

package/src/internal/request-options.ts

@@ -10,17 +10,70 @@ import { type HeadersLike } from './headers';
 export type FinalRequestOptions = RequestOptions & { method: HTTPMethod; path: string };
 
 export type RequestOptions = {
+  /**
+   * The HTTP method for the request (e.g., 'get', 'post', 'put', 'delete').
+   */
   method?: HTTPMethod;
+
+  /**
+   * The URL path for the request.
+   *
+   * @example "/v1/foo"
+   */
   path?: string;
+
+  /**
+   * Query parameters to include in the request URL.
+   */
   query?: object | undefined | null;
+
+  /**
+   * The request body. Can be a string, JSON object, FormData, or other supported types.
+   */
   body?: unknown;
+
+  /**
+   * HTTP headers to include with the request. Can be a Headers object, plain object, or array of tuples.
+   */
   headers?: HeadersLike;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
   maxRetries?: number;
+
   stream?: boolean | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * @unit milliseconds
+   */
   timeout?: number;
+
+  /**
+   * Additional `RequestInit` options to be passed to the underlying `fetch` call.
+   * These options will be merged with the client's default fetch options.
+   */
   fetchOptions?: MergedRequestInit;
+
+  /**
+   * An AbortSignal that can be used to cancel the request.
+   */
   signal?: AbortSignal | undefined | null;
+
+  /**
+   * A unique key for this request to enable idempotency.
+   */
   idempotencyKey?: string;
+
+  /**
+   * Override the default base URL for this specific request.
+   */
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;

package/src/resources/browsers.ts

@@ -84,6 +84,27 @@ export class Browsers extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Get browser session replay.
+   *
+   * @example
+   * ```ts
+   * const response = await client.browsers.retrieveReplay(
+   *   'htzv5orfit78e1m2biiifpbv',
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  retrieveReplay(id: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/browsers/${id}/replay`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'video/mp4' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
 }
 
 /**
@@ -97,11 +118,6 @@ export interface BrowserPersistence {
 }
 
 export interface BrowserCreateResponse {
-  /**
-   * Remote URL for live viewing the browser session
-   */
-  browser_live_view_url: string;
-
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
    */
@@ -112,18 +128,24 @@ export interface BrowserCreateResponse {
    */
   session_id: string;
 
+  /**
+   * Remote URL for live viewing the browser session. Only available for non-headless
+   * browsers.
+   */
+  browser_live_view_url?: string;
+
   /**
    * Optional persistence configuration for the browser session.
    */
   persistence?: BrowserPersistence;
-}
 
-export interface BrowserRetrieveResponse {
   /**
-   * Remote URL for live viewing the browser session
+   * Remote URL for viewing the browser session replay if enabled
    */
-  browser_live_view_url: string;
+  replay_view_url?: string;
+}
 
+export interface BrowserRetrieveResponse {
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
    */
@@ -134,21 +156,27 @@ export interface BrowserRetrieveResponse {
    */
   session_id: string;
 
+  /**
+   * Remote URL for live viewing the browser session. Only available for non-headless
+   * browsers.
+   */
+  browser_live_view_url?: string;
+
   /**
    * Optional persistence configuration for the browser session.
    */
   persistence?: BrowserPersistence;
+
+  /**
+   * Remote URL for viewing the browser session replay if enabled
+   */
+  replay_view_url?: string;
 }
 
 export type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseItem>;
 
 export namespace BrowserListResponse {
   export interface BrowserListResponseItem {
-    /**
-     * Remote URL for live viewing the browser session
-     */
-    browser_live_view_url: string;
-
     /**
      * Websocket URL for Chrome DevTools Protocol connections to the browser session
      */
@@ -159,14 +187,31 @@ export namespace BrowserListResponse {
      */
     session_id: string;
 
+    /**
+     * Remote URL for live viewing the browser session. Only available for non-headless
+     * browsers.
+     */
+    browser_live_view_url?: string;
+
     /**
      * Optional persistence configuration for the browser session.
      */
     persistence?: BrowsersAPI.BrowserPersistence;
+
+    /**
+     * Remote URL for viewing the browser session replay if enabled
+     */
+    replay_view_url?: string;
   }
 }
 
 export interface BrowserCreateParams {
+  /**
+   * If true, launches the browser using a headless image (no VNC/GUI). Defaults to
+   * false.
+   */
+  headless?: boolean;
+
   /**
    * action invocation ID
    */
@@ -177,6 +222,11 @@ export interface BrowserCreateParams {
    */
   persistence?: BrowserPersistence;
 
+  /**
+   * If true, enables replay recording of the browser session. Defaults to false.
+   */
+  replay?: boolean;
+
   /**
    * If true, launches the browser in stealth mode to reduce detection by anti-bot
    * mechanisms.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.6.5'; // x-release-please-version
+export const VERSION = '0.7.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.5";
+export declare const VERSION = "0.7.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.5";
+export declare const VERSION = "0.7.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.6.5'; // x-release-please-version
+exports.VERSION = '0.7.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.6.5'; // x-release-please-version
+export const VERSION = '0.7.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map