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

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

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

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

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

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

- 包体积（解压后）：103 kB，25 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-08-07T19:28:54.695Z
- 最新版本发布：2026-11-10T19:18:12.770Z
- 近 30 天下载量：13732（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：227（近 12 个月 227 个）

## 中文简介

无密码浏览器和 Databricks 认证计划和类型

## 安装

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

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

## README

# @dbx-tools/ shared- auth (英语)

验证无密码的签名、 密码、 Databricks 配置文件以及解析客户端 在浏览器和服务器边界上的数据。 软件包还提供了浏览器帮助 所拥有路线 [@dbx-工具/自动门](https://npmcn.com/package/node/auth-gate)。 。 。 .

## 读取认证状态

```ts
import { authStatusSchema } from "@dbx-tools/shared-auth";

const response = await fetch("/api/email/auth/status", { credentials: "include" });
const status = authStatusSchema.parse(await response.json());

if (status.enabled && !status.authenticated) {
  showSignIn();
}
```

在自定义 UI 时使用请求、 校验、 登录和状态方案 运输码直接调用认证门.

## 构建配置选择器

简介摘要从不包含令牌或客户秘密. 验证前面的值 提供或持续选择 :

```ts
import {
  databricksProfileListSchema,
  databricksProfileSelectionSchema,
} from "@dbx-tools/shared-auth";

export function selectFirstProfile(input: unknown) {
  const profiles = databricksProfileListSchema.parse(input);
  return databricksProfileSelectionSchema.parse({
    kind: "profile",
    profile: profiles[0]!.name,
  });
}
```

使用 `{ kind: "ambient" }` 当耗尽的运行时间选择正常时 Databricks 认证来源.

## 使用浏览器登录帮助

这个 `browser` 模块请求并验证电子邮件的一次性密码, 开始密码签入或注册,管理注册的密码,读取门 状态,并通过服务器提供的同源重定向日志.

```ts
import { requestEmailOtp, verifyEmailOtp } from "@dbx-tools/shared-auth/browser";

export async function requestCode(email: string) {
  return requestEmailOtp(email);
}

export async function submitCode(email: string, code: string, name: string) {
  return verifyEmailOtp(email, code, name);
}
```

浏览器助手使用同源 `/api/email/auth` 路径并包含会话 饼干 电子邮件一次性密码和登录需要认证门服务器路由. Passkey操作还需要一个有WebAuthn支持的浏览器. 直接认证 其它地方挂载的运行时间必须使用相同的基路径,这些帮助者才能使用 说吧.

## 运行时边界

Zod schemas and secret-free profile 类型对于共享代码是安全的. 这个 `./browser` 子路径执行浏览器网络和WebAuthn操作. 这个 软件包不解析证书、薄荷数据砖符号或注册服务器 路线。 使用 [@dbx-tools/ auth (英语)](https://npmcn.com/package/node/auth) databricks 证书 决议和 [@dbx-工具/自动门](https://npmcn.com/package/node/auth-gate) 无密码 服务器路由.

## 软件包出口

-   `auth`:验证无密码门请求和回复.
-   `browser`:执行电子邮件检察官办公室、密码、状态和登出业务.
-   `config`:定义 Databricks 认证和目标值.
-   `profile`:验证无秘密配置列表和选择.
-   `client`: 验证已解决,无秘密 Databricks 客户端信息.

## 常见问题

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

无密码浏览器和 Databricks 认证计划和类型

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

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

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

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

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

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

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

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

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

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

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

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