Documentation and return type fix

src/domain/index.ts

@@ -69,7 +69,7 @@ export function init(repositories: Repositories, appConfig: AppConfig): DomainSe
 
   const aiService = new AIService(repositories.aiRepository);
   const editorToolsService = new EditorToolsService(repositories.editorToolsRepository);
-  const userListService = new UserListService(repositories.userListRepository)
+  const userListService = new UserListService(repositories.userListRepository);
 
   return {
     noteService,
@@ -79,6 +79,6 @@ export function init(repositories: Repositories, appConfig: AppConfig): DomainSe
     authService,
     aiService,
     editorToolsService,
-    userListService
+    userListService,
   };
 }

src/domain/service/userListService.ts

@@ -3,14 +3,15 @@ import type { UserList } from '@domain/entities/userList';
 
 
 /**
- * User List service 
+ * User List service
  */
 export default class UserListService {
   public readonly repository: UserListRepository;
 
   /**
-   * User List service constructor 
-   * @param repository - userList repository instance 
+   * User List service constructor
+   *
+   * @param repository - userList repository instance
    */
   constructor(repository: UserListRepository) {
     this.repository = repository;

src/presentation/http/router/userList.ts

@@ -16,6 +16,7 @@ interface UsersRouterOptions {
  */
 const AllUsersRouter: FastifyPluginCallback<UsersRouterOptions> = (fastify, opts, done) => {
   const usersService = opts.userListService;
+
   /**
    * Get all users
    */

src/repository/index.ts

@@ -125,7 +125,7 @@ export async function init(orm: Orm): Promise<Repositories> {
   const aiRepository = new AIRepository(openaiApiTransport);
   const editorToolsRepository = new EditorToolsRepository(editorToolsStorage);
   const teamRepository = new TeamRepository(teamStorage);
-  const userListRepository = new UserListRepository(userStorage)
+  const userListRepository = new UserListRepository(userStorage);
 
   return {
     noteRepository,
@@ -135,6 +135,6 @@ export async function init(orm: Orm): Promise<Repositories> {
     aiRepository,
     editorToolsRepository,
     teamRepository,
-    userListRepository
+    userListRepository,
   };
 }

src/repository/storage/postgres/orm/sequelize/user.ts

@@ -283,9 +283,9 @@ export default class UserSequelizeStorage {
     };
   }
 
+
   /**
-   * Get list users
-   * @returns { Promise<UserList> } - found all users  
+   * Get all users
    */
   public async getAllUsers(): Promise<User[]> {
     const userList  = await this.model.findAll({  });

src/repository/userList.repository.ts

@@ -3,7 +3,7 @@ import type User from '@domain/entities/user';
 
 
 /**
- *
+ * Repository allows accessing data from business-logic (domain) level
  */
 export default class UserListRepository {
   public storage: UserStorage;
@@ -17,9 +17,7 @@ export default class UserListRepository {
   }
 
   /**
-   * Gets note list by creator id
-   *
-   * @returns { Promise<UserList> } user
+   * Get all users
    */
   public async getAllUsers(): Promise<User[]> {
     return await this.storage.getAllUsers();