# @dbx-tools/shared-lakebox 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/shared-lakebox/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:08.027Z
中文译文更新时间：2026-11-11T18:01:33.432Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/shared-lakebox
原文对照：https://npmcn.com/package/%40dbx-tools/shared-lakebox/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：126 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-15T08:38:02.718Z
- 最新版本发布：2026-11-10T19:18:07.646Z
- 近 30 天下载量：6052（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 56 个）

## 中文简介

应用程序 Lakebox 的浏览器安全合同、用户服务、命令、衡量标准和路线

## 安装

```sh
npm install @dbx-tools/shared-lakebox
```

也可以使用：`pnpm add @dbx-tools/shared-lakebox`、`yarn add @dbx-tools/shared-lakebox`、`bun add @dbx-tools/shared-lakebox`

## README

# @ dbx- 工具/ 共享- lakebox

浏览器-安全 Zod 合同和 app Lakebox 的路由构建器: 生命周期 摘要,当前用户的账户,服务,命令,日志,以及衡量标准.

## 验证服务定义

```ts
import { createLakeboxServiceRequestSchema } from "@dbx-tools/shared-lakebox";

const request = createLakeboxServiceRequestSchema.parse({
  name: "hello",
  image: "docker.io/library/python:3.12-alpine",
});
```

解析应用默认值( E)`route: true`, (中文(简体) ), `stripPrefix: true`, (中文(简体) ), `pull: "missing"`)并拒绝保留变量(`SERVICE_NAME`, (中文(简体) ), `SERVICE_PATH`, (中文(简体) ), `SERVICE_PORT`, (中文(简体) ), `PORT`), Databricks 证书,内置 服务名称,并挂载用户家外的源.

对于路由服务,图像内部的进程必须倾听 `127.0.0.1:$SERVICE_PORT`。计划不支持多克式端口 发布、特权模式、设备或绝对主机挂载路径.

## 构建 API 和服务 URL

接受插件已公布的客户端配置为输入并生成每个 来自共享常数的路由 :

```ts
import { LAKEBOX_ROUTES, lakeboxRoute, type LakeboxClientConfig } from "@dbx-tools/shared-lakebox";
import { lakeboxServicePath } from "@dbx-tools/shared-lakebox/client";

export function lakeboxUrls(config: LakeboxClientConfig, userHash: string, serviceName: string) {
  return {
    start: `${config.basePath}${lakeboxRoute(LAKEBOX_ROUTES.serviceStart, {
      name: serviceName,
    })}`,
    open: lakeboxServicePath(config.routePrefix, userHash, serviceName),
  };
}
```

读取 `basePath` 财务报告和审定财务报表 `routePrefix` 从插件发布的客户端配置和 从 `LAKEBOX_ROUTES`服务路线 `<routePrefix>/<user hash>/<service>`。 。 。 .

## 验证服务器响应

在存储或渲染前分析服务器的响应 :

```ts
import {
  LAKEBOX_ROUTES,
  lakeboxMetricsResponseSchema,
  lakeboxSummarySchema,
  type LakeboxClientConfig,
} from "@dbx-tools/shared-lakebox";

export async function readLakebox(config: LakeboxClientConfig) {
  const [statusResponse, metricsResponse] = await Promise.all([
    fetch(`${config.basePath}${LAKEBOX_ROUTES.status}`),
    fetch(`${config.basePath}${LAKEBOX_ROUTES.metrics}`),
  ]);
  return {
    summary: lakeboxSummarySchema.parse(await statusResponse.json()),
    metrics: lakeboxMetricsResponseSchema.parse(await metricsResponse.json()),
  };
}
```

合同涵盖生命周期状态、服务状态、有界限的日志、命令 结果,以及机器级CPU,内存,存储,和网络度量. 他们 不包含 Databricks 证书或请求身份标志.

## 使用合同界限

-   `LAKEBOX_ROUTES` 包含插件 API 模板。 使用 `lakeboxRoute()` 编码 已命名的路由参数.
-   `lakeboxServicePath()` 构建一个认证的倒置代理路由 用户和服务.
-   `CreateLakeboxServiceRequest` 是呼叫器输入类型. `LakeboxServiceDefinition` 是应用了默认的解析类型.
-   日志请求默认为200行和16,000个字符.
-   服务名称 `terminal` 财务报告和审定财务报表 `desktop` 预留用于内置服务.
-   浏览器合同不执行生命周期,认证,SSH,或 反应状态. 这些能力存在于节点和UI包中.

## 常见问题

### @dbx-tools/shared-lakebox 是什么？

应用程序 Lakebox 的浏览器安全合同、用户服务、命令、衡量标准和路线

### 如何安装 @dbx-tools/shared-lakebox？

在项目目录运行 npm install @dbx-tools/shared-lakebox，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/shared-lakebox 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dbx-tools/shared-lakebox 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dbx-tools/shared-lakebox 可以商用吗？

@dbx-tools/shared-lakebox 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/shared-lakebox 的下载量有多少？

根据 npm 官方下载统计，@dbx-tools/shared-lakebox 在 2026/10/12 – 2026/11/10 这 30 天内被下载 6,052 次，日均约 202 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dbx-tools/shared-lakebox 还在维护吗？

最新版本 0\.9\.206 发布于 2026/11/11（今天）；至今共发布 56 个版本，其中过去 12 个月发布了 56 个；首次发布于 2026/10/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。