Naming convention changes, added tests

Author: Abhishek Jasud

src/domain/entities/noteTree.ts src/domain/entities/NoteHierarchy.tssrc/domain/entities/noteTree.ts renamed to src/domain/entities/NoteHierarchy.ts

@@ -3,7 +3,7 @@ import type { NoteContent, NotePublicId } from './note.js';
 /**
  * Note Tree entity
  */
-export interface NoteTree {
+export interface NoteHierarchy {
 
   /**
    * public note id
@@ -18,6 +18,6 @@ export interface NoteTree {
   /**
    * child notes
    */
-  childNotes: NoteTree[] | null;
+  childNotes: NoteHierarchy[] | null;
 
 }

src/domain/service/note.ts

@@ -9,7 +9,7 @@ import type User from '@domain/entities/user.js';
 import type { NoteList } from '@domain/entities/noteList.js';
 import type NoteHistoryRepository from '@repository/noteHistory.repository.js';
 import type { NoteHistoryMeta, NoteHistoryRecord, NoteHistoryPublic } from '@domain/entities/noteHistory.js';
-import type { NoteTree } from '@domain/entities/noteTree.js';
+import type { NoteHierarchy } from '@domain/entities/NoteHierarchy.js';
 
 /**
  * Note service
@@ -460,14 +460,14 @@ export default class NoteService {
    * @param noteId - id of the note to get structure
    * @returns - Object of notes.
    */
-  public async getNoteHierarchy(noteId: NoteInternalId): Promise<NoteTree | null> {
-    const ultimateParent = await this.noteRelationsRepository.getUltimateParent(noteId);
+  public async getNoteHierarchy(noteId: NoteInternalId): Promise<NoteHierarchy | null> {
+    const ultimateParent = await this.noteRelationsRepository.getUltimateParentNoteId(noteId);
 
     // If there is no ultimate parent, the provided noteId is the ultimate parent
     const rootNoteId = ultimateParent ?? noteId;
 
-    const noteTree = await this.noteRepository.getNoteTreeByNoteId(rootNoteId);
+    const noteHierarchy = await this.noteRepository.getNoteHierarchyByNoteId(rootNoteId);
 
-    return noteTree;
+    return noteHierarchy;
   }
 }

src/presentation/http/http-api.ts

@@ -33,7 +33,7 @@ import { DomainError } from '@domain/entities/DomainError.js';
 import UploadRouter from './router/upload.js';
 import { ajvFilePlugin } from '@fastify/multipart';
 import { UploadSchema } from './schema/Upload.js';
-import { NoteTreeSchema } from './schema/NoteTree.js';
+import { NoteHierarchySchema } from './schema/NoteHierarchy.js';
 
 const appServerLogger = getLogger('appServer');
 
@@ -301,7 +301,7 @@ export default class HttpApi implements Api {
     this.server?.addSchema(JoinSchemaResponse);
     this.server?.addSchema(OauthSchema);
     this.server?.addSchema(UploadSchema);
-    this.server?.addSchema(NoteTreeSchema);
+    this.server?.addSchema(NoteHierarchySchema);
   }
 
   /**

src/presentation/http/router/note.test.ts

@@ -2273,7 +2273,7 @@ describe('Note API', () => {
     });
   });
 
-  describe('GET /note/notehierarchy/:noteId', () => {
+  describe('GET /note/note-hierarchy/:noteId', () => {
     let accessToken = '';
     let user: User;
 
@@ -2297,13 +2297,14 @@ describe('Note API', () => {
         headers: {
           authorization: `Bearer ${accessToken}`,
         },
-        url: `/note/notehierarchy/${note.publicId}`,
+        url: `/note/note-hierarchy/${note.publicId}`,
       });
 
       expect(response?.json().notehierarchy.id).toBe(note.publicId);
+      expect(response?.json().notehierarchy.childNotes).toHaveLength(0);
     });
 
-    test('Get note hierarchy with parent or child', async () => {
+    test('Get note hierarchy with child', async () => {
       /* create test child note */
       const childNote = await global.db.insertNote({
         creatorId: user.id,
@@ -2331,10 +2332,16 @@ describe('Note API', () => {
         headers: {
           authorization: `Bearer ${accessToken}`,
         },
-        url: `/note/notehierarchy/${parentNote.publicId}`,
+        url: `/note/note-hierarchy/${parentNote.publicId}`,
       });
 
-      expect(response?.json().notehierarchy.childNotes[0].id).toBe(childNote.publicId);
+      const childNoteObj = {
+        id: childNote.publicId,
+        content: childNote.content,
+        childNotes: [],
+      };
+
+      expect(response?.json().notehierarchy.childNotes[0]).toStrictEqual(childNoteObj);
     });
   });
 });

src/presentation/http/router/note.ts

@@ -12,7 +12,7 @@ import type NoteVisitsService from '@domain/service/noteVisits.js';
 import type EditorToolsService from '@domain/service/editorTools.js';
 import type EditorTool from '@domain/entities/editorTools.js';
 import type { NoteHistoryMeta, NoteHistoryPublic, NoteHistoryRecord } from '@domain/entities/noteHistory.js';
-import type { NoteTree } from '@domain/entities/noteTree.js';
+import type { NoteHierarchy } from '@domain/entities/NoteHierarchy.js';
 
 /**
  * Interface for the note router.
@@ -782,9 +782,9 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
       notePublicId: NotePublicId;
     };
     Reply: {
-      notehierarchy: NoteTree | null;
+      notehierarchy: NoteHierarchy | null;
     } | ErrorResponse;
-  }>('/notehierarchy/:notePublicId', {
+  }>('/note-hierarchy/:notePublicId', {
     config: {
       policy: [
         'authRequired',
@@ -801,7 +801,7 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
           type: 'object',
           properties: {
             notehierarchy: {
-              $ref: 'NoteTreeSchema#',
+              $ref: 'NoteHierarchySchema#',
             },
           },
         },

src/presentation/http/schema/NoteTree.ts …resentation/http/schema/NoteHierarchy.tssrc/presentation/http/schema/NoteTree.ts renamed to src/presentation/http/schema/NoteHierarchy.ts src/presentation/http/schema/NoteTree.ts renamed to src/presentation/http/schema/NoteHierarchy.ts

@@ -1,5 +1,5 @@
-export const NoteTreeSchema = {
-  $id: 'NoteTreeSchema',
+export const NoteHierarchySchema = {
+  $id: 'NoteHierarchySchema',
   properties: {
     id: {
       type: 'string',
@@ -23,7 +23,7 @@ export const NoteTreeSchema = {
     },
     childNotes: {
       type: 'array',
-      items: { $ref: 'NoteTreeSchema#' },
+      items: { $ref: 'NoteHierarchySchema#' },
       nullable: true,
     },
   },

src/repository/note.repository.ts

@@ -1,5 +1,5 @@
 import type { Note, NoteCreationAttributes, NoteInternalId, NotePublicId } from '@domain/entities/note.js';
-import type { NoteTree } from '@domain/entities/noteTree.js';
+import type { NoteHierarchy } from '@domain/entities/NoteHierarchy.js';
 import type NoteStorage from '@repository/storage/note.storage.js';
 
 /**
@@ -95,9 +95,9 @@ export default class NoteRepository {
   /**
    * Gets the Note tree by note id
    * @param noteId - note id
-   * @returns NoteTree structure
+   * @returns NoteHierarchy structure
    */
-  public async getNoteTreeByNoteId(noteId: NoteInternalId): Promise<NoteTree | null> {
-    return await this.storage.getNoteTreebyNoteId(noteId);
+  public async getNoteHierarchyByNoteId(noteId: NoteInternalId): Promise<NoteHierarchy | null> {
+    return await this.storage.getNoteHierarchybyNoteId(noteId);
   }
 }

src/repository/noteRelations.repository.ts

@@ -82,7 +82,7 @@ export default class NoteRelationsRepository {
    * @param noteId - note id to get ultimate parent
    * @returns - note id of the ultimate parent
    */
-  public async getUltimateParent(noteId: NoteInternalId): Promise<NoteInternalId | null> {
+  public async getUltimateParentNoteId(noteId: NoteInternalId): Promise<NoteInternalId | null> {
     return await this.storage.getUltimateParentByNoteId(noteId);
   }
 }

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

@@ -6,7 +6,7 @@ import { UserModel } from '@repository/storage/postgres/orm/sequelize/user.js';
 import type { NoteSettingsModel } from './noteSettings.js';
 import type { NoteVisitsModel } from './noteVisits.js';
 import type { NoteHistoryModel } from './noteHistory.js';
-import type { NoteTree } from '@domain/entities/noteTree.js';
+import type { NoteHierarchy } from '@domain/entities/NoteHierarchy.js';
 
 /* eslint-disable @typescript-eslint/naming-convention */
 
@@ -351,9 +351,9 @@ export default class NoteSequelizeStorage {
   /**
    * Creates a tree of notes
    * @param noteId - public note id
-   * @returns NoteTree
+   * @returns NoteHierarchy
    */
-  public async getNoteTreebyNoteId(noteId: NoteInternalId): Promise<NoteTree | null> {
+  public async getNoteHierarchybyNoteId(noteId: NoteInternalId): Promise<NoteHierarchy | null> {
     // Fetch all notes and relations in a recursive query
     const query = `
     WITH RECURSIVE note_tree AS (
@@ -398,9 +398,9 @@ export default class NoteSequelizeStorage {
 
     const notes = result as NoteRow[];
 
-    const notesMap = new Map<NoteInternalId, NoteTree>();
+    const notesMap = new Map<NoteInternalId, NoteHierarchy>();
 
-    let root: NoteTree | null = null;
+    let root: NoteHierarchy | null = null;
 
     // Step 1: Parse and initialize all notes
     notes.forEach((note) => {