@benlampson/heimdall-browser

中文文档
5.10.0发布于 2026/11/07MITTypeScriptES Module近 30 天下载 2228

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

中文使用文档

@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 指南。

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

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

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 共发布 13 个版本,首次发布于 2026/10/11;过去 12 个月发布了 13 个版本。

版本发布日期距今
5.10.0latest2026/11/071 天前
5.9.42026/11/052 天前
5.9.32026/11/052 天前
5.9.22026/11/052 天前
5.9.12026/11/053 天前
5.9.02026/11/053 天前

关于 @benlampson/heimdall-browser 的常见问题

@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 和提交记录判断。