@onkernel/sdk 0.9.0 → 0.10.0

package/src/resources/browsers/browsers.ts

@@ -2,6 +2,24 @@
 
 import { APIResource } from '../../core/resource';
 import * as BrowsersAPI from './browsers';
+import * as LogsAPI from './logs';
+import { LogStreamParams, Logs } from './logs';
+import * as ProcessAPI from './process';
+import {
+  Process,
+  ProcessExecParams,
+  ProcessExecResponse,
+  ProcessKillParams,
+  ProcessKillResponse,
+  ProcessSpawnParams,
+  ProcessSpawnResponse,
+  ProcessStatusParams,
+  ProcessStatusResponse,
+  ProcessStdinParams,
+  ProcessStdinResponse,
+  ProcessStdoutStreamParams,
+  ProcessStdoutStreamResponse,
+} from './process';
 import * as ReplaysAPI from './replays';
 import {
   ReplayDownloadParams,
@@ -16,6 +34,7 @@ import {
   FCreateDirectoryParams,
   FDeleteDirectoryParams,
   FDeleteFileParams,
+  FDownloadDirZipParams,
   FFileInfoParams,
   FFileInfoResponse,
   FListFilesParams,
@@ -23,6 +42,8 @@ import {
   FMoveParams,
   FReadFileParams,
   FSetFilePermissionsParams,
+  FUploadParams,
+  FUploadZipParams,
   FWriteFileParams,
   Fs,
 } from './fs/fs';
@@ -34,6 +55,8 @@ import { path } from '../../internal/utils/path';
 export class Browsers extends APIResource {
   replays: ReplaysAPI.Replays = new ReplaysAPI.Replays(this._client);
   fs: FsAPI.Fs = new FsAPI.Fs(this._client);
+  process: ProcessAPI.Process = new ProcessAPI.Process(this._client);
+  logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
 
   /**
    * Create a new browser session from within an action.
@@ -129,11 +152,31 @@ export interface BrowserCreateResponse {
    */
   cdp_ws_url: string;
 
+  /**
+   * When the browser session was created.
+   */
+  created_at: string;
+
+  /**
+   * Whether the browser session is running in headless mode.
+   */
+  headless: boolean;
+
   /**
    * Unique identifier for the browser session
    */
   session_id: string;
 
+  /**
+   * Whether the browser session is running in stealth mode.
+   */
+  stealth: boolean;
+
+  /**
+   * The number of seconds of inactivity before the browser session is terminated.
+   */
+  timeout_seconds: number;
+
   /**
    * Remote URL for live viewing the browser session. Only available for non-headless
    * browsers.
@@ -152,11 +195,31 @@ export interface BrowserRetrieveResponse {
    */
   cdp_ws_url: string;
 
+  /**
+   * When the browser session was created.
+   */
+  created_at: string;
+
+  /**
+   * Whether the browser session is running in headless mode.
+   */
+  headless: boolean;
+
   /**
    * Unique identifier for the browser session
    */
   session_id: string;
 
+  /**
+   * Whether the browser session is running in stealth mode.
+   */
+  stealth: boolean;
+
+  /**
+   * The number of seconds of inactivity before the browser session is terminated.
+   */
+  timeout_seconds: number;
+
   /**
    * Remote URL for live viewing the browser session. Only available for non-headless
    * browsers.
@@ -178,11 +241,31 @@ export namespace BrowserListResponse {
      */
     cdp_ws_url: string;
 
+    /**
+     * When the browser session was created.
+     */
+    created_at: string;
+
+    /**
+     * Whether the browser session is running in headless mode.
+     */
+    headless: boolean;
+
     /**
      * Unique identifier for the browser session
      */
     session_id: string;
 
+    /**
+     * Whether the browser session is running in stealth mode.
+     */
+    stealth: boolean;
+
+    /**
+     * The number of seconds of inactivity before the browser session is terminated.
+     */
+    timeout_seconds: number;
+
     /**
      * Remote URL for live viewing the browser session. Only available for non-headless
      * browsers.
@@ -218,6 +301,13 @@ export interface BrowserCreateParams {
    * mechanisms.
    */
   stealth?: boolean;
+
+  /**
+   * 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.
+   */
+  timeout_seconds?: number;
 }
 
 export interface BrowserDeleteParams {
@@ -229,6 +319,8 @@ export interface BrowserDeleteParams {
 
 Browsers.Replays = Replays;
 Browsers.Fs = Fs;
+Browsers.Process = Process;
+Browsers.Logs = Logs;
 
 export declare namespace Browsers {
   export {
@@ -256,11 +348,32 @@ export declare namespace Browsers {
     type FCreateDirectoryParams as FCreateDirectoryParams,
     type FDeleteDirectoryParams as FDeleteDirectoryParams,
     type FDeleteFileParams as FDeleteFileParams,
+    type FDownloadDirZipParams as FDownloadDirZipParams,
     type FFileInfoParams as FFileInfoParams,
     type FListFilesParams as FListFilesParams,
     type FMoveParams as FMoveParams,
     type FReadFileParams as FReadFileParams,
     type FSetFilePermissionsParams as FSetFilePermissionsParams,
+    type FUploadParams as FUploadParams,
+    type FUploadZipParams as FUploadZipParams,
     type FWriteFileParams as FWriteFileParams,
   };
+
+  export {
+    Process as Process,
+    type ProcessExecResponse as ProcessExecResponse,
+    type ProcessKillResponse as ProcessKillResponse,
+    type ProcessSpawnResponse as ProcessSpawnResponse,
+    type ProcessStatusResponse as ProcessStatusResponse,
+    type ProcessStdinResponse as ProcessStdinResponse,
+    type ProcessStdoutStreamResponse as ProcessStdoutStreamResponse,
+    type ProcessExecParams as ProcessExecParams,
+    type ProcessKillParams as ProcessKillParams,
+    type ProcessSpawnParams as ProcessSpawnParams,
+    type ProcessStatusParams as ProcessStatusParams,
+    type ProcessStdinParams as ProcessStdinParams,
+    type ProcessStdoutStreamParams as ProcessStdoutStreamParams,
+  };
+
+  export { Logs as Logs, type LogStreamParams as LogStreamParams };
 }

package/src/resources/browsers/fs/fs.ts

@@ -11,8 +11,10 @@ import {
   WatchStopParams,
 } from './watch';
 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 Fs extends APIResource {
@@ -70,6 +72,29 @@ export class Fs extends APIResource {
     });
   }
 
+  /**
+   * Returns a ZIP file containing the contents of the specified directory.
+   *
+   * @example
+   * ```ts
+   * const response = await client.browsers.fs.downloadDirZip(
+   *   'id',
+   *   { path: '/J!' },
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  downloadDirZip(id: string, query: FDownloadDirZipParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/browsers/${id}/fs/download_dir_zip`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/zip' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
   /**
    * Get information about a file or directory
    *
@@ -162,6 +187,52 @@ export class Fs extends APIResource {
     });
   }
 
+  /**
+   * Allows uploading single or multiple files to the remote filesystem.
+   *
+   * @example
+   * ```ts
+   * await client.browsers.fs.upload('id', {
+   *   files: [
+   *     {
+   *       dest_path: '/J!',
+   *       file: fs.createReadStream('path/to/file'),
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  upload(id: string, body: FUploadParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(
+      path`/browsers/${id}/fs/upload`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
+
+  /**
+   * Upload a zip file and extract its contents to the specified destination path.
+   *
+   * @example
+   * ```ts
+   * await client.browsers.fs.uploadZip('id', {
+   *   dest_path: '/J!',
+   *   zip_file: fs.createReadStream('path/to/file'),
+   * });
+   * ```
+   */
+  uploadZip(id: string, body: FUploadZipParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(
+      path`/browsers/${id}/fs/upload_zip`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
+
   /**
    * Write or create a file
    *
@@ -290,6 +361,13 @@ export interface FDeleteFileParams {
   path: string;
 }
 
+export interface FDownloadDirZipParams {
+  /**
+   * Absolute directory path to archive and download.
+   */
+  path: string;
+}
+
 export interface FFileInfoParams {
   /**
    * Absolute path of the file or directory.
@@ -345,6 +423,30 @@ export interface FSetFilePermissionsParams {
   owner?: string;
 }
 
+export interface FUploadParams {
+  files: Array<FUploadParams.File>;
+}
+
+export namespace FUploadParams {
+  export interface File {
+    /**
+     * Absolute destination path to write the file.
+     */
+    dest_path: string;
+
+    file: Uploadable;
+  }
+}
+
+export interface FUploadZipParams {
+  /**
+   * Absolute destination directory to extract the archive to.
+   */
+  dest_path: string;
+
+  zip_file: Uploadable;
+}
+
 export interface FWriteFileParams {
   /**
    * Query param: Destination absolute file path.
@@ -366,11 +468,14 @@ export declare namespace Fs {
     type FCreateDirectoryParams as FCreateDirectoryParams,
     type FDeleteDirectoryParams as FDeleteDirectoryParams,
     type FDeleteFileParams as FDeleteFileParams,
+    type FDownloadDirZipParams as FDownloadDirZipParams,
     type FFileInfoParams as FFileInfoParams,
     type FListFilesParams as FListFilesParams,
     type FMoveParams as FMoveParams,
     type FReadFileParams as FReadFileParams,
     type FSetFilePermissionsParams as FSetFilePermissionsParams,
+    type FUploadParams as FUploadParams,
+    type FUploadZipParams as FUploadZipParams,
     type FWriteFileParams as FWriteFileParams,
   };
 

package/src/resources/browsers/fs/index.ts

@@ -7,11 +7,14 @@ export {
   type FCreateDirectoryParams,
   type FDeleteDirectoryParams,
   type FDeleteFileParams,
+  type FDownloadDirZipParams,
   type FFileInfoParams,
   type FListFilesParams,
   type FMoveParams,
   type FReadFileParams,
   type FSetFilePermissionsParams,
+  type FUploadParams,
+  type FUploadZipParams,
   type FWriteFileParams,
 } from './fs';
 export {

package/src/resources/browsers/index.ts

@@ -16,13 +16,32 @@ export {
   type FCreateDirectoryParams,
   type FDeleteDirectoryParams,
   type FDeleteFileParams,
+  type FDownloadDirZipParams,
   type FFileInfoParams,
   type FListFilesParams,
   type FMoveParams,
   type FReadFileParams,
   type FSetFilePermissionsParams,
+  type FUploadParams,
+  type FUploadZipParams,
   type FWriteFileParams,
 } from './fs/index';
+export { Logs, type LogStreamParams } from './logs';
+export {
+  Process,
+  type ProcessExecResponse,
+  type ProcessKillResponse,
+  type ProcessSpawnResponse,
+  type ProcessStatusResponse,
+  type ProcessStdinResponse,
+  type ProcessStdoutStreamResponse,
+  type ProcessExecParams,
+  type ProcessKillParams,
+  type ProcessSpawnParams,
+  type ProcessStatusParams,
+  type ProcessStdinParams,
+  type ProcessStdoutStreamParams,
+} from './process';
 export {
   Replays,
   type ReplayListResponse,

package/src/resources/browsers/logs.ts

@@ -0,0 +1,50 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { Stream } from '../../core/streaming';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Logs extends APIResource {
+  /**
+   * Stream log files on the browser instance via SSE
+   *
+   * @example
+   * ```ts
+   * const logEvent = await client.browsers.logs.stream('id', {
+   *   source: 'path',
+   * });
+   * ```
+   */
+  stream(id: string, query: LogStreamParams, options?: RequestOptions): APIPromise<Stream<Shared.LogEvent>> {
+    return this._client.get(path`/browsers/${id}/logs/stream`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<Shared.LogEvent>>;
+  }
+}
+
+export interface LogStreamParams {
+  source: 'path' | 'supervisor';
+
+  follow?: boolean;
+
+  /**
+   * only required if source is path
+   */
+  path?: string;
+
+  /**
+   * only required if source is supervisor
+   */
+  supervisor_process?: string;
+}
+
+export declare namespace Logs {
+  export { type LogStreamParams as LogStreamParams };
+}