# @getmocha/users-service 中文文档

规范地址：https://npmcn.com/package/%40getmocha/users-service/

版本：0\.0\.4
npm 元数据更新时间：2026-01-26T21:02:54.703Z
中文译文更新时间：2026-11-16T06:28:07.273Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40getmocha/users-service
原文对照：https://npmcn.com/package/%40getmocha/users-service/?lang=original

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

- 包体积（解压后）：34.3 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：hono ^4\.0\.0，react ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2025-06-19T20:39:51.954Z
- 最新版本发布：2025-07-01T11:48:34.956Z
- 近 30 天下载量：3265（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

API 客户端 Hono 中间软件和 Mocha 用户服务的反应提供者

## 安装

```sh
npm install @getmocha/users-service
```

也可以使用：`pnpm add @getmocha/users-service`、`yarn add @getmocha/users-service`、`bun add @getmocha/users-service`

## README

# @ getmocha/ 用户服务

一个用于与Mocha用户服务互动的SDK,为Hono和React应用程序提供认证和用户管理功能.

## 安装

```bash
npm install @getmocha/users-service
```

## 特征

-   Google OAuth 通过 Mocha 用户服务认证
-   会话管理
-   用户信息检索
-   受保护路线的Hono中间软件
-   在 React apps 中管理用户和认证状态的 React 上下文提供者和相关钩子.

## 使用量

### 后端认证流程

使用@ getmocha/ users- service/后端导出后端功能和Hono支持 .

1.  **获取 OAuth 重定向 URL**

```typescript
import { getOAuthRedirectUrl } from '@getmocha/users-service/backend';

// In your API handler
app.get('/api/oauth/google/redirect_url', async (c) => {
  const redirectUrl = await getOAuthRedirectUrl('google', {
    apiUrl: c.env.MOCHA_USERS_SERVICE_API_URL,
    apiKey: c.env.MOCHA_USERS_SERVICE_API_KEY,
  });

  return c.json({ redirectUrl }, 200);
});
```

2.  **会话键的交换代码**

```typescript
import {
  exchangeCodeForSessionToken,
  MOCHA_SESSION_TOKEN_COOKIE_NAME,
} from '@getmocha/users-service/backend';
import { setCookie } from 'hono/cookie';

// In your API handler for the callback
app.post('/api/sessions', async (c) => {
  const { code } = await c.req.json();

  const sessionToken = await exchangeCodeForSessionToken(code, {
    apiUrl: c.env.MOCHA_USERS_SERVICE_API_URL,
    apiKey: c.env.MOCHA_USERS_SERVICE_API_KEY,
  });

  // Set the session cookie
  setCookie(c, MOCHA_SESSION_TOKEN_COOKIE_NAME, sessionToken, {
    httpOnly: true,
    path: '/',
    sameSite: 'none',
    secure: true,
    maxAge: 60 * 24 * 60 * 60, // 60 days
  });

  return c.json({ success: true });
});
```

3.  **使用 Auth 中间软件保护路由**

```typescript
import { authMiddleware } from '@getmocha/users-service/backend';
import { Hono } from 'hono';

// Create your Hono app
const app = new Hono();

// Use the middleware to protect routes
app.get('/api/protected-route', authMiddleware, async (c) => {
  // The user is available in the context
  const user = c.get('user');

  return c.json({ message: `Hello, ${user.email}!` });
});
```

4.  **获取当前用户**

```typescript
import { authMiddleware } from '@getmocha/users-service/backend';
import { Hono } from 'hono';

// Create your Hono app
const app = new Hono();

app.get('/api/users/me', authMiddleware, async (c) => {
  const user = c.get('user');
  return c.json(user);
});
```

5.  **注销**

```typescript
import { deleteSession } from '@getmocha/users-service/backend';
import { Hono } from 'hono';
import { getCookie, setCookie } from 'hono/cookie';

// Create your Hono app
const app = new Hono();

app.get('/api/logout', async (c) => {
  const sessionToken = getCookie(c, MOCHA_SESSION_TOKEN_COOKIE_NAME);

  if (typeof sessionToken === 'string') {
    await deleteSession(sessionToken, {
      apiUrl: c.env.MOCHA_USERS_SERVICE_API_URL,
      apiKey: c.env.MOCHA_USERS_SERVICE_API_KEY,
    });
  }

  // Delete cookie by setting max age to 0 These params must match the ones
  // used when setting the cookie, except max age (0) and the cookie value ('').
  setCookie(c, MOCHA_SESSION_TOKEN_COOKIE_NAME, '', {
    httpOnly: true,
    path: '/',
    sameSite: 'none',
    secure: true,
    maxAge: 0,
  });

  return c.json({ success: true }, 200);
});
```

### 共享

使用 @ getmocha/ users- service/ share导出用于前端或后端的功能 .

例如 `MochaUser` 类型脚本 .

```typescript
import type { MochaUser } from '@getmocha/users-service/shared';
import { Hono } from 'hono';

type Variables = {
  user?: MochaUser;
};

const app = new Hono<{ Bindings: Env; Variables: Variables }>();
```

### 前端反应包

使用 @ getmocha/ users- service/ react 导出用于提供用户和认证管理的 React 上下文提供者和钩子 .

```tsx
import { AuthProvider } from '@getmocha/users-service/react';

export default function App() {
  return (
    <AuthProvider>
      <Router>
        <Routes>
          <Route path="/" element={<HomePage />} />
          <Route path="/auth/callback" element={<AuthCallbackPage />} />
        </Routes>
      </Router>
    </AuthProvider>
  );
}
```

然后可以使用导出 `useAuth` 钩.

```tsx
const {
  user,
  isPending,
  isFetching,
  fetchUser,
  redirectToUrl,
  exchangeCodeForSessionToken,
  logout,
} = useAuth();
```

## 常见问题

### @getmocha/users-service 是什么？

API 客户端 Hono 中间软件和 Mocha 用户服务的反应提供者

### 如何安装 @getmocha/users-service？

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

### @getmocha/users-service 支持 TypeScript 吗？

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

### @getmocha/users-service 支持 ESM 还是 CommonJS？

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

### @getmocha/users-service 可以商用吗？

@getmocha/users-service 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @getmocha/users-service 的下载量有多少？

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

### @getmocha/users-service 还在维护吗？

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

