@cloudflare/sandbox 0.0.0-fddccfd → 0.0.0-ff2fa91

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 (74) hide show
  1. package/CHANGELOG.md +102 -15
  2. package/Dockerfile +84 -31
  3. package/README.md +9 -2
  4. package/dist/index.d.ts +1889 -9
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +3144 -64
  7. package/dist/index.js.map +1 -1
  8. package/package.json +9 -9
  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 +51 -20
  12. package/src/clients/git-client.ts +3 -4
  13. package/src/clients/index.ts +12 -15
  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 +34 -5
  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 +22 -15
  25. package/src/interpreter.ts +50 -41
  26. package/src/request-handler.ts +34 -21
  27. package/src/sandbox.ts +443 -144
  28. package/src/security.ts +21 -6
  29. package/src/sse-parser.ts +4 -3
  30. package/src/version.ts +6 -0
  31. package/tests/base-client.test.ts +116 -80
  32. package/tests/command-client.test.ts +149 -112
  33. package/tests/file-client.test.ts +373 -185
  34. package/tests/file-stream.test.ts +24 -20
  35. package/tests/get-sandbox.test.ts +149 -0
  36. package/tests/git-client.test.ts +188 -101
  37. package/tests/port-client.test.ts +100 -108
  38. package/tests/process-client.test.ts +204 -179
  39. package/tests/request-handler.test.ts +292 -0
  40. package/tests/sandbox.test.ts +303 -62
  41. package/tests/sse-parser.test.ts +17 -16
  42. package/tests/utility-client.test.ts +129 -56
  43. package/tests/version.test.ts +16 -0
  44. package/tsdown.config.ts +12 -0
  45. package/vitest.config.ts +6 -6
  46. package/dist/chunk-2P3MDMNJ.js +0 -2367
  47. package/dist/chunk-2P3MDMNJ.js.map +0 -1
  48. package/dist/chunk-BFVUNTP4.js +0 -104
  49. package/dist/chunk-BFVUNTP4.js.map +0 -1
  50. package/dist/chunk-EKSWCBCA.js +0 -86
  51. package/dist/chunk-EKSWCBCA.js.map +0 -1
  52. package/dist/chunk-JXZMAU2C.js +0 -559
  53. package/dist/chunk-JXZMAU2C.js.map +0 -1
  54. package/dist/chunk-Z532A7QC.js +0 -78
  55. package/dist/chunk-Z532A7QC.js.map +0 -1
  56. package/dist/file-stream.d.ts +0 -43
  57. package/dist/file-stream.js +0 -9
  58. package/dist/file-stream.js.map +0 -1
  59. package/dist/interpreter.d.ts +0 -33
  60. package/dist/interpreter.js +0 -8
  61. package/dist/interpreter.js.map +0 -1
  62. package/dist/request-handler.d.ts +0 -18
  63. package/dist/request-handler.js +0 -12
  64. package/dist/request-handler.js.map +0 -1
  65. package/dist/sandbox-CZTMzV2R.d.ts +0 -587
  66. package/dist/sandbox.d.ts +0 -4
  67. package/dist/sandbox.js +0 -12
  68. package/dist/sandbox.js.map +0 -1
  69. package/dist/security.d.ts +0 -31
  70. package/dist/security.js +0 -13
  71. package/dist/security.js.map +0 -1
  72. package/dist/sse-parser.d.ts +0 -28
  73. package/dist/sse-parser.js +0 -11
  74. package/dist/sse-parser.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,95 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.14
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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
8
+
9
+ - [#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
10
+
11
+ 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.
12
+
13
+ - [#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
14
+
15
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
16
+
17
+ - [#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
18
+
19
+ ## 0.4.13
20
+
21
+ ### Patch Changes
22
+
23
+ - [#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
24
+
25
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
26
+
27
+ - [#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
28
+
29
+ ## 0.4.12
30
+
31
+ ### Patch Changes
32
+
33
+ - [#137](https://github.com/cloudflare/sandbox-sdk/pull/137) [`7f4442b`](https://github.com/cloudflare/sandbox-sdk/commit/7f4442b7a097587d8f8e8f9ff2f887df6943a3db) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add keepAlive flag to prevent containers from shutting down
34
+
35
+ ## 0.4.11
36
+
37
+ ### Patch Changes
38
+
39
+ - [#159](https://github.com/cloudflare/sandbox-sdk/pull/159) [`e16659a`](https://github.com/cloudflare/sandbox-sdk/commit/e16659a1815923f1cd1176f51a052725d820ee16) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Use latest containers package version
40
+
41
+ ## 0.4.10
42
+
43
+ ### Patch Changes
44
+
45
+ - [#156](https://github.com/cloudflare/sandbox-sdk/pull/156) [`b61841c`](https://github.com/cloudflare/sandbox-sdk/commit/b61841cfb3248022ee8136311e54955ed9faa1ee) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix WebSocket upgrade requests through exposed ports
46
+
47
+ ## 0.4.9
48
+
49
+ ### Patch Changes
50
+
51
+ - [#152](https://github.com/cloudflare/sandbox-sdk/pull/152) [`8e7773e`](https://github.com/cloudflare/sandbox-sdk/commit/8e7773ec9571a5f968cbbc5f48e38e01d7d13b77) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add exists() method to check if a file or directory exists
52
+
53
+ 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()`.
54
+
55
+ The implementation is end-to-end:
56
+ - New `FileExistsResult` and `FileExistsRequest` types in shared package
57
+ - Handler endpoint at `/api/exists` in container layer
58
+ - Client method in `FileClient` and `Sandbox` classes
59
+ - Full test coverage (unit tests and E2E tests)
60
+
61
+ ## 0.4.8
62
+
63
+ ### Patch Changes
64
+
65
+ - [#153](https://github.com/cloudflare/sandbox-sdk/pull/153) [`f6a5c3e`](https://github.com/cloudflare/sandbox-sdk/commit/f6a5c3e1607fce5fc26f816e9206ae437898d5af) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix token extraction regex causing Invalid token errors
66
+
67
+ ## 0.4.7
68
+
69
+ ### Patch Changes
70
+
71
+ - [#141](https://github.com/cloudflare/sandbox-sdk/pull/141) [`c39674b`](https://github.com/cloudflare/sandbox-sdk/commit/c39674b8fe2e986e59a794b6bb3a5f51a87bae89) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix commands hanging when reading stdin by redirecting stdin to /dev/null
72
+
73
+ - [#143](https://github.com/cloudflare/sandbox-sdk/pull/143) [`276efc0`](https://github.com/cloudflare/sandbox-sdk/commit/276efc0ca8776bcc8de79e7e58dd24d9f418cc5c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Remove unnecessary existing session check
74
+
75
+ ## 0.4.6
76
+
77
+ ### Patch Changes
78
+
79
+ - [#133](https://github.com/cloudflare/sandbox-sdk/pull/133) [`da2cfb8`](https://github.com/cloudflare/sandbox-sdk/commit/da2cfb876675eb3445970c90b4d70d00288a7c74) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - feat: Add version sync detection between npm package and Docker image
80
+
81
+ ## 0.4.5
82
+
83
+ ### Patch Changes
84
+
85
+ - [#127](https://github.com/cloudflare/sandbox-sdk/pull/127) [`e79ac80`](https://github.com/cloudflare/sandbox-sdk/commit/e79ac80bc855a3ec527d44cc14585794b23cb129) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - configurable sleepAfter
86
+
87
+ ## 0.4.4
88
+
89
+ ### Patch Changes
90
+
91
+ - [#125](https://github.com/cloudflare/sandbox-sdk/pull/125) [`fddccfd`](https://github.com/cloudflare/sandbox-sdk/commit/fddccfdce8204ce2aa7dadc0ad9fb2acbdeaec51) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add docker image to pkg workflow
92
+
3
93
  ## 0.4.3
4
94
 
5
95
  ### Patch Changes
@@ -61,50 +151,47 @@
61
151
  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.
62
152
 
63
153
  **Key security improvements:**
64
-
65
154
  - Control plane processes are hidden from sandboxed commands
66
155
  - Platform secrets in `/proc/1/environ` are inaccessible
67
156
  - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
68
157
 
69
158
  **Breaking changes:**
70
-
71
159
  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.
72
160
 
73
161
  ```javascript
74
162
  // Before: manual session management
75
- await sandbox.exec("cd /app", { sessionId: "my-session" });
163
+ await sandbox.exec('cd /app', { sessionId: 'my-session' });
76
164
 
77
165
  // After: automatic session per sandbox
78
- await sandbox.exec("cd /app");
166
+ await sandbox.exec('cd /app');
79
167
  ```
80
168
 
81
169
  2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
82
170
 
83
171
  ```javascript
84
172
  // Before: each exec was independent
85
- await sandbox.exec("cd /app");
86
- await sandbox.exec("pwd"); // Output: /workspace
173
+ await sandbox.exec('cd /app');
174
+ await sandbox.exec('pwd'); // Output: /workspace
87
175
 
88
176
  // After: state persists in session
89
- await sandbox.exec("cd /app");
90
- await sandbox.exec("pwd"); // Output: /app
177
+ await sandbox.exec('cd /app');
178
+ await sandbox.exec('pwd'); // Output: /app
91
179
  ```
92
180
 
93
181
  **Migration guide:**
94
-
95
182
  - Remove `sessionId` from all method calls - each sandbox maintains its own session
96
183
  - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
97
184
  ```javascript
98
185
  // Create independent sessions with different environments
99
186
  const buildSession = await sandbox.createSession({
100
- name: "build",
101
- env: { NODE_ENV: "production" },
102
- cwd: "/build",
187
+ name: 'build',
188
+ env: { NODE_ENV: 'production' },
189
+ cwd: '/build'
103
190
  });
104
191
  const testSession = await sandbox.createSession({
105
- name: "test",
106
- env: { NODE_ENV: "test" },
107
- cwd: "/test",
192
+ name: 'test',
193
+ env: { NODE_ENV: 'test' },
194
+ cwd: '/test'
108
195
  });
109
196
  ```
110
197
  - 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
+ npm ci
34
35
 
35
36
  # Copy pruned source code
36
37
  COPY --from=pruner /app/out/full/ .
@@ -53,50 +54,102 @@ 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
+ 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
 
107
+ # Accept version as build argument (passed from npm_package_version)
108
+ ARG SANDBOX_VERSION=unknown
109
+
63
110
  # Prevent interactive prompts during package installation
64
111
  ENV DEBIAN_FRONTEND=noninteractive
65
112
 
66
- # Install essential runtime packages
67
- RUN apt-get update && apt-get install -y --no-install-recommends \
68
- curl \
69
- wget \
70
- ca-certificates \
71
- python3.11 \
72
- python3-pip \
73
- python3.11-venv \
74
- procps \
75
- git \
76
- unzip \
77
- zip \
78
- jq \
79
- file \
80
- && rm -rf /var/lib/apt/lists/*
113
+ # Set the sandbox version as an environment variable for version checking
114
+ ENV SANDBOX_VERSION=${SANDBOX_VERSION}
115
+
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
81
136
 
82
137
  # Set Python 3.11 as default python3
83
- 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
84
139
 
85
- # Install Node.js 20 LTS using official NodeSource setup script
86
- RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
87
- && apt-get install -y nodejs \
88
- && 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
89
149
 
90
150
  # Install Bun runtime from official image
91
151
  COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
92
152
 
93
- # Install essential Python packages for code execution
94
- RUN pip3 install --no-cache-dir \
95
- matplotlib \
96
- numpy \
97
- pandas \
98
- ipython
99
-
100
153
  # Set up runtime container server directory
101
154
  WORKDIR /container-server
102
155
 
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