@basenative/auth

中文文档
3.3.0发布于 2026/11/03Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 1874

Authentication, session management, RBAC, and OAuth2/OIDC for BaseNative apps

原始使用文档
文档目录9 节
  1. Install
  2. Quick Start
  3. API
  4. Sessions
  5. Password
  6. RBAC
  7. Middleware
  8. OAuth Providers
  9. License

@basenative/auth

Session management, password hashing, RBAC, and OAuth — no external dependencies

Part of the BaseNative ecosystem — a signal-based web runtime over native HTML.

Install

npm install @basenative/auth

Quick Start

import {
  createSessionManager,
  hashPassword,
  verifyPassword,
  defineRoles,
  createGuard,
  sessionMiddleware,
  requireAuth,
} from '@basenative/auth';

// Password hashing (uses node:crypto — no bcrypt dependency)
const hash = await hashPassword('secret123');
const ok = await verifyPassword('secret123', hash); // true

// Session management
const sessions = createSessionManager({ maxAge: 24 * 60 * 60 * 1000 });
const session = await sessions.create({ userId: 42, role: 'admin' });

// RBAC
const roles = defineRoles({
  admin: { permissions: ['read', 'write', 'delete'] },
  editor: { permissions: ['read', 'write'] },
  viewer: { permissions: ['read'] },
});
const guard = createGuard(roles);
guard.can('editor', 'write'); // true
guard.can('viewer', 'write'); // false

API

Sessions

  • createSessionManager(options?) — Creates a session manager with pluggable storage. Options: store, cookieName, maxAge, secure, sameSite, httpOnly.
    • .create(data) — Creates a new session and returns it.
    • .get(id) — Retrieves a session by ID (returns null if expired).
    • .update(id, data) — Merges data into an existing session.
    • .destroy(id) — Deletes a session.
  • createMemoryStore() — In-memory session store (development / single-process).
  • createDbStore(db) — Database-backed session store using a @basenative/db adapter.

Password

  • hashPassword(password) — Hashes a password using PBKDF2 via node:crypto. Returns a Promise<string>.
  • verifyPassword(password, hash) — Verifies a password against a stored hash. Returns a Promise<boolean>.

RBAC

  • defineRoles(config) — Defines a role hierarchy with permissions arrays.
  • createGuard(roles) — Creates a guard object with .can(role, permission) checks.

Middleware

  • sessionMiddleware(manager) — Loads the session from the request cookie and attaches it to ctx.state.session.
  • requireAuth(options?) — Rejects unauthenticated requests with a 401 response.
  • login(manager, sessionData, ctx) — Creates a session and sets the session cookie on the response.
  • logout(manager, ctx) — Destroys the current session and clears the cookie.

OAuth Providers

  • credentialsProvider(options) — Username/password authentication strategy.
  • oauthProvider(providerName, options) — OAuth 2.0 flow for a named provider.
  • providers — Pre-configured OAuth settings for common providers (GitHub, Google, etc.).

License

Apache-2.0

版本与发布记录

@basenative/auth 共发布 14 个版本,首次发布于 2026/03/20;过去 12 个月发布了 14 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.3.0latest2026/11/035 天前
3.2.02026/11/035 天前
3.1.02026/11/017 天前
3.0.02026/10/317 天前
2.4.02026/10/2613 天前
2.3.22026/10/2217 天前

关于 @basenative/auth 的常见问题

@basenative/auth 是什么?

Authentication, session management, RBAC, and OAuth2/OIDC for BaseNative apps

如何安装 @basenative/auth?

在项目目录运行 npm install @basenative/auth,或使用 pnpm add / yarn add / bun add。

@basenative/auth 支持 TypeScript 吗?

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

@basenative/auth 支持 ESM 还是 CommonJS?

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

@basenative/auth 可以商用吗?

@basenative/auth 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@basenative/auth 的下载量有多少?

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

@basenative/auth 还在维护吗?

最新版本 3.3.0 发布于 2026/11/03(5 天前);至今共发布 14 个版本,其中过去 12 个月发布了 14 个;首次发布于 2026/03/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。