@exact-team/telegram-oauth2
Advanced tools
Библиотека для упрощённой авторизации пользователей через Telegram OAuth2 и TMA(Telegram Mini Apps).
npm install @exact-team/telegram-oauth2
/setdomain внутри @BotFather.botId — это часть токена до символа :, например в 1234567890:ABC... бот id будет 1234567890.botId для использования на frontend.Добавьте скрипт в <body> вашего HTML:
<body>
<script async src="https://telegram.org/js/telegram-widget.js"></script>
</body>
Создайте файл telegram.d.ts рядом с tsconfig.json:
Давайте разберём подробнее, почему мы используем именно этот подход к авторизации:
Плюсы:Минусы:declare global {
interface ITelegramOptions {
bot_id: string;
request_access?: boolean;
lang?: string;
}
interface ITelegramData {
id: number;
first_name: string;
auth_date: number;
hash: string;
last_name?: string;
username?: string;
photo_url?: string;
}
type ITelegramCallback = (dataOrFalse: ITelegramData | false) => void;
interface Window {
Telegram: {
Login: {
auth(options: ITelegramOptions, callback: ITelegramCallback): void;
};
};
}
}
export {};
И добавьте telegram.d.ts в секцию include вашего tsconfig.json:
{
"compilerOptions": {
// ...
},
"include": [
"telegram.d.ts"
// другие файлы
]
}
import React from 'react';
import { Button } from '@shared/components/ui/button';
const botId = process.env.REACT_APP_TELEGRAM_BOT_ID!; // Ваш botID !!!!!
export function LoginPage() {
const handleCallback = (data: ITelegramData | false) => {
if (!data) return;
// Отправьте данные на backend для проверки и генерации JWT
fetch('/api/auth/telegram', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(data),
});
};
const handleLogin = () => {
window.Telegram.Login.auth({ bot_id: botId, request_access: true }, handleCallback);
};
return (
<div className="flex items-center justify-center min-h-screen">
<Button onClick={handleLogin}>Войти через Telegram</Button>
</div>
);
}
import { TelegramOAuth2 } from 'telegram-oauth2';
const telegramAuth = new TelegramOAuth2({
botToken: process.env.TELEGRAM_BOT_TOKEN!, // Токен бота
validUntil: 2000, // (опционально) сколько секунд тело запроса считается валидным
});
В вашем роуте (например, Express или любом другом фреймворке):
import express, { Request, Response } from 'express';
const app = express();
app.use(express.json());
app.post('/api/auth/telegram', (req: Request, res: Response) => {
const result = telegramAuth.handleTelegramOAuthCallback(req.body);
if (!result.isSuccess || !result.data) {
return res
.status(400)
.json({ error: result.message || 'Неправильная подпись данных или auth_date истёк' });
}
const user = result.data;
// Найдите или создайте пользователя в БД и сгенерируйте JWT
res.json({ user });
});
app.listen(3000, () => {
console.log('Server started on http://localhost:3000');
});
// Параметры конструктора TelegramOAuth2
interface ICfgConstructor {
botToken: string;
}
// Данные пользователя из Telegram
interface IUserTelegram {
id: number;
first_name: string;
last_name?: string;
username?: string;
photo_url?: string;
auth_date: number;
}
// Ответ команды библиотеки
interface ICommandResponse<T> {
isSuccess: boolean;
message?: string;
data?: T;
}
Библиотека может возвращать следующие типы ошибок:
INVALID_HASH — некорректная подпись данных, возможная попытка взлома.EXPIRED_HASH — Время auth_date истекло.Этот проект распространяется под лицензией ISC.
FAQs
telegram oauth2
The npm package @exact-team/telegram-oauth2 receives a total of 38 weekly downloads. As such, @exact-team/telegram-oauth2 popularity was classified as not popular.
We found that @exact-team/telegram-oauth2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Former RubyGems maintainers have launched The Gem Cooperative, a new community-run project aimed at rebuilding open governance in the Ruby ecosystem.
Security News
An opt-in lazy import keyword aims to speed up Python startups, especially CLIs, without the ecosystem-wide risks that sank PEP 690.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.