@onkernel/sdk 0.61.0 → 0.63.0

package/src/internal/qs/types.ts

@@ -0,0 +1,71 @@
+export type Format = 'RFC1738' | 'RFC3986';
+
+export type DefaultEncoder = (str: any, defaultEncoder?: any, charset?: string) => string;
+export type DefaultDecoder = (str: string, decoder?: any, charset?: string) => string;
+
+export type BooleanOptional = boolean | undefined;
+
+export type StringifyBaseOptions = {
+  delimiter?: string;
+  allowDots?: boolean;
+  encodeDotInKeys?: boolean;
+  strictNullHandling?: boolean;
+  skipNulls?: boolean;
+  encode?: boolean;
+  encoder?: (
+    str: any,
+    defaultEncoder: DefaultEncoder,
+    charset: string,
+    type: 'key' | 'value',
+    format?: Format,
+  ) => string;
+  filter?: Array<PropertyKey> | ((prefix: PropertyKey, value: any) => any);
+  arrayFormat?: 'indices' | 'brackets' | 'repeat' | 'comma';
+  indices?: boolean;
+  sort?: ((a: PropertyKey, b: PropertyKey) => number) | null;
+  serializeDate?: (d: Date) => string;
+  format?: 'RFC1738' | 'RFC3986';
+  formatter?: (str: PropertyKey) => string;
+  encodeValuesOnly?: boolean;
+  addQueryPrefix?: boolean;
+  charset?: 'utf-8' | 'iso-8859-1';
+  charsetSentinel?: boolean;
+  allowEmptyArrays?: boolean;
+  commaRoundTrip?: boolean;
+};
+
+export type StringifyOptions = StringifyBaseOptions;
+
+export type ParseBaseOptions = {
+  comma?: boolean;
+  delimiter?: string | RegExp;
+  depth?: number | false;
+  decoder?: (str: string, defaultDecoder: DefaultDecoder, charset: string, type: 'key' | 'value') => any;
+  arrayLimit?: number;
+  parseArrays?: boolean;
+  plainObjects?: boolean;
+  allowPrototypes?: boolean;
+  allowSparse?: boolean;
+  parameterLimit?: number;
+  strictDepth?: boolean;
+  strictNullHandling?: boolean;
+  ignoreQueryPrefix?: boolean;
+  charset?: 'utf-8' | 'iso-8859-1';
+  charsetSentinel?: boolean;
+  interpretNumericEntities?: boolean;
+  allowEmptyArrays?: boolean;
+  duplicates?: 'combine' | 'first' | 'last';
+  allowDots?: boolean;
+  decodeDotInKeys?: boolean;
+};
+
+export type ParseOptions = ParseBaseOptions;
+
+export type ParsedQs = {
+  [key: string]: undefined | string | string[] | ParsedQs | ParsedQs[];
+};
+
+// Type to remove null or undefined union from each property
+export type NonNullableProperties<T> = {
+  [K in keyof T]-?: Exclude<T[K], undefined | null>;
+};

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+import { isArray } from '../utils/values';
+
+export let has = (obj: object, key: PropertyKey): boolean => (
+  (has = (Object as any).hasOwn ?? Function.prototype.call.bind(Object.prototype.hasOwnProperty)),
+  has(obj, key)
+);
+
+const hex_table = /* @__PURE__ */ (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (isArray(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (isArray(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (isArray(target) && !isArray(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (isArray(target) && isArray(source)) {
+    source.forEach(function (item, i) {
+      if (has(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (isArray(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/internal/utils/query.ts

@@ -1,23 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { KernelError } from '../../core/error';
+import * as qs from '../qs/stringify';
 
-/**
- * Basic re-implementation of `qs.stringify` for primitive types.
- */
 export function stringifyQuery(query: object | Record<string, unknown>) {
-  return Object.entries(query)
-    .filter(([_, value]) => typeof value !== 'undefined')
-    .map(([key, value]) => {
-      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-      }
-      if (value === null) {
-        return `${encodeURIComponent(key)}=`;
-      }
-      throw new KernelError(
-        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-      );
-    })
-    .join('&');
+  return qs.stringify(query, { arrayFormat: 'comma' });
 }

package/src/resources/browser-pools.ts

@@ -5,6 +5,7 @@ import * as Shared from './shared';
 import * as BrowsersAPI from './browsers/browsers';
 import * as TelemetryAPI from './browsers/telemetry';
 import { APIPromise } from '../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -60,11 +61,17 @@ export class BrowserPools extends APIResource {
    *
    * @example
    * ```ts
-   * const browserPools = await client.browserPools.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const browserPool of client.browserPools.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<BrowserPoolListResponse> {
-    return this._client.get('/browser_pools', options);
+  list(
+    query: BrowserPoolListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BrowserPoolsOffsetPagination, BrowserPool> {
+    return this._client.getAPIList('/browser_pools', OffsetPagination<BrowserPool>, { query, ...options });
   }
 
   /**
@@ -143,6 +150,8 @@ export class BrowserPools extends APIResource {
   }
 }
 
+export type BrowserPoolsOffsetPagination = OffsetPagination<BrowserPool>;
+
 /**
  * A browser pool containing multiple identically configured browsers.
  */
@@ -276,8 +285,6 @@ export namespace BrowserPool {
   }
 }
 
-export type BrowserPoolListResponse = Array<BrowserPool>;
-
 export interface BrowserPoolAcquireResponse {
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
@@ -348,6 +355,11 @@ export interface BrowserPoolAcquireResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -372,6 +384,12 @@ export interface BrowserPoolAcquireResponse {
    */
   start_url?: string;
 
+  /**
+   * User-defined key-value tags that were set on this browser session, if any.
+   * Echoed back when present.
+   */
+  tags?: BrowsersAPI.Tags;
+
   /**
    * Active telemetry configuration for the session, if any.
    */
@@ -591,6 +609,8 @@ export interface BrowserPoolUpdateParams {
   viewport?: Shared.BrowserViewport;
 }
 
+export interface BrowserPoolListParams extends OffsetPaginationParams {}
+
 export interface BrowserPoolDeleteParams {
   /**
    * If true, force delete even if browsers are currently leased. Leased browsers
@@ -624,10 +644,11 @@ export interface BrowserPoolReleaseParams {
 export declare namespace BrowserPools {
   export {
     type BrowserPool as BrowserPool,
-    type BrowserPoolListResponse as BrowserPoolListResponse,
     type BrowserPoolAcquireResponse as BrowserPoolAcquireResponse,
+    type BrowserPoolsOffsetPagination as BrowserPoolsOffsetPagination,
     type BrowserPoolCreateParams as BrowserPoolCreateParams,
     type BrowserPoolUpdateParams as BrowserPoolUpdateParams,
+    type BrowserPoolListParams as BrowserPoolListParams,
     type BrowserPoolDeleteParams as BrowserPoolDeleteParams,
     type BrowserPoolAcquireParams as BrowserPoolAcquireParams,
     type BrowserPoolReleaseParams as BrowserPoolReleaseParams,

package/src/resources/browsers/browsers.ts

@@ -319,6 +319,11 @@ export interface Profile {
   updated_at?: string;
 }
 
+/**
+ * User-defined key-value tags.
+ */
+export type Tags = { [key: string]: string };
+
 export interface BrowserCreateResponse {
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
@@ -389,6 +394,11 @@ export interface BrowserCreateResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -413,6 +423,12 @@ export interface BrowserCreateResponse {
    */
   start_url?: string;
 
+  /**
+   * User-defined key-value tags that were set on this browser session, if any.
+   * Echoed back when present.
+   */
+  tags?: Tags;
+
   /**
    * Active telemetry configuration for the session, if any.
    */
@@ -510,6 +526,11 @@ export interface BrowserRetrieveResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -534,6 +555,12 @@ export interface BrowserRetrieveResponse {
    */
   start_url?: string;
 
+  /**
+   * User-defined key-value tags that were set on this browser session, if any.
+   * Echoed back when present.
+   */
+  tags?: Tags;
+
   /**
    * Active telemetry configuration for the session, if any.
    */
@@ -631,6 +658,11 @@ export interface BrowserUpdateResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -655,6 +687,12 @@ export interface BrowserUpdateResponse {
    */
   start_url?: string;
 
+  /**
+   * User-defined key-value tags that were set on this browser session, if any.
+   * Echoed back when present.
+   */
+  tags?: Tags;
+
   /**
    * Active telemetry configuration for the session, if any.
    */
@@ -752,6 +790,11 @@ export interface BrowserListResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -776,6 +819,12 @@ export interface BrowserListResponse {
    */
   start_url?: string;
 
+  /**
+   * User-defined key-value tags that were set on this browser session, if any.
+   * Echoed back when present.
+   */
+  tags?: Tags;
+
   /**
    * Active telemetry configuration for the session, if any.
    */
@@ -865,6 +914,13 @@ export interface BrowserCreateParams {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Optional human-readable name for the browser session, used to find it later in
+   * the dashboard. Must be unique among active sessions within the project. Set at
+   * creation time only.
+   */
+  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.
@@ -891,6 +947,12 @@ export interface BrowserCreateParams {
    */
   stealth?: boolean;
 
+  /**
+   * Optional user-defined key-value tags for the browser session, used to find and
+   * group sessions later. Set at creation time only. Up to 50 pairs.
+   */
+  tags?: Tags;
+
   /**
    * Telemetry configuration for the browser session. Set enabled to true to start
    * capture using VM defaults, or provide browser category settings. If omitted,
@@ -1040,7 +1102,7 @@ export interface BrowserListParams extends OffsetPaginationParams {
   include_deleted?: boolean;
 
   /**
-   * Search browsers by session ID, profile ID, proxy ID, or pool name.
+   * Search browsers by name, session ID, profile ID, proxy ID, or pool name.
    */
   query?: string;
 
@@ -1049,6 +1111,13 @@ export interface BrowserListParams extends OffsetPaginationParams {
    * "deleted" returns only soft-deleted sessions, "all" returns both.
    */
   status?: 'active' | 'deleted' | 'all';
+
+  /**
+   * Filter sessions by tag key-value pairs using deepObject style, e.g.
+   * ?tags[team]=backend&tags[env]=staging. Multiple pairs are ANDed: a session must
+   * match every supplied pair exactly.
+   */
+  tags?: { [key: string]: string };
 }
 
 export interface BrowserCurlParams {
@@ -1118,6 +1187,7 @@ export declare namespace Browsers {
     type BrowserPoolRef as BrowserPoolRef,
     type BrowserUsage as BrowserUsage,
     type Profile as Profile,
+    type Tags as Tags,
     type BrowserCreateResponse as BrowserCreateResponse,
     type BrowserRetrieveResponse as BrowserRetrieveResponse,
     type BrowserUpdateResponse as BrowserUpdateResponse,

package/src/resources/browsers/index.ts

@@ -5,6 +5,7 @@ export {
   type BrowserPoolRef,
   type BrowserUsage,
   type Profile,
+  type Tags,
   type BrowserCreateResponse,
   type BrowserRetrieveResponse,
   type BrowserUpdateResponse,

package/src/resources/credential-providers.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -63,12 +64,20 @@ export class CredentialProviders extends APIResource {
    *
    * @example
    * ```ts
-   * const credentialProviders =
-   *   await client.credentialProviders.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const credentialProvider of client.credentialProviders.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<CredentialProviderListResponse> {
-    return this._client.get('/org/credential_providers', options);
+  list(
+    query: CredentialProviderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CredentialProvidersOffsetPagination, CredentialProvider> {
+    return this._client.getAPIList('/org/credential_providers', OffsetPagination<CredentialProvider>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -115,6 +124,8 @@ export class CredentialProviders extends APIResource {
   }
 }
 
+export type CredentialProvidersOffsetPagination = OffsetPagination<CredentialProvider>;
+
 /**
  * Request to create an external credential provider
  */
@@ -280,8 +291,6 @@ export interface UpdateCredentialProviderRequest {
   priority?: number;
 }
 
-export type CredentialProviderListResponse = Array<CredentialProvider>;
-
 export interface CredentialProviderListItemsResponse {
   items?: Array<CredentialProviderItem>;
 }
@@ -335,6 +344,8 @@ export interface CredentialProviderUpdateParams {
   priority?: number;
 }
 
+export interface CredentialProviderListParams extends OffsetPaginationParams {}
+
 export declare namespace CredentialProviders {
   export {
     type CreateCredentialProviderRequest as CreateCredentialProviderRequest,
@@ -342,9 +353,10 @@ export declare namespace CredentialProviders {
     type CredentialProviderItem as CredentialProviderItem,
     type CredentialProviderTestResult as CredentialProviderTestResult,
     type UpdateCredentialProviderRequest as UpdateCredentialProviderRequest,
-    type CredentialProviderListResponse as CredentialProviderListResponse,
     type CredentialProviderListItemsResponse as CredentialProviderListItemsResponse,
+    type CredentialProvidersOffsetPagination as CredentialProvidersOffsetPagination,
     type CredentialProviderCreateParams as CredentialProviderCreateParams,
     type CredentialProviderUpdateParams as CredentialProviderUpdateParams,
+    type CredentialProviderListParams as CredentialProviderListParams,
   };
 }