microsandbox 0.1.0 → 0.1.1

package/README.md

@@ -1,33 +1,138 @@
-# Microsandbox JavaScript SDK
+# Microsandbox JavaScript/TypeScript SDK
 
-A minimal JavaScript SDK for the Microsandbox project.
+A secure, efficient sandbox for executing untrusted code from TypeScript/JavaScript applications.
 
 ## Installation
 
-```bash
+```sh
 npm install microsandbox
 ```
 
-## Usage
+## Requirements
 
-```javascript
-const { greet } = require("microsandbox");
+- Node.js 14.x or later
+- A running Microsandbox server with a valid API key
 
-// Print a greeting
-greet("World");
+## Configuration
 
-// Using ES modules
-// import { greet } from 'microsandbox';
-// greet('World');
+Before using the SDK, you need to set your Microsandbox API key:
+
+```sh
+export MSB_API_KEY=msb_***
+```
+
+## Quick Start
+
+Here's a simple example using the NodeSandbox to execute JavaScript code:
+
+```typescript
+import { NodeSandbox } from "microsandbox";
+
+async function main() {
+  // Create and start a Node.js sandbox
+  const sb = await NodeSandbox.create({ name: "test" });
+
+  try {
+    // Execute JavaScript code in the sandbox
+    let exec = await sb.run("var name = 'JavaScript'");
+    exec = await sb.run("console.log(`Hello ${name}!`)");
+
+    // Get the output
+    console.log(await exec.output()); // prints Hello JavaScript!
+  } finally {
+    // Stop the sandbox when done
+    await sb.stop();
+  }
+}
+
+main().catch(console.error);
 ```
 
-## Examples
+## Available Sandbox Types
+
+The SDK provides several specialized sandbox environments:
+
+- `NodeSandbox`: For executing JavaScript/TypeScript code
+- `PythonSandbox`: For executing Python code
+
+Each sandbox type is optimized for its respective language environment.
+
+## Creating a Sandbox
+
+You can create a sandbox with custom options:
+
+```typescript
+import { NodeSandbox, SandboxOptions } from "microsandbox";
+
+// Using builder pattern
+const options = SandboxOptions.builder()
+  .name("my-sandbox")
+  .memory(1024)
+  .cpus(2)
+  .build();
+
+// Create and start the sandbox
+const sandbox = await NodeSandbox.create(options);
+
+// Don't forget to stop the sandbox when done
+await sandbox.stop();
+```
 
-Check out the [examples directory](./examples) for sample scripts that demonstrate how to:
+## Running Shell Commands
 
-- Use the SDK in both JavaScript and TypeScript
-- See simple usage patterns
+You can execute shell commands in the sandbox:
+
+```typescript
+const cmd = await sandbox.command.run("ls", ["-la"]);
+console.log(await cmd.output());
+console.log("Exit code:", cmd.exitCode);
+```
+
+## Monitoring Sandbox Metrics
+
+Get resource usage metrics for your sandbox:
+
+```typescript
+// Get all metrics
+const metrics = await sandbox.metrics.all();
+console.log(metrics);
+
+// Get specific metrics
+const cpuUsage = await sandbox.metrics.cpu();
+const memoryUsage = await sandbox.metrics.memory();
+const diskUsage = await sandbox.metrics.disk();
+```
+
+## Error Handling
+
+```typescript
+try {
+  const exec = await sandbox.run("invalid code");
+
+  if (exec.hasError()) {
+    console.error("Execution error:", await exec.error());
+  } else {
+    console.log("Result:", await exec.output());
+  }
+} catch (err) {
+  console.error("Sandbox error:", err.message);
+}
+```
+
+## Development
+
+### Building the SDK
+
+```sh
+npm run build
+```
+
+### Running Tests
+
+```sh
+npm test
+```
 
 ## License
 
-[MIT](LICENSE)
+Apache License 2.0

package/dist/base-sandbox.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Base sandbox implementation for the Microsandbox TypeScript SDK.
+ */
+import { Command } from "./command";
+import { Metrics } from "./metrics";
+import { Execution } from "./execution";
+import { SandboxOptions } from "./types";
+export declare abstract class BaseSandbox {
+    protected _serverUrl: string;
+    protected _namespace: string;
+    protected _name: string;
+    protected _apiKey: string | undefined;
+    protected _isStarted: boolean;
+    /**
+     * Initialize a base sandbox instance.
+     *
+     * @param options - Configuration options for the sandbox
+     */
+    constructor(options?: SandboxOptions);
+    /**
+     * Create and initialize a new sandbox instance.
+     *
+     * This is the base implementation that subclasses should call.
+     *
+     * @param ctor - The constructor function for the subclass
+     * @param options - Configuration options for the sandbox
+     * @returns A Promise resolving to a new sandbox instance
+     */
+    protected static createBase<T extends BaseSandbox>(ctor: new (options?: SandboxOptions) => T, options?: SandboxOptions): Promise<T>;
+    static create(options?: SandboxOptions): Promise<BaseSandbox>;
+    /**
+     * Get the default Docker image for this sandbox type.
+     *
+     * @returns A string containing the Docker image name and tag
+     */
+    abstract getDefaultImage(): Promise<string>;
+    /**
+     * Start the sandbox container.
+     *
+     * @param image - Docker image to use for the sandbox (defaults to language-specific image)
+     * @param memory - Memory limit in MB
+     * @param cpus - CPU limit (will be rounded to nearest integer)
+     * @param timeout - Maximum time in seconds to wait for the sandbox to start (default: 180 seconds)
+     *
+     * @throws Error if the sandbox fails to start
+     * @throws Error if the sandbox doesn't start within the specified timeout
+     */
+    start(image?: string, memory?: number, cpus?: number, timeout?: number): Promise<void>;
+    /**
+     * Stop the sandbox container.
+     *
+     * @throws Error if the sandbox fails to stop
+     */
+    stop(): Promise<void>;
+    /**
+     * Execute code in the sandbox.
+     *
+     * @param code - Code to execute
+     * @returns An Execution object representing the executed code
+     * @throws Error if execution fails
+     */
+    abstract run(code: string): Promise<Execution>;
+    /**
+     * Access the command namespace for executing shell commands in the sandbox.
+     */
+    get command(): Command;
+    /**
+     * Access the metrics namespace for retrieving sandbox metrics.
+     */
+    get metrics(): Metrics;
+    /**
+     * Check if the sandbox is started.
+     */
+    get isStarted(): boolean;
+    /**
+     * Get the server URL.
+     */
+    get serverUrl(): string;
+    /**
+     * Get the namespace.
+     */
+    get namespace(): string;
+    /**
+     * Get the sandbox name.
+     */
+    get name(): string;
+    /**
+     * Get the API key.
+     */
+    get apiKey(): string | undefined;
+}

package/dist/base-sandbox.js

@@ -0,0 +1,264 @@
+"use strict";
+/**
+ * Base sandbox implementation for the Microsandbox TypeScript SDK.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSandbox = void 0;
+const uuid_1 = require("uuid");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const dotenv = __importStar(require("dotenv"));
+const command_1 = require("./command");
+const metrics_1 = require("./metrics");
+class BaseSandbox {
+    /**
+     * Initialize a base sandbox instance.
+     *
+     * @param options - Configuration options for the sandbox
+     */
+    constructor(options) {
+        this._isStarted = false;
+        // Try to load from .env if MSB_API_KEY is not already set
+        if (!process.env.MSB_API_KEY) {
+            try {
+                dotenv.config();
+            }
+            catch (error) {
+                // Ignore errors if .env file doesn't exist
+            }
+        }
+        this._serverUrl =
+            options?.serverUrl ||
+                process.env.MSB_SERVER_URL ||
+                "http://127.0.0.1:5555";
+        this._namespace = options?.namespace || "default";
+        this._name = options?.name || `sandbox-${(0, uuid_1.v4)().substring(0, 8)}`;
+        this._apiKey = options?.apiKey || process.env.MSB_API_KEY;
+    }
+    /**
+     * Create and initialize a new sandbox instance.
+     *
+     * This is the base implementation that subclasses should call.
+     *
+     * @param ctor - The constructor function for the subclass
+     * @param options - Configuration options for the sandbox
+     * @returns A Promise resolving to a new sandbox instance
+     */
+    static async createBase(ctor, options) {
+        // Try to load from .env if MSB_API_KEY is not already set
+        if (!process.env.MSB_API_KEY) {
+            try {
+                dotenv.config();
+            }
+            catch (error) {
+                // Ignore errors if .env file doesn't exist
+            }
+        }
+        const sandbox = new ctor(options);
+        // Start the sandbox
+        await sandbox.start(options?.image, options?.memory, options?.cpus, options?.timeout);
+        return sandbox;
+    }
+    // Abstract static method signature that subclasses must implement
+    static create(options) {
+        throw new Error("Static method 'create' must be implemented by subclass");
+    }
+    /**
+     * Start the sandbox container.
+     *
+     * @param image - Docker image to use for the sandbox (defaults to language-specific image)
+     * @param memory - Memory limit in MB
+     * @param cpus - CPU limit (will be rounded to nearest integer)
+     * @param timeout - Maximum time in seconds to wait for the sandbox to start (default: 180 seconds)
+     *
+     * @throws Error if the sandbox fails to start
+     * @throws Error if the sandbox doesn't start within the specified timeout
+     */
+    async start(image, memory = 512, cpus = 1.0, timeout = 180.0) {
+        if (this._isStarted) {
+            return;
+        }
+        const sandboxImage = image || (await this.getDefaultImage());
+        const requestData = {
+            jsonrpc: "2.0",
+            method: "sandbox.start",
+            params: {
+                namespace: this._namespace,
+                sandbox: this._name,
+                config: {
+                    image: sandboxImage,
+                    memory,
+                    cpus: Math.round(cpus),
+                },
+            },
+            id: (0, uuid_1.v4)(),
+        };
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        if (this._apiKey) {
+            headers["Authorization"] = `Bearer ${this._apiKey}`;
+        }
+        try {
+            // We don't have a client-side timeout like the Python SDK, but we can implement one if needed
+            const response = await (0, node_fetch_1.default)(`${this._serverUrl}/api/v1/rpc`, {
+                method: "POST",
+                headers,
+                body: JSON.stringify(requestData),
+                // We'd need to use a more sophisticated fetch library for proper timeout handling
+                // Node-fetch doesn't have a timeout option that works the same way as Python's aiohttp
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new Error(`Failed to start sandbox: ${errorText}`);
+            }
+            const responseData = await response.json();
+            if ("error" in responseData) {
+                throw new Error(`Failed to start sandbox: ${responseData.error.message}`);
+            }
+            // Check the result message - it might indicate the sandbox is still initializing
+            const result = responseData.result;
+            if (typeof result === "string" && result.includes("timed out waiting")) {
+                // Server timed out but still started the sandbox
+                // We'll log a warning but still consider it started
+                console.warn(`Sandbox start warning: ${result}`);
+            }
+            this._isStarted = true;
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                if (e.message.includes("timeout")) {
+                    throw new Error(`Timed out waiting for sandbox to start after ${timeout} seconds`);
+                }
+                throw new Error(`Failed to communicate with Microsandbox server: ${e.message}`);
+            }
+            throw new Error("Failed to communicate with Microsandbox server: Unknown error");
+        }
+    }
+    /**
+     * Stop the sandbox container.
+     *
+     * @throws Error if the sandbox fails to stop
+     */
+    async stop() {
+        if (!this._isStarted) {
+            return;
+        }
+        const requestData = {
+            jsonrpc: "2.0",
+            method: "sandbox.stop",
+            params: {
+                namespace: this._namespace,
+                sandbox: this._name,
+            },
+            id: (0, uuid_1.v4)(),
+        };
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        if (this._apiKey) {
+            headers["Authorization"] = `Bearer ${this._apiKey}`;
+        }
+        try {
+            const response = await (0, node_fetch_1.default)(`${this._serverUrl}/api/v1/rpc`, {
+                method: "POST",
+                headers,
+                body: JSON.stringify(requestData),
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new Error(`Failed to stop sandbox: ${errorText}`);
+            }
+            const responseData = await response.json();
+            if ("error" in responseData) {
+                throw new Error(`Failed to stop sandbox: ${responseData.error.message}`);
+            }
+            this._isStarted = false;
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                throw new Error(`Failed to communicate with Microsandbox server: ${e.message}`);
+            }
+            throw new Error("Failed to communicate with Microsandbox server: Unknown error");
+        }
+    }
+    /**
+     * Access the command namespace for executing shell commands in the sandbox.
+     */
+    get command() {
+        return new command_1.Command(this);
+    }
+    /**
+     * Access the metrics namespace for retrieving sandbox metrics.
+     */
+    get metrics() {
+        return new metrics_1.Metrics(this);
+    }
+    /**
+     * Check if the sandbox is started.
+     */
+    get isStarted() {
+        return this._isStarted;
+    }
+    /**
+     * Get the server URL.
+     */
+    get serverUrl() {
+        return this._serverUrl;
+    }
+    /**
+     * Get the namespace.
+     */
+    get namespace() {
+        return this._namespace;
+    }
+    /**
+     * Get the sandbox name.
+     */
+    get name() {
+        return this._name;
+    }
+    /**
+     * Get the API key.
+     */
+    get apiKey() {
+        return this._apiKey;
+    }
+}
+exports.BaseSandbox = BaseSandbox;
+//# sourceMappingURL=base-sandbox.js.map

package/dist/base-sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-sandbox.js","sourceRoot":"","sources":["../src/base-sandbox.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+BAAoC;AACpC,4DAA+B;AAC/B,+CAAiC;AAEjC,uCAAoC;AACpC,uCAAoC;AAIpC,MAAsB,WAAW;IAO/B;;;;OAIG;IACH,YAAY,OAAwB;QAP1B,eAAU,GAAY,KAAK,CAAC;QAQpC,0DAA0D;QAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,2CAA2C;YAC7C,CAAC;QACH,CAAC;QAED,IAAI,CAAC,UAAU;YACb,OAAO,EAAE,SAAS;gBAClB,OAAO,CAAC,GAAG,CAAC,cAAc;gBAC1B,uBAAuB,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,SAAS,IAAI,SAAS,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,IAAI,IAAI,WAAW,IAAA,SAAM,GAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACpE,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,KAAK,CAAC,UAAU,CAC/B,IAAyC,EACzC,OAAwB;QAExB,0DAA0D;QAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,2CAA2C;YAC7C,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAElC,oBAAoB;QACpB,MAAM,OAAO,CAAC,KAAK,CACjB,OAAO,EAAE,KAAK,EACd,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,OAAO,CACjB,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,MAAM,CAAC,OAAwB;QACpC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IASD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CACT,KAAc,EACd,SAAiB,GAAG,EACpB,OAAe,GAAG,EAClB,UAAkB,KAAK;QAEvB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QAC7D,MAAM,WAAW,GAAG;YAClB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE;gBACN,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,OAAO,EAAE,IAAI,CAAC,KAAK;gBACnB,MAAM,EAAE;oBACN,KAAK,EAAE,YAAY;oBACnB,MAAM;oBACN,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;iBACvB;aACF;YACD,EAAE,EAAE,IAAA,SAAM,GAAE;SACb,CAAC;QAEF,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QACtD,CAAC;QAED,IAAI,CAAC;YACH,8FAA8F;YAC9F,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,IAAI,CAAC,UAAU,aAAa,EAAE;gBAC5D,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;gBACjC,kFAAkF;gBAClF,uFAAuF;aACxF,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,4BAA4B,SAAS,EAAE,CAAC,CAAC;YAC3D,CAAC;YAED,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAE3C,IAAI,OAAO,IAAI,YAAY,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,4BAA4B,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,CACzD,CAAC;YACJ,CAAC;YAED,iFAAiF;YACjF,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;YACnC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACvE,iDAAiD;gBACjD,oDAAoD;gBACpD,OAAO,CAAC,IAAI,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;YACnD,CAAC;YAED,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,gDAAgD,OAAO,UAAU,CAClE,CAAC;gBACJ,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,mDAAmD,CAAC,CAAC,OAAO,EAAE,CAC/D,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG;YAClB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,cAAc;YACtB,MAAM,EAAE;gBACN,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,OAAO,EAAE,IAAI,CAAC,KAAK;aACpB;YACD,EAAE,EAAE,IAAA,SAAM,GAAE;SACb,CAAC;QAEF,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QACtD,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,IAAI,CAAC,UAAU,aAAa,EAAE;gBAC5D,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;aAClC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAE3C,IAAI,OAAO,IAAI,YAAY,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,2BAA2B,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,CACxD,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CACb,mDAAmD,CAAC,CAAC,OAAO,EAAE,CAC/D,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QACJ,CAAC;IACH,CAAC;IAWD;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAlSD,kCAkSC"}

package/dist/command-execution.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Class representing command execution results in a sandbox environment.
+ */
+import { OutputData } from "./types";
+export declare class CommandExecution {
+    private outputLines;
+    private _command;
+    private _args;
+    private _exitCode;
+    private _success;
+    /**
+     * Initialize a command execution instance.
+     *
+     * @param outputData - Output data from the sandbox.command.run response
+     */
+    constructor(outputData?: OutputData);
+    /**
+     * Process output data from the sandbox.command.run response.
+     *
+     * @param outputData - Dictionary containing the output data
+     */
+    private processOutputData;
+    /**
+     * Get the standard output from the command execution.
+     *
+     * @returns String containing the stdout output of the command
+     */
+    output(): Promise<string>;
+    /**
+     * Get the error output from the command execution.
+     *
+     * @returns String containing the stderr output of the command
+     */
+    error(): Promise<string>;
+    /**
+     * Get the exit code of the command execution.
+     *
+     * @returns Integer containing the exit code
+     */
+    get exitCode(): number;
+    /**
+     * Check if the command executed successfully.
+     *
+     * @returns Boolean indicating whether the command succeeded (exit code 0)
+     */
+    get success(): boolean;
+    /**
+     * Get the command that was executed.
+     *
+     * @returns String containing the command
+     */
+    get command(): string;
+    /**
+     * Get the arguments used for the command.
+     *
+     * @returns List of strings containing the command arguments
+     */
+    get args(): string[];
+}

package/dist/command-execution.js

@@ -0,0 +1,102 @@
+"use strict";
+/**
+ * Class representing command execution results in a sandbox environment.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandExecution = void 0;
+class CommandExecution {
+    /**
+     * Initialize a command execution instance.
+     *
+     * @param outputData - Output data from the sandbox.command.run response
+     */
+    constructor(outputData) {
+        this.outputLines = [];
+        this._command = "";
+        this._args = [];
+        this._exitCode = -1;
+        this._success = false;
+        if (outputData) {
+            this.processOutputData(outputData);
+        }
+    }
+    /**
+     * Process output data from the sandbox.command.run response.
+     *
+     * @param outputData - Dictionary containing the output data
+     */
+    processOutputData(outputData) {
+        // Extract output lines from the response
+        this.outputLines = outputData.output || [];
+        // Store command-specific metadata
+        this._command = outputData.command || "";
+        this._args = outputData.args || [];
+        this._exitCode =
+            outputData.exit_code !== undefined ? outputData.exit_code : -1;
+        this._success = outputData.success || false;
+    }
+    /**
+     * Get the standard output from the command execution.
+     *
+     * @returns String containing the stdout output of the command
+     */
+    async output() {
+        // Combine the stdout output lines into a single string
+        let outputText = "";
+        for (const line of this.outputLines) {
+            if (line.stream === "stdout") {
+                outputText += line.text + "\n";
+            }
+        }
+        return outputText.trim();
+    }
+    /**
+     * Get the error output from the command execution.
+     *
+     * @returns String containing the stderr output of the command
+     */
+    async error() {
+        // Combine the stderr output lines into a single string
+        let errorText = "";
+        for (const line of this.outputLines) {
+            if (line.stream === "stderr") {
+                errorText += line.text + "\n";
+            }
+        }
+        return errorText.trim();
+    }
+    /**
+     * Get the exit code of the command execution.
+     *
+     * @returns Integer containing the exit code
+     */
+    get exitCode() {
+        return this._exitCode;
+    }
+    /**
+     * Check if the command executed successfully.
+     *
+     * @returns Boolean indicating whether the command succeeded (exit code 0)
+     */
+    get success() {
+        return this._success;
+    }
+    /**
+     * Get the command that was executed.
+     *
+     * @returns String containing the command
+     */
+    get command() {
+        return this._command;
+    }
+    /**
+     * Get the arguments used for the command.
+     *
+     * @returns List of strings containing the command arguments
+     */
+    get args() {
+        return this._args;
+    }
+}
+exports.CommandExecution = CommandExecution;
+//# sourceMappingURL=command-execution.js.map

package/dist/command-execution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-execution.js","sourceRoot":"","sources":["../src/command-execution.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH,MAAa,gBAAgB;IAO3B;;;;OAIG;IACH,YAAY,UAAuB;QAX3B,gBAAW,GAAiB,EAAE,CAAC;QAC/B,aAAQ,GAAW,EAAE,CAAC;QACtB,UAAK,GAAa,EAAE,CAAC;QACrB,cAAS,GAAW,CAAC,CAAC,CAAC;QACvB,aAAQ,GAAY,KAAK,CAAC;QAQhC,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,iBAAiB,CAAC,UAAsB;QAC9C,yCAAyC;QACzC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC;QAE3C,kCAAkC;QAClC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS;YACZ,UAAU,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,IAAI,KAAK,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,uDAAuD;QACvD,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC7B,UAAU,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjC,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,uDAAuD;QACvD,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC7B,SAAS,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AAxGD,4CAwGC"}