@estifanos-sh/convex-auth

中文文档
0.0.12发布于 2026/08/29Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3653

Convex 认证

中文使用文档

@estifanos-sh/convex-auth (英语)

Convex应用程序的认证和授权.

安装已发布的软件包 :

npm install @estifanos-sh/convex-auth

配置组件在 convex/convex.config.ts数字 :

import auth from "@estifanos-sh/convex-auth/convex.config";
import { defineApp } from "convex/server";
import { v } from "convex/values";

const app = defineApp({
  env: {
    CONVEX_SITE_URL: v.string(),
  },
});
app.use(auth);

export default app;

然后定义您的提供者和权限 defineAuth数字 :

import { definePermissions } from "@estifanos-sh/convex-auth/permissions";
import { password } from "@estifanos-sh/convex-auth/providers/password";
import { webauthn } from "@estifanos-sh/convex-auth/providers/webauthn";
import { defineAuth } from "@estifanos-sh/convex-auth/server";
import { components } from "./_generated/api";

const permissions = definePermissions({
  grants: [],
  roles: {},
});

export const auth = defineAuth(components.auth, {
  permissions,
  providers: [password(), webauthn()],
});

export const { signIn, signOut, store } = auth;

将生成的动作直接传递给浏览器客户端. 供应商的身份证, 自定义证书验证符、动作结果和启用因素帮助符是 未经一般或类型断言而推断.

import { client } from "@estifanos-sh/convex-auth/browser";
import { api } from "../convex/_generated/api";

export const authClient = client({ convex, api: api.auth });

Convex Auth拥有用户,供应商账户,证书机密,密码, 恢复的继续,和会话。 申请表应注明: 品牌认证 userId;它们不应反映这些记录或制造认证 测试中的身份证明.

读取 安装指南 对于完整的设置,生成的文件,环境变量,客户端绑定, 和提供者配置.

读取 文档浏览 来源,或报告 问题。 。 。 .

阿帕奇 - 2.0

版本与发布记录

@estifanos-sh/convex-auth 共发布 16 个版本,首次发布于 2026/08/10;过去 12 个月发布了 16 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.0.12latest2026/08/292 个月前
0.0.112026/08/292 个月前
0.0.102026/08/272 个月前
0.0.92026/08/242 个月前
0.0.82026/08/242 个月前
0.0.72026/08/242 个月前

其他发布通道:preview → 0.0.1-preview.2,alpha → 0.0.5-alpha.0。

关于 @estifanos-sh/convex-auth 的常见问题

@estifanos-sh/convex-auth 是什么?

Convex 认证

如何安装 @estifanos-sh/convex-auth?

在项目目录运行 npm install @estifanos-sh/convex-auth,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:convex(^1.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 convex-auth,可以用 npx convex-auth 直接运行。

@estifanos-sh/convex-auth 支持 TypeScript 吗?

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

@estifanos-sh/convex-auth 支持 ESM 还是 CommonJS?

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

@estifanos-sh/convex-auth 可以商用吗?

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

@estifanos-sh/convex-auth 的下载量有多少?

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

@estifanos-sh/convex-auth 还在维护吗?

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