added todo

Author: e11sy

src/application/services/useNoteHistory.ts

@@ -5,10 +5,16 @@ import type { Note } from '@/domain/entities/Note';
 import { noteHistoryService } from '@/domain';
 
 interface UseNoteHistoryComposableState {
+  /**
+   * Note hisotry is array of the history meta used for history preview
+   */
   noteHistory: Ref<NoteHistoryMeta[] | null>;
 }
 
 interface UseNoteHistoryComposableOptions {
+  /**
+   * Id of the note
+   */
   noteId: MaybeRefOrGetter<NoteHistoryRecord['noteId'] | null>;
 }
 
@@ -21,6 +27,9 @@ export default function useNoteHistory(options: UseNoteHistoryComposableOptions)
     noteHistory.value = await noteHistoryService.loadNoteHistory(noteId);
   }
 
+  /**
+   * When page is mounted, we should load note history
+   */
   onMounted(() => {
     if (currentNoteId.value !== null) {
       void loadNoteHistory(currentNoteId.value);

src/domain/noteHistory.repository.interface.ts

@@ -1,6 +1,9 @@
 import type { NoteHistoryMeta } from './entities/History';
 import type { Note } from './entities/Note';
 
+/**
+ * Interface of the note history repository
+ */
 export default interface NoteHistoryRepositoryInterface {
   /**
    * Loads note history meta for note history preview

src/domain/noteHistory.service.ts

@@ -2,13 +2,24 @@ import type { NoteHistoryMeta } from './entities/History';
 import type { Note } from './entities/Note';
 import type NoteHistoryRepository from './noteHistory.repository.interface';
 
+/**
+ * Note history service class, used for logic handling of the data,
+ * Also used for data delivery from repository to application service
+ */
 export default class NoteHistoryService {
+  /**
+   * Note history repository instance
+   */
   private readonly noteHistoryRepository: NoteHistoryRepository;
 
   constructor(historyRepository: NoteHistoryRepository) {
     this.noteHistoryRepository = historyRepository;
   }
 
+  /**
+   * Loads note history meta for note history preview
+   * @param noteId - id of the note
+   */
   public async loadNoteHistory(noteId: Note['id']): Promise<NoteHistoryMeta[]> {
     return await this.noteHistoryRepository.loadNoteHistory(noteId);
   }

src/infrastructure/noteHistory.repository.ts

@@ -3,19 +3,26 @@ import type NotesApiTransport from './transport/notes-api';
 import type { Note } from '@/domain/entities/Note';
 import type { NoteHistoryMeta } from '@/domain/entities/History';
 
+/**
+ * Note history repository class used for data delivery from transport to service
+ */
 export default class NoteHistoryRepository implements NoteHistoryRepositoryInterface {
+  /**
+   * Notes api transport instance
+   */
   private readonly transport: NotesApiTransport;
 
   constructor(notesApiTransport: NotesApiTransport) {
     this.transport = notesApiTransport;
   }
 
+  /**
+   * Loads note history meta for note history preview
+   * @param noteId - id of the note
+   */
   public async loadNoteHistory(noteId: Note['id']): Promise<NoteHistoryMeta[]> {
-    console.log('noteIID', noteId);
     const response = await this.transport.get<{ noteHistoryMeta: NoteHistoryMeta[] }>(`/note/${noteId}/history`);
 
-    console.log('resssssss', response);
-
     return response.noteHistoryMeta;
   }
 }