@cloudflare/sandbox 0.0.0-02ee8fe → 0.0.0-04a60d8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/CHANGELOG.md +70 -16
  2. package/Dockerfile +79 -32
  3. package/README.md +9 -2
  4. package/dist/index.d.ts +1953 -9
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +3278 -65
  7. package/dist/index.js.map +1 -1
  8. package/package.json +5 -5
  9. package/src/clients/base-client.ts +39 -24
  10. package/src/clients/command-client.ts +8 -8
  11. package/src/clients/file-client.ts +31 -26
  12. package/src/clients/git-client.ts +9 -3
  13. package/src/clients/index.ts +16 -16
  14. package/src/clients/interpreter-client.ts +51 -47
  15. package/src/clients/port-client.ts +10 -10
  16. package/src/clients/process-client.ts +11 -8
  17. package/src/clients/sandbox-client.ts +2 -4
  18. package/src/clients/types.ts +6 -2
  19. package/src/clients/utility-client.ts +43 -6
  20. package/src/errors/adapter.ts +90 -32
  21. package/src/errors/classes.ts +189 -64
  22. package/src/errors/index.ts +9 -5
  23. package/src/file-stream.ts +11 -6
  24. package/src/index.ts +28 -17
  25. package/src/interpreter.ts +50 -41
  26. package/src/request-handler.ts +24 -21
  27. package/src/sandbox.ts +372 -149
  28. package/src/security.ts +21 -6
  29. package/src/sse-parser.ts +4 -3
  30. package/src/version.ts +1 -1
  31. package/startup.sh +1 -1
  32. package/tests/base-client.test.ts +116 -80
  33. package/tests/command-client.test.ts +149 -112
  34. package/tests/file-client.test.ts +309 -197
  35. package/tests/file-stream.test.ts +24 -20
  36. package/tests/get-sandbox.test.ts +10 -10
  37. package/tests/git-client.test.ts +260 -101
  38. package/tests/port-client.test.ts +100 -108
  39. package/tests/process-client.test.ts +204 -179
  40. package/tests/request-handler.test.ts +117 -65
  41. package/tests/sandbox.test.ts +252 -67
  42. package/tests/sse-parser.test.ts +17 -16
  43. package/tests/utility-client.test.ts +79 -72
  44. package/tsdown.config.ts +12 -0
  45. package/vitest.config.ts +6 -6
  46. package/dist/chunk-BFVUNTP4.js +0 -104
  47. package/dist/chunk-BFVUNTP4.js.map +0 -1
  48. package/dist/chunk-EKSWCBCA.js +0 -86
  49. package/dist/chunk-EKSWCBCA.js.map +0 -1
  50. package/dist/chunk-JXZMAU2C.js +0 -559
  51. package/dist/chunk-JXZMAU2C.js.map +0 -1
  52. package/dist/chunk-UJ3TV4M6.js +0 -7
  53. package/dist/chunk-UJ3TV4M6.js.map +0 -1
  54. package/dist/chunk-YE265ASX.js +0 -2484
  55. package/dist/chunk-YE265ASX.js.map +0 -1
  56. package/dist/chunk-Z532A7QC.js +0 -78
  57. package/dist/chunk-Z532A7QC.js.map +0 -1
  58. package/dist/file-stream.d.ts +0 -43
  59. package/dist/file-stream.js +0 -9
  60. package/dist/file-stream.js.map +0 -1
  61. package/dist/interpreter.d.ts +0 -33
  62. package/dist/interpreter.js +0 -8
  63. package/dist/interpreter.js.map +0 -1
  64. package/dist/request-handler.d.ts +0 -18
  65. package/dist/request-handler.js +0 -13
  66. package/dist/request-handler.js.map +0 -1
  67. package/dist/sandbox-CLZWpfGc.d.ts +0 -613
  68. package/dist/sandbox.d.ts +0 -4
  69. package/dist/sandbox.js +0 -13
  70. package/dist/sandbox.js.map +0 -1
  71. package/dist/security.d.ts +0 -31
  72. package/dist/security.js +0 -13
  73. package/dist/security.js.map +0 -1
  74. package/dist/sse-parser.d.ts +0 -28
  75. package/dist/sse-parser.js +0 -11
  76. package/dist/sse-parser.js.map +0 -1
  77. package/dist/version.d.ts +0 -8
  78. package/dist/version.js +0 -7
  79. package/dist/version.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,63 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.18
4
+
5
+ ### Patch Changes
6
+
7
+ - [`228ef5b`](https://github.com/cloudflare/sandbox-sdk/commit/228ef5b6e57fa3c38dc8d90e006ae58d0815aaec) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix encoding parameter handling in file operations to enable MIME auto-detection. Previously, SDK and container handlers added default 'utf8' encoding, preventing MIME-based detection of binary files. Now encoding parameter is passed through as-is, allowing automatic detection when not explicitly specified.
8
+
9
+ ## 0.4.17
10
+
11
+ ### Patch Changes
12
+
13
+ - [#198](https://github.com/cloudflare/sandbox-sdk/pull/198) [`93c6cc7`](https://github.com/cloudflare/sandbox-sdk/commit/93c6cc7c6b8df9e0a733fa852faf5d2f1c5758da) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix container startup failures when WORKDIR is changed in derived Dockerfiles
14
+
15
+ ## 0.4.16
16
+
17
+ ### Patch Changes
18
+
19
+ - [#184](https://github.com/cloudflare/sandbox-sdk/pull/184) [`7989b61`](https://github.com/cloudflare/sandbox-sdk/commit/7989b6105cea8c381dd162be0bcb29db3e214fde) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Redact credentials from Git URLs in logs
20
+
21
+ - [#186](https://github.com/cloudflare/sandbox-sdk/pull/186) [`c2e3384`](https://github.com/cloudflare/sandbox-sdk/commit/c2e3384b151ae3f430c2edc8c492921d0b6b8b1c) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Expose deleteSession API with proper safeguards
22
+ - Add `deleteSession(sessionId)` method to public SDK API
23
+ - Prevent deletion of default session (throws error with guidance to use `sandbox.destroy()`)
24
+ - Session cleanup kills all running commands in parallel before destroying shell
25
+ - Return structured `SessionDeleteResult` with success status, sessionId, and timestamp
26
+
27
+ ## 0.4.15
28
+
29
+ ### Patch Changes
30
+
31
+ - [#185](https://github.com/cloudflare/sandbox-sdk/pull/185) [`7897cdd`](https://github.com/cloudflare/sandbox-sdk/commit/7897cddefc366bbd640ea138b34a520a0b2ddf8c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix foreground commands blocking on background processes
32
+
33
+ - [#183](https://github.com/cloudflare/sandbox-sdk/pull/183) [`ff2fa91`](https://github.com/cloudflare/sandbox-sdk/commit/ff2fa91479357ef88cfb22418f88acb257462faa) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - update python to 3.11.14
34
+
35
+ ## 0.4.14
36
+
37
+ ### Patch Changes
38
+
39
+ - [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Update dependencies
40
+
41
+ - [#176](https://github.com/cloudflare/sandbox-sdk/pull/176) [`7edbfa9`](https://github.com/cloudflare/sandbox-sdk/commit/7edbfa906668d75f540527f50b52483dc787192c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add cache mounts to Dockerfile for faster builds
42
+
43
+ Adds cache mounts for npm, apt, and pip package managers in the Dockerfile. This speeds up Docker image builds when dependencies change, particularly beneficial for users building from source.
44
+
45
+ - [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
46
+
47
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
48
+
49
+ - [#175](https://github.com/cloudflare/sandbox-sdk/pull/175) [`77cb937`](https://github.com/cloudflare/sandbox-sdk/commit/77cb93762a619523758f769a10509e665ca819fe) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Move .connect to .wsConnect within DO stub
50
+
51
+ ## 0.4.13
52
+
53
+ ### Patch Changes
54
+
55
+ - [#168](https://github.com/cloudflare/sandbox-sdk/pull/168) [`6b08f02`](https://github.com/cloudflare/sandbox-sdk/commit/6b08f02c061aef07cc98188abef2973ac92365f8) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
56
+
57
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
58
+
59
+ - [#162](https://github.com/cloudflare/sandbox-sdk/pull/162) [`c4db459`](https://github.com/cloudflare/sandbox-sdk/commit/c4db459389a7b86048a03410d67d4dd7bf4a6085) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Add WebSocket support via connect() method for routing client WebSocket connections directly to container services
60
+
3
61
  ## 0.4.12
4
62
 
5
63
  ### Patch Changes
@@ -27,7 +85,6 @@
27
85
  This adds a new `exists()` method to the SDK that checks whether a file or directory exists at a given path. The method returns a boolean indicating existence, similar to Python's `os.path.exists()` and JavaScript's `fs.existsSync()`.
28
86
 
29
87
  The implementation is end-to-end:
30
-
31
88
  - New `FileExistsResult` and `FileExistsRequest` types in shared package
32
89
  - Handler endpoint at `/api/exists` in container layer
33
90
  - Client method in `FileClient` and `Sandbox` classes
@@ -126,50 +183,47 @@
126
183
  Implements PID namespace isolation to protect control plane processes (Jupyter, Bun) from sandboxed code. Commands executed via `exec()` now run in isolated namespaces that cannot see or interact with system processes.
127
184
 
128
185
  **Key security improvements:**
129
-
130
186
  - Control plane processes are hidden from sandboxed commands
131
187
  - Platform secrets in `/proc/1/environ` are inaccessible
132
188
  - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
133
189
 
134
190
  **Breaking changes:**
135
-
136
191
  1. **Removed `sessionId` parameter**: The `sessionId` parameter has been removed from all methods (`exec()`, `execStream()`, `startProcess()`, etc.). Each sandbox now maintains its own persistent session automatically.
137
192
 
138
193
  ```javascript
139
194
  // Before: manual session management
140
- await sandbox.exec("cd /app", { sessionId: "my-session" });
195
+ await sandbox.exec('cd /app', { sessionId: 'my-session' });
141
196
 
142
197
  // After: automatic session per sandbox
143
- await sandbox.exec("cd /app");
198
+ await sandbox.exec('cd /app');
144
199
  ```
145
200
 
146
201
  2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
147
202
 
148
203
  ```javascript
149
204
  // Before: each exec was independent
150
- await sandbox.exec("cd /app");
151
- await sandbox.exec("pwd"); // Output: /workspace
205
+ await sandbox.exec('cd /app');
206
+ await sandbox.exec('pwd'); // Output: /workspace
152
207
 
153
208
  // After: state persists in session
154
- await sandbox.exec("cd /app");
155
- await sandbox.exec("pwd"); // Output: /app
209
+ await sandbox.exec('cd /app');
210
+ await sandbox.exec('pwd'); // Output: /app
156
211
  ```
157
212
 
158
213
  **Migration guide:**
159
-
160
214
  - Remove `sessionId` from all method calls - each sandbox maintains its own session
161
215
  - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
162
216
  ```javascript
163
217
  // Create independent sessions with different environments
164
218
  const buildSession = await sandbox.createSession({
165
- name: "build",
166
- env: { NODE_ENV: "production" },
167
- cwd: "/build",
219
+ name: 'build',
220
+ env: { NODE_ENV: 'production' },
221
+ cwd: '/build'
168
222
  });
169
223
  const testSession = await sandbox.createSession({
170
- name: "test",
171
- env: { NODE_ENV: "test" },
172
- cwd: "/test",
224
+ name: 'test',
225
+ env: { NODE_ENV: 'test' },
226
+ cwd: '/test'
173
227
  });
174
228
  ```
175
229
  - Environment variables set in one command persist to the next
package/Dockerfile CHANGED
@@ -29,8 +29,9 @@ WORKDIR /app
29
29
  COPY --from=pruner /app/out/json/ .
30
30
  COPY --from=pruner /app/out/package-lock.json ./package-lock.json
31
31
 
32
- # Install ALL dependencies (including devDependencies for build)
33
- RUN npm ci
32
+ # Install ALL dependencies with cache mount for npm packages
33
+ RUN --mount=type=cache,target=/root/.npm \
34
+ CI=true npm ci
34
35
 
35
36
  # Copy pruned source code
36
37
  COPY --from=pruner /app/out/full/ .
@@ -53,10 +54,53 @@ COPY --from=builder /app/packages ./packages
53
54
  COPY --from=builder /app/tooling ./tooling
54
55
 
55
56
  # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
56
- RUN npm ci --production
57
+ RUN --mount=type=cache,target=/root/.npm \
58
+ CI=true npm ci --production
57
59
 
58
60
  # ============================================================================
59
- # Stage 4: Runtime - Ubuntu 22.04 with only runtime dependencies
61
+ # Stage 4: Download pre-built Python 3.11.14
62
+ # ============================================================================
63
+ FROM ubuntu:22.04 AS python-builder
64
+
65
+ # Prevent interactive prompts during package installation
66
+ ENV DEBIAN_FRONTEND=noninteractive
67
+
68
+ # Accept architecture from Docker BuildKit (for multi-arch builds)
69
+ ARG TARGETARCH
70
+
71
+ # Install minimal dependencies for downloading
72
+ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
73
+ --mount=type=cache,target=/var/lib/apt,sharing=locked \
74
+ rm -f /etc/apt/apt.conf.d/docker-clean && \
75
+ echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' >/etc/apt/apt.conf.d/keep-cache && \
76
+ apt-get update && apt-get install -y --no-install-recommends \
77
+ wget ca-certificates
78
+
79
+ # Download and extract pre-built Python 3.11.14 from python-build-standalone
80
+ # Using PGO+LTO optimized builds for better performance
81
+ # Supports multi-arch: amd64 (x86_64) and arm64 (aarch64)
82
+ RUN --mount=type=cache,target=/tmp/python-cache \
83
+ # Map Docker TARGETARCH to python-build-standalone arch naming
84
+ if [ "$TARGETARCH" = "amd64" ]; then \
85
+ PYTHON_ARCH="x86_64-unknown-linux-gnu"; \
86
+ EXPECTED_SHA256="edd8d11aa538953d12822fab418359a692fd1ee4ca2675579fbf0fa31e3688f1"; \
87
+ elif [ "$TARGETARCH" = "arm64" ]; then \
88
+ PYTHON_ARCH="aarch64-unknown-linux-gnu"; \
89
+ EXPECTED_SHA256="08141d31f95d86a23f23e4c741b726de0055f12f83200d1d4867b4e8e6e967c5"; \
90
+ else \
91
+ echo "Unsupported architecture: $TARGETARCH" && exit 1; \
92
+ fi && \
93
+ cd /tmp/python-cache && \
94
+ wget -nc https://github.com/indygreg/python-build-standalone/releases/download/20251028/cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz && \
95
+ # Verify SHA256 checksum for security
96
+ echo "${EXPECTED_SHA256} cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz" | sha256sum -c - && \
97
+ cd /tmp && \
98
+ tar -xzf /tmp/python-cache/cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz && \
99
+ mv python /usr/local/ && \
100
+ rm -rf /tmp/cpython-*
101
+
102
+ # ============================================================================
103
+ # Stage 5: Runtime - Ubuntu 22.04 with only runtime dependencies
60
104
  # ============================================================================
61
105
  FROM ubuntu:22.04 AS runtime
62
106
 
@@ -69,40 +113,43 @@ ENV DEBIAN_FRONTEND=noninteractive
69
113
  # Set the sandbox version as an environment variable for version checking
70
114
  ENV SANDBOX_VERSION=${SANDBOX_VERSION}
71
115
 
72
- # Install essential runtime packages
73
- RUN apt-get update && apt-get install -y --no-install-recommends \
74
- curl \
75
- wget \
76
- ca-certificates \
77
- python3.11 \
78
- python3-pip \
79
- python3.11-venv \
80
- procps \
81
- git \
82
- unzip \
83
- zip \
84
- jq \
85
- file \
86
- && rm -rf /var/lib/apt/lists/*
116
+ # Install runtime packages and Python runtime libraries
117
+ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
118
+ --mount=type=cache,target=/var/lib/apt,sharing=locked \
119
+ rm -f /etc/apt/apt.conf.d/docker-clean && \
120
+ echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' >/etc/apt/apt.conf.d/keep-cache && \
121
+ apt-get update && apt-get install -y --no-install-recommends \
122
+ ca-certificates curl wget procps git unzip zip jq file \
123
+ libssl3 zlib1g libbz2-1.0 libreadline8 libsqlite3-0 \
124
+ libncursesw6 libtinfo6 libxml2 libxmlsec1 libffi8 liblzma5 libtk8.6 && \
125
+ update-ca-certificates
126
+
127
+ # Copy pre-built Python from python-builder stage
128
+ COPY --from=python-builder /usr/local/python /usr/local/python
129
+
130
+ # Create symlinks and update shared library cache
131
+ RUN ln -s /usr/local/python/bin/python3.11 /usr/local/bin/python3.11 && \
132
+ ln -s /usr/local/python/bin/python3 /usr/local/bin/python3 && \
133
+ ln -s /usr/local/python/bin/pip3 /usr/local/bin/pip3 && \
134
+ echo "/usr/local/python/lib" > /etc/ld.so.conf.d/python.conf && \
135
+ ldconfig
87
136
 
88
137
  # Set Python 3.11 as default python3
89
- RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
138
+ RUN update-alternatives --install /usr/bin/python3 python3 /usr/local/bin/python3.11 1
90
139
 
91
- # Install Node.js 20 LTS using official NodeSource setup script
92
- RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
93
- && apt-get install -y nodejs \
94
- && rm -rf /var/lib/apt/lists/*
140
+ # Install Python packages
141
+ RUN --mount=type=cache,target=/root/.cache/pip \
142
+ pip3 install --no-cache-dir matplotlib numpy pandas ipython
143
+
144
+ # Install Node.js 20 LTS from official Node image
145
+ COPY --from=node:20-slim /usr/local/bin/node /usr/local/bin/node
146
+ COPY --from=node:20-slim /usr/local/lib/node_modules /usr/local/lib/node_modules
147
+ RUN ln -s /usr/local/lib/node_modules/npm/bin/npm-cli.js /usr/local/bin/npm && \
148
+ ln -s /usr/local/lib/node_modules/npm/bin/npx-cli.js /usr/local/bin/npx
95
149
 
96
150
  # Install Bun runtime from official image
97
151
  COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
98
152
 
99
- # Install essential Python packages for code execution
100
- RUN pip3 install --no-cache-dir \
101
- matplotlib \
102
- numpy \
103
- pandas \
104
- ipython
105
-
106
153
  # Set up runtime container server directory
107
154
  WORKDIR /container-server
108
155
 
@@ -140,4 +187,4 @@ COPY packages/sandbox/startup.sh ./
140
187
  RUN chmod +x startup.sh
141
188
 
142
189
  # Use startup script
143
- CMD ["./startup.sh"]
190
+ CMD ["/container-server/startup.sh"]
package/README.md CHANGED
@@ -116,9 +116,17 @@ export default {
116
116
  - **Preview URLs** - Expose services with public URLs
117
117
  - **Git Integration** - Clone repositories directly
118
118
 
119
+ ## Contributing
120
+
121
+ We welcome contributions from the community! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on:
122
+
123
+ - Setting up your development environment
124
+ - Creating pull requests
125
+ - Code style and testing requirements
126
+
119
127
  ## Development
120
128
 
121
- This repository contains the SDK source code. To contribute:
129
+ This repository contains the SDK source code. Quick start:
122
130
 
123
131
  ```bash
124
132
  # Clone the repo
@@ -144,7 +152,6 @@ See the [examples directory](./examples) for complete working examples:
144
152
 
145
153
  - [Minimal](./examples/minimal) - Basic sandbox setup
146
154
  - [Code Interpreter](./examples/code-interpreter) - Use sandbox as an interpreter tool with gpt-oss
147
- - [Complete](./examples/basic) - Huge example integrated with every sandbox feature
148
155
 
149
156
  ## Status
150
157