10 naming

src/app.module.ts

@@ -6,7 +6,7 @@ import { AppService } from './app.service';
 import { AuthModule } from './auth/auth.module';
 import { AppConfig, DatabaseConfig } from './config';
 import { EventModule } from './resource/event/event.module';
-import { NoteModule } from './resource/notes/notes.module';
+import { NoteModule } from './resource/note/note.module';
 import { SearchModule } from './resource/search/search.module';
 import { TaskModule } from './resource/task/task.module';
 import { UserModule } from './resource/user/user.module';

src/decorators/OpenAPI/event.decorators.ts

@@ -39,7 +39,7 @@ export function GetEventExceptionByIdApi() {
     );
 }
 
-export function CreateEventByCurrentUserApi() {
+export function AddEventApi() {
     return applyDecorators(
         ApiCreatedResponse({ type: ReturnEventDTO }),
         ApiNotFoundResponse({ description: 'Event not found' }),

src/decorators/OpenAPI/index.ts

@@ -1,6 +1,6 @@
 export * from './auth.decorators';
 export * from './event.decorators';
-export * from './notes.decorators';
+export * from './note.decorators';
 export * from './search.decorators';
 export * from './task.decorators';
 export * from './user.decorators';

src/decorators/OpenAPI/notes.decorators.ts → src/decorators/OpenAPI/note.decorators.ts

@@ -6,9 +6,9 @@ import {
     ApiNotFoundResponse,
     ApiOkResponse,
 } from '@nestjs/swagger';
-import { editNoteDTO, NoteDTO } from '../../resource/notes/dto';
+import { editNoteDTO, NoteDTO } from '../../resource/note/dto';
 
-export function FetchUserNotesApi() {
+export function GetUserNotesApi() {
     return applyDecorators(ApiOkResponse({ type: [NoteDTO] }));
 }
 
@@ -21,7 +21,7 @@ export function AddNoteApi() {
     );
 }
 
-export function EditNoteByIdApi() {
+export function EditNoteApi() {
     return applyDecorators(
         ApiOkResponse(),
         ApiBadRequestResponse({ description: 'Invalid body' }),

src/decorators/OpenAPI/task.decorators.ts

@@ -13,11 +13,11 @@ import {
     ReturnTaskDTO,
 } from '../../resource/task/dto';
 
-export function GetAllUserTasksApi() {
+export function GetUserTasksApi() {
     return applyDecorators(ApiOkResponse({ type: [ReturnTaskDTO] }));
 }
 
-export function GetUserTaskApi() {
+export function GetTaskByIdApi() {
     return applyDecorators(
         ApiOkResponse({ type: ReturnTaskDTO }),
         ApiNotFoundResponse({ description: 'Task not found' }),

src/resource/event/event.controller.ts

@@ -20,7 +20,7 @@ import { JwtGuard } from 'src/auth/guard';
 import { GetUser } from 'src/decorators';
 import {
     AddEventExceptionApi,
-    CreateEventByCurrentUserApi,
+    AddEventApi,
     DeleteEventApi,
     DeleteExceptionApi,
     EditEventApi,
@@ -54,7 +54,7 @@ export class EventController {
     async getUserEvents(
         @GetUser('id') userId: number,
     ): Promise<ReturnEventDTO[]> {
-        return await this.eventService.fetchUserEvents(userId);
+        return await this.eventService.fetchByUser(userId);
     }
 
     @Get('dates')
@@ -86,12 +86,12 @@ export class EventController {
     }
 
     @Post()
-    @CreateEventByCurrentUserApi()
-    async createEventByCurrentUser(
+    @AddEventApi()
+    async addEvent(
         @GetUser('id') userId: number,
         @Body() eventDto: CreateEventDTO,
     ): Promise<ReturnEventDTO> {
-        return await this.eventService.createEvent(userId, eventDto);
+        return await this.eventService.add(userId, eventDto);
     }
 
     @Post('exceptions/:id')
@@ -100,7 +100,7 @@ export class EventController {
         @Param('id') eventId: number,
         @Body() exceptionDto: CreateEventExceptionDTO,
     ): Promise<ReturnEventExceptionDTO> {
-        return await this.eventService.createException(eventId, exceptionDto);
+        return await this.eventService.addException(eventId, exceptionDto);
     }
 
     @Patch(':id')
@@ -109,7 +109,7 @@ export class EventController {
         @Param('id') eventId: number,
         @Body() editEventDto: EditEventDTO,
     ): Promise<ReturnEventDTO> {
-        return await this.eventService.editById(eventId, editEventDto);
+        return await this.eventService.edit(eventId, editEventDto);
     }
 
     @Patch('exceptions/:id')
@@ -118,7 +118,7 @@ export class EventController {
         @Param('id') exceptionId: number,
         @Body() editExceptionDto: EditEventExceptionDTO,
     ): Promise<ReturnEventExceptionDTO> {
-        return await this.eventService.editExceptionById(
+        return await this.eventService.editException(
             exceptionId,
             editExceptionDto,
         );
@@ -128,13 +128,13 @@ export class EventController {
     @Delete(':id')
     @DeleteEventApi()
     async deleteEvent(@Param('id') eventId: number): Promise<void> {
-        await this.eventService.deleteById(eventId);
+        await this.eventService.delete(eventId);
     }
 
     @HttpCode(HttpStatus.NO_CONTENT)
     @Delete('exceptions/:id')
     @DeleteExceptionApi()
     async deleteException(@Param('id') exceptionId: number): Promise<void> {
-        await this.eventService.removeExceptionById(exceptionId);
+        await this.eventService.deleteException(exceptionId);
     }
 }

src/resource/event/event.service.ts

@@ -42,7 +42,7 @@ export class EventService {
         return event;
     }
 
-    async fetchUserEvents(userId: number): Promise<ReturnEventDTO[]> {
+    async fetchByUser(userId: number): Promise<ReturnEventDTO[]> {
         return this.eventRepository.find({
             where: { createdById: userId },
             relations: { recurrencePattern: true, eventExceptions: true },
@@ -182,7 +182,7 @@ export class EventService {
         return exception;
     }
 
-    async createEvent(
+    async add(
         userId: number,
         eventDto: CreateEventDTO,
     ): Promise<ReturnEventDTO> {
@@ -194,7 +194,7 @@ export class EventService {
         return event;
     }
 
-    async createException(
+    async addException(
         eventId: number,
         exceptionDto: CreateEventExceptionDTO,
     ): Promise<ReturnEventExceptionDTO> {
@@ -206,7 +206,7 @@ export class EventService {
         return exception;
     }
 
-    async editById(
+    async edit(
         eventId: number,
         editEventDto: EditEventDTO,
     ): Promise<ReturnEventDTO> {
@@ -228,7 +228,7 @@ export class EventService {
         return eventToUpdate;
     }
 
-    async editExceptionById(
+    async editException(
         exceptionId: number,
         editExceptionDto: EditEventExceptionDTO,
     ): Promise<ReturnEventExceptionDTO> {
@@ -245,11 +245,11 @@ export class EventService {
         return exceptionToUpdate;
     }
 
-    async deleteById(eventId: number): Promise<void> {
+    async delete(eventId: number): Promise<void> {
         await this.eventRepository.delete({ id: eventId });
     }
 
-    async removeExceptionById(exceptionId: number): Promise<void> {
+    async deleteException(exceptionId: number): Promise<void> {
         await this.exceptionRepository.delete({ id: exceptionId });
     }
 }

src/resource/notes/dto/index.ts → src/resource/note/dto/index.ts

@@ -1,2 +1,2 @@
-export * from './notes.dto';
+export * from './note.dto';
 export * from './editNote.dto';

src/resource/notes/notes.controller.ts → src/resource/note/note.controller.ts

@@ -7,16 +7,16 @@ import {
     Post,
     UseGuards,
 } from '@nestjs/common';
-import { NoteService } from './notes.service';
+import { NoteService } from './note.service';
 import { editNoteDTO, NoteDTO } from './dto';
 import { JwtGuard } from '../../auth/guard';
 import { GetUser } from '../../decorators';
 import { UserEntity } from 'src/database/entities/user.entity';
 import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
 import {
     AddNoteApi,
-    EditNoteByIdApi,
-    FetchUserNotesApi,
+    EditNoteApi,
+    GetUserNotesApi
 } from '../../decorators/OpenAPI';
 
 @UseGuards(JwtGuard)
@@ -27,20 +27,20 @@ export class NoteController {
     constructor(private notesService: NoteService) {}
 
     @Get()
-    @FetchUserNotesApi()
-    fetchUserNotes(@GetUser() user: UserEntity) {
-        return this.notesService.fetchUserNotes(user);
+    @GetUserNotesApi()
+    getUserNotes(@GetUser() user: UserEntity): Promise<NoteDTO[]> {
+        return this.notesService.fetchByUser(user);
     }
 
-    @Post(':id')
+    @Post()
     @AddNoteApi()
-    addNote(@GetUser() user: UserEntity, @Body() noteDto: NoteDTO) {
-        return this.notesService.addNote(user, noteDto);
+    addNote(@GetUser() user: UserEntity, @Body() noteDto: NoteDTO): Promise<NoteDTO> {
+        return this.notesService.add(user, noteDto);
     }
 
     @Patch(':id')
-    @EditNoteByIdApi()
-    editNoteById(@Param('id') id: number, @Body() noteDto: editNoteDTO) {
-        return this.notesService.editNoteById(id, noteDto);
+    @EditNoteApi()
+    editNote(@Param('id') id: number, @Body() noteDto: editNoteDTO): Promise<void> {
+        return this.notesService.edit(id, noteDto);
     }
 }

src/resource/notes/notes.module.ts → src/resource/note/note.module.ts

@@ -1,8 +1,8 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { NoteEntity } from 'src/database/entities/notes.entity';
-import { NoteService } from './notes.service';
-import { NoteController } from './notes.controller';
+import { NoteService } from './note.service';
+import { NoteController } from './note.controller';
 import { UserEntity } from 'src/database/entities/user.entity';
 
 @Module({

src/resource/notes/notes.service.ts → src/resource/note/note.service.ts

@@ -12,22 +12,22 @@ export class NoteService {
         private noteRepository: Repository<NoteEntity>,
     ) {}
 
-    async fetchUserNotes(user: UserEntity) {
+    async fetchByUser(user: UserEntity): Promise<NoteDTO[]> {
         return this.noteRepository.find({
             relations: ['user'],
             where: { user },
         });
     }
 
-    async addNote(user: UserEntity, noteDto: NoteDTO) {
+    async add(user: UserEntity, noteDto: NoteDTO): Promise<NoteDTO> {
         if (!user)
             throw new HttpException('User not found', HttpStatus.NOT_FOUND);
         const newNote = this.noteRepository.create({ ...noteDto, user });
 
         return this.noteRepository.save(newNote);
     }
 
-    async editNoteById(id: number, noteDto: editNoteDTO) {
-        return this.noteRepository.update({ id }, { ...noteDto });
+    async edit(id: number, noteDto: editNoteDTO): Promise<void> {
+        this.noteRepository.update({ id }, { ...noteDto });
     }
 }

src/resource/search/dto/SearchResult.dto.ts

@@ -1,5 +1,5 @@
 import { ReturnEventDTO } from 'src/resource/event/dto';
-import { NoteDTO } from 'src/resource/notes/dto';
+import { NoteDTO } from 'src/resource/note/dto';
 import { ReturnTaskDTO } from 'src/resource/task/dto';
 import { ApiProperty } from '@nestjs/swagger';
 

src/resource/task/task.controller.ts

@@ -23,8 +23,8 @@ import {
     AddTaskApi,
     DeleteTaskApi,
     EditTaskApi,
-    GetAllUserTasksApi,
-    GetUserTaskApi,
+    GetUserTasksApi,
+    GetTaskByIdApi
 } from '../../decorators/OpenAPI';
 
 @UseGuards(JwtGuard)
@@ -34,21 +34,21 @@ import {
 export class TaskController {
     constructor(private readonly taskService: TaskService) {}
 
-    @Get('/user/all')
-    @GetAllUserTasksApi()
-    async getAllUserTasks(
+    @Get()
+    @GetUserTasksApi()
+    async getUserTasks(
         @GetUser() user: UserEntity,
     ): Promise<ReturnTaskDTO[]> {
-        return await this.taskService.getAllUserTasks(user);
+        return await this.taskService.fetchByUser(user);
     }
 
-    @Get('/user/:id')
-    @GetUserTaskApi()
-    async getUserTask(
+    @Get(':id')
+    @GetTaskByIdApi()
+    async getTaskById(
         @GetUser() user: UserEntity,
         @Param('id', ParseIntPipe) taskId: number,
     ): Promise<ReturnTaskDTO> {
-        const task = await this.taskService.getUserTask(user, taskId);
+        const task = await this.taskService.fetchById(user, taskId);
         if (!task) {
             throw new NotFoundException('Task not found');
         }
@@ -62,7 +62,7 @@ export class TaskController {
         @GetUser() user: UserEntity,
         @Body() createTaskDTO: CreateTaskDTO,
     ): Promise<ReturnTaskDTO> {
-        return await this.taskService.addTask(user, createTaskDTO);
+        return await this.taskService.add(user, createTaskDTO);
     }
 
     @Patch(':id')
@@ -76,7 +76,7 @@ export class TaskController {
             throw new BadRequestException('ID is not valid in URL and body');
         }
 
-        const task = await this.taskService.editTask(user, editTask);
+        const task = await this.taskService.edit(user, editTask);
         if (!task) {
             throw new NotFoundException('Task not found');
         }
@@ -90,7 +90,7 @@ export class TaskController {
         @GetUser() user: UserEntity,
         @Param('id', ParseIntPipe) taskId: number,
     ): Promise<void> {
-        const isTaskRemoved = await this.taskService.deleteTask(user, taskId);
+        const isTaskRemoved = await this.taskService.delete(user, taskId);
         if (!isTaskRemoved) throw new NotFoundException('Task not found');
         return;
     }