@drej/opensandbox 0.1.2

package/dist/control.d.ts

@@ -0,0 +1,28 @@
+import type { Sandbox, CreateSandboxOptions, ListSandboxesOptions, Snapshot, ListSnapshotsOptions, SandboxEndpoint, DiagnosticLog, DiagnosticEvent } from "./types";
+export declare class OpenSandboxError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+export declare class ControlClient {
+    private baseUrl;
+    private apiKey;
+    constructor(options: {
+        baseUrl: string;
+        apiKey: string;
+    });
+    private request;
+    createSandbox(options: CreateSandboxOptions): Promise<Sandbox>;
+    listSandboxes(options?: ListSandboxesOptions): Promise<Sandbox[]>;
+    getSandbox(id: string): Promise<Sandbox>;
+    deleteSandbox(id: string): Promise<void>;
+    pauseSandbox(id: string): Promise<void>;
+    resumeSandbox(id: string): Promise<void>;
+    renewExpiration(id: string): Promise<void>;
+    getEndpoint(sandboxId: string, port: number): Promise<SandboxEndpoint>;
+    getDiagnosticLogs(sandboxId: string): Promise<DiagnosticLog[]>;
+    getDiagnosticEvents(sandboxId: string): Promise<DiagnosticEvent[]>;
+    createSnapshot(sandboxId: string): Promise<Snapshot>;
+    listSnapshots(options?: ListSnapshotsOptions): Promise<Snapshot[]>;
+    getSnapshot(id: string): Promise<Snapshot>;
+    deleteSnapshot(id: string): Promise<void>;
+}

package/dist/exec.d.ts

@@ -0,0 +1,41 @@
+import type { SSEEvent, CodeContext, ExecuteCodeOptions, ExecuteCommandOptions, CommandStatus, FileInfo, FileReplacement, DirectoryEntry, Metrics } from "./types";
+export declare class ExecClient {
+    private baseUrl;
+    private accessToken;
+    constructor(options: {
+        baseUrl?: string;
+        accessToken: string;
+    });
+    private get authHeader();
+    private request;
+    private streamRequest;
+    ping(): Promise<{
+        status: string;
+    }>;
+    listContexts(language?: string): Promise<CodeContext[]>;
+    clearContexts(language?: string): Promise<void>;
+    deleteContext(contextId: string): Promise<void>;
+    createContext(language: string): Promise<CodeContext>;
+    executeCode(options: ExecuteCodeOptions): AsyncGenerator<SSEEvent>;
+    interruptCode(): Promise<void>;
+    executeCommand(options: ExecuteCommandOptions): AsyncGenerator<SSEEvent>;
+    interruptCommand(): Promise<void>;
+    getCommandStatus(session: string): Promise<CommandStatus>;
+    getCommandOutput(session: string): Promise<{
+        stdout: string;
+        stderr: string;
+    }>;
+    getFileInfo(path: string): Promise<FileInfo>;
+    deleteFile(path: string): Promise<void>;
+    setPermissions(path: string, mode: string): Promise<void>;
+    moveFile(from: string, to: string): Promise<void>;
+    searchFiles(pattern: string, dir?: string): Promise<string[]>;
+    replaceInFiles(replacements: FileReplacement[]): Promise<void>;
+    uploadFile(path: string, content: Blob | BufferSource | string): Promise<void>;
+    downloadFile(path: string): Promise<ReadableStream<Uint8Array>>;
+    listDirectory(path: string, depth?: number): Promise<DirectoryEntry[]>;
+    createDirectory(path: string): Promise<void>;
+    deleteDirectory(path: string): Promise<void>;
+    getMetrics(): Promise<Metrics>;
+    watchMetrics(): AsyncGenerator<SSEEvent>;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { ControlClient, OpenSandboxError } from "./control";
+export { ExecClient } from "./exec";
+export { SandboxState, SnapshotState, SSEEventType } from "./types";
+export type { Resources, ImageAuth, ImageSpec, Sandbox, SandboxStatus, CreateSandboxOptions, ListSandboxesOptions, Snapshot, ListSnapshotsOptions, SandboxEndpoint, DiagnosticLog, DiagnosticEvent, SSEEvent, CodeContext, ExecuteCodeOptions, ExecuteCommandOptions, CommandStatus, FileInfo, FileReplacement, DirectoryEntry, Metrics, } from "./types";

package/dist/types.d.ts

@@ -0,0 +1,162 @@
+export interface Resources {
+    cpu?: string;
+    memory?: string;
+    gpu?: string;
+}
+export interface ImageAuth {
+    username: string;
+    password: string;
+}
+export interface ImageSpec {
+    uri: string;
+    auth?: ImageAuth;
+}
+export declare enum SandboxState {
+    Pending = "Pending",
+    Running = "Running",
+    Pausing = "Pausing",
+    Paused = "Paused",
+    Resuming = "Resuming",
+    Stopping = "Stopping",
+    Terminated = "Terminated",
+    Failed = "Failed",
+    Unknown = "Unknown"
+}
+export interface SandboxStatus {
+    state: SandboxState;
+    reason?: string;
+    message?: string;
+    lastTransitionAt?: string;
+}
+export interface Sandbox {
+    id: string;
+    status: SandboxStatus;
+    createdAt: string;
+    expiresAt?: string | null;
+    image?: ImageSpec;
+    snapshotId?: string;
+    entrypoint?: string[];
+    metadata?: Record<string, string>;
+    platform?: unknown;
+}
+export interface CreateSandboxOptions {
+    image?: ImageSpec;
+    snapshotId?: string;
+    timeout?: number;
+    resourceLimits?: Resources;
+    entrypoint?: string[];
+    env?: Record<string, string>;
+    metadata?: Record<string, string>;
+    secureAccess?: boolean;
+}
+export interface ListSandboxesOptions {
+    state?: SandboxState;
+    limit?: number;
+    offset?: number;
+}
+export declare enum SnapshotState {
+    Pending = "Pending",
+    Committing = "Committing",
+    Pushing = "Pushing",
+    Ready = "Ready",
+    Failed = "Failed"
+}
+export interface Snapshot {
+    id: string;
+    sandboxId: string;
+    state: SnapshotState;
+    createdAt: string;
+}
+export interface ListSnapshotsOptions {
+    sandboxId?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface SandboxEndpoint {
+    endpoint: string;
+    headers?: Record<string, string>;
+}
+export interface DiagnosticLog {
+    name: string;
+    size: number;
+    url?: string;
+    inline?: string;
+}
+export interface DiagnosticEvent {
+    timestamp: string;
+    type: string;
+    message: string;
+}
+export declare enum SSEEventType {
+    Init = "init",
+    Status = "status",
+    Stdout = "stdout",
+    Stderr = "stderr",
+    Result = "result",
+    ExecutionComplete = "execution_complete",
+    ExecutionCount = "execution_count",
+    Error = "error",
+    Ping = "ping",
+    Message = "message"
+}
+export interface SSEEvent {
+    type: SSEEventType;
+    text?: string;
+    results?: Record<string, string>;
+    error?: {
+        name?: string;
+        message: string;
+        evalue?: string;
+    };
+    execution_count?: number;
+    execution_time?: number;
+    timestamp: number;
+}
+export interface CodeContext {
+    id: string;
+    language: string;
+}
+export interface ExecuteCodeOptions {
+    code: string;
+    context?: {
+        id: string;
+        language: string;
+    };
+}
+export interface ExecuteCommandOptions {
+    command: string;
+    cwd?: string;
+    background?: boolean;
+    timeout?: number;
+    uid?: number;
+    gid?: number;
+    envs?: Record<string, string>;
+}
+export interface CommandStatus {
+    session: string;
+    status: "running" | "completed" | "failed";
+    exitCode?: number;
+}
+export interface FileInfo {
+    path: string;
+    size: number;
+    mode: string;
+    modifiedAt: string;
+    isDirectory: boolean;
+}
+export interface DirectoryEntry {
+    name: string;
+    path: string;
+    isDirectory: boolean;
+    size?: number;
+}
+export interface FileReplacement {
+    path: string;
+    old: string;
+    new: string;
+}
+export interface Metrics {
+    cpu: number;
+    memory: number;
+    timestamp: string;
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@drej/opensandbox",
+  "version": "0.1.2",
+  "main": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": { "access": "public" },
+  "scripts": {
+    "typecheck": "bunx tsc --noEmit",
+    "build:types": "tsc --project tsconfig.build.json"
+  },
+  "devDependencies": {
+    "bun-types": "latest",
+    "typescript": "latest"
+  }
+}