fix: remove x-total-count

Author: zzswang

openapi.json

@@ -10,7 +10,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,
@@ -19,8 +18,8 @@ import {
   ApiOperation,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common';
 import { ErrorCodes } from 'src/constants';
 
 import { CaptchaService } from './captcha.service';
@@ -62,11 +61,22 @@ export class CaptchaController {
     type: [Captcha],
   })
   @Get()
-  async list(@Query() query: ListCaptchasQuery, @Res() res: Response): Promise<CaptchaDocument[]> {
+  list(@Query() query: ListCaptchasQuery): Promise<CaptchaDocument[]> {
+    return this.captchaService.list(query);
+  }
+
+  /**
+   * Count captchas
+   */
+  @ApiOperation({ operationId: 'countCaptchas' })
+  @ApiOkResponse({
+    description: 'The count of captchas.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListCaptchasQuery): Promise<CountResult> {
     const count = await this.captchaService.count(query);
-    const data = await this.captchaService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/captcha/captcha.controller.ts

@@ -10,8 +10,6 @@ import {
   Patch,
   Post,
   Query,
-  Req,
-  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,
@@ -22,8 +20,8 @@ import {
   ApiSecurity,
   ApiTags,
 } from '@nestjs/swagger';
-import { Request, Response } from 'express';
 
+import { CountResult } from 'src/common';
 import { ErrorCodes } from 'src/constants';
 
 import { CreateEmailRecordDto } from './dto/create-email-record.dto';
@@ -60,11 +58,22 @@ export class EmailRecordController {
     type: [EmailRecord],
   })
   @Get()
-  async list(@Req() req: Request, @Query() query: ListEmailRecordsQuery, @Res() res: Response) {
+  list(@Query() query: ListEmailRecordsQuery) {
+    return this.emailRecordService.list(query);
+  }
+
+  /**
+   * Count email records
+   */
+  @ApiOperation({ operationId: 'countEmailRecords' })
+  @ApiOkResponse({
+    description: 'The count of email records.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListEmailRecordsQuery): Promise<CountResult> {
     const count = await this.emailRecordService.count(query);
-    const data = await this.emailRecordService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/email/email-record.controller.ts

@@ -11,7 +11,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import {
   ApiBearerAuth,
@@ -22,8 +21,8 @@ import {
   ApiParam,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common/entities/count.entity';
 import { ErrorCodes } from 'src/constants';
 import { NamespaceService } from 'src/namespace';
 
@@ -74,11 +73,22 @@ export class GroupController {
     type: [Group],
   })
   @Get()
-  async list(@Query() query: ListGroupsQuery, @Res() res: Response): Promise<GroupDocument[]> {
+  list(@Query() query: ListGroupsQuery): Promise<GroupDocument[]> {
+    return this.groupService.list(query);
+  }
+
+  /**
+   * Count groups
+   */
+  @ApiOperation({ operationId: 'countGroups' })
+  @ApiOkResponse({
+    description: 'The result of count groups.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListGroupsQuery): Promise<CountResult> {
     const count = await this.groupService.count(query);
-    const data = await this.groupService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/group/group.controller.ts

@@ -12,7 +12,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
   UseInterceptors,
 } from '@nestjs/common';
 import {
@@ -24,9 +23,8 @@ import {
   ApiSecurity,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
-import { SetCacheInterceptor, UnsetCacheInterceptor } from 'src/common';
+import { CountResult, SetCacheInterceptor, UnsetCacheInterceptor } from 'src/common';
 import { ErrorCodes } from 'src/constants';
 
 import { CreateNamespaceDto } from './dto/create-namespace.dto';
@@ -97,14 +95,22 @@ export class NamespaceController {
     type: [Namespace],
   })
   @Get()
-  async list(
-    @Query() query: ListNamespacesQuery,
-    @Res() res: Response
-  ): Promise<NamespaceDocument[]> {
+  list(@Query() query: ListNamespacesQuery): Promise<NamespaceDocument[]> {
+    return this.namespaceService.list(query);
+  }
+
+  /**
+   * Count namespaces
+   */
+  @ApiOperation({ operationId: 'countNamespaces' })
+  @ApiOkResponse({
+    description: 'The result of count namespaces.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListNamespacesQuery): Promise<CountResult> {
     const count = await this.namespaceService.count(query);
-    const data = await this.namespaceService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/namespace/namespace.controller.ts

@@ -11,7 +11,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,
@@ -22,8 +21,8 @@ import {
   ApiSecurity,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common/entities/count.entity';
 import { ErrorCodes } from 'src/constants';
 
 import { CreateRoleDto } from './dto/create-role.dto';
@@ -70,11 +69,22 @@ export class RoleController {
     type: [Role],
   })
   @Get()
-  async list(@Query() query: ListRolesQuery, @Res() res: Response): Promise<RoleDocument[]> {
+  list(@Query() query: ListRolesQuery): Promise<RoleDocument[]> {
+    return this.roleService.list(query);
+  }
+
+  /**
+   * Count roles
+   */
+  @ApiOperation({ operationId: 'countRoles' })
+  @ApiOkResponse({
+    description: 'The result of count roles.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListRolesQuery): Promise<CountResult> {
     const count = await this.roleService.count(query);
-    const data = await this.roleService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/role/role.controller.ts

@@ -10,7 +10,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import {
@@ -21,8 +20,8 @@ import {
   ApiSecurity,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common';
 import { ErrorCodes } from 'src/constants';
 
 import { CreateSessionDto } from './dto/create-session.dto';
@@ -62,11 +61,22 @@ export class SessionController {
     type: [Session],
   })
   @Get()
-  async list(@Query() query: ListSessionsQuery, @Res() res: Response): Promise<Session[]> {
+  list(@Query() query: ListSessionsQuery): Promise<Session[]> {
+    return this.sessionService.list(query);
+  }
+
+  /**
+   * Count sessions
+   */
+  @ApiOperation({ operationId: 'countSessions' })
+  @ApiOkResponse({
+    description: 'The count of sessions.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListSessionsQuery): Promise<CountResult> {
     const count = await this.sessionService.count(query);
-    const data = await this.sessionService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/session/session.controller.ts

@@ -10,7 +10,6 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,
@@ -21,8 +20,8 @@ import {
   ApiSecurity,
   ApiTags,
 } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common/entities/count.entity';
 import { ErrorCodes } from 'src/constants';
 
 import { CreateSmsRecordDto } from './dto/create-sms-record.dto';
@@ -59,11 +58,22 @@ export class SmsRecordController {
     type: [SmsRecord],
   })
   @Get()
-  async list(@Query() query: ListSmsRecordsQuery, @Res() res: Response) {
+  list(@Query() query: ListSmsRecordsQuery) {
+    return this.smsRecordService.list(query);
+  }
+
+  /**
+   * Count sms records
+   */
+  @ApiOperation({ operationId: 'countSmsRecords' })
+  @ApiOkResponse({
+    description: 'The count of sms records.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListSmsRecordsQuery): Promise<CountResult> {
     const count = await this.smsRecordService.count(query);
-    const data = await this.smsRecordService.list(query);
-    res.set({ 'X-Total-Count': count.toString() }).json(data);
-    return data;
+    return { count };
   }
 
   /**

src/sms/sms-record.controller.ts

@@ -8,11 +8,10 @@ import {
   Patch,
   Post,
   Query,
-  Res,
 } from '@nestjs/common';
 import { ApiCreatedResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
-import { Response } from 'express';
 
+import { CountResult } from 'src/common';
 import { ErrorCodes } from 'src/constants';
 import { UserService } from 'src/user';
 
@@ -53,14 +52,22 @@ export class ThirdPartyController {
     type: [ThirdParty],
   })
   @Get()
-  async list(
-    @Query() query: ListThirdPartyQuery,
-    @Res() res: Response
-  ): Promise<ThirdPartyDocument[]> {
+  list(@Query() query: ListThirdPartyQuery): Promise<ThirdPartyDocument[]> {
+    return this.thirdPartyService.list(query);
+  }
+
+  /**
+   * Count third party
+   */
+  @ApiOperation({ operationId: 'countThirdParty' })
+  @ApiCreatedResponse({
+    description: 'The third party record count.',
+    type: CountResult,
+  })
+  @Post('@count')
+  async count(@Query() query: ListThirdPartyQuery): Promise<CountResult> {
     const count = await this.thirdPartyService.count(query);
-    const data = await this.thirdPartyService.list(query);
-    res.set('X-Total-Count', count.toString()).json(data);
-    return data;
+    return { count };
   }
 
   /**