@rockyatoyan/nest-oauth 0.0.1 → 0.0.3

package/README.md

@@ -1,98 +1,118 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Project setup
+# @rockyatoyan/nest-oauth
 
-```bash
-$ npm install
-```
+Универсальный OAuth-модуль для **NestJS**, позволяющий легко подключать OAuth-провайдеров (Google, GitHub и др.) с единым API, минимальной конфигурацией и удобными декораторами.
 
-## Compile and run the project
+---
 
-```bash
-# development
-$ npm run start
+## Возможности
 
-# watch mode
-$ npm run start:dev
+- 🔐 Поддержка нескольких OAuth-провайдеров
+- 🧩 Простое расширение через кастомные провайдеры
+- ⚙️ Асинхронная регистрация модуля
+- 🪝 Готовые декораторы для URL авторизации и callback
+- 📦 Удобная интеграция с `@nestjs/config`
 
-# production mode
-$ npm run start:prod
-```
+---
 
-## Run tests
+## Установка
 
 ```bash
-# unit tests
-$ npm run test
-
-# e2e tests
-$ npm run test:e2e
-
-# test coverage
-$ npm run test:cov
+npm i @rockyatoyan/nest-oauth
 ```
 
-## Deployment
-
-When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
-
-If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
-
-```bash
-$ npm install -g mau
-$ mau deploy
+## Регистрация модуля
+
+```typescript
+import { ProviderModule } from '@rockyatoyan/nest-oauth';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+
+ProviderModule.registerAsync({
+  imports: [ConfigModule],
+  inject: [ConfigService],
+  useFactory: (configService: ConfigService) => {
+    return {
+      baseUrl: configService.getOrThrow<string>(envNames.DOMAIN),
+      providers: [
+        new GoogleProvider({
+          clientId: configService.getOrThrow<string>(envNames.OAUTH_GOOGLE_CLIENT_ID),
+          clientSecret: configService.getOrThrow<string>(envNames.OAUTH_GOOGLE_CLIENT_SECRET),
+        }),
+        new GithubProvider({
+          clientId: configService.getOrThrow<string>(envNames.OAUTH_GITHUB_CLIENT_ID),
+          clientSecret: configService.getOrThrow<string>(envNames.OAUTH_GITHUB_CLIENT_SECRET),
+        }),
+      ],
+    };
+  },
+});
 ```
 
-With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
-
-## Resources
-
-Check out a few resources that may come in handy when working with NestJS:
-
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
-
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+## Создание OAuth-провайдеров
+
+```typescript
+import { BaseProvider, ProviderInstanceOptions, ExtractUserResponse } from '@rockyatoyan/nest-oauth';
+
+interface GithubUserInfo {
+  id: number;
+  name: string;
+  avatar_url: string;
+  email: string;
+}
+
+export class GithubProvider extends BaseProvider {
+  constructor(options: ProviderInstanceOptions) {
+    super({
+      name: 'github',
+      clientId: options.clientId,
+      clientSecret: options.clientSecret,
+      scopes: ['user'],
+      authUrl: 'https://github.com/login/oauth/authorize',
+      tokensUrl: 'https://github.com/login/oauth/access_token',
+      userInfoUrl: 'https://api.github.com/user',
+    });
+  }
+
+  override extractUserInfo(data: GithubUserInfo): ExtractUserResponse {
+    return {
+      id: String(data.id),
+      avatarUrl: data.avatar_url,
+      email: data.email,
+      provider: this.options.name,
+    };
+  }
+}
+```
 
-## Stay in touch
+## Использование
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+### Получение URL авторизации
 
-## License
+```typescript
+@OAuthUrl()
+@Get('oauth/:provider/url')
+async getOAuthProviderUrl() {}
+```
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+### OAuth callback
+
+```typescript
+@OAuthCallback()
+@Get('oauth/:provider/callback')
+async oauthCallback(
+  @Req() req: Request,
+  @Res({ passthrough: true }) res: Response,
+) {
+  try {
+    await this.authService.loginWithOAuth(req, req.providerInfo!);
+  } catch (error) {
+    return res.redirect(
+      this.configService.get(envNames.CLIENT_ORIGIN) +
+        '/auth/login?error=true',
+    );
+  }
+
+  return res.redirect(
+    this.configService.get(envNames.CLIENT_ORIGIN) + '/dashboard/profile',
+  );
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,75 @@
+import { FactoryProvider, ModuleMetadata, DynamicModule } from '@nestjs/common';
+
+interface ProviderOptions {
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    scopes: string[];
+    authUrl: string;
+    tokensUrl: string;
+    userInfoUrl: string;
+}
+type ProviderInstanceOptions = Pick<ProviderOptions, 'clientId' | 'clientSecret'>;
+interface TokensResponse {
+    access_token: string;
+    refresh_token?: string;
+    expires_in?: number;
+    refresh_token_expires_in?: number;
+}
+interface ExtractUserResponse {
+    id: string;
+    avatarUrl: string;
+    email: string;
+    provider: string;
+}
+interface UserInfo extends ExtractUserResponse {
+    accessToken: string;
+    refreshToken?: string;
+    expiresIn?: number;
+}
+
+declare module 'express-serve-static-core' {
+  interface Request {
+    providerInfo?: UserInfo;
+  }
+}
+
+declare class BaseProvider {
+    protected readonly options: ProviderOptions;
+    BASE_URL: string;
+    constructor(options: ProviderOptions);
+    getAuthUrl(): string;
+    getRedirectUrl(): string;
+    extractUserInfo(data: any): ExtractUserResponse;
+    getUserFromCode(code: string): Promise<{
+        accessToken: string;
+        refreshToken: string | undefined;
+        expiresIn: number | undefined;
+        id: string;
+        avatarUrl: string;
+        email: string;
+        provider: string;
+    }>;
+    set BaseUrl(url: string);
+    get BaseUrl(): string;
+    get name(): string;
+}
+
+interface ProviderModuleOptions {
+    baseUrl: string;
+    providers: BaseProvider[];
+}
+interface ProviderModuleAsyncOptions extends Omit<FactoryProvider<ProviderModuleOptions>, 'provide'> {
+    imports: ModuleMetadata['imports'];
+}
+
+declare class ProviderModule {
+    static register(options: ProviderModuleOptions): DynamicModule;
+    static registerAsync(options: ProviderModuleAsyncOptions): DynamicModule;
+}
+
+declare const OAuthUrl: () => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+declare const OAuthCallback: () => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+export { BaseProvider, type ExtractUserResponse, OAuthCallback, OAuthUrl, type ProviderInstanceOptions, ProviderModule, type ProviderOptions, type TokensResponse, type UserInfo };

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+import { FactoryProvider, ModuleMetadata, DynamicModule } from '@nestjs/common';
+
+interface ProviderOptions {
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    scopes: string[];
+    authUrl: string;
+    tokensUrl: string;
+    userInfoUrl: string;
+}
+type ProviderInstanceOptions = Pick<ProviderOptions, 'clientId' | 'clientSecret'>;
+interface TokensResponse {
+    access_token: string;
+    refresh_token?: string;
+    expires_in?: number;
+    refresh_token_expires_in?: number;
+}
+interface ExtractUserResponse {
+    id: string;
+    avatarUrl: string;
+    email: string;
+    provider: string;
+}
+interface UserInfo extends ExtractUserResponse {
+    accessToken: string;
+    refreshToken?: string;
+    expiresIn?: number;
+}
+
+declare module 'express-serve-static-core' {
+  interface Request {
+    providerInfo?: UserInfo;
+  }
+}
+
+declare class BaseProvider {
+    protected readonly options: ProviderOptions;
+    BASE_URL: string;
+    constructor(options: ProviderOptions);
+    getAuthUrl(): string;
+    getRedirectUrl(): string;
+    extractUserInfo(data: any): ExtractUserResponse;
+    getUserFromCode(code: string): Promise<{
+        accessToken: string;
+        refreshToken: string | undefined;
+        expiresIn: number | undefined;
+        id: string;
+        avatarUrl: string;
+        email: string;
+        provider: string;
+    }>;
+    set BaseUrl(url: string);
+    get BaseUrl(): string;
+    get name(): string;
+}
+
+interface ProviderModuleOptions {
+    baseUrl: string;
+    providers: BaseProvider[];
+}
+interface ProviderModuleAsyncOptions extends Omit<FactoryProvider<ProviderModuleOptions>, 'provide'> {
+    imports: ModuleMetadata['imports'];
+}
+
+declare class ProviderModule {
+    static register(options: ProviderModuleOptions): DynamicModule;
+    static registerAsync(options: ProviderModuleAsyncOptions): DynamicModule;
+}
+
+declare const OAuthUrl: () => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+declare const OAuthCallback: () => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+export { BaseProvider, type ExtractUserResponse, OAuthCallback, OAuthUrl, type ProviderInstanceOptions, ProviderModule, type ProviderOptions, type TokensResponse, type UserInfo };