diff --git a/packages/js-sdk/etc/sdk.api.md b/packages/js-sdk/etc/sdk.api.md new file mode 100644 index 000000000..71dc72aad --- /dev/null +++ b/packages/js-sdk/etc/sdk.api.md @@ -0,0 +1,579 @@ +## API Report File for "@e2b/sdk" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import * as fetcher from 'openapi-typescript-fetch'; +import { OpArgType } from 'openapi-typescript-fetch'; +import * as openapi_typescript_fetch_dist_cjs_types from 'openapi-typescript-fetch/dist/cjs/types'; +import { Run } from 'openai/resources/beta/threads/runs/runs'; +import { RunSubmitToolOutputsParams } from 'openai/resources/beta/threads/runs/runs'; +import { TypedFetch } from 'openapi-typescript-fetch'; + +// @public (undocumented) +export interface Action { + // (undocumented) + (sandbox: S, args: T): string | Promise; +} + +// @public (undocumented) +export const api: { + configure: (config: openapi_typescript_fetch_dist_cjs_types.FetchConfig) => void; + use: (mw: fetcher.Middleware) => number; + path:

(path: P) => { + method: (method: M) => { + create: openapi_typescript_fetch_dist_cjs_types.CreateFetch; + }; + }; +}; + +// @public (undocumented) +export const API_HOST: string; + +// @public (undocumented) +export class Artifact { + constructor(path: string, sandbox: S); + // (undocumented) + readonly path: string; + // (undocumented) + readonly _sandbox: S; +} + +// @public (undocumented) +export type ClientType = typeof api; + +// @public (undocumented) +export enum CodeRuntime { + // (undocumented) + Bash = "Bash", + // (undocumented) + Node16 = "Node16", + // (undocumented) + Python3 = "Python3", + // (undocumented) + Python3_DataAnalysis = "Python3-DataAnalysis" +} + +// @public (undocumented) +export interface components { + // (undocumented) + parameters: { + envID: string; + buildID: string; + instanceID: string; + }; + // (undocumented) + responses: { + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + // (undocumented) + schemas: { + NewInstance: { + envID: string; + }; + Environment: { + envID: string; + buildID: string; + public: boolean; + aliases?: string[]; + }; + EnvironmentBuild: { + logs: string[]; + envID: string; + buildID: string; + status?: "building" | "ready" | "error"; + } & { + finished: unknown; + }; + Instance: { + envID: string; + instanceID: string; + clientID: string; + }; + Error: { + code: number; + message: string; + }; + }; +} + +// @public (undocumented) +class DataAnalysis extends Sandbox { + constructor(opts: Omit); + // (undocumented) + static create(): Promise; + // (undocumented) + static create(opts: Omit): Promise; + // (undocumented) + installPythonPackages(packageNames: string | string[]): Promise; + // (undocumented) + installSystemPackages(packageNames: string | string[]): Promise; + // (undocumented) + runPython(code: string, opts?: RunPythonOpts): Promise<{ + stdout: string; + stderr: string; + artifacts: Artifact[]; + }>; +} +export { DataAnalysis as CodeInterpreter } +export { DataAnalysis } + +// @public (undocumented) +export type DownloadFileFormat = 'base64' | 'blob' | 'buffer' | 'arraybuffer' | 'text'; + +// @public (undocumented) +export type EnvVars = { + [key: string]: string; +}; + +// @public (undocumented) +export interface FileInfo { + // (undocumented) + isDir: boolean; + // (undocumented) + name: string; +} + +// @public (undocumented) +export interface FilesystemEvent { + // (undocumented) + isDir: boolean; + // (undocumented) + name: string; + // (undocumented) + operation: FilesystemOperation; + // (undocumented) + path: string; + // (undocumented) + timestamp: number; +} + +// @public (undocumented) +export type FilesystemEventListener = (event: FilesystemEvent) => Promise | void; + +// @public +export interface FilesystemManager { + list(path: string, opts?: CallOpts): Promise; + makeDir(path: string, opts?: CallOpts): Promise; + read(path: string, opts?: CallOpts): Promise; + readBytes(path: string): Promise; + remove(path: string, opts?: CallOpts): Promise; + watchDir(path: string): FilesystemWatcher; + // Warning: (ae-forgotten-export) The symbol "CallOpts" needs to be exported by the entry point index.d.ts + write(path: string, content: string, opts?: CallOpts): Promise; + writeBytes(path: string, content: Uint8Array): Promise; +} + +// @public (undocumented) +export enum FilesystemOperation { + // (undocumented) + Chmod = "Chmod", + // (undocumented) + Create = "Create", + // (undocumented) + Remove = "Remove", + // (undocumented) + Rename = "Rename", + // (undocumented) + Write = "Write" +} + +// @public (undocumented) +export class FilesystemWatcher { + // Warning: (ae-forgotten-export) The symbol "SandboxConnection" needs to be exported by the entry point index.d.ts + constructor(sessConn: SandboxConnection, path: string); + // (undocumented) + addEventListener(l: FilesystemEventListener): () => boolean; + // (undocumented) + start(opts?: CallOpts): Promise; + // (undocumented) + stop(): Promise; +} + +// @public (undocumented) +export interface OpenPort { + // (undocumented) + ip: string; + // (undocumented) + port: number; + // (undocumented) + state: string; +} + +// @public +export interface paths { + // (undocumented) + "/envs": { + get: { + responses: { + 200: { + content: { + "application/json": components["schemas"]["Environment"][]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + }; + post: { + responses: { + 202: { + content: { + "application/json": components["schemas"]["Environment"]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "multipart/form-data": { + alias?: string; + buildContext: string; + dockerfile: string; + startCmd?: string; + }; + }; + }; + }; + }; + // (undocumented) + "/envs/{envID}": { + post: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + }; + }; + responses: { + 202: { + content: { + "application/json": components["schemas"]["Environment"]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "multipart/form-data": { + alias?: string; + buildContext: string; + dockerfile: string; + startCmd?: string; + }; + }; + }; + }; + delete: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + }; + }; + responses: { + 204: never; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + }; + }; + // (undocumented) + "/envs/{envID}/builds/{buildID}": { + get: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + buildID: components["parameters"]["buildID"]; + }; + query: { + logsOffset?: number; + }; + }; + responses: { + 200: { + content: { + "application/json": components["schemas"]["EnvironmentBuild"]; + }; + }; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; + }; + }; + // (undocumented) + "/envs/{envID}/builds/{buildID}/logs": { + post: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + buildID: components["parameters"]["buildID"]; + }; + }; + responses: { + 201: unknown; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + }; + requestBody: { + content: { + "application/json": { + apiSecret: string; + logs: string[]; + }; + }; + }; + }; + }; + // (undocumented) + "/health": { + get: { + responses: { + 200: unknown; + 401: components["responses"]["401"]; + }; + }; + }; + // (undocumented) + "/instances": { + post: { + responses: { + 201: { + content: { + "application/json": components["schemas"]["Instance"]; + }; + }; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NewInstance"]; + }; + }; + }; + }; + // (undocumented) + "/instances/{instanceID}/refreshes": { + post: { + parameters: { + path: { + instanceID: components["parameters"]["instanceID"]; + }; + }; + responses: { + 204: never; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + }; + requestBody: { + content: { + "application/json": { + duration?: number; + }; + }; + }; + }; + }; +} + +// @public +export class Process { + constructor(processID: string, sandbox: SandboxConnection, triggerExit: () => void, finished: Promise, output: ProcessOutput); + // @deprecated (undocumented) + readonly finished: Promise; + kill(): Promise; + // (undocumented) + readonly output: ProcessOutput; + // (undocumented) + readonly processID: string; + sendStdin(data: string, opts?: CallOpts): Promise; + wait(): Promise; +} + +// @public +export interface ProcessManager { + start(cmd: string): Promise; + // Warning: (ae-forgotten-export) The symbol "ProcessOpts" needs to be exported by the entry point index.d.ts + start(opts: ProcessOpts): Promise; + startAndWait(cmd: string): Promise; + startAndWait(opts: ProcessOpts): Promise; +} + +// @public +export class ProcessMessage { + constructor(line: string, + timestamp: number, error: boolean); + // (undocumented) + readonly error: boolean; + // (undocumented) + readonly line: string; + readonly timestamp: number; + // (undocumented) + toString(): string; +} + +// @public +export class ProcessOutput { + // (undocumented) + addStderr(message: ProcessMessage): void; + // (undocumented) + addStdout(message: ProcessMessage): void; + get error(): boolean; + get exitCode(): number | undefined; + // (undocumented) + setExitCode(exitCode: number): void; + get stderr(): string; + get stdout(): string; +} + +// @public +export function runCode(runtime: CodeRuntime, code: string, opts?: { + apiKey?: string; +}): Promise<{ + stdout: string; + stderr: string; +}>; + +// @public (undocumented) +export interface RunPythonOpts extends Omit { + // (undocumented) + onArtifact?: (artifact: Artifact) => Promise | void; +} + +// @public +class Sandbox extends SandboxConnection { + protected constructor(opts?: SandboxOpts); + get actions(): Map>; + // (undocumented) + readonly _actions: Map>; + addAction(action: Action): this; + addAction(name: string, action: Action): this; + static create(): Promise; + static create(template: string): Promise; + static create(opts: SandboxOpts): Promise; + downloadFile(remotePath: string, format?: DownloadFileFormat): Promise; + readonly filesystem: FilesystemManager; + get fileURL(): string; + // (undocumented) + protected _open(opts: CallOpts): Promise; + get openai(): { + readonly actions: Actions; + }; + readonly process: ProcessManager; + static reconnect(sandboxID: string): Promise; + static reconnect(opts: Omit & { + sandboxID: string; + }): Promise; + removeAction(name: string): this; + readonly terminal: TerminalManager; + uploadFile(file: Buffer | Blob, filename: string): Promise; +} +export { Sandbox } +export default Sandbox; + +// @public (undocumented) +export const SANDBOX_DOMAIN: string; + +// Warning: (ae-forgotten-export) The symbol "SandboxConnectionOpts" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export interface SandboxOpts extends SandboxConnectionOpts { + // (undocumented) + onExit?: (() => Promise | void) | ((exitCode: number) => Promise | void); + // Warning: (ae-forgotten-export) The symbol "ScanOpenedPortsHandler" needs to be exported by the entry point index.d.ts + // + // (undocumented) + onScanPorts?: ScanOpenedPortsHandler; + // (undocumented) + onStderr?: (out: ProcessMessage) => Promise | void; + // (undocumented) + onStdout?: (out: ProcessMessage) => Promise | void; + timeout?: number; +} + +// @public +export class Terminal { + constructor(terminalID: string, sandbox: SandboxConnection, triggerExit: () => void, finished: Promise, output: TerminalOutput); + // (undocumented) + get data(): string; + // @deprecated (undocumented) + readonly finished: Promise; + kill(): Promise; + // (undocumented) + readonly output: TerminalOutput; + resize({ cols, rows }: { + cols: number; + rows: number; + }): Promise; + sendData(data: string): Promise; + // (undocumented) + readonly terminalID: string; + wait(): Promise; +} + +// @public +export interface TerminalManager { + // Warning: (ae-forgotten-export) The symbol "TerminalOpts" needs to be exported by the entry point index.d.ts + // + // (undocumented) + start(opts: TerminalOpts): Promise; +} + +// @public (undocumented) +export class TerminalOutput { + // (undocumented) + addData(data: string): void; + // (undocumented) + get data(): string; +} + +// Warning: (ae-forgotten-export) The symbol "WithAccessToken" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function withAccessToken(f: TypedFetch): WithAccessToken & { + Error: typeof f.Error; +}; + +// Warning: (ae-forgotten-export) The symbol "WithAPIKey" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function withAPIKey(f: TypedFetch): WithAPIKey & { + Error: typeof f.Error; +}; + +// Warnings were encountered during analysis: +// +// dist/index.d.ts:834:9 - (ae-forgotten-export) The symbol "Actions" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/packages/js-sdk/temp/sdk.api.md b/packages/js-sdk/temp/sdk.api.md new file mode 100644 index 000000000..71dc72aad --- /dev/null +++ b/packages/js-sdk/temp/sdk.api.md @@ -0,0 +1,579 @@ +## API Report File for "@e2b/sdk" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import * as fetcher from 'openapi-typescript-fetch'; +import { OpArgType } from 'openapi-typescript-fetch'; +import * as openapi_typescript_fetch_dist_cjs_types from 'openapi-typescript-fetch/dist/cjs/types'; +import { Run } from 'openai/resources/beta/threads/runs/runs'; +import { RunSubmitToolOutputsParams } from 'openai/resources/beta/threads/runs/runs'; +import { TypedFetch } from 'openapi-typescript-fetch'; + +// @public (undocumented) +export interface Action { + // (undocumented) + (sandbox: S, args: T): string | Promise; +} + +// @public (undocumented) +export const api: { + configure: (config: openapi_typescript_fetch_dist_cjs_types.FetchConfig) => void; + use: (mw: fetcher.Middleware) => number; + path:

(path: P) => { + method: (method: M) => { + create: openapi_typescript_fetch_dist_cjs_types.CreateFetch; + }; + }; +}; + +// @public (undocumented) +export const API_HOST: string; + +// @public (undocumented) +export class Artifact { + constructor(path: string, sandbox: S); + // (undocumented) + readonly path: string; + // (undocumented) + readonly _sandbox: S; +} + +// @public (undocumented) +export type ClientType = typeof api; + +// @public (undocumented) +export enum CodeRuntime { + // (undocumented) + Bash = "Bash", + // (undocumented) + Node16 = "Node16", + // (undocumented) + Python3 = "Python3", + // (undocumented) + Python3_DataAnalysis = "Python3-DataAnalysis" +} + +// @public (undocumented) +export interface components { + // (undocumented) + parameters: { + envID: string; + buildID: string; + instanceID: string; + }; + // (undocumented) + responses: { + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + // (undocumented) + schemas: { + NewInstance: { + envID: string; + }; + Environment: { + envID: string; + buildID: string; + public: boolean; + aliases?: string[]; + }; + EnvironmentBuild: { + logs: string[]; + envID: string; + buildID: string; + status?: "building" | "ready" | "error"; + } & { + finished: unknown; + }; + Instance: { + envID: string; + instanceID: string; + clientID: string; + }; + Error: { + code: number; + message: string; + }; + }; +} + +// @public (undocumented) +class DataAnalysis extends Sandbox { + constructor(opts: Omit); + // (undocumented) + static create(): Promise; + // (undocumented) + static create(opts: Omit): Promise; + // (undocumented) + installPythonPackages(packageNames: string | string[]): Promise; + // (undocumented) + installSystemPackages(packageNames: string | string[]): Promise; + // (undocumented) + runPython(code: string, opts?: RunPythonOpts): Promise<{ + stdout: string; + stderr: string; + artifacts: Artifact[]; + }>; +} +export { DataAnalysis as CodeInterpreter } +export { DataAnalysis } + +// @public (undocumented) +export type DownloadFileFormat = 'base64' | 'blob' | 'buffer' | 'arraybuffer' | 'text'; + +// @public (undocumented) +export type EnvVars = { + [key: string]: string; +}; + +// @public (undocumented) +export interface FileInfo { + // (undocumented) + isDir: boolean; + // (undocumented) + name: string; +} + +// @public (undocumented) +export interface FilesystemEvent { + // (undocumented) + isDir: boolean; + // (undocumented) + name: string; + // (undocumented) + operation: FilesystemOperation; + // (undocumented) + path: string; + // (undocumented) + timestamp: number; +} + +// @public (undocumented) +export type FilesystemEventListener = (event: FilesystemEvent) => Promise | void; + +// @public +export interface FilesystemManager { + list(path: string, opts?: CallOpts): Promise; + makeDir(path: string, opts?: CallOpts): Promise; + read(path: string, opts?: CallOpts): Promise; + readBytes(path: string): Promise; + remove(path: string, opts?: CallOpts): Promise; + watchDir(path: string): FilesystemWatcher; + // Warning: (ae-forgotten-export) The symbol "CallOpts" needs to be exported by the entry point index.d.ts + write(path: string, content: string, opts?: CallOpts): Promise; + writeBytes(path: string, content: Uint8Array): Promise; +} + +// @public (undocumented) +export enum FilesystemOperation { + // (undocumented) + Chmod = "Chmod", + // (undocumented) + Create = "Create", + // (undocumented) + Remove = "Remove", + // (undocumented) + Rename = "Rename", + // (undocumented) + Write = "Write" +} + +// @public (undocumented) +export class FilesystemWatcher { + // Warning: (ae-forgotten-export) The symbol "SandboxConnection" needs to be exported by the entry point index.d.ts + constructor(sessConn: SandboxConnection, path: string); + // (undocumented) + addEventListener(l: FilesystemEventListener): () => boolean; + // (undocumented) + start(opts?: CallOpts): Promise; + // (undocumented) + stop(): Promise; +} + +// @public (undocumented) +export interface OpenPort { + // (undocumented) + ip: string; + // (undocumented) + port: number; + // (undocumented) + state: string; +} + +// @public +export interface paths { + // (undocumented) + "/envs": { + get: { + responses: { + 200: { + content: { + "application/json": components["schemas"]["Environment"][]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + }; + post: { + responses: { + 202: { + content: { + "application/json": components["schemas"]["Environment"]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "multipart/form-data": { + alias?: string; + buildContext: string; + dockerfile: string; + startCmd?: string; + }; + }; + }; + }; + }; + // (undocumented) + "/envs/{envID}": { + post: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + }; + }; + responses: { + 202: { + content: { + "application/json": components["schemas"]["Environment"]; + }; + }; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "multipart/form-data": { + alias?: string; + buildContext: string; + dockerfile: string; + startCmd?: string; + }; + }; + }; + }; + delete: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + }; + }; + responses: { + 204: never; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + }; + }; + // (undocumented) + "/envs/{envID}/builds/{buildID}": { + get: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + buildID: components["parameters"]["buildID"]; + }; + query: { + logsOffset?: number; + }; + }; + responses: { + 200: { + content: { + "application/json": components["schemas"]["EnvironmentBuild"]; + }; + }; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; + }; + }; + // (undocumented) + "/envs/{envID}/builds/{buildID}/logs": { + post: { + parameters: { + path: { + envID: components["parameters"]["envID"]; + buildID: components["parameters"]["buildID"]; + }; + }; + responses: { + 201: unknown; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + }; + requestBody: { + content: { + "application/json": { + apiSecret: string; + logs: string[]; + }; + }; + }; + }; + }; + // (undocumented) + "/health": { + get: { + responses: { + 200: unknown; + 401: components["responses"]["401"]; + }; + }; + }; + // (undocumented) + "/instances": { + post: { + responses: { + 201: { + content: { + "application/json": components["schemas"]["Instance"]; + }; + }; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 500: components["responses"]["500"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NewInstance"]; + }; + }; + }; + }; + // (undocumented) + "/instances/{instanceID}/refreshes": { + post: { + parameters: { + path: { + instanceID: components["parameters"]["instanceID"]; + }; + }; + responses: { + 204: never; + 401: components["responses"]["401"]; + 404: components["responses"]["404"]; + }; + requestBody: { + content: { + "application/json": { + duration?: number; + }; + }; + }; + }; + }; +} + +// @public +export class Process { + constructor(processID: string, sandbox: SandboxConnection, triggerExit: () => void, finished: Promise, output: ProcessOutput); + // @deprecated (undocumented) + readonly finished: Promise; + kill(): Promise; + // (undocumented) + readonly output: ProcessOutput; + // (undocumented) + readonly processID: string; + sendStdin(data: string, opts?: CallOpts): Promise; + wait(): Promise; +} + +// @public +export interface ProcessManager { + start(cmd: string): Promise; + // Warning: (ae-forgotten-export) The symbol "ProcessOpts" needs to be exported by the entry point index.d.ts + start(opts: ProcessOpts): Promise; + startAndWait(cmd: string): Promise; + startAndWait(opts: ProcessOpts): Promise; +} + +// @public +export class ProcessMessage { + constructor(line: string, + timestamp: number, error: boolean); + // (undocumented) + readonly error: boolean; + // (undocumented) + readonly line: string; + readonly timestamp: number; + // (undocumented) + toString(): string; +} + +// @public +export class ProcessOutput { + // (undocumented) + addStderr(message: ProcessMessage): void; + // (undocumented) + addStdout(message: ProcessMessage): void; + get error(): boolean; + get exitCode(): number | undefined; + // (undocumented) + setExitCode(exitCode: number): void; + get stderr(): string; + get stdout(): string; +} + +// @public +export function runCode(runtime: CodeRuntime, code: string, opts?: { + apiKey?: string; +}): Promise<{ + stdout: string; + stderr: string; +}>; + +// @public (undocumented) +export interface RunPythonOpts extends Omit { + // (undocumented) + onArtifact?: (artifact: Artifact) => Promise | void; +} + +// @public +class Sandbox extends SandboxConnection { + protected constructor(opts?: SandboxOpts); + get actions(): Map>; + // (undocumented) + readonly _actions: Map>; + addAction(action: Action): this; + addAction(name: string, action: Action): this; + static create(): Promise; + static create(template: string): Promise; + static create(opts: SandboxOpts): Promise; + downloadFile(remotePath: string, format?: DownloadFileFormat): Promise; + readonly filesystem: FilesystemManager; + get fileURL(): string; + // (undocumented) + protected _open(opts: CallOpts): Promise; + get openai(): { + readonly actions: Actions; + }; + readonly process: ProcessManager; + static reconnect(sandboxID: string): Promise; + static reconnect(opts: Omit & { + sandboxID: string; + }): Promise; + removeAction(name: string): this; + readonly terminal: TerminalManager; + uploadFile(file: Buffer | Blob, filename: string): Promise; +} +export { Sandbox } +export default Sandbox; + +// @public (undocumented) +export const SANDBOX_DOMAIN: string; + +// Warning: (ae-forgotten-export) The symbol "SandboxConnectionOpts" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export interface SandboxOpts extends SandboxConnectionOpts { + // (undocumented) + onExit?: (() => Promise | void) | ((exitCode: number) => Promise | void); + // Warning: (ae-forgotten-export) The symbol "ScanOpenedPortsHandler" needs to be exported by the entry point index.d.ts + // + // (undocumented) + onScanPorts?: ScanOpenedPortsHandler; + // (undocumented) + onStderr?: (out: ProcessMessage) => Promise | void; + // (undocumented) + onStdout?: (out: ProcessMessage) => Promise | void; + timeout?: number; +} + +// @public +export class Terminal { + constructor(terminalID: string, sandbox: SandboxConnection, triggerExit: () => void, finished: Promise, output: TerminalOutput); + // (undocumented) + get data(): string; + // @deprecated (undocumented) + readonly finished: Promise; + kill(): Promise; + // (undocumented) + readonly output: TerminalOutput; + resize({ cols, rows }: { + cols: number; + rows: number; + }): Promise; + sendData(data: string): Promise; + // (undocumented) + readonly terminalID: string; + wait(): Promise; +} + +// @public +export interface TerminalManager { + // Warning: (ae-forgotten-export) The symbol "TerminalOpts" needs to be exported by the entry point index.d.ts + // + // (undocumented) + start(opts: TerminalOpts): Promise; +} + +// @public (undocumented) +export class TerminalOutput { + // (undocumented) + addData(data: string): void; + // (undocumented) + get data(): string; +} + +// Warning: (ae-forgotten-export) The symbol "WithAccessToken" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function withAccessToken(f: TypedFetch): WithAccessToken & { + Error: typeof f.Error; +}; + +// Warning: (ae-forgotten-export) The symbol "WithAPIKey" needs to be exported by the entry point index.d.ts +// +// @public (undocumented) +export function withAPIKey(f: TypedFetch): WithAPIKey & { + Error: typeof f.Error; +}; + +// Warnings were encountered during analysis: +// +// dist/index.d.ts:834:9 - (ae-forgotten-export) The symbol "Actions" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/readme-assets/preview.png b/readme-assets/preview.png index eb82171f8..451abe09f 100644 Binary files a/readme-assets/preview.png and b/readme-assets/preview.png differ