让开源，少一点语言距离。
npm包中文文档

@betterportal/auth-workos

中文文档
11.0.9发布于 2026/11/07(AGPL-3.0-only OR Commercial)TypeScriptES Module构建来源已验证近 30 天下载 1744

BetterPortal WorkOS auth service for Node.js

原始使用文档
中文原文

BetterPortal WorkOS Auth Service

WorkOS AuthKit provider for BetterPortal. The service redirects users to WorkOS, exchanges the callback code server-side with the WorkOS Node SDK, issues BetterPortal tokens, and refreshes BP tokens from the WorkOS refresh token.

Per-app service config requires:

  • clientId
  • apiKey

Optional config:

  • provider defaults to authkit
  • connectionId, organizationId, domainHint
  • scopes
  • roleClaimPath defaults to roles
  • service config workosStatePath defaults to ./workos-state.json; set it to a persistent path such as /data/workos-state.json in production
  • service config syncIntervalSeconds defaults to 21600 and retries stale permission/role sync every 6 hours

Registry org: betterportal.

OAuth login states are stored as SHA-256 named pending files beside workosStatePath and atomically removed before a callback code is exchanged. Keep this directory writable. Replicas should share the same persistent path so callbacks can complete on any replica; a replica without the issued state rejects the callback. Expired pending files are cleaned during later login starts, and each replica limits its outstanding states to 10,000.

After-login and after-logout destinations are app-owned app.auth.redirects view references configured in Tenants & Apps, not provider addon fields.

Role sync keeps BP as the permission source of truth. WorkOS permission slugs are short service-owned keys, bp_<shortId>_<read|create|update|delete>, with the full tenant/service/view mapping stored in workosStatePath. Roles are mirrored per app from WorkOS role slugs into BP app roles.

The manifest advertises role-sync endpoints through the standard auth.roles.sync.view, auth.permissions.sync, and auth.roles.sync operation roles. Consumers discover their published paths instead of depending on WorkOS route names.

The service uses @workos-inc/node 11 on Node 24 (the SDK requires Node 22.11+). Its AuthKit, user/role/permission and SSO integrations retain their existing contracts; this service does not use the SDK's Pipes APIs changed in version 11.

To validate the SDK integration after updating the dependency:

npm run build -w @betterportal/auth-workos
npm run test -w @betterportal/auth-workos

版本与发布记录

@betterportal/auth-workos 共发布 118 个版本，首次发布于 2026/07/06；过去 12 个月发布了 118 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
11.0.9latest2026/11/072 天前
11.0.82026/11/072 天前
11.0.72026/11/072 天前
11.0.62026/11/063 天前
11.0.52026/11/054 天前
11.0.42026/11/054 天前

关于 @betterportal/auth-workos 的常见问题

@betterportal/auth-workos 是什么？

BetterPortal WorkOS auth service for Node.js

如何安装 @betterportal/auth-workos？

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

@betterportal/auth-workos 支持 TypeScript 吗？

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

@betterportal/auth-workos 支持 ESM 还是 CommonJS？

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

@betterportal/auth-workos 可以商用吗？

@betterportal/auth-workos 使用 (AGPL-3.0-only OR Commercial) 许可。可在 AGPL-3.0、Commercial 中任选其一遵守。以上为概括，不构成法律意见，请以许可原文为准。

@betterportal/auth-workos 的下载量有多少？

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

@betterportal/auth-workos 还在维护吗？

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