# @dronedeploy/rocos-js-sdk 中文文档 规范地址：https://npmcn.com/package/%40dronedeploy/rocos-js-sdk/ 版本：4\.5\.1 npm 元数据更新时间：2026-11-11T12:51:47.780Z 中文译文更新时间：2026-11-13T05:47:06.196Z 软件包许可：UNLICENSED 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40dronedeploy/rocos-js-sdk 原文对照：https://npmcn.com/package/%40dronedeploy/rocos-js-sdk/?lang=original ## 关键信息（来自 npm 元数据） - 包体积（解压后）：3 MB，1263 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：9 个 - peer 依赖：rxjs ^6\.6\.6 \|\| ^7\.0\.0，@types/node \* - 首次发布：2023-08-22T06:54:30.593Z - 最新版本发布：2026-11-11T12:51:47.497Z - 近 30 天下载量：2176（2026-10-13 至 2026-11-11，npm 官方下载统计） - 已发布版本数：113（近 12 个月 44 个） ## 中文简介 Rocos 的 Javascript SDK ## 安装 ```sh npm install @dronedeploy/rocos-js-sdk ``` 也可以使用：`pnpm add @dronedeploy/rocos-js-sdk`、`yarn add @dronedeploy/rocos-js-sdk`、`bun add @dronedeploy/rocos-js-sdk` ## README # 罗斯 -杰 -斯德克 与Rocos平台互动的Javascript SDK. ## 使用节点 要使用带有节点的SDK,必须使用18.13或更高的节点版本. ## 安装 用 npm 安装软件包 ```bash npm install @dronedeploy/rocos-js-sdk ``` 线条 ```bash yarn add @dronedeploy/rocos-js-sdk rxjs@^7 ``` ## 有什么新情况 ### 4.0.0 (单位:千美元) - **抢了:** 默认遥测 `transport` 现在 `'connect'` (连接协议)而不是 `'grpc-web'`未设置的消费者 `transport` 明确将自动切换到连接。 如果您的后端或代理端只支持 gRPC- web, 请用 `transport: 'grpc-web'`。 。 。 . - 这个 `'grpc-web'` 遥测运输已贬值,将在今后发行时拆除。 现在选择它会记录一次性的贬值警告 . ### 3.1.2 国家 - 使用可选 `fetch` gRPC-web 传输也执行,所以习惯 `fetch` 可在运输过程中始终如一地供应. ### 3.1.1 国家 - 允许选项 `fetch` 将提供给连接运输. ### 3.1.0 (中文(简体) ) - 添加连接-RPC遥测传输变体. - 升级 `connectrpc` 财务报告和审定财务报表 `bufbuild` 移动至 TypeScript 6 . - 粗糙未用和微不足道的可替代依赖. ### 3.0.30 (中文(简体) ) - _地图服务_ - 添加一个 `create` API 并修复 `copy` API (英语). ### 3.0.29 联合国 - 为设置地图内容和元数据添加新的 API. ### 3.0.28 联合国 - 添加 `base_floor_plan` 改为 `Level`。 。 。 . ### 3.0.27 (中文(简体) ) - 添加 `staticAttributes` 字段改为 `AssetSyncDefinitionModel`。 。 。 . ### 3.0.25 (中文(简体) ) - _整合服务_ - 添加 `getLevels` 方法. ### 3.0.23 (中文(简体) ) - 添加 `metadata` 字段为设备证书. ### 3.0.21 信息技术 - 设备证书导出类型 . ### 3.0.20 联合国 - 添加库列表/导入端点 . ### 3.0.19 联合国 - _调用服务_ - 在服务电话中添加一个可观察到的取消 . ### 3.0.18 联合国 - _调用服务_ - 添加一个 `rawPayload` 选择服务呼叫. ### 3.0.17 信息技术 - _机器人服务_ - 按账户/org列出机器人. ### 3.0.16 (中文(简体) ) - 添加缺失类型 `EventService` 财务报告和审定财务报表 `ProfileService`。 。 。 . ### 3.0.15 信息技术 - _配置服务_ - 更改配置导出类型为 `Blob`。 。 。 . ### 3.0.14 联合国 - _用户_ - 展览 `splitRobotTopic`。 。 。 . ### 3.0.13 信息技术 - _标记_ - 自定义部件的额外支持 . ### 3.0.11 (中文(简体) ) - 提高文件同步类型的准确性 . ### 3.0.10 信息技术 - _地图服务_ - 在列表地图端点中添加一个系统参数. ### 3.0.9 信息技术 - _工作流程服务_ - 添加导入/出口工作流程的方法. ### 3.0.8 (简体中文) - 添加一个 HTTP 听/ hook . ### 3.0.7 (中文(简体) ) - _地图服务_ - 添加 `lastModifiedTimestamp` 以列表地图. ### 3.0.6 (中文(简体) ) - _工作流程服务_ - 添加一个函数以删除资产. ### 3.0.5 (中文(简体) ) - 添加 `name` 页:1 `Locations` 类型. ### 3.0.4 (中文(简体) ) - _全景_ - 允许 `any` 键 `data` 道具 (英语). ### 3.0.3 信息技术 - _地图服务_ - 添加一个 `hash` 属性到云映射对象. ### 3.0.2 国家 - 添加删除资产端点. ### 3.0.1 (中文(简体) ) #### 中断更改 - 改变原生出型以使用 [原生自带](https://github.com/timostamm/protobuf-ts) 软件包代替 [(原始内容存档于2018-10-21) (英语). protobuf-javascript](https://github.com/protocolbuffers/protobuf-javascript)。 。 。 . - 不再使用 `@improbable-eng/grpc-web` 实施gRPC-web客户端. - _调用服务_ - 变动 `CallerService.invokeRequest` 响应为UTF-8编码的UInt8Arrays,而不是base64编码的字符串. - 更改阵列字段名称以删除 `List` 后缀. - `IRocosCallerMessageResponses.responsesList` - > (中文) `IRocosCallerMessageResponses.responses` - `IRocosCallerMessageChunks.rowsList` - > (中文) `IRocosCallerMessageChunks.rows` - 分隔 `IRocosCallerMessageResponseReturn.header.created` 字段进入 `createdAt` 财务报告和审定财务报表 `createdNs` 字段 - `createdAt` 是一个 `Date` 代表信件创建时间的物体,精确度为毫秒. - `createdNs` 是一个 `string` 代表消息创建时间,精确度为纳秒. 你可以用这个 `BigInt` 要获得一个 `BigInt` 代表时代. - _RTPWebRTC 服务_ - 重构以下函数以返回承诺,而不是使用回调 : - `WebRTCSignallingStream.offerConnection()` - `WebRTCSignallingStream.getDetails()` - `WebRTCSignallingStream.addIceCandidate()` - 分割流界面 `IWebRTCSignallingResponseStream.on(type, handler)` 输入 `onMessage(handler)`, (中文(简体) ), `onError(handler)`,以及 `onComplete(handler)`。 。 。 . - _地图服务_ - 删除 `initDB` 方法 - 已更改 `copyFromRobot` 方法 `sendToCloud` - 已更改 `copyFromCloud` 方法 `copy` - _文件存取服务_ - 删除 `uploadFile` 方法 - _代理服务_ - 取消了使用用户名和密码登录的能力 。 现在只支持 api 密钥或令牌 . - 在使用前, 将检查托肯的有效性 - `IToken` 接口更改 - `created` 现在 `issuedAt` 是一个 `Date` 对象而不是一个 `string` - `expiresIn` 现在 `expires` 是一个 `Date` 对象而不是一个 `number` - 登录并使用电子邮件和密码签名已被删除 - 重新设置密码已被删除 - _工作流程服务_ - 已重命名 `getDeployedOnRobot` 改为 `getDeployedWorkflow` - 已重命名 `listDeployedOnRobot` 改为 `list` - _用户_ - 删除 `generateUUID` 方法 - 重构 `Token` 类 - `expiresIn: number` - > (中文) `expires?: Date` - `created: string` - > (中文) `issuedAt?: Date` - 删除未使用的数学工具函数 #### 删除 - **断开 :** 删除 `FileAccessorService.uploadFile` - **断开 :** 取消使用用户名和密码进行认证的能力。 现在只支持 API 密钥和令牌 . - **断开 :** 删除未使用的数学工具函数 #### 固定 - 删除节点 18 引擎要求,允许在之前的节点版本上构建网页目标. **节点18仍然需要运行节点的SDK.** ### 2.6.1 国家 - 修改地图服务响应类型 ### 2.6.0 (中文(简体) ) - 变动 `rxjs` 依赖同伴依赖(支持 `^6.6.6 || ^7.0.0`(中文(简体) ) - 使用时 `yarn` 您可能需要添加 `rxjs` 对您的依赖关系 ### 2.4.0 (中文(简体) ) - 删除不再支持的与遗留账户有关的未用端点 ### 2.3.0 (单位:千美元) - 已添加 `mapService` 用于支持代理映射功能 ### 2.2.0 (中文(简体) ) - 已添加 `listUsers` 在项目服务中列出项目用户的方法 - 为失败的 HTTP 响应添加了额外的调试信息 ### 2.1.0 国家 - 添加 PlansPage 方法到集成服务中以页方式检索计划 ### 2.0.2 (中文(简体) ) - 修正试图解析为 JSON 的无内容响应 ### 2.0.1 国家 - React 演示应用程序依赖性的安全更新 ### 2.0.0 (韩语) - 更新所有 REST 请求的基础类, 以便通过取取取而不是取取轴 - 删除未使用的依赖 `source-map-loader`, (中文(简体) ), `ts-loader`, (中文(简体) ), `axios` - 在 AuthService 中标出某些认证方法 - `login` 用电子邮件和密码登录 . - `signup` - `resetPassword` - 删除后遗留服务,这些服务前缀为BC,例如. `BCRocosClient` - 更新Angular 演示应用程序中过时的依赖性 #### 从1.x迁移到2.x - 节点JS引擎需求需要为v18.13和npm v8,在节点JS中作为基础的HTTP服务现在使用取取API - 需要迁移前缀为BC的遗留服务,以便使用标准服务 ### 1.19.0 (中文(简体) ) 新增方法 `IntegrationService` 在当前位置创建新问题. - 创建 Issue - 在最新地图计划中的特定位置创建新问题 ### 1.18.0 (简体中文) 添加了新的集成服务, 以检索在 DroneDeplob 中创建的计划 此选项可通过 integration Service () 获取 。 可用方法: - 获取计划 - 获取计划列表 - 获取 PlanById - 用平板图层获取特定计划, 用于制取网格、 点云或平板图 - getWMTS - 返回在地图框等工具中可以提供的 WMTS 牌, 如果您的项目具有 WMTS 特性启用的话) ## 常见问题 ### @dronedeploy/rocos-js-sdk 是什么？ Rocos 的 Javascript SDK ### 如何安装 @dronedeploy/rocos-js-sdk？ 在项目目录运行 npm install @dronedeploy/rocos-js-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：rxjs（^6\.6\.6 \|\| ^7\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @dronedeploy/rocos-js-sdk 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @dronedeploy/rocos-js-sdk 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @dronedeploy/rocos-js-sdk 可以商用吗？ @dronedeploy/rocos-js-sdk 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。 ### @dronedeploy/rocos-js-sdk 的下载量有多少？ 根据 npm 官方下载统计，@dronedeploy/rocos-js-sdk 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,176 次，日均约 73 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @dronedeploy/rocos-js-sdk 还在维护吗？ 最新版本 4\.5\.1 发布于 2026/11/11（2 天前）；至今共发布 113 个版本，其中过去 12 个月发布了 44 个；首次发布于 2023/08/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。