Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
8991517
feat: add ts-sdk
Timandes Feb 12, 2026
12c5a13
chore: add related docs&examples
Timandes Feb 13, 2026
656c3ed
fix(ts-sdk): use snake_case for response fields to match API
Timandes Feb 14, 2026
b1aafc9
fix: make basic-usage.ts works
Timandes Feb 14, 2026
5498424
fix: make background-tasks.ts works
Timandes Feb 14, 2026
3b39194
docs: update doc files
Timandes Feb 14, 2026
5634748
fix: make complete-workflow.ts works
Timandes Feb 14, 2026
bf865f0
fix: make file-operations.ts works
Timandes Feb 14, 2026
b1c7adb
chore: add eslint
Timandes Feb 14, 2026
fd51672
feat(ts-sdk)!: adopt camelCase naming convention for public API
Timandes Feb 14, 2026
45ebf47
fix(ts-sdk): use snake_case for URL query parameters
Timandes Feb 14, 2026
a7efe2d
refactor(ts-sdk): rename methods to camelCase convention
Timandes Feb 16, 2026
2368f86
feat(ts-sdk): include response headers in all response types
Timandes Feb 16, 2026
829b7aa
chore(ts-sdk): release v1.2.3
Timandes Feb 16, 2026
2ec4dcf
fix: add missing field 'error'
Timandes Feb 16, 2026
7b1b02b
Revert "fix: add missing field 'error'"
Timandes Feb 16, 2026
888d988
Revert "chore(ts-sdk): release v1.2.3"
Timandes Feb 16, 2026
b71df60
Revert "feat(ts-sdk): include response headers in all response types"
Timandes Feb 16, 2026
d7429b5
feat(ts-sdk): include response headers and error info in HTTP responses
Timandes Feb 16, 2026
a832d3f
chore(ts-sdk): release v1.2.4
Timandes Feb 16, 2026
c929266
fix(ts-sdk): correct type parameters for HttpUtils methods
Timandes Feb 16, 2026
acc94a3
feat(ts-sdk): add integration test setup with Jest projects mode
Timandes Mar 2, 2026
7b96aac
feat(ts-sdk): implement uploadDir for directory upload to sandbox
Timandes Mar 3, 2026
71d3b67
fix(ts-sdk): correct Content-Type handling for multipart/form-data re…
Timandes Mar 3, 2026
9692d65
fix(ts-sdk): add shims for __dirname ESM compatibility
Timandes Mar 3, 2026
f976077
fix(ts-sdk): use unquoted heredoc for APT speedup command
Timandes Mar 3, 2026
606a284
fix(ts-sdk): add missing /download/ path in Python V31212 install URL
Timandes Mar 3, 2026
52d3597
fix(ts-sdk): sync VERSION with package.json dynamically
Timandes Mar 3, 2026
6a30946
feat(ts-sdk): add RuntimeEnv, ModelService and Agent modules
Timandes Mar 3, 2026
e26d57c
fix(ts-sdk): add timeout and cancellation support to ModelClient poll…
Timandes Mar 3, 2026
092f3a5
fix(ts-sdk): integrate typed exceptions (raiseForCode) into Sandbox c…
Timandes Mar 3, 2026
5a9fa77
fix(ts-sdk): add Zod validation to API response parsing
Timandes Mar 3, 2026
4d222c1
refactor(ts-sdk): remove duplicated code across modules
Timandes Mar 4, 2026
7170db7
fix(ts-sdk): change default backoff from 1.0 to 2.0 for exponential r…
Timandes Mar 4, 2026
68752f6
fix(ts-sdk): add command injection protection across modules
Timandes Mar 4, 2026
1f1bd61
chore: bump version
Timandes Mar 4, 2026
c8a92ce
fix(ts-sdk): remove fragile session detection in arun()
Timandes Mar 4, 2026
172f1bf
fix(ts-sdk): use winston.Container for logger cache management
Timandes Mar 5, 2026
c1d0bf2
refactor(ts-sdk): remove deprecated Constants class (dead code)
Timandes Mar 5, 2026
43ab597
fix(ts-sdk): use winston logger with warn-once for deprecated decorator
Timandes Mar 5, 2026
cfdf85d
refactor(ts-sdk): make sandbox config defaults configurable via env vars
Timandes Mar 5, 2026
3330140
refactor(ts-sdk): consolidate types - remove sandbox/types.ts
Timandes Mar 5, 2026
7582e0f
refactor(ts-sdk): remove misleading isBrowser() - SDK requires Node.j…
Timandes Mar 5, 2026
fb9d661
fix(ts-sdk): initialize sandboxId in RockEnv and use HttpUtils
Timandes Mar 5, 2026
a6416d8
fix(ts-sdk): add error handling for JSON.parse and use async file I/O…
Timandes Mar 5, 2026
4ec1f23
fix(ts-sdk): use shared https.Agent for connection pooling
Timandes Mar 5, 2026
36c1002
fix(ts-sdk): use async file I/O in Sandbox.uploadByPath
Timandes Mar 5, 2026
78270ef
fix(ts-sdk): use lazy evaluation for Zod schema defaults
Timandes Mar 5, 2026
ff276c7
fix(ts-sdk): use public PyPI mirror as default for ROCK_PIP_INDEX_URL
Timandes Mar 5, 2026
b9c46fc
fix(ts-sdk): update repository URLs to alibaba/ROCK
Timandes Mar 5, 2026
e89fff5
chore: bump version
Timandes Mar 10, 2026
52915ef
fix(ts-sdk): preserve HTTP response in errors for status code detection
Timandes Mar 11, 2026
93ad9f4
chore: bump version
Timandes Mar 11, 2026
4089be0
docs(ts-sdk): add CHANGELOG entry for v1.2.7
Timandes Mar 11, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions rock/ts-sdk/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
module.exports = {
parser: '@typescript-eslint/parser',
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
],
parserOptions: {
project: './tsconfig.json',
ecmaVersion: 2022,
sourceType: 'module',
},
rules: {
'@typescript-eslint/explicit-function-return-type': 'warn',
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
'@typescript-eslint/no-explicit-any': 'warn',
'no-constant-condition': ['error', { checkLoops: false }],
// Enforce camelCase for methods and functions
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'method',
format: ['camelCase'],
leadingUnderscore: 'allow',
},
{
selector: 'function',
format: ['camelCase', 'PascalCase'],
leadingUnderscore: 'allow',
},
{
selector: 'variable',
format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
leadingUnderscore: 'allow',
},
{
selector: 'parameter',
format: ['camelCase'],
leadingUnderscore: 'allow',
},
],
},
ignorePatterns: ['dist', 'node_modules', 'examples'],
};
31 changes: 31 additions & 0 deletions rock/ts-sdk/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Dependencies
node_modules/

# Build output
dist/

# Test coverage
coverage/

# IDE
.idea/
.vscode/
*.swp
*.swo

# OS
.DS_Store
Thumbs.db

# Logs
*.log
npm-debug.log*

# Environment
.env
.env.local
.env.*.local

# Cache
.cache/
.npm/
84 changes: 84 additions & 0 deletions rock/ts-sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.2.7] - 2026-03-11

### Fixed

- HTTP errors now preserve `response` property for status code detection
- Previously, `HttpUtils.post()`, `get()`, and `postMultipart()` wrapped errors in generic `Error` objects, losing HTTP status code information
- Now re-throws original `AxiosError`, allowing callers to access `error.response.status` (e.g., 401, 403, 500)
- Consistent with Python SDK behavior

## [1.2.4] - 2026-02-16

### Added

- `HttpResponse` interface with `status`, `result`, `error`, and `headers` fields
- Response header extraction in `HttpUtils` methods (`get`, `post`, `postMultipart`)
- New fields in `SandboxStatusResponse`: `cluster`, `requestId`, `eagleeyeTraceid`
- Header info extraction in `Sandbox.getStatus()` for debugging and tracing

### Changed

- `HttpUtils.get()`, `post()`, `postMultipart()` now return `HttpResponse<T>` instead of `T`
- Improved error messages to include backend `error` field when available
- Updated `EnvHubClient` to adapt to new `HttpResponse` return type

## [1.2.1] - 2025-02-12

### Added

- Initial TypeScript SDK release based on Python SDK `rl-rock`
- Apache License 2.0
- **Sandbox Module**
- `Sandbox` class for managing remote container sandboxes
- `SandboxGroup` class for batch sandbox operations
- `Deploy` class for deploying working directories
- `FileSystem` class for file operations (chown, chmod, uploadDir)
- `Network` class for network acceleration configuration
- `Process` class for script execution
- `RemoteUser` class for user management
- `RuntimeEnv` framework for Python/Node.js runtime management
- `SpeedupType` enum for acceleration types (APT, PIP, GitHub)
- **EnvHub Module**
- `EnvHubClient` for environment registration and management
- `RockEnvInfo` schema for environment information
- **Envs Module**
- `RockEnv` class with Gym-style interface (step, reset, close)
- `make()` factory function
- **Model Module**
- `ModelClient` for LLM communication
- `ModelService` for local model service management
- **Common Module**
- `Codes` enum for status codes
- Exception classes (`RockException`, `BadRequestRockError`, etc.)
- **Utils Module**
- `HttpUtils` class with axios backend
- `retryAsync` and `withRetry` decorators
- `deprecated` and `deprecatedClass` decorators
- **Logger**
- Winston-based logging with timezone support
- **Types**
- Zod schemas for request/response validation
- Full TypeScript type definitions

### Technical Details

- Built with TypeScript 5.x
- Dual ESM/CommonJS module support via tsup
- Tested with Jest (59 test cases)
- Dependencies: axios, zod, winston, ali-oss

## [Unreleased]

### Planned

- Agent framework (RockAgent, SWEAgent, OpenHands agent)
- More comprehensive test coverage
- Documentation improvements
- Performance optimizations
201 changes: 201 additions & 0 deletions rock/ts-sdk/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading
Loading