# @dofe/sso-node 中文文档

规范地址：https://npmcn.com/package/%40dofe/sso-node/

版本：0\.1\.86
npm 元数据更新时间：2026-11-11T03:11:02.554Z
中文译文更新时间：2026-11-12T16:18:43.400Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dofe/sso-node
原文对照：https://npmcn.com/package/%40dofe/sso-node/?lang=original
项目主页：https://github.com/dofe-ai/sso.dofe.ai#readme
源码仓库：https://github.com/dofe-ai/sso.dofe.ai

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

- 包体积（解压后）：165 kB，34 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2026-06-05T15:53:43.552Z
- 最新版本发布：2026-11-11T03:11:02.362Z
- 近 30 天下载量：2723（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：83（近 12 个月 83 个）

## 中文简介

Sso.dofe.ai内部服务API的运行时中性节点SDK.

## 安装

```sh
npm install @dofe/sso-node
```

也可以使用：`pnpm add @dofe/sso-node`、`yarn add @dofe/sso-node`、`bun add @dofe/sso-node`

## README

# @ dofe/sso-节点

运行时中性节点 SDK `sso.dofe.ai` 内部服务API.

## 安装

```bash
pnpm add @dofe/sso-node
```

## 使用量

```ts
import { createSsoInternalClient } from '@dofe/sso-node';

const sso = createSsoInternalClient({
  baseUrl: process.env.SSO_INTERNAL_API_URL!,
  internalSecret: process.env.INTERNAL_API_SECRET!,
  serviceName: 'agents.dofe.ai',
});

const user = await sso.users.get('00000000-0000-0000-0000-000000000000');
const permissions = await sso.permissions.getUserPermissions(user.id);
```

对于暴露出平坦方法的当地老年客户的移徙,使用 `createSsoLegacyClient`数字 :

```ts
import { createSsoLegacyClient } from '@dofe/sso-node/legacy';

const sso = createSsoLegacyClient({
  baseUrl: process.env.SSO_INTERNAL_API_URL!,
  internalSecret: process.env.INTERNAL_API_SECRET!,
  internalBasePath: '/api/internal',
  authMode: 'x-internal-secret',
  serviceName: 'agents.dofe.ai',
});

const user = await sso.getUser('00000000-0000-0000-0000-000000000000');
const hasPermission = await sso.checkPermission(user.id, 'team.read', 'team-id');
const role = await sso.getUserTeamRole('team-id', user.id);
```

## 认证模式

| 模式 | 页眉 |
| --- | --- |
| `bearer` | `Authorization: Bearer <internalSecret>` |
| `x-internal-secret` | `X-Internal-Secret: <internalSecret>` |

默认模式是 `bearer`启用 `x-internal-secret` 仅用于移民时的遗产服务.

默认取取器拒绝 HTTP 重定向既用于输入方法,又用于 `raw` 请求, 包括重定向到同一来源。 设定 `baseUrl` 财务报告和审定财务报表 `internalBasePath` 页:1 最终内部API地址. 防止转发服务证明或遗留机密 头到方向方向 习惯 `fetcher` 必须执行同样的规则.

## 验证

运行 `pnpm --filter @dofe/sso-node test` 用于构建和测试软件包。 定向测试 使用本地的HTTP服务器和合成证书;它们不需要现场SSO访问.

## 边界

这个软件包是只供客户使用的 SDK. 它不包括雀巢JS模块,Redis订阅者,Prisma,迁移,种子,或数据库连接逻辑.

## 可选届会时间安排

`SessionV2ClientOptions.onTiming` 财务报告和审定财务报表 `SessionV2BffOptions.onTiming` 接受 `SessionV2TimingObserver`, (中文(简体) ), `(event: SessionV2TimingEvent) => void | Promise<void>`。 。 。 . 所有时间类型均从包根导出. 钩是可选的; 同步抛出 同步拒绝 被忽略 承诺永远不会 等着呢 保持观察同步工作缩短.

活动仅包含 `phase`, (中文(简体) ), `operation`,非负数 `durationMs`, (中文(简体) ), `outcome` (单位:千美元)`success` 或者说 `error`),和可选数字 HTTP `status`没有识别器, 请求对象、URL、证书或应答有效载荷被释放.

| 阶段 | 运行 | 边界 |
| --- | --- | --- |
| `remote` | `exchange-code`, (中文(简体) ), `rotate`, (中文(简体) ), `introspect`, (中文(简体) ), `renew-ticket`, (中文(简体) ), `confirmation`, (中文(简体) ), `bootstrap-exchange`, (中文(简体) ), `logout-confirmation`, (中文(简体) ), `logout`, (中文(简体) ), `call` | SSO 通过 JSON 机构解析和 HTTP 错误处理获取 . `call` 是其它路径的固定倒置。 呼叫后的方法级计划检查不在此限. |
| `active-entry` | `read` | 故障读取,过期和撤销检查. |
| `admission` | `begin-dispatch`, (中文(简体) ), `begin-window-dispatch` | 地铁招生,包括其远程内测和租赁收购. |
| `completion` | `complete` | 破损完成承诺. |
| `compat-dispatch` | `dispatch` | 通过缓冲体和完成来进行上游取水的相容性,或流接;不包括随后的流接期. |

嵌入跨度重叠:不总和录取/完成及其远程跨度. `status` 是原始的 HTTP 响应状态, 即使SDK 正在使一个 错误为 503. 远程成功描述 HTTP/ JSON 完成, 不是活动 课程赠款。 兼容性 HTTP 状态 QQ 400 产生出错误结果而不包含 改变上游的反应。 直接运输仍在进行中,且未发出 相近的间隔。 兼容性响应转发保留 `Server-Timing` 和现有的 `x-request-id`; 它不注入或重写有校正条件的请求 标题或向前任意的上游标题。 未添加关联标识符 用于事件;应用程序可以使用自己的同步上下文连接事件.

## 常见问题

### @dofe/sso-node 是什么？

Sso\.dofe\.ai内部服务API的运行时中性节点SDK\.

### 如何安装 @dofe/sso-node？

在项目目录运行 npm install @dofe/sso-node，或使用 pnpm add / yarn add / bun add。

### @dofe/sso-node 支持 TypeScript 吗？

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

### @dofe/sso-node 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dofe/sso-node 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @dofe/sso-node 可以商用吗？

@dofe/sso-node 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dofe/sso-node 的下载量有多少？

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

### @dofe/sso-node 还在维护吗？

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