@onkernel/sdk 0.11.0 → 0.11.2

package/src/client.ts

@@ -13,6 +13,8 @@ import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
 import { VERSION } from './version';
 import * as Errors from './core/error';
+import * as Pagination from './core/pagination';
+import { AbstractPage, type OffsetPaginationParams, OffsetPaginationResponse } from './core/pagination';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
@@ -24,6 +26,7 @@ import {
   DeploymentFollowResponse,
   DeploymentListParams,
   DeploymentListResponse,
+  DeploymentListResponsesOffsetPagination,
   DeploymentRetrieveResponse,
   DeploymentStateEvent,
   Deployments,
@@ -40,6 +43,13 @@ import {
   Invocations,
 } from './resources/invocations';
 import { ProfileCreateParams, ProfileListResponse, Profiles } from './resources/profiles';
+import {
+  Proxies,
+  ProxyCreateParams,
+  ProxyCreateResponse,
+  ProxyListResponse,
+  ProxyRetrieveResponse,
+} from './resources/proxies';
 import {
   BrowserCreateParams,
   BrowserCreateResponse,
@@ -551,6 +561,25 @@ export class Kernel {
     return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
   }
 
+  getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
+    path: string,
+    Page: new (...args: any[]) => PageClass,
+    opts?: RequestOptions,
+  ): Pagination.PagePromise<PageClass, Item> {
+    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+  }
+
+  requestAPIList<
+    Item = unknown,
+    PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
+  >(
+    Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
+    options: FinalRequestOptions,
+  ): Pagination.PagePromise<PageClass, Item> {
+    const request = this.makeRequest(options, null, undefined);
+    return new Pagination.PagePromise<PageClass, Item>(this as any as Kernel, request, Page);
+  }
+
   async fetchWithTimeout(
     url: RequestInfo,
     init: RequestInit | undefined,
@@ -798,6 +827,7 @@ export class Kernel {
   invocations: API.Invocations = new API.Invocations(this);
   browsers: API.Browsers = new API.Browsers(this);
   profiles: API.Profiles = new API.Profiles(this);
+  proxies: API.Proxies = new API.Proxies(this);
 }
 
 Kernel.Deployments = Deployments;
@@ -805,10 +835,17 @@ Kernel.Apps = Apps;
 Kernel.Invocations = Invocations;
 Kernel.Browsers = Browsers;
 Kernel.Profiles = Profiles;
+Kernel.Proxies = Proxies;
 
 export declare namespace Kernel {
   export type RequestOptions = Opts.RequestOptions;
 
+  export import OffsetPagination = Pagination.OffsetPagination;
+  export {
+    type OffsetPaginationParams as OffsetPaginationParams,
+    type OffsetPaginationResponse as OffsetPaginationResponse,
+  };
+
   export {
     Deployments as Deployments,
     type DeploymentStateEvent as DeploymentStateEvent,
@@ -816,6 +853,7 @@ export declare namespace Kernel {
     type DeploymentRetrieveResponse as DeploymentRetrieveResponse,
     type DeploymentListResponse as DeploymentListResponse,
     type DeploymentFollowResponse as DeploymentFollowResponse,
+    type DeploymentListResponsesOffsetPagination as DeploymentListResponsesOffsetPagination,
     type DeploymentCreateParams as DeploymentCreateParams,
     type DeploymentListParams as DeploymentListParams,
     type DeploymentFollowParams as DeploymentFollowParams,
@@ -851,6 +889,14 @@ export declare namespace Kernel {
     type ProfileCreateParams as ProfileCreateParams,
   };
 
+  export {
+    Proxies as Proxies,
+    type ProxyCreateResponse as ProxyCreateResponse,
+    type ProxyRetrieveResponse as ProxyRetrieveResponse,
+    type ProxyListResponse as ProxyListResponse,
+    type ProxyCreateParams as ProxyCreateParams,
+  };
+
   export type AppAction = API.AppAction;
   export type ErrorDetail = API.ErrorDetail;
   export type ErrorEvent = API.ErrorEvent;

package/src/core/pagination.ts

@@ -0,0 +1,167 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { KernelError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type Kernel } from '../client';
+import { APIPromise } from './api-promise';
+import { type APIResponseProps } from '../internal/parse';
+import { maybeCoerceBoolean, maybeCoerceInteger, maybeObj } from '../internal/utils/values';
+
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+
+export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+  #client: Kernel;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: Kernel, response: Response, body: unknown, options: FinalRequestOptions) {
+    this.#client = client;
+    this.options = options;
+    this.response = response;
+    this.body = body;
+  }
+
+  abstract nextPageRequestOptions(): PageRequestOptions | null;
+
+  abstract getPaginatedItems(): Item[];
+
+  hasNextPage(): boolean {
+    const items = this.getPaginatedItems();
+    if (!items.length) return false;
+    return this.nextPageRequestOptions() != null;
+  }
+
+  async getNextPage(): Promise<this> {
+    const nextOptions = this.nextPageRequestOptions();
+    if (!nextOptions) {
+      throw new KernelError(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
+      );
+    }
+
+    return await this.#client.requestAPIList(this.constructor as any, nextOptions);
+  }
+
+  async *iterPages(): AsyncGenerator<this> {
+    let page: this = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
+      }
+    }
+  }
+}
+
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export class PagePromise<
+    PageClass extends AbstractPage<Item>,
+    Item = ReturnType<PageClass['getPaginatedItems']>[number],
+  >
+  extends APIPromise<PageClass>
+  implements AsyncIterable<Item>
+{
+  constructor(
+    client: Kernel,
+    request: Promise<APIResponseProps>,
+    Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass,
+  ) {
+    super(
+      client,
+      request,
+      async (client, props) =>
+        new Page(client, props.response, await defaultParseResponse(client, props), props.options),
+    );
+  }
+
+  /**
+   * Allow auto-paginating iteration on an unawaited list call, eg:
+   *
+   *    for await (const item of client.items.list()) {
+   *      console.log(item)
+   *    }
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
+  }
+}
+
+export type OffsetPaginationResponse<Item> = Item[];
+
+export interface OffsetPaginationParams {
+  offset?: number;
+
+  limit?: number;
+}
+
+export class OffsetPagination<Item> extends AbstractPage<Item> {
+  items: Array<Item>;
+
+  has_more: boolean | null;
+
+  next_offset: number | null;
+
+  constructor(
+    client: Kernel,
+    response: Response,
+    body: OffsetPaginationResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.items = body || [];
+    this.has_more = maybeCoerceBoolean(this.response.headers.get('x-has-more')) ?? null;
+    this.next_offset = maybeCoerceInteger(this.response.headers.get('x-next-offset')) ?? null;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.items ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const offset = this.next_offset;
+    if (!offset) {
+      return null;
+    }
+
+    const length = this.getPaginatedItems().length;
+    const currentCount = offset + length;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        offset: currentCount,
+      },
+    };
+  }
+}

package/src/index.ts

@@ -5,6 +5,7 @@ export { Kernel as default } from './client';
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
 export { Kernel, type ClientOptions } from './client';
+export { PagePromise } from './core/pagination';
 export {
   KernelError,
   APIError,

package/src/internal/utils/values.ts

@@ -76,21 +76,21 @@ export const coerceBoolean = (value: unknown): boolean => {
 };
 
 export const maybeCoerceInteger = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceInteger(value);
 };
 
 export const maybeCoerceFloat = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceFloat(value);
 };
 
 export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceBoolean(value);

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resources/browsers/browsers.ts

@@ -348,6 +348,12 @@ export interface BrowserCreateParams {
    */
   profile?: BrowserCreateParams.Profile;
 
+  /**
+   * Optional proxy to associate to the browser session. Must reference a proxy
+   * belonging to the caller's org.
+   */
+  proxy_id?: string;
+
   /**
    * If true, launches the browser in stealth mode to reduce detection by anti-bot
    * mechanisms.
@@ -357,7 +363,10 @@ export interface BrowserCreateParams {
   /**
    * The number of seconds of inactivity before the browser session is terminated.
    * Only applicable to non-persistent browsers. Activity includes CDP connections
-   * and live view connections. Defaults to 60 seconds.
+   * and live view connections. Defaults to 60 seconds. Minimum allowed is 10
+   * seconds. Maximum allowed is 86400 (24 hours). We check for inactivity every 5
+   * seconds, so the actual timeout behavior you will see is +/- 5 seconds around the
+   * specified value.
    */
   timeout_seconds?: number;
 }

package/src/resources/deployments.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
 import { Stream } from '../core/streaming';
 import { type Uploadable } from '../core/uploads';
 import { buildHeaders } from '../internal/headers';
@@ -43,14 +44,20 @@ export class Deployments extends APIResource {
    *
    * @example
    * ```ts
-   * const deployments = await client.deployments.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const deploymentListResponse of client.deployments.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: DeploymentListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DeploymentListResponse> {
-    return this._client.get('/deployments', { query, ...options });
+  ): PagePromise<DeploymentListResponsesOffsetPagination, DeploymentListResponse> {
+    return this._client.getAPIList('/deployments', OffsetPagination<DeploymentListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -77,6 +84,8 @@ export class Deployments extends APIResource {
   }
 }
 
+export type DeploymentListResponsesOffsetPagination = OffsetPagination<DeploymentListResponse>;
+
 /**
  * An event representing the current state of a deployment.
  */
@@ -234,53 +243,49 @@ export interface DeploymentRetrieveResponse {
   updated_at?: string | null;
 }
 
-export type DeploymentListResponse = Array<DeploymentListResponse.DeploymentListResponseItem>;
-
-export namespace DeploymentListResponse {
+/**
+ * Deployment record information.
+ */
+export interface DeploymentListResponse {
   /**
-   * Deployment record information.
+   * Unique identifier for the deployment
    */
-  export interface DeploymentListResponseItem {
-    /**
-     * Unique identifier for the deployment
-     */
-    id: string;
+  id: string;
 
-    /**
-     * Timestamp when the deployment was created
-     */
-    created_at: string;
+  /**
+   * Timestamp when the deployment was created
+   */
+  created_at: string;
 
-    /**
-     * Deployment region code
-     */
-    region: 'aws.us-east-1a';
+  /**
+   * Deployment region code
+   */
+  region: 'aws.us-east-1a';
 
-    /**
-     * Current status of the deployment
-     */
-    status: 'queued' | 'in_progress' | 'running' | 'failed' | 'stopped';
+  /**
+   * Current status of the deployment
+   */
+  status: 'queued' | 'in_progress' | 'running' | 'failed' | 'stopped';
 
-    /**
-     * Relative path to the application entrypoint
-     */
-    entrypoint_rel_path?: string;
+  /**
+   * Relative path to the application entrypoint
+   */
+  entrypoint_rel_path?: string;
 
-    /**
-     * Environment variables configured for this deployment
-     */
-    env_vars?: { [key: string]: string };
+  /**
+   * Environment variables configured for this deployment
+   */
+  env_vars?: { [key: string]: string };
 
-    /**
-     * Status reason
-     */
-    status_reason?: string;
+  /**
+   * Status reason
+   */
+  status_reason?: string;
 
-    /**
-     * Timestamp when the deployment was last updated
-     */
-    updated_at?: string | null;
-  }
+  /**
+   * Timestamp when the deployment was last updated
+   */
+  updated_at?: string | null;
 }
 
 /**
@@ -373,7 +378,7 @@ export interface DeploymentCreateParams {
   version?: string;
 }
 
-export interface DeploymentListParams {
+export interface DeploymentListParams extends OffsetPaginationParams {
   /**
    * Filter results by application name.
    */
@@ -394,6 +399,7 @@ export declare namespace Deployments {
     type DeploymentRetrieveResponse as DeploymentRetrieveResponse,
     type DeploymentListResponse as DeploymentListResponse,
     type DeploymentFollowResponse as DeploymentFollowResponse,
+    type DeploymentListResponsesOffsetPagination as DeploymentListResponsesOffsetPagination,
     type DeploymentCreateParams as DeploymentCreateParams,
     type DeploymentListParams as DeploymentListParams,
     type DeploymentFollowParams as DeploymentFollowParams,

package/src/resources/index.ts

@@ -22,6 +22,7 @@ export {
   type DeploymentCreateParams,
   type DeploymentListParams,
   type DeploymentFollowParams,
+  type DeploymentListResponsesOffsetPagination,
 } from './deployments';
 export {
   Invocations,
@@ -34,3 +35,10 @@ export {
   type InvocationUpdateParams,
 } from './invocations';
 export { Profiles, type ProfileListResponse, type ProfileCreateParams } from './profiles';
+export {
+  Proxies,
+  type ProxyCreateResponse,
+  type ProxyRetrieveResponse,
+  type ProxyListResponse,
+  type ProxyCreateParams,
+} from './proxies';

package/src/resources/invocations.ts

@@ -40,7 +40,8 @@ export class Invocations extends APIResource {
   }
 
   /**
-   * Update an invocation's status or output.
+   * Update an invocation's status or output. This can used to cancel an invocation
+   * by setting the status to "failed".
    *
    * @example
    * ```ts