fix: improve types and Swagger definitions

safe-global · Feb 12, 2025 · abe7bf9 · abe7bf9
1 parent dcc4b4a
commit abe7bf9
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 18 deletions.
diff --git a/src/routes/targeted-messaging/entities/targeted-safe.entity.ts b/src/routes/targeted-messaging/entities/targeted-safe.entity.ts
@@ -4,17 +4,9 @@ import type { TargetedSafe as DomainTargetedSafe } from '@/domain/targeted-messa
 export class TargetedSafe
   implements Pick<DomainTargetedSafe, 'outreachId' | 'address'>
 {
-  @ApiProperty()
-  outreachId: number;
+  @ApiProperty({ type: Number })
+  outreachId!: DomainTargetedSafe['outreachId'];
 
-  @ApiProperty()
-  address: `0x${string}`;
-
-  constructor({
-    outreachId,
-    address,
-  }: Pick<DomainTargetedSafe, 'outreachId' | 'address'>) {
-    this.outreachId = outreachId;
-    this.address = address;
-  }
+  @ApiProperty({ type: String })
+  address!: DomainTargetedSafe['address'];
 }
diff --git a/src/routes/targeted-messaging/targeted-messaging.controller.ts b/src/routes/targeted-messaging/targeted-messaging.controller.ts
@@ -1,4 +1,7 @@
-import { TargetedSafeSchema } from '@/domain/targeted-messaging/entities/targeted-safe.entity';
+import {
+  TargetedSafe as DomainTargetedSafe,
+  TargetedSafeSchema,
+} from '@/domain/targeted-messaging/entities/targeted-safe.entity';
 import { TargetedSafeNotFoundError } from '@/domain/targeted-messaging/errors/targeted-safe-not-found.error';
 import {
   CreateSubmissionDto,
@@ -21,7 +24,12 @@ import {
   Post,
   Res,
 } from '@nestjs/common';
-import { ApiCreatedResponse, ApiOkResponse, ApiTags } from '@nestjs/swagger';
+import {
+  ApiCreatedResponse,
+  ApiNotFoundResponse,
+  ApiOkResponse,
+  ApiTags,
+} from '@nestjs/swagger';
 import { Response } from 'express';
 
 @ApiTags('targeted-messaging')
@@ -33,14 +41,15 @@ export class TargetedMessagingController {
   constructor(private readonly service: TargetedMessagingService) {}
 
   @ApiOkResponse({ type: TargetedSafe })
+  @ApiNotFoundResponse({ description: 'Safe not targeted.' })
   @Get(':outreachId/chains/:chainId/safes/:safeAddress')
   async getTargetedSafe(
     @Param(
       'outreachId',
       ParseIntPipe,
       new ValidationPipe(TargetedSafeSchema.shape.outreachId),
     )
-    outreachId: number,
+    outreachId: DomainTargetedSafe['outreachId'],
     @Param('chainId', new ValidationPipe(NumericStringSchema)) chainId: string,
     @Param('safeAddress', new ValidationPipe(AddressSchema))
     safeAddress: `0x${string}`,

diff --git a/src/routes/targeted-messaging/targeted-messaging.service.ts b/src/routes/targeted-messaging/targeted-messaging.service.ts
@@ -14,15 +14,15 @@ export class TargetedMessagingService {
   ) {}
 
   async getTargetedSafe(args: {
-    outreachId: number;
+    outreachId: TargetedSafe['outreachId'];
     chainId: string;
     safeAddress: `0x${string}`;
   }): Promise<RouteTargetedSafe> {
     const targetedSafe = await this.repository.getTargetedSafe(args);
-    return new RouteTargetedSafe({
+    return {
       outreachId: targetedSafe.outreachId,
       address: targetedSafe.address,
-    });
+    };
   }
 
   async getSubmission(args: {