rl-rock 1.2.1 → 1.2.3

package/LICENSE

@@ -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.

package/README.md

@@ -0,0 +1,243 @@
+# ROCK TypeScript SDK
+
+[![npm version](https://img.shields.io/npm/v/rl-rock.svg)](https://www.npmjs.com/package/rl-rock)
+[![License](https://img.shields.io/npm/l/rl-rock.svg)](https://github.com/Timandes/ROCK/blob/master/LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
+
+ROCK (Remote Operation Container Kit) TypeScript SDK - 用于管理远程沙箱环境的客户端库。
+
+## 特性
+
+- 🚀 **沙箱管理** - 创建、启动、停止远程容器沙箱
+- 📁 **文件系统** - 上传、下载、读取、写入文件
+- 🖥️ **命令执行** - 同步/异步执行 Shell 命令
+- 🔧 **运行时环境** - 支持 Python、Node.js 运行时环境管理
+- 🤖 **Agent 框架** - 内置 Agent 支持自动化任务
+- 📦 **EnvHub** - 环境注册与管理
+- 🔄 **双模式构建** - 同时支持 ESM 和 CommonJS
+
+## 安装
+
+```bash
+# 使用 pnpm
+pnpm add rl-rock
+
+# 使用 npm
+npm install rl-rock
+
+# 使用 yarn
+yarn add rl-rock
+```
+
+## 快速开始
+
+### 创建沙箱
+
+```typescript
+import { Sandbox, SandboxConfig } from 'rl-rock';
+
+// 创建沙箱实例
+const sandbox = new Sandbox({
+  image: 'python:3.11',
+  baseUrl: 'http://localhost:8080',
+  cluster: 'default',
+  memory: '8g',
+  cpus: 2,
+});
+
+// 启动沙箱
+await sandbox.start();
+
+console.log(`Sandbox ID: ${sandbox.getSandboxId()}`);
+```
+
+### 执行命令
+
+```typescript
+// 同步执行命令
+const result = await sandbox.arun('ls -la', {
+  mode: 'normal',
+});
+
+console.log(result.output);
+
+// 后台执行命令 (nohup 模式)
+const bgResult = await sandbox.arun('python long_running_script.py', {
+  mode: 'nohup',
+  waitTimeout: 600,
+});
+```
+
+### 文件操作
+
+```typescript
+// 写入文件
+await sandbox.write_file({
+  content: 'Hello, ROCK!',
+  path: '/tmp/hello.txt',
+});
+
+// 读取文件
+const fileContent = await sandbox.read_file({
+  path: '/tmp/hello.txt',
+});
+
+// 上传本地文件
+await sandbox.upload({
+  sourcePath: './local-file.txt',
+  targetPath: '/remote/path/file.txt',
+});
+```
+
+### 使用 EnvHub
+
+```typescript
+import { EnvHubClient } from 'rl-rock';
+
+const client = new EnvHubClient({
+  baseUrl: 'http://localhost:8081',
+});
+
+// 注册环境
+await client.register({
+  envName: 'my-python-env',
+  image: 'python:3.11',
+  description: 'My Python environment',
+  tags: ['python', 'ml'],
+});
+
+// 获取环境
+const env = await client.getEnv('my-python-env');
+```
+
+### 使用 RockEnv (Gym 风格接口)
+
+```typescript
+import { make, RockEnv } from 'rl-rock';
+
+// 创建环境
+const env = make('my-env-id');
+
+// 重置环境
+const [observation, info] = await env.reset();
+
+// 执行步骤
+const [obs, reward, terminated, truncated, info] = await env.step('action');
+
+// 关闭环境
+await env.close();
+```
+
+## 配置
+
+### 环境变量
+
+| 变量名 | 说明 | 默认值 |
+|--------|------|--------|
+| `ROCK_BASE_URL` | ROCK 服务基础 URL | `http://localhost:8080` |
+| `ROCK_ENVHUB_BASE_URL` | EnvHub 服务 URL | `http://localhost:8081` |
+| `ROCK_SANDBOX_STARTUP_TIMEOUT_SECONDS` | 沙箱启动超时时间 | `180` |
+| `ROCK_OSS_ENABLE` | 是否启用 OSS 上传 | `false` |
+| `ROCK_OSS_BUCKET_ENDPOINT` | OSS Endpoint | - |
+| `ROCK_OSS_BUCKET_NAME` | OSS Bucket 名称 | - |
+
+### SandboxConfig 选项
+
+```typescript
+interface SandboxConfig {
+  image: string;           // Docker 镜像
+  baseUrl: string;         // 服务 URL
+  cluster: string;         // 集群名称
+  memory: string;          // 内存限制 (如 '8g')
+  cpus: number;            // CPU 核心数
+  autoClearSeconds: number; // 自动清理时间
+  startupTimeout: number;  // 启动超时
+  routeKey?: string;       // 路由键
+  extraHeaders?: Record<string, string>; // 额外请求头
+}
+```
+
+## API 文档
+
+详细 API 文档请参阅 [开发者手册](./docs/DEVELOPER_GUIDE.md)。
+
+## 示例
+
+更多示例请参阅 [examples](./examples/) 目录。
+
+### 示例列表
+
+| 文件 | 说明 |
+|------|------|
+| `basic-usage.ts` | 基础沙箱使用示例 |
+| `file-operations.ts` | 文件操作示例 |
+| `background-tasks.ts` | 后台任务 (nohup) 示例 |
+| `envhub-usage.ts` | EnvHub 环境管理示例 |
+| `sandbox-group.ts` | 沙箱组批量操作示例 |
+| `complete-workflow.ts` | 完整开发工作流示例 |
+
+### 运行示例
+
+```bash
+# 进入 ts-sdk 目录
+cd ts-sdk
+
+# 安装依赖 (如未安装)
+pnpm install
+
+# 设置环境变量
+export ROCK_BASE_URL=http://your-rock-server:8080
+export ROCK_ENVHUB_BASE_URL=http://your-envhub-server:8081
+
+# 运行示例 (使用 tsx)
+npx tsx examples/basic-usage.ts
+
+# 或使用 ts-node
+npx ts-node examples/basic-usage.ts
+```
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 运行测试
+pnpm test
+
+# 构建
+pnpm build
+
+# 类型检查
+pnpm exec tsc --noEmit
+```
+
+## 从 Python SDK 迁移
+
+TypeScript SDK 与 Python SDK API 基本一致，主要差异：
+
+| Python | TypeScript |
+|--------|-----------|
+| `sandbox.arun(cmd, mode="nohup")` | `sandbox.arun(cmd, { mode: 'nohup' })` |
+| `await sandbox.fs.upload_dir(...)` | `await sandbox.getFs().uploadDir(...)` |
+| `sandbox.process.execute_script(...)` | `sandbox.getProcess().executeScript(...)` |
+
+### 响应字段命名
+
+SDK 使用 **camelCase** 命名规范，符合 TypeScript 约定。HTTP 层自动处理 snake_case 到 camelCase 的转换：
+
+```typescript
+// 响应示例 - 使用 camelCase
+const status = await sandbox.getStatus();
+console.log(status.sandboxId);    // ✓ 正确
+console.log(status.hostName);     // ✓ 正确
+console.log(status.isAlive);      // ✓ 正确
+
+const result = await sandbox.arun('ls');
+console.log(result.exitCode);     // ✓ 正确
+console.log(result.failureReason);// ✓ 正确
+```
+
+## License
+
+Apache License 2.0