# @farm\.js/auth 中文文档

规范地址：https://npmcn.com/package/%40farm.js/auth/

版本：0\.1\.70
npm 元数据更新时间：2026-11-14T07:07:05.692Z
中文译文更新时间：2026-11-14T10:22:50.463Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40farm.js/auth
原文对照：https://npmcn.com/package/%40farm.js/auth/?lang=original
项目主页：https://github.com/farming-labs/farm.js#readme
源码仓库：https://github.com/farming-labs/farm.js

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

- 包体积（解压后）：82.8 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.0\.0，@farm\.js/native ^0\.1\.0-beta\.4
- 首次发布：2026-07-31T11:00:48.653Z
- 最新版本发布：2026-11-14T07:07:05.504Z
- 近 30 天下载量：9588（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：173（近 12 个月 173 个）

## 中文简介

Farm-native身份验证，包括email/password、服务器助手和React钩子

## 安装

```sh
npm install @farm.js/auth
```

也可以使用：`pnpm add @farm.js/auth`、`yarn add @farm.js/auth`、`bun add @farm.js/auth`

## README

# @farm.js/auth (英语)

Farm.js应用程序的内置电子邮件/密码认证. 设定 `auth: true` 内 `farm.config.ts` 和 Farm 挂载认证路径,存储基于数据库的会话,并曝光 服务器帮助器和反应钩。 更好的 Auth 是下面的引擎, 但应用程序代码从来没有 配置或导入它.

见 [稳定和支持](https://farmjs.dev/docs/stability) 对于这个包裹的保证.

## 安装

```bash
pnpm add @farm.js/auth
```

`react` 是一个对等依赖,由客户端钩子使用。 更好的奥特和 `pg` 邮政驱动程序 安装软件包。 本地开发打开 SQLite 通过 `node:sqlite` 在22号节点和之后, 然后回到可选的 `better-sqlite3` 依赖更古老的节点释放.

从一个完整的应用程序开始:

```bash
pnpm create @farm.js/app my-app --template auth
```

## 配置

```ts
import { defineConfig } from "@farm.js/core";

export default defineConfig({
  auth: true,
});
```

这是顶级的 `auth` 框架键,而非 `integrations.auth` 供养. 农场装了这个 软件包,仅当键被启用时。 设置两者 `auth` 财务报告和审定财务报表 `integrations.auth` 是一个 配置出错, 因为每个都拥有所有路径的认证 .

没有其他选择,农场:

-   挂载 `GET` 财务报告和审定财务报表 `POST` 处理者在 `/api/auth/[...auth]`· ;
-   允许电子邮件/密码登录和登录;
-   创建基于数据库的会议,持续7天,每天更新;
-   用途 `.farm/auth.sqlite` 正在开发中,并更新其首先使用的计划;
-   通过 Postgres `DATABASE_URL` 在生产中.

## 服务器助手

在服务器组件、服务器功能、中间软件或路由中读取当前会话或用户 处理者。 两个都回来 `null` 对于匿名请求.

```ts
import { auth } from "@farm.js/auth/server";

const session = await auth.session();
const user = await auth.user();
```

过 `required: true` 当请求必须签名时。 匿名请求会发出 `401` 用代码响应 `FARM_AUTH_REQUIRED`数字 :

```ts
const user = await auth.user({ required: true });
```

两位帮手也接受明确 `request`,如同此路由中间软件:

```ts
// src/app/dashboard/middleware.ts
import { auth } from "@farm.js/auth/server";

export const config = {
  runtime: "nodejs" as const,
};

export async function middleware(request: Request) {
  const user = await auth.user({ request });

  if (!user) {
    return Response.redirect(new URL("/sign-in", request.url), 307);
  }
}
```

## 客户助手

```tsx
"use client";

import { useAuth } from "@farm.js/auth/client";

export function AccountMenu() {
  const { user, isPending, signOut } = useAuth();

  if (isPending) return <span>Loading</span>;
  if (!user) return <a href="/sign-in">Sign in</a>;

  return <button onClick={() => signOut()}>Sign out {user.email}</button>;
}
```

`useAuth` ưμ㼯a `session`, (中文(简体) ), `error`, (中文(简体) ), `isRefetching`, (中文(简体) ), `refetch`, (中文(简体) ), `signIn`,以及 `signUp`编辑 同一种函数直接导出于不需要勾结的窗体:

```ts
import { signIn, signUp } from "@farm.js/auth/client";

await signUp({ name: "Ada Lovelace", email: "ada@example.com", password: "a-long-password" });
await signIn({ email: "ada@example.com", password: "a-long-password" });
```

`getSession` 也可以输出。 何时 `basePath` 定制, 创建匹配的帮助 `createFarmAuthClient({ basePath: "/account/auth" })`。它也接受 `baseURL` 客户 不在浏览器中运行.

## 选项

| 选项 | 默认 | 页:1 |
| --- | --- | --- |
| `enabled` | `true` | 设定 `false` 在不删除的情况下禁用. |
| `appName` | `"Farm app"` | 认证元数据和电子邮件中使用的名称 . |
| `basePath` | `"/api/auth"` | 路线前缀. 一定是一个简单的路径名 . |
| `emailAndPassword` | 启用 | 设定 `false` 以禁用. |
| `emailAndPassword.requireEmailVerification` | `false` |  |
| `emailAndPassword.minPasswordLength` | `8` |  |
| `emailAndPassword.maxPasswordLength` | `128` |  |
| `session.expiresIn` | `604800` | 会话寿命数秒. |
| `session.updateAge` | `86400` | 刷新间隔数秒 . |
| `database.url` | `DATABASE_URL` | Postgres 连接字符串 . |
| `database.path` | `.farm/auth.sqlite` | 本地 SQLite 文件 . |
| `database.migrateInDevelopment` | `true` | 更新本地的首次使用计划 . |

`auth: { enabled: true }` 等同为 `auth: true`。 。 。 .

## 环境和部署

| 变量 | 目的 |
| --- | --- |
| `DATABASE_URL` | Postgres 连接字符串 。 生产中要求. |
| `FARM_AUTH_SECRET` | 签名秘密,生产中需要. `AUTH_SECRET` 财务报告和审定财务报表 `BETTER_AUTH_SECRET` 还有工作. |
| `FARM_AUTH_URL` | 出自大众. `BETTER_AUTH_URL` 也读作。 未定时引入凡尔塞. |

无 `FARM_AUTH_URL`, (中文(简体) ), `farm dev` 信任它的源头 `localhost`, (中文(简体) ), `*.localhost`,或者一个IP地址,所以其他端口,Android模拟器 `10.0.2.2`,以及 局域网设备 `--host` 可以签入。 生产只信任配置的来源 .

没有秘密,开发就会产生随机的 `.farm/auth-secret` 并重用它跨越 重启 。 正在装入 `farm.config.ts` 运行 `farm build` 从不连接数据库。 应用 服务交通前的生产计划:

```bash
farm auth migrate
farm auth migrate --dry-run
farm auth migrate --write auth-schema.sql
```

第一个命令应用了这个计划. `--dry-run` 打印语句和 `--write` 保存到 文件,不更改数据库。 命令需求 `DATABASE_URL` 但不是那个秘密.

签名率限制客户端地址上的密钥 Farm 解析请求 。 在代理商背后, 启用 `server.trustProxy` 因此,访客并非全部被算作代理地址.

## 入境点

-   `@farm.js/auth/server`页:1 `auth.session()` 财务报告和审定财务报表 `auth.user()` 帮手.
-   `@farm.js/auth/client`数字 : `useAuth`, (中文(简体) ), `signIn`, (中文(简体) ), `signUp`, (中文(简体) ), `signOut`, (中文(简体) ), `getSession`,以及 `createFarmAuthClient`。反应原生屏幕(`page.native.tsx`)使用相同的导入: Metro 决定: `react-native` 构造,它称为通过 `serverFetch` 从 `@farm.js/native` (可选对等). `signIn` 财务报告和审定财务报表 `signUp` 通过移动外壳的原生 代码, 将会话 cookie 保存在 WebView 中并发布设备符; 社交签名 暂时拒绝 Web 捆绑不改变 .
-   `@farm.js/auth`数字 : `resolveFarmAuthConfig` 以及配置和会话类型,例如 `FarmAuthConfig`, (中文(简体) ), `FarmAuthSession`,以及 `FarmAuthUser`。 。 。 .
-   `@farm.js/auth/internal`: 由农场核心装入 `farm auth migrate`。应用程序不 导入它.

使用 [`@farm.js/better-auth`](https://www.npmjs.com/package/@farm.js/better-auth) 而不是当 应用程序需要更好的 Auth 插件、适配器、社会提供者或原始实例 API.

## 文档

-   [内建验证](https://farmjs.dev/docs/auth)
-   [Auth 整合](https://farmjs.dev/docs/integrations/auth)

报告问题和在报告 [Farm.js仓库](https://github.com/farming-labs/farm.js)。 。 。 .

## 常见问题

### @farm\.js/auth 是什么？

Farm-native身份验证，包括email/password、服务器助手和React钩子

### 如何安装 @farm\.js/auth？

在项目目录运行 npm install @farm\.js/auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farm\.js/auth 支持 TypeScript 吗？

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

### @farm\.js/auth 支持 ESM 还是 CommonJS？

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

### @farm\.js/auth 可以商用吗？

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

### @farm\.js/auth 的下载量有多少？

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

### @farm\.js/auth 还在维护吗？

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