@buddy-works/sandbox-sdk 0.1.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Buddy Works
+
+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,81 @@
+# Buddy Sandbox SDK
+
+TypeScript SDK for managing Buddy sandboxes - isolated Ubuntu environments for running commands.
+
+## Installation
+
+```bash
+npm install @buddy-works/sandbox-sdk
+```
+
+## Usage
+
+```typescript
+import { Sandbox } from "@buddy-works/sandbox-sdk";
+
+const identifier = "my-sandbox";
+
+let sandbox: Sandbox;
+
+try {
+    sandbox = await Sandbox.getByIdentifier(identifier);
+} catch {
+    sandbox = await Sandbox.create({
+        identifier,
+        name: "My Sandbox",
+        os: "ubuntu:24.04",
+    });
+}
+
+await sandbox.runCommand({
+    command: "ping -c 5 buddy.works",
+});
+```
+
+Set required environment variables:
+
+```bash
+export BUDDY_TOKEN="your-api-token"
+export BUDDY_WORKSPACE="your-workspace"
+export BUDDY_PROJECT="your-project"
+export BUDDY_REGION="US"  # Optional: US (default), EU, or AP
+```
+
+## Regions
+
+Configure the API region:
+
+```bash
+# Via environment variable (recommended)
+export BUDDY_REGION="EU"
+```
+
+```typescript
+// Or via connection config
+const sandbox = await Sandbox.create({
+    identifier: "my-sandbox",
+    name: "My Sandbox",
+    os: "ubuntu:24.04",
+    connection: {
+        region: "EU"  // US, EU, or AP
+    }
+});
+```
+
+## Connection overrides
+
+Override workspace/auth per call:
+
+```typescript
+await Sandbox.create({
+    identifier: "my-sandbox",
+    name: "My Sandbox",
+    os: "ubuntu:24.04",
+    connection: {
+        workspace: "different-workspace",
+        project: "different-project",
+        token: "custom-token",
+        region: "EU"
+    }
+});
+```

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@buddy-works/sandbox-sdk",
+  "version": "0.1.0-rc.0",
+  "type": "module",
+  "description": "TypeScript SDK for managing sandboxes through the Buddy API",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "sandbox",
+    "api",
+    "sdk",
+    "ci",
+    "cd",
+    "devops",
+    "cloud",
+    "typescript"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "sideEffects": false,
+  "author": "Cyprian Zdebski <cyprian.zdebski@buddy.works>",
+  "homepage": "https://github.com/buddy/sandbox-sdk#readme",
+  "bugs": "https://github.com/buddy/sandbox-sdk/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/buddy/sandbox-sdk.git"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@biomejs/biome": "2.3.11",
+    "@dotenvx/dotenvx": "1.51.4",
+    "@hey-api/openapi-ts": "0.90.3",
+    "@tsconfig/node20": "20",
+    "@tsconfig/strictest": "2.0.8",
+    "@types/node": "20",
+    "knip": "5.81.0",
+    "msw": "2.12.7",
+    "tsdown": "0.20.0-beta.3",
+    "typescript": "5.9.3",
+    "vitest": "4.0.17"
+  },
+  "dependencies": {
+    "p-retry": "7.1.1",
+    "zod": "4.3.5"
+  },
+  "scripts": {
+    "fetch:schemas": "openapi-ts",
+    "build": "tsdown",
+    "test": "NODE_OPTIONS='--enable-source-maps' dotenvx run -q -- vitest run",
+    "test:watch": "NODE_OPTIONS='--enable-source-maps' dotenvx run -q -- vitest",
+    "lint:check": "tsc --skipLibCheck --noEmit && biome check",
+    "lint:fix": "tsc --skipLibCheck --noEmit && biome check --write",
+    "knip": "knip"
+  }
+}