@tpmjs/tools-sprites-exec 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 TPMJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# @tpmjs/sprites-exec
+
+Execute a command inside a sprite and return the output.
+
+## Installation
+
+```bash
+npm install @tpmjs/sprites-exec
+```
+
+## Requirements
+
+- `SPRITES_TOKEN` environment variable - Get your token from https://sprites.dev
+
+## Usage
+
+```typescript
+import { spritesExecTool } from '@tpmjs/sprites-exec';
+
+// Run a simple command
+const result = await spritesExecTool.execute({
+  name: 'my-sandbox',
+  cmd: 'ls -la /home'
+});
+
+console.log(result);
+// {
+//   exitCode: 0,
+//   stdout: 'total 4\ndrwxr-xr-x 2 root root 4096 Jan 15 10:30 .\n...',
+//   stderr: '',
+//   duration: 45
+// }
+
+// Run with stdin input
+const pythonResult = await spritesExecTool.execute({
+  name: 'my-sandbox',
+  cmd: 'python3',
+  stdin: 'print("Hello from stdin!")'
+});
+```
+
+## Input Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `name` | `string` | Yes | Name of the sprite to execute command in |
+| `cmd` | `string` | Yes | Command to execute (e.g., 'ls -la', 'python script.py') |
+| `stdin` | `string` | No | Optional stdin input to pass to the command |
+| `timeoutMs` | `number` | No | Execution timeout in milliseconds (default: 60000) |
+
+## Output
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `exitCode` | `number` | Command exit code (0 = success) |
+| `stdout` | `string` | Standard output from the command |
+| `stderr` | `string` | Standard error from the command |
+| `duration` | `number` | Execution duration in milliseconds |
+
+## Error Handling
+
+The tool throws errors in these cases:
+- `SPRITES_TOKEN` environment variable is not set
+- Sprite not found (HTTP 404)
+- Command execution timeout
+- Invalid or expired API token (HTTP 401)
+- Network errors with descriptive messages
+
+## License
+
+MIT

package/dist/index.js

@@ -68,9 +68,7 @@ var spritesExecTool = tool({
     } catch (error) {
       if (error instanceof Error) {
         if (error.name === "AbortError") {
-          throw new Error(
-            `Command execution in sprite "${name}" timed out after ${timeout}ms`
-          );
+          throw new Error(`Command execution in sprite "${name}" timed out after ${timeout}ms`);
         }
         throw new Error(`Failed to execute command in sprite "${name}": ${error.message}`);
       }

package/package.json

@@ -1,28 +1,32 @@
 {
   "name": "@tpmjs/tools-sprites-exec",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Execute a command inside a sprite and return the output with exit code",
   "type": "module",
-  "keywords": ["tpmjs", "sprites", "sandbox", "code-execution", "ai"],
+  "keywords": [
+    "tpmjs",
+    "sprites",
+    "sandbox",
+    "code-execution",
+    "ai"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     }
   },
-  "files": ["dist"],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "type-check": "tsc --noEmit",
-    "clean": "rm -rf dist .turbo"
-  },
+  "files": [
+    "dist"
+  ],
   "devDependencies": {
-    "@tpmjs/tsconfig": "workspace:*",
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "@tpmjs/tsconfig": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
   },
-  "publishConfig": { "access": "public" },
   "repository": {
     "type": "git",
     "url": "https://github.com/anthropics/tpmjs.git",
@@ -32,21 +36,53 @@
   "license": "MIT",
   "tpmjs": {
     "category": "sandbox",
-    "frameworks": ["vercel-ai"],
-    "tools": [{
-      "name": "spritesExecTool",
-      "description": "Execute a command inside a sprite and return the output with exit code",
-      "parameters": [
-        { "name": "name", "type": "string", "description": "Name of the sprite to execute command in", "required": true },
-        { "name": "cmd", "type": "string", "description": "Command to execute", "required": true },
-        { "name": "stdin", "type": "string", "description": "Optional stdin input", "required": false },
-        { "name": "timeoutMs", "type": "number", "description": "Execution timeout in milliseconds", "required": false }
-      ],
-      "returns": {
-        "type": "ExecResult",
-        "description": "Command output with exitCode, stdout, stderr, and duration"
+    "frameworks": [
+      "vercel-ai"
+    ],
+    "tools": [
+      {
+        "name": "spritesExecTool",
+        "description": "Execute a command inside a sprite and return the output with exit code",
+        "parameters": [
+          {
+            "name": "name",
+            "type": "string",
+            "description": "Name of the sprite to execute command in",
+            "required": true
+          },
+          {
+            "name": "cmd",
+            "type": "string",
+            "description": "Command to execute",
+            "required": true
+          },
+          {
+            "name": "stdin",
+            "type": "string",
+            "description": "Optional stdin input",
+            "required": false
+          },
+          {
+            "name": "timeoutMs",
+            "type": "number",
+            "description": "Execution timeout in milliseconds",
+            "required": false
+          }
+        ],
+        "returns": {
+          "type": "ExecResult",
+          "description": "Command output with exitCode, stdout, stderr, and duration"
+        }
       }
-    }]
+    ]
   },
-  "dependencies": { "ai": "6.0.23" }
-}
+  "dependencies": {
+    "ai": "6.0.23"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist .turbo"
+  }
+}