refactor: apply camelCase conversion and fix model/controller naming

Author: FP22FD

src/controllers/authorsController.ts

@@ -1,9 +1,10 @@
+import camelcaseKeys from "camelcase-keys";
 import dotenv from "dotenv";
 import sql from "mssql";
 import { Body, Controller, Delete, Get, Path, Post, Put, Route, SuccessResponse, Tags } from "tsoa";
 
-import { BookAuthor } from "../models/book.js";
-import { AuthorCreateRequest, AuthorRequest, AuthorUpdateRequest } from "./../models/author.js";
+import { BookAuthorResponse } from "../models/book.js";
+import { AuthorCreateRequest, AuthorResponse, AuthorUpdateRequest } from "./../models/author.js";
 
 dotenv.config();
 
@@ -74,7 +75,7 @@ export class AuthorsController extends Controller {
 
   /** GET /Authors/{id} */
   @Get("{id}")
-  public async getAuthor(@Path() id: number): Promise<AuthorRequest | null> {
+  public async getAuthor(@Path() id: number): Promise<AuthorResponse | null> {
     const pool = await sql.connect(sqlConfig);
     // const pool = await getSqlPool();
     const result = await pool.request().input("id", sql.Int, id).query("SELECT * FROM Authors WHERE AuthorId = @id");
@@ -84,24 +85,29 @@ export class AuthorsController extends Controller {
       return null;
     }
 
-    return result.recordset[0] as AuthorRequest;
+    // return result.recordset[0] as AuthorRequest;
+    return camelcaseKeys(result.recordset[0], { deep: true }) as unknown as AuthorResponse;
   }
 
   /** GET /authors */
   @Get()
-  public async getAuthors(): Promise<AuthorRequest[]> {
+  public async getAuthors(): Promise<AuthorResponse[]> {
     const pool = await sql.connect(sqlConfig);
     // const pool = await getSqlPool();
     const result = await pool.request().query("SELECT * FROM Authors");
-    return result.recordset as AuthorRequest[];
+    // return result.recordset as AuthorRequest[];
+
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as AuthorResponse[];
   }
 
   /** GET /authors/{authorId}/books */
   @Get("{authorId}/books")
-  public async getBooksByAuthor(@Path() authorId: number): Promise<BookAuthor[]> {
+  public async getBooksByAuthor(@Path() authorId: number): Promise<BookAuthorResponse[]> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().input("authorId", sql.Int, authorId).query("SELECT * FROM BooksAuthors WHERE AuthorId = @authorId");
-    return result.recordset as BookAuthor[];
+    // return result.recordset as BookAuthor[];
+
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as BookAuthorResponse[];
   }
 
   /** PUT /Authors/{id} */

src/controllers/booksController.ts

@@ -1,8 +1,9 @@
+import camelcaseKeys from "camelcase-keys";
 import dotenv from "dotenv";
 import sql from "mssql";
 import { Body, Controller, Delete, Get, Path, Post, Put, Route, SuccessResponse, Tags } from "tsoa";
 
-import { BookAuthor, BookAuthorCreateRequest, BookCreateRequest, BookRequest, BookUpdateRequest } from "./../models/book.js";
+import { BookAuthorCreateRequest, BookAuthorResponse, BookCreateRequest, BookResponse, BookUpdateRequest } from "./../models/book.js";
 
 dotenv.config();
 
@@ -81,10 +82,10 @@ export class BooksController extends Controller {
       .input("title", sql.NVarChar(200), title)
       .input("year", sql.Int, year).query<{ BookId: number }>(`
         INSERT INTO Books
-          (CreatedBy, Description, DownloadUrl, ImageUrl, ISBN, LanguageId, Title, Year)
+          (Description, DownloadUrl, ImageUrl, ISBN, LanguageId, Title, Year)
         OUTPUT INSERTED.BookId
         VALUES
-          (@createdBy, @description, @downloadUrl, @imageUrl, @isbn, @languageId, @title, @year)
+          ( @description, @downloadUrl, @imageUrl, @isbn, @languageId, @title, @year)
       `);
 
     return { id: result.recordset[0].BookId, message: "Book created successfully" };
@@ -110,15 +111,16 @@ export class BooksController extends Controller {
 
   /** GET /books/{bookId}/authors */
   @Get("{bookId}/authors")
-  public async getAuthorsByBook(@Path() bookId: number): Promise<BookAuthor[]> {
+  public async getAuthorsByBook(@Path() bookId: number): Promise<BookAuthorResponse[]> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().input("bookId", sql.Int, bookId).query("SELECT * FROM BooksAuthors WHERE BookId = @bookId");
-    return result.recordset as BookAuthor[];
+    // return result.recordset as BookAuthor[];
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as BookAuthorResponse[];
   }
 
   /** GET /books/{id} */
   @Get("{id}")
-  public async getBook(@Path() id: number): Promise<BookRequest | null> {
+  public async getBook(@Path() id: number): Promise<BookResponse | null> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().input("id", sql.Int, id).query("SELECT * FROM Books WHERE BookId = @id");
 
@@ -127,15 +129,17 @@ export class BooksController extends Controller {
       return null;
     }
 
-    return result.recordset[0] as BookRequest;
+    // return result.recordset[0] as BookRequest;
+    return camelcaseKeys(result.recordset[0], { deep: true }) as BookResponse;
   }
 
   /** GET /books */ // -- books
   @Get()
-  public async getBooks(): Promise<BookRequest[]> {
+  public async getBooks(): Promise<BookResponse[]> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().query("SELECT * FROM Books");
-    return result.recordset;
+    // return result.recordset;
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as BookResponse[];
   }
 
   /** DELETE /books/{bookId}/authors/{authorId} */

src/controllers/languagesController.ts

@@ -1,8 +1,9 @@
+import camelcaseKeys from "camelcase-keys";
 import dotenv from "dotenv";
 import sql from "mssql";
 import { Body, Controller, Delete, Get, Path, Post, Put, Route, SuccessResponse, Tags } from "tsoa";
 
-import { CreateLanguageRequest, LanguageRequest, UpdateLanguageRequest } from "./../models/language.js";
+import { CreateLanguageRequest, LanguageResponse, UpdateLanguageRequest } from "./../models/language.js";
 
 dotenv.config();
 
@@ -63,7 +64,7 @@ export class LanguagesController extends Controller {
 
   /** GET /languages/{id} */
   @Get("{id}")
-  public async getLanguage(@Path() id: number): Promise<LanguageRequest | null> {
+  public async getLanguage(@Path() id: number): Promise<LanguageResponse | null> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().input("id", sql.Int, id).query("SELECT * FROM Languages WHERE LanguageId = @id");
 
@@ -72,15 +73,17 @@ export class LanguagesController extends Controller {
       return null;
     }
 
-    return result.recordset[0] as LanguageRequest;
+    // return result.recordset[0] as LanguageRequest;
+    return camelcaseKeys(result.recordset[0], { deep: true }) as unknown as LanguageResponse;
   }
 
   /** GET /languages */
   @Get()
-  public async getLanguages(): Promise<LanguageRequest[]> {
+  public async getLanguages(): Promise<LanguageResponse[]> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().query("SELECT * FROM Languages");
-    return result.recordset as LanguageRequest[];
+    // return result.recordset as LanguageRequest[];
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as LanguageResponse[];
   }
 
   /** PUT /languages/{id} */

src/controllers/usersController.ts

@@ -1,8 +1,9 @@
+import camelcaseKeys from "camelcase-keys";
 import dotenv from "dotenv";
 import sql from "mssql";
 import { Body, Controller, Delete, Get, Path, Post, Put, Route, SuccessResponse, Tags } from "tsoa";
 
-import { UserCreateRequest, UserRequest, UserUpdateRequest } from "./../models/user.js";
+import { UserCreateRequest, UserResponse, UserUpdateRequest } from "./../models/user.js";
 
 dotenv.config();
 
@@ -28,7 +29,7 @@ export class UsersController extends Controller {
   /** POST /users */
   @Post()
   @SuccessResponse("201", "Created")
-  public async createUser(@Body() body: UserCreateRequest): Promise<{ message: string; user?: UserRequest }> {
+  public async createUser(@Body() body: UserCreateRequest): Promise<{ message: string }> {
     const { username } = body;
 
     if (!username || username.length < 3) {
@@ -38,9 +39,9 @@ export class UsersController extends Controller {
 
     const pool = await sql.connect(sqlConfig);
 
-    const result = await pool.request().input("username", sql.VarChar(100), username).query("INSERT INTO Users (Username) VALUES (@username)");
+    await pool.request().input("username", sql.VarChar(100), username).query("INSERT INTO Users (Username) VALUES (@username)");
 
-    return { message: "User created successfully", user: result.recordset[0] as UserRequest };
+    return { message: "User created successfully" };
   }
 
   /** DELETE /users/{id} */
@@ -68,7 +69,7 @@ export class UsersController extends Controller {
 
   /** GET /users/{id} */
   @Get("{id}")
-  public async getUser(@Path() id: number): Promise<null | UserRequest> {
+  public async getUser(@Path() id: number): Promise<null | UserResponse> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().input("id", sql.Int, id).query("SELECT * FROM Users WHERE UserId = @id");
 
@@ -77,19 +78,23 @@ export class UsersController extends Controller {
       return null;
     }
 
-    return result.recordset[0] as UserRequest;
+    // return result.recordset[0] as UserRequest;
+
+    return camelcaseKeys(result.recordset[0], { deep: true }) as UserResponse;
   }
 
   @Get()
-  public async getUsers(): Promise<UserRequest[]> {
+  public async getUsers(): Promise<UserResponse[]> {
     const pool = await sql.connect(sqlConfig);
     const result = await pool.request().query("SELECT * FROM Users");
-    return result.recordset as UserRequest[];
+    // return result.recordset as UserRequest[];
+
+    return camelcaseKeys(result.recordset, { deep: true }) as unknown as UserResponse[];
   }
 
   /** PUT /users/{id} */
   @Put("{id}")
-  public async updateUser(@Path() id: number, @Body() body: UserUpdateRequest): Promise<{ message: string; user?: UserRequest }> {
+  public async updateUser(@Path() id: number, @Body() body: UserUpdateRequest): Promise<{ message: string; user?: UserResponse }> {
     const { username } = body;
 
     if (!username || username.length < 3) {
@@ -112,7 +117,7 @@ export class UsersController extends Controller {
 
     return {
       message: "User updated successfully",
-      user: result.recordset[0] as UserRequest,
+      user: result.recordset[0] as UserResponse,
     };
   }
 }

src/models/author.ts

@@ -4,11 +4,11 @@ export interface AuthorCreateRequest {
   surname?: string;
 }
 
-export interface AuthorRequest {
-  AuthorId: number;
-  Middlename?: string;
-  Name: string;
-  Surname?: string;
+export interface AuthorResponse {
+  authorId: number;
+  middlename?: string;
+  name: string;
+  surname?: string;
 }
 
 export interface AuthorUpdateRequest {

src/models/book.ts

@@ -1,10 +1,10 @@
-export interface BookAuthor {
-  AuthorId: number;
-  BookId: number;
+export interface BookAuthorCreateRequest {
+  authorId: number;
 }
 
-export interface BookAuthorCreateRequest {
+export interface BookAuthorResponse {
   authorId: number;
+  bookId: number;
 }
 
 export interface BookCreateRequest {
@@ -17,7 +17,7 @@ export interface BookCreateRequest {
   year: number;
 }
 
-export interface BookRequest {
+export interface BookResponse {
   bookId: number;
   createdAtUtc: string;
   createdBy: number;

src/models/language.ts

@@ -1,7 +1,7 @@
 export interface CreateLanguageRequest {
   languageCode: string;
 }
-export interface LanguageRequest {
+export interface LanguageResponse {
   languageCode: string;
   languageId: number;
 }

src/models/user.ts

@@ -2,7 +2,7 @@ export interface UserCreateRequest {
   username: string;
 }
 
-export interface UserRequest {
+export interface UserResponse {
   userId: number;
   username: string;
 }