Expose note publicId as id property

app-config.yaml

@@ -32,4 +32,3 @@ database:
 
 openai:
   token: 'token'
-

src/domain/entities/noteList.ts

@@ -1,4 +1,6 @@
 import type { Note } from '@domain/entities/note.js';
+import type { NotePublic } from '@domain/entities/notePublic.js';
+
 
 /**
  * Note list  entity.
@@ -7,3 +9,12 @@ import type { Note } from '@domain/entities/note.js';
 export type NoteList = {
   items: Note[];
 };
+
+/**
+ * Public Note list entity .
+ * An object with list of public notes
+ */
+export type NoteListPublic = {
+  items: NotePublic[];
+};
+

src/domain/entities/notePublic.ts

@@ -0,0 +1,27 @@
+import type { Note } from '@domain/entities/note';
+
+type NotePublicProperties = 'content' | 'createdAt' | 'updatedAt'| 'creatorId';
+
+export interface NotePublic extends Pick<Note, NotePublicProperties> {
+  /**
+   * Expose public id as the "id" property
+   */
+  id: string;
+}
+
+/**
+ *Change Note to NotePublic
+ *
+ * @param note - Note data to compose a public note
+ */
+export function definePublicNote(note: Note): NotePublic {
+  const notePublic: NotePublic = {
+    id: note.publicId,
+    content: note.content,
+    createdAt: note.createdAt,
+    updatedAt: note.updatedAt,
+    creatorId: note.creatorId,
+  };
+
+  return notePublic;
+}

src/domain/entities/noteSettings.ts

@@ -20,7 +20,7 @@ export default interface NoteSettings {
   /**
    * Custom hostname
    */
-  customHostname?: string;
+  customHostname?: string ;
 
   /**
    * Is note public for everyone or only for collaborators

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

@@ -10,19 +10,11 @@ describe('Note API', () => {
       const expectedStatus = 200;
       const expectedResponse = {
         'note': {
-          'id': 1,
-          'publicId': 'note_1',
+          'id': 'note_1',
           'creatorId': 1,
           'content': null,
           'createdAt': '2023-10-16T13:49:19.000Z',
           'updatedAt': '2023-10-16T13:49:19.000Z',
-          'noteSettings':  {
-            'customHostname': 'codex.so',
-            'isPublic': true,
-            'id': 1,
-            'noteId': 1,
-            'invitationHash': 'Hzh2hy4igf',
-          },
         },
         'accessRights': {
           'canEdit': false,
@@ -59,8 +51,7 @@ describe('Note API', () => {
       const correctID = 'Pq1T9vc23Q';
       const expectedResponse = {
         'note': {
-          'id': 2,
-          'publicId': 'Pq1T9vc23Q',
+          'id': 'Pq1T9vc23Q',
           'creatorId': 1,
           'content': null,
           'createdAt': '2023-10-16T13:49:19.000Z',
@@ -69,6 +60,7 @@ describe('Note API', () => {
         'accessRights': {
           'canEdit': false,
         },
+
       };
 
       const response = await global.api?.fakeRequest({
@@ -78,15 +70,18 @@ describe('Note API', () => {
 
       expect(response?.statusCode).toBe(expectedStatus);
 
-      expect(response?.json()).toStrictEqual(expectedResponse);
+      const res = response?.json();
+
+      expect(res).toStrictEqual(expectedResponse);
     });
 
     test('Returns note by public id with 200 status when access is disabled, but user is creator', async () => {
       const expectedStatus = 200;
+      const userId = 1;
+      const accessToken = global.auth(userId);
       const expectedResponse = {
         'note': {
-          'id': 3,
-          'publicId': '73NdxFZ4k7',
+          'id': '73NdxFZ4k7',
           'creatorId': 1,
           'content': null,
           'createdAt': '2023-10-16T13:49:19.000Z',
@@ -95,9 +90,8 @@ describe('Note API', () => {
         'accessRights': {
           'canEdit': true,
         },
+
       };
-      const userId = 1;
-      const accessToken = global.auth(userId);
 
       const privateUserNote = notes.find(newNote => {
         const settings = noteSettings.find(ns => ns.note_id === newNote.id);
@@ -251,7 +245,5 @@ describe('Note API', () => {
         expect(response?.json().accessRights).toStrictEqual({ canEdit: true });
       });
     });
-
-    test.todo('API should not return internal id and "publicId".  It should return only "id" which is public id.');
   });
 });

src/presentation/http/router/note.ts

@@ -5,6 +5,7 @@ import type { ErrorResponse } from '@presentation/http/types/HttpResponse.js';
 import type { Note, NotePublicId } from '@domain/entities/note.js';
 import useNoteResolver from '../middlewares/note/useNoteResolver.js';
 import useNoteSettingsResolver from '../middlewares/noteSettings/useNoteSettingsResolver.js';
+import { type NotePublic, definePublicNote } from '@domain/entities/notePublic.js';
 
 /**
  * Interface for the note router.
@@ -55,9 +56,11 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
       notePublicId: NotePublicId;
     },
     Reply: {
-      note : Note
-      accessRights: { canEdit: boolean },
-    } | ErrorResponse,
+      note: NotePublic,
+      accessRights: {
+        canEdit: boolean,
+      },
+    }| ErrorResponse,
   }>('/:notePublicId', {
     config: {
       policy: [
@@ -70,6 +73,24 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
           $ref: 'NoteSchema#/properties/id',
         },
       },
+      response: {
+        '2xx': {
+          type: 'object',
+          properties: {
+            note: {
+              $ref: 'NoteSchema',
+            },
+            accessRights: {
+              type: 'object',
+              properties: {
+                canEdit: {
+                  type: 'boolean',
+                },
+              },
+            },
+          },
+        },
+      },
     },
     preHandler: [
       noteResolver,
@@ -79,19 +100,25 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
     const { note } = request;
 
     /**
-     * Check if note does not exist
+     * Check if note exists
      */
     if (note === null) {
       return reply.notFound('Note not found');
     }
 
+    /**
+     * Wrap note for public use
+     */
+    const notePublic = definePublicNote(note);
+
     /**
      * Check if current user is creator of the note
      */
-    const canEdit = note.creatorId === request.userId;
+    const canEdit = note.creatorId == request.userId;
+
 
     return reply.send({
-      note: note,
+      note: notePublic,
       accessRights: { canEdit: canEdit },
     });
   });
@@ -110,7 +137,7 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
     schema: {
       params: {
         notePublicId: {
-          $ref: 'NoteSchema#/properties/id',
+          $ref: 'NoteSchema',
         },
       },
     },
@@ -227,28 +254,57 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
       hostname: string;
     },
     Reply: {
-      note : Note
-      accessRights: { canEdit: boolean },
-    } | ErrorResponse,
-  }>('/resolve-hostname/:hostname', async (request, reply) => {
+      note: NotePublic,
+      accessRights: {
+        canEdit: boolean,
+      },
+    }| ErrorResponse,
+  }>('/resolve-hostname/:hostname', {
+    schema: {
+      response: {
+        '2xx': {
+          type: 'object',
+          properties: {
+            note: {
+              $ref: 'NoteSchema',
+            },
+            accessRights: {
+              type: 'object',
+              properties: {
+                canEdit: {
+                  type: 'boolean',
+                },
+              },
+            },
+          },
+
+        },
+      },
+    },
+  }, async (request, reply) => {
     const params = request.params;
 
     const note = await noteService.getNoteByHostname(params.hostname);
 
     /**
-     * Check if note does not exist
+     * Check if note exists
      */
     if (note === null) {
       return reply.notFound('Note not found');
     }
 
     /**
-     * Check if current user is creator of the note
+     * Wrapping Note for public use
+     */
+    const notePublic = definePublicNote(note);
+
+    /**
+     *  Check if current user is creator of the note
      */
-    const canEdit = note.creatorId === request.userId;
+    const canEdit = note.creatorId == request.userId;
 
     return reply.send({
-      note: note,
+      note: notePublic,
       accessRights: { canEdit: canEdit },
     });
   });

src/presentation/http/router/noteList.ts

@@ -1,5 +1,8 @@
 import type { FastifyPluginCallback } from 'fastify';
 import type NoteListService from '@domain/service/noteList.js';
+import { definePublicNote, type NotePublic } from '@domain/entities/notePublic.js';
+import type { NoteListPublic } from '@domain/entities/noteList';
+
 
 /**
  * Interface for the noteList router.
@@ -49,8 +52,17 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
     const page = request.query.page;
 
     const noteList = await noteListService.getNoteListByCreatorId(userId, page);
+    /**
+     * Wrapping Notelist for public use
+     */
+    const noteListItemsPublic: NotePublic[] = noteList.items.map(definePublicNote);
+
+    const noteListPublic: NoteListPublic = {
+      items: noteListItemsPublic,
+    };
+
 
-    return reply.send(noteList);
+    return reply.send(noteListPublic);
   });
 
   done();

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

@@ -2,9 +2,9 @@ import type { CreationOptional, InferAttributes, InferCreationAttributes, ModelS
 import { DataTypes, Model } from 'sequelize';
 import type Orm from '@repository/storage/postgres/orm/sequelize/index.js';
 import type { Note, NoteCreationAttributes, NoteInternalId, NotePublicId } from '@domain/entities/note.js';
-import type { NoteList } from '@domain/entities/noteList.js';
-import type { NoteSettingsModel } from '@repository/storage/postgres/orm/sequelize/noteSettings.js';
 import { UserModel } from '@repository/storage/postgres/orm/sequelize/user.js';
+import type { NoteSettingsModel } from './noteSettings';
+import { NoteList } from '@domain/entities/noteList';
 
 /* eslint-disable @typescript-eslint/naming-convention */