@fayz-ai/auth

中文文档
0.94.0发布于 2026/11/11MITTypeScriptES Module近 30 天下载 2万

Fayz SDK 认证上下文——会话、适配器、认证链接以及登录和密码屏幕

中文使用文档
文档目录5 节
  1. 里面的东西
  2. 安装
  3. 使用量
  4. 费兹SDK的一部分
  5. 路线图贡献( I)

@fayz-ai/auth (英语)

法伊兹应用软件的可插式认证——一钩,可互换适配器.

npm license

状态 : β-发布至npm并在整个法伊兹狗食应用. 事前1.0:小API在1.0之前可能会有变化.

奥特不应该是 与你的应用软件 后端. @fayz-ai/auth 将认证包裹在核心后面 AuthAdapter 所以Fayz的应用读取相同, 无论是生产中运行在Supabase还是测试和预览中的模拟适配器. 一个供应商,一个供应商 useAuth 钩子,一个Zustand后置的会话商店——其余的是一个可以互换的执行细节.

这是由 Fayz SaaS 编组的应用程序的认证层: 降入 AuthProvider,选择一个适配器,每个插件都获得一致的用户和会话,而不知道它来自何处.

里面的东西

  • createSupabaseAuthAdapter 生产 Supabase 认证,通过 SupabaseAuthConfig
  • createMockAuthAdapter 用于测试、演示和预览的决定性认证(MockUser(中文(简体) )
  • AuthProvider + 键 useAuth ——当前用户和会话的回放上下文和钩子
  • useAuthStore - 地下Zustand商店(AuthState, (中文(简体) ), AuthStore高级接入
  • 按路径导入的屏幕和规则 : @fayz-ai/auth/views/AuthGate, (中文(简体) ), views/LoginPage, (中文(简体) ), views/SetPasswordPage, (中文(简体) ), views/usePasswordSetupGate, (中文(简体) ), lib/runtime (单位:千美元)createAuthRuntime, (中文(简体) ), domain/auth-config (单位:千美元)AuthPluginOptions, (中文(简体) ), LoginAmbassador, (中文(简体) ), domain/password术语 格洛萨里·姆德。 。 。 .

安装

npm install @fayz-ai/auth

端点 : react (^18或^19) (中文(简体) ). 建造在 @fayz-ai/core。 。 。 .

使用量

import { AuthProvider, useAuth, createSupabaseAuthAdapter } from '@fayz-ai/auth'

const adapter = createSupabaseAuthAdapter({ url, anonKey })

function App() {
  return (
    <AuthProvider adapter={adapter}>
      <Dashboard />
    </AuthProvider>
  )
}

function Dashboard() {
  const { user } = useAuth()
  return <p>Hello, {user?.email}</p>
}

费兹SDK的一部分

认证之间的接合 @fayz-ai/core 和多租户 @fayz-ai/admin 层.

路线图贡献( I)

建设并不断发展于开阔. 见 费兹SDK路线图 对于当前空白,缺失的特征,以及良好的第一问题.

版本与发布记录

@fayz-ai/auth 共发布 72 个版本,首次发布于 2026/06/18;过去 12 个月发布了 72 个版本。

版本发布日期距今
0.94.0latest2026/11/112 天前
0.92.02026/11/113 天前
0.90.02026/11/068 天前
0.79.02026/11/059 天前
0.78.02026/11/0410 天前
0.77.02026/10/3015 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.76.0-canary.20261028153856。

关于 @fayz-ai/auth 的常见问题

@fayz-ai/auth 是什么?

Fayz SDK 认证上下文——会话、适配器、认证链接以及登录和密码屏幕

如何安装 @fayz-ai/auth?

在项目目录运行 npm install @fayz-ai/auth,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/auth 支持 TypeScript 吗?

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

@fayz-ai/auth 支持 ESM 还是 CommonJS?

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

@fayz-ai/auth 可以商用吗?

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

@fayz-ai/auth 的下载量有多少?

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

@fayz-ai/auth 还在维护吗?

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