# @benlampson/heimdall-browser 中文文档

规范地址：https://npmcn.com/package/%40benlampson/heimdall-browser/

版本：5\.10\.0
npm 元数据更新时间：2026-11-06T18:45:04.198Z
中文译文更新时间：2026-11-07T22:29:32.564Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40benlampson/heimdall-browser
原文对照：https://npmcn.com/package/%40benlampson/heimdall-browser/?lang=original
项目主页：https://github.com/BenLampson/Asgard.Heimdall#readme
源码仓库：https://github.com/BenLampson/Asgard.Heimdall

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

- 包体积（解压后）：109 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2026-10-11T13:58:59.396Z
- 最新版本发布：2026-11-06T18:45:04.016Z
- 近 30 天下载量：2228（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

海姆达尔OAuth/PKCE,设备代码,可选的代号存储和数据客户端没有UI.

## 安装

```sh
npm install @benlampson/heimdall-browser
```

也可以使用：`pnpm add @benlampson/heimdall-browser`、`yarn add @benlampson/heimdall-browser`、`bun add @benlampson/heimdall-browser`

## README

# @benlampson/heimdall-browser

框架无关的 Heimdall 浏览器 Token 与数据客户端，版本跟随 Heimdall 整体 Release。

提供 Code + PKCE、Device Code、JWT 校验/未验证解码、JWT/opaque Access Token 获取与刷新、可选自动刷新、UserInfo、受控 Bearer 请求及撤销/退出。没有 UI、业务后端状态接口或数据库依赖。

默认自动保存到 localStorage；可选 sessionStorage、自定义 Storage 或 `storage: false` 仅使用内存。localStorage 跨标签页协调要求 Web Locks。浏览器不使用 Client Secret。

公开接口与示例见仓库 [SDK 指南](https://github.com/BenLampson/Asgard.Heimdall/blob/main/sdk/README.md)。

JWT 时间容差 `clockSkewSeconds` 默认 `30`，可由客户设置为非负安全整数秒数，`0` 禁用容差。浏览器和 `/protocol` 入口均支持；`nbf`、`exp`、未来 `iat` 使用同一容差，验签和身份边界保持启用，缓存及刷新仍按真实到期时间执行。

`HeimdallProtocolClient` 从 `@benlampson/heimdall-browser/protocol` 导出，无 window 或存储访问；完整 Token 和登录事务由调用方保存。

```ts
import { HeimdallBrowserClient } from '@benlampson/heimdall-browser';
const client = new HeimdallBrowserClient({
  authority: 'https://idp.example.com/tenant-a', clientId: 'business-spa',
  tenantId: 'tenant-a', applicationId: 'business-app', audience: 'business-api',
  scope: 'openid profile offline_access business.api',
  redirectUri: 'https://business.example.com/callback',
  resourceBaseUrls: ['https://api.example.com/'], automaticRenew: true,
});
// 生成登录地址，由应用决定如何使用。
const { url } = await client.createLoginRequest();
// 在应用自己的回调路由中：await client.handleLoginCallback();
// 业务按需获取：await client.getAccessToken() / client.getTokenSet();
// 主动刷新：await client.refreshAccessToken();
// 开关自动刷新：client.setAutomaticRenew(false);
// 设备登录：requestDeviceAuthorization / exchangeDeviceCode / waitForDeviceToken。
```

登录方式在 Heimdall 托管页面完成，SDK 统一使用授权码 + PKCE。business.api 是需登记的示例 scope；回调、Origin、grant 与 audience 按实际 Client 配置。

## 常见问题

### @benlampson/heimdall-browser 是什么？

海姆达尔OAuth/PKCE,设备代码,可选的代号存储和数据客户端没有UI\.

### 如何安装 @benlampson/heimdall-browser？

在项目目录运行 npm install @benlampson/heimdall-browser，或使用 pnpm add / yarn add / bun add。

### @benlampson/heimdall-browser 支持 TypeScript 吗？

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

### @benlampson/heimdall-browser 支持 ESM 还是 CommonJS？

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

### @benlampson/heimdall-browser 需要什么版本的 Node\.js？

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

### @benlampson/heimdall-browser 可以商用吗？

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

### @benlampson/heimdall-browser 的下载量有多少？

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

### @benlampson/heimdall-browser 还在维护吗？

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