refactor project interfaces and DTOs for improved clarity and validation

src/app.ts

@@ -71,18 +71,7 @@ spec.paths = Object.keys(spec.paths).reduce(
   {} as Record<string, any>,
 );
 
-app.use('/docs', ...swaggerUi.serve, (req, res, next) => {
-  const baseUrl = `${req.protocol}://${req.get('host')}${req.baseUrl}`;
-
-  spec.servers = [
-    {
-      url: `${baseUrl}/v1`,
-      description: 'Dynamic Server',
-    },
-  ];
-
-  swaggerUi.setup(spec)(req, res, next);
-});
+app.use('/docs', ...swaggerUi.serve, swaggerUi.setup(spec));
 
 useExpressServer(app, {
   routePrefix: '/v1',

src/modules/auth/auth.service.ts

@@ -168,7 +168,7 @@ export class AuthService {
   }
 
   async getCurrentUser(token: string): Promise<AuthData> {
-    token = token.slice(7);
+    // token = token.slice(7);
     if (token.startsWith('bta_')) {
       return this.authenticateProjectApiToken(token);
     }

src/modules/project/dto/create-project.dto.ts

@@ -11,6 +11,9 @@ export class CreateProjectDto {
   @MinLength(3, {
     message: 'Project name must be more than 3 characters',
   })
+  @MaxLength(20, {
+    message: 'Project name must be more than 3 characters',
+  })
   name: string;
 
   @IsString()
@@ -21,7 +24,7 @@ export class CreateProjectDto {
     message:
       'Project slug must start with a small letter and contain only small letters, numbers and dashes',
   })
-  @MaxLength(50, {
+  @MaxLength(30, {
     message: 'Project slug must be less than 50 characters',
   })
   slug: string;

src/modules/project/dto/generate-project-api-key.dto.ts

@@ -12,7 +12,6 @@ export class GenerateProjectApiKeyDto {
   })
   name: string;
 
-  @IsString()
   @IsNotEmpty({
     message: 'Api Key expire time not provided',
   })

src/modules/project/project.controller.ts

@@ -1,5 +1,5 @@
-import { request } from 'express';
-import { Authorized, Body, Delete, Get, JsonController, Post, Put } from 'routing-controllers';
+import { Request } from 'express';
+import { Body, Delete, Get, JsonController, Param, Post, Put, Req } from 'routing-controllers';
 import { Inject, Service } from 'typedi';
 
 import { JsonResponse } from '../shared';
@@ -39,15 +39,16 @@ import { ProjectService } from './project.service';
 
 @Service()
 @JsonController('/projects')
-@Authorized()
 export class ProjectController {
   constructor(@Inject() private readonly projectService: ProjectService) {}
 
   @Post('/')
   async create(
     @Body({ validate: true }) payload: CreateProjectDto,
+    @Req() request: Request,
   ): Promise<JsonResponse<CreateProjectResponse>> {
-    const response = await this.projectService.create(payload as CreateProjectRequest);
+    const authData = request.auth;
+    const response = await this.projectService.create(payload as CreateProjectRequest, authData);
     return {
       data: response,
       status: 'successful',
@@ -56,7 +57,7 @@ export class ProjectController {
   }
 
   @Get('/')
-  async list(): Promise<JsonResponse<ListProjectResponse>> {
+  async list(@Req() request: Request): Promise<JsonResponse<ListProjectResponse>> {
     const authData = request.auth;
     const response = await this.projectService.list(authData);
     return {
@@ -67,7 +68,10 @@ export class ProjectController {
   }
 
   @Get('/:projectId')
-  async get(projectId: number): Promise<JsonResponse<ProjectDetailsResponse>> {
+  async get(
+    @Param('projectId') projectId: number,
+    @Req() request: Request,
+  ): Promise<JsonResponse<ProjectDetailsResponse>> {
     const authData = request.auth;
     const response = await this.projectService.get(projectId, authData);
     return {
@@ -78,7 +82,10 @@ export class ProjectController {
   }
 
   @Delete('/:projectId')
-  async delete(projectId: number): Promise<JsonResponse> {
+  async delete(
+    @Param('projectId') projectId: number,
+    @Req() request: Request,
+  ): Promise<JsonResponse> {
     const authData = request.auth;
     const response = await this.projectService.delete(projectId, authData);
     return {
@@ -90,7 +97,8 @@ export class ProjectController {
   @Post('/:projectId/api-key')
   async generateApiKey(
     @Body({ validate: true }) payload: GenerateProjectApiKeyDto,
-    projectId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
   ): Promise<JsonResponse<GenerateProjectApiKeyResponse>> {
     const authData = request.auth;
     const response = await this.projectService.generateApiKey(
@@ -106,7 +114,10 @@ export class ProjectController {
   }
 
   @Get('/:projectId/api-key')
-  async listApiKeys(projectId: number): Promise<JsonResponse<ListApiKeysResponse>> {
+  async listApiKeys(
+    @Param('projectId') projectId: number,
+    @Req() request: Request,
+  ): Promise<JsonResponse<ListApiKeysResponse>> {
     const authData = request.auth;
     const response = await this.projectService.listApiKeys(projectId, authData);
     return {
@@ -117,7 +128,11 @@ export class ProjectController {
   }
 
   @Delete('/:projectId/api-key/:apiKeyId')
-  async revokeApiKey(projectId: number, apiKeyId: number): Promise<JsonResponse> {
+  async revokeApiKey(
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('apiKeyId') apiKeyId: number,
+  ): Promise<JsonResponse> {
     const authData = request.auth;
     this.projectService.revokeApiKey(projectId, apiKeyId, authData);
 
@@ -129,8 +144,9 @@ export class ProjectController {
 
   @Post('/:projectId/collection')
   async createCollection(
+    @Req() request: Request,
     @Body({ validate: true }) payload: CreateProjectCollectionDto,
-    projectId: number,
+    @Param('projectId') projectId: number,
   ): Promise<JsonResponse<CreateProjectCollectionResponse>> {
     const authData = request.auth;
     const response = await this.projectService.createCollection(
@@ -146,7 +162,10 @@ export class ProjectController {
   }
 
   @Get('/:projectId/collection')
-  async listCollection(projectId: number): Promise<JsonResponse<ListProjectCollectionsResponse>> {
+  async listCollection(
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+  ): Promise<JsonResponse<ListProjectCollectionsResponse>> {
     const authData = request.auth;
     const response = await this.projectService.listCollections(projectId, authData);
 
@@ -159,8 +178,9 @@ export class ProjectController {
 
   @Get('/:projectId/collection/:collectionId')
   async getCollection(
-    projectId: number,
-    collectionId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('collectionId') collectionId: number,
   ): Promise<JsonResponse<GetProjectCollectionByIdResponse>> {
     const authData = request.auth;
     const response = await this.projectService.getCollection(projectId, collectionId, authData);
@@ -173,8 +193,8 @@ export class ProjectController {
 
   @Get('/:projectId/collection/:collectionId/data')
   async getCollectionData(
-    projectId: number,
-    collectionId: number,
+    @Param('projectId') projectId: number,
+    @Param('collectionId') collectionId: number,
   ): Promise<JsonResponse<GetCollectionDataResponse>> {
     const response = await this.projectService.getCollectionData(projectId, collectionId);
     return {
@@ -186,8 +206,9 @@ export class ProjectController {
 
   @Put('/:projectId/collection/:collectionId')
   async updateCollection(
-    projectId: number,
-    collectionId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('collectionId') collectionId: number,
     @Body({ validate: true }) payload: UpdateProjectCollectionDto,
   ): Promise<JsonResponse> {
     const authData = request.auth;
@@ -203,12 +224,20 @@ export class ProjectController {
     };
   }
 
-  @Post('/:projectId')
+  @Put('/:projectId/collection/:collectionId/register-device')
   async registerDevice(
-    projectId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('collectionId') collectionId: number,
     @Body({ validate: true }) payload: RegisterDeviceDto,
   ): Promise<JsonResponse> {
-    const response = await this.registerDevice(projectId, payload);
+    const authData = request.auth;
+    const response = await this.projectService.registerDevice(
+      projectId,
+      collectionId,
+      authData,
+      payload,
+    );
     return {
       status: response ? 'successful' : 'error',
       message: response ? 'Device Successfully Registered' : 'Unable to register device',
@@ -217,7 +246,8 @@ export class ProjectController {
 
   @Post('/:projectId/invitations')
   async inviteProjectUser(
-    projectId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
     @Body({ validate: true }) payload: InviteProjectUserDto,
   ): Promise<JsonResponse> {
     await this.projectService.inviteUser(
@@ -233,6 +263,8 @@ export class ProjectController {
 
   @Post('/:projectId/invitations/accept')
   async acceptProjectInvitation(
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
     @Body({ validate: true })
     payload: AcceptProjectInvitationDto,
   ): Promise<JsonResponse> {
@@ -243,11 +275,12 @@ export class ProjectController {
     };
   }
 
-  @Delete('/:project/invitations/cancel')
+  @Delete('/:projectId/invitations/cancel')
   async cancelProjectInvitation(
+    @Req() request: Request,
     @Body({ validate: true })
     payload: CancelProjectInvitationDto,
-    projectId: number,
+    @Param('projectId') projectId: number,
   ): Promise<JsonResponse> {
     await this.projectService.cancelInvite(
       projectId,
@@ -260,9 +293,10 @@ export class ProjectController {
     };
   }
 
-  @Get('/:project/invitations/')
+  @Get('/:projectId/invitations/')
   async listProjectInvitations(
-    projectId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
   ): Promise<JsonResponse<listProjectInvitationResponse>> {
     const response = await this.projectService.listInvites(projectId, request.auth);
     return {
@@ -273,7 +307,10 @@ export class ProjectController {
   }
 
   @Get('/:projectId/users')
-  async listProjectUser(projectId: number): Promise<JsonResponse<listProjectUsersResponse>> {
+  async listProjectUser(
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+  ): Promise<JsonResponse<listProjectUsersResponse>> {
     const response = await this.projectService.listUsers(projectId, request.auth);
     return {
       status: 'successful',
@@ -284,8 +321,9 @@ export class ProjectController {
 
   @Delete('/:projectId/users/:userId')
   async removeProjectUser(
-    projectId: number,
-    userId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('userId') userId: number,
   ): Promise<JsonResponse<listProjectUsersResponse>> {
     await this.projectService.removeUser(projectId, userId, request.auth);
     return {
@@ -296,8 +334,9 @@ export class ProjectController {
 
   @Put('/:projectId/users/:userId')
   async updateProjectUser(
-    projectId: number,
-    userId: number,
+    @Req() request: Request,
+    @Param('projectId') projectId: number,
+    @Param('userId') userId: number,
     @Body({ validate: true }) payload: UpdateProjectUserPermissionDto,
   ): Promise<JsonResponse<listProjectUsersResponse>> {
     await this.projectService.updateUserPermission(

src/modules/project/project.interface.ts

@@ -17,7 +17,6 @@ export interface CreateProjectResponse {
 export interface CreateProjectRequest {
   name: string;
   slug: string;
-  authData: AuthData;
 }
 
 export type ListProjectResponse = ProjectForUserDTO[];