Swagger Integration

.eslintrc.js

@@ -6,10 +6,7 @@ module.exports = {
  sourceType: 'module',
  },
  plugins: ['@typescript-eslint/eslint-plugin'],
- extends: [
- 'plugin:@typescript-eslint/recommended',
- 'plugin:prettier/recommended',
- ],
+ extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
  root: true,
  env: {
  node: true,
@@ -21,5 +18,13 @@ module.exports = {
  '@typescript-eslint/explicit-function-return-type': 'off',
  '@typescript-eslint/explicit-module-boundary-types': 'off',
  '@typescript-eslint/no-explicit-any': 'off',
+ '@typescript-eslint/no-unused-vars': [
+ 'error',
+ {
+ argsIgnorePattern: '^_',
+ varsIgnorePattern: '^_',
+ caughtErrorsIgnorePattern: '^_',
+ },
+ ],
  },
 };

apps/service-auth/src/app.module.ts

@@ -4,6 +4,8 @@ import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
 import { AuthModule } from './auth/auth.module';
 import { ClansModule } from './clans/clans.module';
+import { GuildsModule } from './guilds/guilds.module';
+import { LinksModule } from './links/links.module';
 
 @Module({
  imports: [
@@ -12,6 +14,8 @@ import { ClansModule } from './clans/clans.module';
  RedisModule,
  ClansModule,
  AuthModule,
+ GuildsModule,
+ LinksModule,
  ],
  controllers: [],
  providers: [],

apps/service-auth/src/auth/auth.controller.ts

@@ -1,28 +1,34 @@
 import { CurrentUser, JwtAuthGuard, JwtUser } from '@app/auth';
 import { getAppHealth } from '@app/helper';
 import { Body, Controller, Get, Post, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiExcludeEndpoint, ApiTags } from '@nestjs/swagger';
 import { AuthService } from './auth.service';
+import { LoginInput } from './dto/login.dto';
 
+@ApiTags('AUTH')
 @Controller('/auth')
 export class AuthController {
  constructor(private authService: AuthService) {}
 
+ @ApiExcludeEndpoint()
  @Get()
  ack() {
  return { message: `Hello from ${AuthController.name}` };
  }
 
+ @ApiExcludeEndpoint()
  @Get('/health')
  stats() {
  return getAppHealth(AuthController.name);
  }
 
  @Post('/login')
- async login(@Body('password') password: string) {
- return this.authService.login(password);
+ async login(@Body() body: LoginInput) {
+ return this.authService.login(body.passkey);
  }
 
  @UseGuards(JwtAuthGuard)
+ @ApiBearerAuth()
  @Get('/status')
  getStatus(@CurrentUser() user: JwtUser) {
  return user;

apps/service-auth/src/auth/dto/login.dto.ts

@@ -0,0 +1,6 @@
+import { IsNotEmpty } from 'class-validator';
+
+export class LoginInput {
+ @IsNotEmpty()
+ passkey: string;
+}

apps/service-auth/src/clans/clans.controller.ts

@@ -0,0 +1,14 @@
+import { JwtAuthGuard } from '@app/auth';
+import { Controller, Get, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
+
+@ApiTags('CLANS')
+@ApiBearerAuth()
+@Controller('/clans')
+@UseGuards(JwtAuthGuard)
+export class ClansController {
+ @Get()
+ getHello() {
+ return {};
+ }
+}

apps/service-auth/src/clans/clans.module.ts

@@ -1,4 +1,9 @@
 import { Module } from '@nestjs/common';
+import { ClansService } from './clans.service';
+import { ClansController } from './clans.controller';
 
-@Module({})
+@Module({
+ providers: [ClansService],
+ controllers: [ClansController],
+})
 export class ClansModule {}

apps/service-auth/src/clans/clans.service.ts

@@ -0,0 +1,4 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class ClansService {}

apps/service-auth/src/guilds/dto/update-clan-categories.dto.ts

@@ -0,0 +1,32 @@
+import { IsInt, IsNotEmpty, ValidateNested } from 'class-validator';
+
+export class ReorderCategoriesInput {
+ @IsNotEmpty()
+ _id: string;
+
+ @IsNotEmpty()
+ name: string;
+
+ @IsInt()
+ order: number;
+
+ @ValidateNested({ each: true })
+ clans: ReorderClansInput[];
+}
+
+export class ReorderClansInput {
+ @IsNotEmpty()
+ _id: string;
+
+ @IsInt()
+ order: number;
+
+ @IsNotEmpty()
+ tag: string;
+
+ @IsNotEmpty()
+ name: string;
+
+ @IsNotEmpty()
+ guildId: string;
+}

apps/service-auth/src/guilds/guilds.controller.ts

@@ -0,0 +1,34 @@
+import { JwtAuthGuard } from '@app/auth';
+import { Body, Controller, Get, Param, Put, Query, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiBody, ApiTags } from '@nestjs/swagger';
+import { ReorderCategoriesInput } from './dto/update-clan-categories.dto';
+import { GuildsService } from './guilds.service';
+
+@ApiTags('GUILDS')
+@Controller('/guilds')
+@ApiBearerAuth()
+@UseGuards(JwtAuthGuard)
+export class GuildsController {
+ constructor(private guildsService: GuildsService) {}
+
+ @Get('/:guildId/clans')
+ getGuildMembers(@Param('guildId') guildId: string, @Query('q') q: string) {
+ return this.guildsService.getMembers(guildId, q);
+ }
+
+ @Get('/:guildId/clans')
+ getClans(@Param('guildId') guildId: string) {
+ return this.guildsService.getClans(guildId);
+ }
+
+ @Get('/:guildId/clans-and-categories')
+ getClansWithCategories(@Param('guildId') guildId: string) {
+ return this.guildsService.getClans(guildId);
+ }
+
+ @Put('/:guildId/reorder-clans')
+ @ApiBody({ type: ReorderCategoriesInput, isArray: true })
+ updateClansAndCategories(@Param('guildId') guildId: string, @Body() _: ReorderCategoriesInput[]) {
+ return this.guildsService.getClans(guildId);
+ }
+}

apps/service-auth/src/guilds/guilds.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { GuildsController } from './guilds.controller';
+import { GuildsService } from './guilds.service';
+
+@Module({
+ controllers: [GuildsController],
+ providers: [GuildsService],
+})
+export class GuildsModule {}

apps/service-auth/src/guilds/guilds.service.ts

@@ -0,0 +1,14 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class GuildsService {
+ constructor() {}
+
+ getMembers(guildId: string, q: string) {
+ return [guildId, q];
+ }
+
+ getClans(guildId: string) {
+ return [guildId];
+ }
+}

apps/service-auth/src/links/dto/bulk-links.dto.ts

@@ -0,0 +1,7 @@
+import { ArrayMaxSize, IsString } from 'class-validator';
+
+export class BulkLinksDto {
+ @IsString({ each: true })
+ @ArrayMaxSize(1000)
+ input: string[];
+}

apps/service-auth/src/links/dto/create-links.dto.ts

@@ -0,0 +1,21 @@
+import { IsNotEmpty } from 'class-validator';
+
+export class CreateLinkInput {
+ @IsNotEmpty()
+ name: string;
+
+ @IsNotEmpty()
+ tag: string;
+
+ @IsNotEmpty()
+ userId: string;
+
+ @IsNotEmpty()
+ username: string;
+
+ @IsNotEmpty()
+ displayName: string;
+
+ @IsNotEmpty()
+ discriminator: string;
+}

apps/service-auth/src/links/dto/delete-link.dto.ts

@@ -0,0 +1,9 @@
+import { IsNotEmpty } from 'class-validator';
+
+export class DeleteLinkInput {
+ @IsNotEmpty()
+ clanTag: string;
+
+ @IsNotEmpty()
+ playerTag: string;
+}

apps/service-auth/src/links/links.controller.ts

@@ -0,0 +1,35 @@
+import { CurrentUser, JwtAuthGuard, JwtUser } from '@app/auth';
+import { Body, Controller, Delete, Get, Param, Post, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
+import { BulkLinksDto } from './dto/bulk-links.dto';
+import { CreateLinkInput } from './dto/create-links.dto';
+import { DeleteLinkInput } from './dto/delete-link.dto';
+import { LinksService } from './links.service';
+
+@ApiTags('LINKS')
+@Controller('/links')
+@ApiBearerAuth()
+@UseGuards(JwtAuthGuard)
+export class LinksController {
+ constructor(private linksService: LinksService) {}
+
+ @Post('/')
+ async createLink(@Body() body: CreateLinkInput) {
+ return this.linksService.createLink(body);
+ }
+
+ @Delete('/')
+ async deleteLink(@CurrentUser() user: JwtUser, @Body() body: DeleteLinkInput) {
+ return this.linksService.deleteLink(user.sub, body);
+ }
+
+ @Get('/:userIdOrTag')
+ getLink(@Param('userIdOrTag') userIdOrTag: string) {
+ return this.linksService.getLink(userIdOrTag);
+ }
+
+ @Post('/bulk')
+ getLinks(@Body() body: BulkLinksDto) {
+ return this.linksService.getLinks(body.input);
+ }
+}

apps/service-auth/src/links/links.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { LinksController } from './links.controller';
+import { LinksService } from './links.service';
+
+@Module({
+ controllers: [LinksController],
+ providers: [LinksService],
+})
+export class LinksModule {}

apps/service-auth/src/links/links.service.ts

@@ -0,0 +1,22 @@
+import { Injectable } from '@nestjs/common';
+import { CreateLinkInput } from './dto/create-links.dto';
+import { DeleteLinkInput } from './dto/delete-link.dto';
+
+@Injectable()
+export class LinksService {
+ createLink(input: CreateLinkInput) {
+ return input;
+ }
+
+ deleteLink(userId: string, input: DeleteLinkInput) {
+ return { userId, input };
+ }
+
+ getLink(userIdOrTag: string) {
+ return [userIdOrTag];
+ }
+
+ getLinks(playerTags: string[]) {
+ return [playerTags];
+ }
+}

apps/service-auth/src/main.ts

@@ -1,10 +1,23 @@
-import { Logger } from '@nestjs/common';
+import { Logger, ValidationPipe } from '@nestjs/common';
 import { NestFactory } from '@nestjs/core';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
  const app = await NestFactory.create(AppModule);
- const logger = new Logger('NestApplication');
+ const logger = new Logger(AppModule.name);
+
+ const config = new DocumentBuilder()
+ .setTitle('Service Auth API')
+ .setDescription('Public and private routes for the Service Auth')
+ .setVersion('1.0')
+ .addBearerAuth()
+ .addTag('AUTH')
+ .build();
+ const document = SwaggerModule.createDocument(app, config);
+ SwaggerModule.setup('/', app, document);
+
+ app.useGlobalPipes(new ValidationPipe({ transform: true }));
 
  const port = process.env.PORT || 8081;
  await app.listen(port);

libs/auth/src/decorators/roles.decorator.ts

@@ -3,6 +3,7 @@ import { CustomDecorator, SetMetadata } from '@nestjs/common';
 export enum Role {
  USER = 'user',
  ADMIN = 'admin',
+ VIEWER = 'viewer',
 }
 
 export const ROLES_KEY = 'roles';

nest-cli.json

@@ -3,6 +3,9 @@
  "collection": "@nestjs/schematics",
  "sourceRoot": "apps/service-auth/src",
  "compilerOptions": {
+ "plugins": [
+ "@nestjs/swagger"
+ ],
  "deleteOutDir": true,
  "webpack": true,
  "tsConfigPath": "apps/service-auth/tsconfig.app.json"