@onkernel/sdk 0.7.0 → 0.8.0

package/resources/index.js

@@ -6,7 +6,7 @@ const tslib_1 = require("../internal/tslib.js");
 tslib_1.__exportStar(require("./shared.js"), exports);
 var apps_1 = require("./apps/apps.js");
 Object.defineProperty(exports, "Apps", { enumerable: true, get: function () { return apps_1.Apps; } });
-var browsers_1 = require("./browsers.js");
+var browsers_1 = require("./browsers/browsers.js");
 Object.defineProperty(exports, "Browsers", { enumerable: true, get: function () { return browsers_1.Browsers; } });
 var deployments_1 = require("./deployments.js");
 Object.defineProperty(exports, "Deployments", { enumerable: true, get: function () { return deployments_1.Deployments; } });

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,uCAA6E;AAApE,4FAAA,IAAI,OAAA;AACb,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA;AAQV,gDAUuB;AATrB,0GAAA,WAAW,OAAA;AAUb,gDASuB;AARrB,0GAAA,WAAW,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,uCAA6E;AAApE,4FAAA,IAAI,OAAA;AACb,mDAQ6B;AAP3B,oGAAA,QAAQ,OAAA;AAQV,gDAUuB;AATrB,0GAAA,WAAW,OAAA;AAUb,gDASuB;AARrB,0GAAA,WAAW,OAAA"}

package/resources/index.mjs

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export * from "./shared.mjs";
 export { Apps } from "./apps/apps.mjs";
-export { Browsers, } from "./browsers.mjs";
+export { Browsers, } from "./browsers/browsers.mjs";
 export { Deployments, } from "./deployments.mjs";
 export { Invocations, } from "./invocations.mjs";
 //# sourceMappingURL=index.mjs.map

package/src/client.ts

@@ -16,15 +16,6 @@ import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
-import {
-  BrowserCreateParams,
-  BrowserCreateResponse,
-  BrowserDeleteParams,
-  BrowserListResponse,
-  BrowserPersistence,
-  BrowserRetrieveResponse,
-  Browsers,
-} from './resources/browsers';
 import {
   DeploymentCreateParams,
   DeploymentCreateResponse,
@@ -48,6 +39,15 @@ import {
   Invocations,
 } from './resources/invocations';
 import { AppListParams, AppListResponse, Apps } from './resources/apps/apps';
+import {
+  BrowserCreateParams,
+  BrowserCreateResponse,
+  BrowserDeleteParams,
+  BrowserListResponse,
+  BrowserPersistence,
+  BrowserRetrieveResponse,
+  Browsers,
+} from './resources/browsers/browsers';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -95,6 +95,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
   /**
@@ -228,7 +230,7 @@ export class Kernel {
    * Create a new client instance re-using the same options given to the current client with optional overriding.
    */
   withOptions(options: Partial<ClientOptions>): this {
-    return new (this.constructor as any as new (props: ClientOptions) => typeof this)({
+    const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
       environment: options.environment ? options.environment : undefined,
       baseURL: options.environment ? undefined : this.baseURL,
@@ -241,6 +243,7 @@ export class Kernel {
       apiKey: this.apiKey,
       ...options,
     });
+    return client;
   }
 
   /**
@@ -258,7 +261,7 @@ export class Kernel {
     return;
   }
 
-  protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined {
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
@@ -390,7 +393,9 @@ export class Kernel {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -468,7 +473,7 @@ export class Kernel {
     } with status ${response.status} in ${headersTime - startTime}ms`;
 
     if (!response.ok) {
-      const shouldRetry = this.shouldRetry(response);
+      const shouldRetry = await this.shouldRetry(response);
       if (retriesRemaining && shouldRetry) {
         const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
 
@@ -567,7 +572,7 @@ export class Kernel {
     }
   }
 
-  private shouldRetry(response: Response): boolean {
+  private async shouldRetry(response: Response): Promise<boolean> {
     // Note this is not a standard header.
     const shouldRetryHeader = response.headers.get('x-should-retry');
 
@@ -644,10 +649,10 @@ export class Kernel {
     return sleepSeconds * jitter * 1000;
   }
 
-  buildRequest(
+  async buildRequest(
     inputOptions: FinalRequestOptions,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: FinalizedRequestInit; url: string; timeout: number } {
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
     const options = { ...inputOptions };
     const { method, path, query, defaultBaseURL } = options;
 
@@ -655,7 +660,7 @@ export class Kernel {
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const { bodyHeaders, body } = this.buildBody({ options });
-    const reqHeaders = this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
 
     const req: FinalizedRequestInit = {
       method,
@@ -671,7 +676,7 @@ export class Kernel {
     return { req, url, timeout: options.timeout };
   }
 
-  private buildHeaders({
+  private async buildHeaders({
     options,
     method,
     bodyHeaders,
@@ -681,7 +686,7 @@ export class Kernel {
     method: HTTPMethod;
     bodyHeaders: HeadersLike;
     retryCount: number;
-  }): Headers {
+  }): Promise<Headers> {
     let idempotencyHeaders: HeadersLike = {};
     if (this.idempotencyHeader && method !== 'get') {
       if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
@@ -697,7 +702,7 @@ export class Kernel {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      this.authHeaders(options),
+      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,

package/src/core/streaming.ts

@@ -5,6 +5,8 @@ import { findDoubleNewlineIndex, LineDecoder } from '../internal/decoders/line';
 import { ReadableStreamToAsyncIterable } from '../internal/shims';
 import { isAbortError } from '../internal/errors';
 import { encodeUTF8 } from '../internal/utils/bytes';
+import { loggerFor } from '../internal/utils/log';
+import type { Kernel } from '../client';
 
 type Bytes = string | ArrayBuffer | Uint8Array | null | undefined;
 
@@ -16,16 +18,24 @@ export type ServerSentEvent = {
 
 export class Stream<Item> implements AsyncIterable<Item> {
   controller: AbortController;
+  #client: Kernel | undefined;
 
   constructor(
     private iterator: () => AsyncIterator<Item>,
     controller: AbortController,
+    client?: Kernel,
   ) {
     this.controller = controller;
+    this.#client = client;
   }
 
-  static fromSSEResponse<Item>(response: Response, controller: AbortController): Stream<Item> {
+  static fromSSEResponse<Item>(
+    response: Response,
+    controller: AbortController,
+    client?: Kernel,
+  ): Stream<Item> {
     let consumed = false;
+    const logger = client ? loggerFor(client) : console;
 
     async function* iterator(): AsyncIterator<Item, any, undefined> {
       if (consumed) {
@@ -38,8 +48,8 @@ export class Stream<Item> implements AsyncIterable<Item> {
           try {
             yield JSON.parse(sse.data);
           } catch (e) {
-            console.error(`Could not parse message into JSON:`, sse.data);
-            console.error(`From chunk:`, sse.raw);
+            logger.error(`Could not parse message into JSON:`, sse.data);
+            logger.error(`From chunk:`, sse.raw);
             throw e;
           }
         }
@@ -54,14 +64,18 @@ export class Stream<Item> implements AsyncIterable<Item> {
       }
     }
 
-    return new Stream(iterator, controller);
+    return new Stream(iterator, controller, client);
   }
 
   /**
    * Generates a Stream from a newline-separated ReadableStream
    * where each item is a JSON value.
    */
-  static fromReadableStream<Item>(readableStream: ReadableStream, controller: AbortController): Stream<Item> {
+  static fromReadableStream<Item>(
+    readableStream: ReadableStream,
+    controller: AbortController,
+    client?: Kernel,
+  ): Stream<Item> {
     let consumed = false;
 
     async function* iterLines(): AsyncGenerator<string, void, unknown> {
@@ -101,7 +115,7 @@ export class Stream<Item> implements AsyncIterable<Item> {
       }
     }
 
-    return new Stream(iterator, controller);
+    return new Stream(iterator, controller, client);
   }
 
   [Symbol.asyncIterator](): AsyncIterator<Item> {
@@ -131,8 +145,8 @@ export class Stream<Item> implements AsyncIterable<Item> {
     };
 
     return [
-      new Stream(() => teeIterator(left), this.controller),
-      new Stream(() => teeIterator(right), this.controller),
+      new Stream(() => teeIterator(left), this.controller, this.#client),
+      new Stream(() => teeIterator(right), this.controller, this.#client),
     ];
   }
 

package/src/internal/parse.ts

@@ -24,10 +24,10 @@ export async function defaultParseResponse<T>(client: Kernel, props: APIResponse
       // that if you set `stream: true` the response type must also be `Stream<T>`
 
       if (props.options.__streamClass) {
-        return props.options.__streamClass.fromSSEResponse(response, props.controller) as any;
+        return props.options.__streamClass.fromSSEResponse(response, props.controller, client) as any;
       }
 
-      return Stream.fromSSEResponse(response, props.controller) as any;
+      return Stream.fromSSEResponse(response, props.controller, client) as any;
     }
 
     // fetch refuses to read the body when the status code is 204.

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/browsers.ts

@@ -0,0 +1,234 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BrowsersAPI from './browsers';
+import * as ReplaysAPI from './replays';
+import {
+  ReplayDownloadParams,
+  ReplayListResponse,
+  ReplayStartParams,
+  ReplayStartResponse,
+  ReplayStopParams,
+  Replays,
+} from './replays';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Browsers extends APIResource {
+  replays: ReplaysAPI.Replays = new ReplaysAPI.Replays(this._client);
+
+  /**
+   * Create a new browser session from within an action.
+   *
+   * @example
+   * ```ts
+   * const browser = await client.browsers.create();
+   * ```
+   */
+  create(
+    body: BrowserCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrowserCreateResponse> {
+    return this._client.post('/browsers', { body, ...options });
+  }
+
+  /**
+   * Get information about a browser session.
+   *
+   * @example
+   * ```ts
+   * const browser = await client.browsers.retrieve(
+   *   'htzv5orfit78e1m2biiifpbv',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BrowserRetrieveResponse> {
+    return this._client.get(path`/browsers/${id}`, options);
+  }
+
+  /**
+   * List active browser sessions
+   *
+   * @example
+   * ```ts
+   * const browsers = await client.browsers.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<BrowserListResponse> {
+    return this._client.get('/browsers', options);
+  }
+
+  /**
+   * Delete a persistent browser session by its persistent_id.
+   *
+   * @example
+   * ```ts
+   * await client.browsers.delete({
+   *   persistent_id: 'persistent_id',
+   * });
+   * ```
+   */
+  delete(params: BrowserDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { persistent_id } = params;
+    return this._client.delete('/browsers', {
+      query: { persistent_id },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Delete a browser session by ID
+   *
+   * @example
+   * ```ts
+   * await client.browsers.deleteByID(
+   *   'htzv5orfit78e1m2biiifpbv',
+   * );
+   * ```
+   */
+  deleteByID(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/browsers/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+/**
+ * Optional persistence configuration for the browser session.
+ */
+export interface BrowserPersistence {
+  /**
+   * Unique identifier for the persistent browser session.
+   */
+  id: string;
+}
+
+export interface BrowserCreateResponse {
+  /**
+   * Websocket URL for Chrome DevTools Protocol connections to the browser session
+   */
+  cdp_ws_url: string;
+
+  /**
+   * Unique identifier for the browser session
+   */
+  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 {
+  /**
+   * Websocket URL for Chrome DevTools Protocol connections to the browser session
+   */
+  cdp_ws_url: string;
+
+  /**
+   * Unique identifier for the browser session
+   */
+  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 type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseItem>;
+
+export namespace BrowserListResponse {
+  export interface BrowserListResponseItem {
+    /**
+     * Websocket URL for Chrome DevTools Protocol connections to the browser session
+     */
+    cdp_ws_url: string;
+
+    /**
+     * Unique identifier for the browser session
+     */
+    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;
+  }
+}
+
+export interface BrowserCreateParams {
+  /**
+   * If true, launches the browser using a headless image (no VNC/GUI). Defaults to
+   * false.
+   */
+  headless?: boolean;
+
+  /**
+   * action invocation ID
+   */
+  invocation_id?: string;
+
+  /**
+   * Optional persistence configuration for the browser session.
+   */
+  persistence?: BrowserPersistence;
+
+  /**
+   * If true, launches the browser in stealth mode to reduce detection by anti-bot
+   * mechanisms.
+   */
+  stealth?: boolean;
+}
+
+export interface BrowserDeleteParams {
+  /**
+   * Persistent browser identifier
+   */
+  persistent_id: string;
+}
+
+Browsers.Replays = Replays;
+
+export declare namespace Browsers {
+  export {
+    type BrowserPersistence as BrowserPersistence,
+    type BrowserCreateResponse as BrowserCreateResponse,
+    type BrowserRetrieveResponse as BrowserRetrieveResponse,
+    type BrowserListResponse as BrowserListResponse,
+    type BrowserCreateParams as BrowserCreateParams,
+    type BrowserDeleteParams as BrowserDeleteParams,
+  };
+
+  export {
+    Replays as Replays,
+    type ReplayListResponse as ReplayListResponse,
+    type ReplayStartResponse as ReplayStartResponse,
+    type ReplayDownloadParams as ReplayDownloadParams,
+    type ReplayStartParams as ReplayStartParams,
+    type ReplayStopParams as ReplayStopParams,
+  };
+}

package/src/resources/browsers/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Browsers,
+  type BrowserPersistence,
+  type BrowserCreateResponse,
+  type BrowserRetrieveResponse,
+  type BrowserListResponse,
+  type BrowserCreateParams,
+  type BrowserDeleteParams,
+} from './browsers';
+export {
+  Replays,
+  type ReplayListResponse,
+  type ReplayStartResponse,
+  type ReplayDownloadParams,
+  type ReplayStartParams,
+  type ReplayStopParams,
+} from './replays';