\n\n\nTable of content (click to expand)\n\n\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Learnings](#learnings)\n- [Contributing](#contributing)\n \n \n\n## Installation\n\nInstallation is as simple as running:\n\n`npm install @cafrotos/nestjs-oauth2-server`\n\nor\n\n`yarn add @cafrotos/nestjs-oauth2-server`.\n\n## Configuration\n\n1. Include the module as a dependency in the module where pdf will be generated:\n\n`app.module.ts`\n\n```ts\nimport { Module } from '@nestjs/common';\nimport { OAuth2ServerModule } from '@cafrotos/nestjs-oauth2-server';\n\n@Module({\n imports: [\n // ... other modules\n OAuth2ServerModule.forRoot({}),\n ],\n})\nexport class AppModule {}\n```\n\nIn addition to the above the, **oauth2-server** requires a [model](https://oauth2-server.readthedocs.io/en/latest/model/overview.html) to create the server. This can be provided as a service from any part of the application. This should be able to fetch data about clients, users, token, and authorization codes. This **MUST** be a service decorated with the `OAuth2Model` decorator.\n\n```ts\nimport { OAuth2Model } from '@cafrotos/nestjs-oauth2-server';\n\n@OAuth2Model()\nexport class OAuth2ModelService\n implements RequestAuthenticationModel {\n getAccessToken() {}\n\n verifyScope() {}\n // ...\n}\n```\n\n## Usage\n\nThe module also provides some nifty decorators to help with configuring the oauth2 handler endpoints. An example controller covering the entire array of decorators is given below\n\n```ts\nimport { Controller } from '@nestjs/common';\nimport {} from '@cafrotos/nestjs-oauth2-server';\n\n@Controller()\nexport class ExampleController {\n @Post()\n @OAuth2Authenticate()\n authenticateClient(@OAuth2Token() token: Token) {\n return of(token);\n }\n\n @OAuth2Authorize()\n @Post()\n authorizeClient(\n @OAuth2Authorization()\n authorization: AuthorizationCode,\n ) {\n return of(authorization);\n }\n\n @Post()\n @OAuth2RenewToken()\n renewToken(@OAuth2Token() token: Token) {\n return of(token);\n }\n}\n```\n\n## Async Configuration\n\nThe module could also be included asynchronously using the `forRootAsync` method.\n\nExamples below:\n\n- Using factory provider approach\n\n```ts\nimport { Module } from '@nestjs/common';\nimport {\n OAuth2ServerModule,\n IOAuth2ServerModuleOptions,\n} from '@cafrotos/nestjs-oauth2-server';\n\n@Module({\n imports: [\n // ... other modules\n OAuth2ServerModule.forRootAsync({\n useFactory: (): IOAuth2ServerModuleOptions => ({}),\n }),\n ],\n})\nexport class AppModule {}\n```\n\n- Using class or existing provider approach:\n\n`./oauth2-server-config.service.ts`\n\n```ts\nimport {\n IOAuth2ServerModuleOptions,\n IOAuth2ServerOptionsFactory,\n} from '@cafrotos/nestjs-oauth2-server';\nimport { Injectable } from '@nestjs/common';\n\n@Injectable()\nexport class OAuth2ServerConfigService\n implements IOAuth2ServerOptionsFactory {\n createOAuth2ServerOptions(): IOAuth2ServerModuleOptions {\n return {};\n }\n}\n```\n\nThe `OAuth2ServerConfigService` **SHOULD** implement the `IOAuth2ServerOptionsFactory`, **MUST** declare the `createOAuth2ServerOptions` method and **MUST** return `IOAuth2ServerModuleOptions` object.\n\n```ts\nimport { Module } from '@nestjs/common';\nimport { OAuth2ServerModule } from '@cafrotos/nestjs-oauth2-server';\nimport { OAuth2ServerConfigService } from './oauth2-server-config.service.ts';\n\n@Module({\n imports: [\n // ... other modules\n OAuth2ServerModule.forRootAsync({\n useClass: OAuth2ServerConfigService,\n }),\n ],\n})\nexport class AppModule {}\n```\n\n## Learnings\n\nThe concept of OAuth2 can be further understood in this article [here](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2). Also you can head over to the oauth2-server package [documentation](package)\n\n## Contributing\n\nSuggestions for improvement are welcomed, however, please adhere to the [contributing](./Contributing.md) guidelines\n\n[package]: https://oauth2-server.readthedocs.io/en/latest/index.html\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n ![\"OAuth2](\"https://github.com/toondaey/nestjs-oauth2-server/blob/master/oauth2.png?raw=true\")
\n![\"npm\"](\"https://img.shields.io/npm/dm/@cafrotos/nestjs-oauth2-server\")
![\"Coveralls](\"https://img.shields.io/coveralls/github/toondaey/nestjs-oauth2-server\")
![\"npm](\"https://img.shields.io/npm/v/@cafrotos/nestjs-oauth2-server?label=NPM&logo=NPM\")
![\"LICENCE\"](\"https://img.shields.io/npm/l/@cafrotos/nestjs-oauth2-server\")
![\"CircleCI](\"https://img.shields.io/circleci/build/gh/toondaey/nestjs-oauth2-server/master\")
![\"synk](\"https://img.shields.io/snyk/vulnerabilities/npm/@cafrotos/nestjs-oauth2-server\")