@ getmocha/ 用户服务
一个用于与Mocha用户服务互动的SDK,为Hono和React应用程序提供认证和用户管理功能.
安装
npm install @getmocha/users-service
特征
- Google OAuth 通过 Mocha 用户服务认证
- 会话管理
- 用户信息检索
- 受保护路线的Hono中间软件
- 在 React apps 中管理用户和认证状态的 React 上下文提供者和相关钩子.
使用量
后端认证流程
使用@ getmocha/ users- service/后端导出后端功能和Hono支持 .
- 获取 OAuth 重定向 URL
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);
});
- 会话键的交换代码
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 });
});
- 使用 Auth 中间软件保护路由
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}!` });
});
- 获取当前用户
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);
});
- 注销
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 类型脚本 .
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 上下文提供者和钩子 .
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 钩.
const {
user,
isPending,
isFetching,
fetchUser,
redirectToUrl,
exchangeCodeForSessionToken,
logout,
} = useAuth();