fix: return types

Author: csuvajit

src/links/dto/link-input.dto.ts

@@ -50,7 +50,10 @@ export class LinksDto {
 }
 
 export class MessageOkDto {
-  message: string;
+  @ApiProperty({ nullable: false, required: true })
+  message?: string;
+
+  [key: string]: unknown;
 }
 
 export class GetLinksInputDto {

src/rosters/rosters.controller.ts

@@ -14,6 +14,7 @@ import { ApiBearerAuth } from '@nestjs/swagger';
 import { Request } from 'express';
 import { JwtAuthGuard, Roles, RolesGuard, UserRoles } from '../auth';
 import { RostersEntity } from '../db';
+import { MessageOkDto } from '../links/dto';
 import {
   RemoveMembersBulkInput,
   TransferRosterMembersDto,
@@ -35,7 +36,7 @@ export class RostersController {
   }
 
   @Post('/:guildId/create')
-  createRoster(@Param('guildId') guildId: string): unknown {
+  createRoster(@Param('guildId') guildId: string): Promise<MessageOkDto> {
     return Promise.resolve({ guildId });
   }
 
@@ -48,23 +49,23 @@ export class RostersController {
   }
 
   @Patch('/:guildId/:rosterId')
-  updateRoster(@Param('rosterId') rosterId: string): unknown {
+  updateRoster(@Param('rosterId') rosterId: string): Promise<MessageOkDto> {
     return Promise.resolve({ rosterId });
   }
 
   @Delete('/:guildId/:rosterId')
-  deleteRoster(@Param('rosterId') rosterId: string, @Req() req: Request): unknown {
+  deleteRoster(@Param('rosterId') rosterId: string, @Req() req: Request): Promise<MessageOkDto> {
     console.log(req.headers);
     return Promise.resolve({ rosterId });
   }
 
   @Post('/:guildId/:rosterId/clone')
-  cloneRoster(@Param('rosterId') rosterId: string): unknown {
+  cloneRoster(@Param('rosterId') rosterId: string): Promise<MessageOkDto> {
     return Promise.resolve({ rosterId });
   }
 
   @Put('/:guildId/:rosterId/members')
-  addRosterMembers(@Param('rosterId') rosterId: string): unknown {
+  addRosterMembers(@Param('rosterId') rosterId: string): Promise<MessageOkDto> {
     return Promise.resolve({ rosterId });
   }
 
@@ -73,7 +74,7 @@ export class RostersController {
     @Param('rosterId') rosterId: string,
     @Param('guildId') guildId: string,
     @Body() body: RemoveMembersBulkInput,
-  ): unknown {
+  ): Promise<MessageOkDto> {
     return this.rostersService.deleteRosterMembers({
       rosterId,
       guildId,
@@ -82,7 +83,7 @@ export class RostersController {
   }
 
   @Post('/:guildId/:rosterId/members/refresh')
-  refreshRosterMembers(@Param('rosterId') rosterId: string): unknown {
+  refreshRosterMembers(@Param('rosterId') rosterId: string): Promise<MessageOkDto> {
     return Promise.resolve({ rosterId });
   }
 

src/tasks/tasks.controller.ts

@@ -1,6 +1,7 @@
 import { ApiExcludeRoute, ApiExcludeTypings, ApiKeyAuth } from '@app/decorators';
 import { Controller, Post, UseGuards } from '@nestjs/common';
 import { ApiKeyGuard } from '../auth/guards';
+import { MessageOkDto } from '../links/dto';
 import { TasksService } from './tasks.service';
 
 @Controller('/tasks')
@@ -12,22 +13,22 @@ export class TasksController {
   constructor(private tasksService: TasksService) {}
 
   @Post('/bulk-add-legend-players')
-  bulkAddLegendPlayers(): unknown {
+  bulkAddLegendPlayers(): Promise<MessageOkDto> {
     return this.tasksService.bulkAddLegendPlayers();
   }
 
   @Post('/seed-legend-players')
-  seedLegendPlayers(): unknown {
+  seedLegendPlayers(): Promise<MessageOkDto> {
     return this.tasksService.seedLegendPlayers();
   }
 
   @Post('/migrate-legend-players')
-  migrateLegendPlayers(): unknown {
+  migrateLegendPlayers(): Promise<MessageOkDto> {
     return this.tasksService.migrateLegendPlayers();
   }
 
   @Post('/update-legend-players')
-  updateLegendPlayers(): unknown {
+  updateLegendPlayers(): Promise<MessageOkDto> {
     return this.tasksService.updateLegendPlayers();
   }
 }

src/tasks/tasks.service.ts

@@ -95,6 +95,8 @@ export class TasksService {
       lastId = docs[docs.length - 1]._id;
       if (lastId) await this.redis.set('player_update_progress', lastId.toHexString());
     }
+
+    return { message: 'Ok' };
   }
 
   async bulkAddLegendPlayers() {

src/users/users.controller.ts

@@ -3,6 +3,7 @@ import { Controller, Get, UseGuards } from '@nestjs/common';
 import { ApiBearerAuth } from '@nestjs/swagger';
 import { JwtAuthGuard } from '../auth/guards';
 import { UsersService } from './users.service';
+import { MessageOkDto } from '../links/dto';
 
 @Controller('/users')
 @ApiBearerAuth()
@@ -12,7 +13,7 @@ export class UsersController {
   constructor(private readonly usersService: UsersService) {}
 
   @Get('/:userId')
-  async getUser(): Promise<unknown> {
+  async getUser(): Promise<MessageOkDto> {
     return Promise.resolve({ version: 'v1' });
   }
 }

src/webhook/webhook.controller.ts

@@ -10,6 +10,7 @@ import {
   Req,
 } from '@nestjs/common';
 import { InteractionType } from 'discord-interactions';
+import { MessageOkDto } from '../links/dto';
 import { WebhookService } from './webhook.service';
 
 @Controller('/webhook')
@@ -26,7 +27,7 @@ export class WebhookController {
     @Headers('X-Signature-Ed25519') signature: string,
     @Headers('X-Signature-Timestamp') timestamp: string,
     @Query('message') message: string,
-  ): unknown {
+  ): Promise<MessageOkDto> {
     return this.webhookService.handleDiscordInteractions({
       rawBody: req.rawBody as Buffer,
       interactionType: body.type as InteractionType,
@@ -37,7 +38,7 @@ export class WebhookController {
   }
 
   @Post('/patreon/incoming')
-  handlePatreonWebhook(): unknown {
-    return {};
+  handlePatreonWebhook(): Promise<MessageOkDto> {
+    return Promise.resolve({ message: 'Ok' });
   }
 }

src/webhook/webhook.service.ts

@@ -22,7 +22,7 @@ export class WebhookService {
     const discordPublicKey = this.configService.getOrThrow<string>('DISCORD_PUBLIC_KEY');
 
     const isValidRequest = await verifyKey(rawBody, signature, timestamp, discordPublicKey);
-    if (!isValidRequest) return new UnauthorizedException();
+    if (!isValidRequest) throw new UnauthorizedException();
 
     if (interactionType === InteractionType.PING) {
       return { type: InteractionResponseType.PONG };