# @fayz-ai/plugin-auth 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/plugin-auth/

版本：0\.13\.26
npm 元数据更新时间：2026-11-11T14:53:21.719Z
中文译文更新时间：2026-11-14T12:13:19.931Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/plugin-auth
原文对照：https://npmcn.com/package/%40fayz-ai/plugin-auth/?lang=original

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

- 包体积（解压后）：44.5 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，lucide-react \>=0\.400\.0 \<1\.0\.0
- 首次发布：2026-07-03T20:25:04.336Z
- 最新版本发布：2026-11-11T14:53:21.427Z
- 近 30 天下载量：6831（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：72（近 12 个月 72 个）

## 中文简介

Fayz SDK — 可重复使用的认证运行时间和 UI 集成插件

## 安装

```sh
npm install @fayz-ai/plugin-auth
```

也可以使用：`pnpm add @fayz-ai/plugin-auth`、`yarn add @fayz-ai/plugin-auth`、`bun add @fayz-ai/plugin-auth`

## README

# @fayz-ai/plugin-auth (英语)

用于 Fayz apps 的可重用认证运行时间和 UI .

**状态 :** β-前1.0. API在1.0前可能会有变化.

`plugin-auth` 是一层薄薄的 `@fayz-ai/auth`:它解决了Supabase/mock/custom适配器,使登录/签名/恢复/重置/召回表面,并给SaaS或存储前置应用一个一致的认证集成路径.

## 安装

```bash
npm install @fayz-ai/plugin-auth
```

端点 : `@fayz-ai/auth`, (中文(简体) ), `@fayz-ai/core`附加时 `react` 编号 : `react-dom`。 。 。 .

## 使用量

```tsx
import { createAuthPlugin } from '@fayz-ai/plugin-auth'

export const auth = createAuthPlugin({
  provider: import.meta.env.VITE_SUPABASE_URL ? 'supabase' : 'mock',
  supabase: {
    url: import.meta.env.VITE_SUPABASE_URL,
    anonKey: import.meta.env.VITE_SUPABASE_ANON_KEY,
  },
  requireAuth: true,
  layout: 'split',
  oauth: { enabled: true, providers: ['google'] },
})
```

## 常见问题

### @fayz-ai/plugin-auth 是什么？

Fayz SDK — 可重复使用的认证运行时间和 UI 集成插件

### 如何安装 @fayz-ai/plugin-auth？

在项目目录运行 npm install @fayz-ai/plugin-auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）、lucide-react（\>=0\.400\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fayz-ai/plugin-auth 支持 TypeScript 吗？

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

### @fayz-ai/plugin-auth 支持 ESM 还是 CommonJS？

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

### @fayz-ai/plugin-auth 可以商用吗？

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

### @fayz-ai/plugin-auth 的下载量有多少？

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

### @fayz-ai/plugin-auth 还在维护吗？

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

