feat: add endpoint to retrieve notes created by user, ordered by creation time

Author: Dobrunia

src/domain/service/note.ts

@@ -238,6 +238,20 @@ export default class NoteService {
     };
   }
 
+  /**
+   * Returns notes created by user, ordered by creation time
+   * @param userId - id of the user
+   * @param page - number of current page
+   * @returns list of the notes ordered by creation time
+   */
+  public async getNotesByCreatorId(userId: User['id'], page: number): Promise<NoteList> {
+    const offset = (page - 1) * this.noteListPortionSize;
+
+    return {
+      items: await this.noteRepository.getNotesByCreatorId(userId, offset, this.noteListPortionSize),
+    };
+  }
+
   /**
    * Create note relation
    * @param noteId - id of the current note

src/presentation/http/router/noteList.ts

@@ -77,6 +77,60 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
     return reply.send(noteListPublic);
   });
 
+  /**
+   * Get note list created by user, ordered by creation time
+   */
+  fastify.get<{
+    Querystring: {
+      page: number;
+    };
+  }>('/created', {
+    config: {
+      policy: [
+        'authRequired',
+      ],
+    },
+    schema: {
+      querystring: {
+        page: {
+          type: 'number',
+          minimum: 1,
+          maximum: 30,
+        },
+      },
+
+      response: {
+        '2xx': {
+          description: 'Query notelist',
+          properties: {
+            items: {
+              id: { type: 'string' },
+              content: { type: 'string' },
+              createdAt: { type: 'string' },
+              creatorId: { type: 'string' },
+              updatedAt: { type: 'string' },
+            },
+          },
+        },
+      },
+    },
+  }, async (request, reply) => {
+    const userId = request.userId as number;
+    const page = request.query.page;
+
+    const noteList = await noteService.getNotesByCreatorId(userId, page);
+    /**
+     * Wrapping Notelist for public use
+     */
+    const noteListItemsPublic: NotePublic[] = noteList.items.map(definePublicNote);
+
+    const noteListPublic: NoteListPublic = {
+      items: noteListItemsPublic,
+    };
+
+    return reply.send(noteListPublic);
+  });
+
   done();
 };
 

src/repository/note.repository.ts

@@ -82,6 +82,16 @@ export default class NoteRepository {
     return await this.storage.getRecentNotesByUserId(id, offset, limit);
   }
 
+  /**
+   * Gets notes created by user, ordered by creation time
+   * @param creatorId - note creator id
+   * @param offset - number of skipped notes
+   * @param limit - number of notes to get
+   */
+  public async getNotesByCreatorId(creatorId: number, offset: number, limit: number): Promise<Note[]> {
+    return await this.storage.getNotesByCreatorId(creatorId, offset, limit);
+  }
+
   /**
    * Get all notes based on their ids
    * @param noteIds : list of note ids

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

@@ -285,6 +285,55 @@ export default class NoteSequelizeStorage {
     });
   }
 
+  /**
+   * Gets notes created by user, ordered by creation time
+   * @param creatorId - id of note creator
+   * @param offset - number of skipped notes
+   * @param limit - number of notes to get
+   * @returns list of the notes ordered by creation time
+   */
+  public async getNotesByCreatorId(creatorId: number, offset: number, limit: number): Promise<Note[]> {
+    if (!this.settingsModel) {
+      throw new Error('NoteStorage: Note settings model not initialized');
+    }
+
+    const reply = await this.model.findAll({
+      offset: offset,
+      limit: limit,
+      where: {
+        creatorId: creatorId,
+      },
+      order: [
+        ['createdAt', 'DESC'],
+      ],
+      include: [{
+        model: this.settingsModel,
+        as: 'noteSettings',
+        attributes: ['cover'],
+        duplicating: false,
+      }],
+    });
+
+    /**
+     * Convert note model data to Note entity with cover property
+     */
+    return reply.map((note) => {
+      return {
+        id: note.id,
+        /**
+         * noteSettings is required to be, because we make join
+         */
+        cover: note.noteSettings!.cover,
+        content: note.content,
+        updatedAt: note.updatedAt,
+        createdAt: note.createdAt,
+        publicId: note.publicId,
+        creatorId: note.creatorId,
+        tools: note.tools,
+      };
+    });
+  }
+
   /**
    * Gets note by id
    * @param hostname - custom hostname