# 0authkit 中文文档

规范地址：https://npmcn.com/package/0authkit/

版本：1\.0\.2
npm 元数据更新时间：2026-04-26T10:40:46.459Z
中文译文更新时间：2026-10-31T12:01:39.030Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/0authkit
原文对照：https://npmcn.com/package/0authkit/?lang=original
项目主页：https://github.com/thejamesnick/0AuthKit
源码仓库：https://github.com/thejamesnick/0AuthKit

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

- 包体积（解压后）：27.1 kB，38 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2026-04-25T13:00:28.579Z
- 最新版本发布：2026-04-26T10:40:46.347Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

在几分钟内将OAuth添加到任何应用程序。带上你自己的证件。

## 安装

```sh
npm install 0authkit
```

也可以使用：`pnpm add 0authkit`、`yarn add 0authkit`、`bun add 0authkit`

## README

# 0 authkit

> 快速将OAuth添加到应用程序中，并使用最少的样板文件。

authkit为谷歌+ GitHub的OAuth流提供了一个小的TypeScript SDK。

## 项目运行状况（诚实状态）

-   ✅构建通道
-   ✅基本自动化测试（核心认证+回调安全检查）
-   ✅核心流程实现：认证URL，令牌交换，配置文件获取
-   ✅状态验证支持（通过） `expectedState` 在回调)

所以：坚实的小型黑客基础，但在称之为生产级之前添加测试。

* * *

## 安装

```bash
npm install 0authkit
```

* * *

## 60秒集成（服务器端）

### 1)制作工具包

```ts
import { OAuthKit } from '0authkit'

const kit = new OAuthKit({
  provider: 'google',
  clientId: process.env.GOOGLE_CLIENT_ID!,
  clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
  redirectUri: 'http://localhost:3000/auth/callback',
})
```

### 2)重定向用户

```ts
app.get('/auth/google', async (req, res) => {
  const { url, state, codeVerifier } = await kit.getAuthUrl()
  req.session.oauthState = state
  req.session.oauthCodeVerifier = codeVerifier
  res.redirect(url)
})
```

### 3)处理回调

```ts
app.get('/auth/callback', async (req, res) => {
  const result = await kit.handleCallback(
    String(req.query.code),
    String(req.query.state)
  )

  // Recommended: use server functional API for explicit state/codeVerifier checks
  // import { handleCallback } from '0authkit/server'
  // const result = await handleCallback({
  //   provider: 'google',
  //   code: String(req.query.code),
  //   state: String(req.query.state),
  //   expectedState: req.session.oauthState,
  //   codeVerifier: req.session.oauthCodeVerifier,
  //   clientId: process.env.GOOGLE_CLIENT_ID!,
  //   clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
  //   redirectUri: 'http://localhost:3000/auth/callback',
  // })

  res.json(result.profile)
})
```

* * *

## 最佳实践回调（推荐）

使用 `0authkit/server` 这样您就可以显式地验证状态和PKCE验证器。

```ts
import { getAuthUrl, handleCallback } from '0authkit/server'

app.get('/auth/google', async (req, res) => {
  const { url, state, codeVerifier } = await getAuthUrl({
    provider: 'google',
    clientId: process.env.GOOGLE_CLIENT_ID!,
    redirectUri: 'http://localhost:3000/auth/callback',
  })

  req.session.oauthState = state
  req.session.oauthCodeVerifier = codeVerifier
  res.redirect(url)
})

app.get('/auth/callback', async (req, res) => {
  const result = await handleCallback({
    provider: 'google',
    code: String(req.query.code),
    state: String(req.query.state),
    expectedState: req.session.oauthState,
    codeVerifier: req.session.oauthCodeVerifier,
    clientId: process.env.GOOGLE_CLIENT_ID!,
    clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
    redirectUri: 'http://localhost:3000/auth/callback',
  })

  res.json(result.profile)
})
```

* * *

## 入口点

| 进口 | 使用 |
| --- | --- |
| `0authkit` | 基于类的服务器API |
| `0authkit/server` | 功能伺服器API (`getAuthUrl`， `handleCallback`） |
| `0authkit/client` | Client-safe `getAuthUrl` 只有 |

* * *

## 供应商

| 提供者 | 状态 | PKCE |
| --- | --- | --- |
| 谷歌 | ✅ | ✅ |
| GitHub | ✅ | ❌ |

* * *

## 安全笔记

-   保持 `clientSecret` 仅在服务器上。
-   始终坚持+验证 `state` （`expectedState`）。
-   对于PKCE提供程序，持久化+重用 `codeVerifier`.
-   在生产环境中使用HTTPS。

* * *

## 输出的形状

```ts
result.tokens  // { accessToken, refreshToken?, expiresIn?, tokenType, scope? }
result.profile // { id, email, name, avatar, raw }
```

* * *

建造的 [thejamesnick](https://github.com/thejamesnick)

## 常见问题

### 0authkit 是什么？

在几分钟内将OAuth添加到任何应用程序。带上你自己的证件。

### 如何安装 0authkit？

在项目目录运行 npm install 0authkit，或使用 pnpm add / yarn add / bun add。

### 0authkit 支持 TypeScript 吗？

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

### 0authkit 支持 ESM 还是 CommonJS？

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

### 0authkit 需要什么版本的 Node\.js？

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

### 0authkit 可以商用吗？

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

### 0authkit 还在维护吗？

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