Merge branch 'main' into recent_note_list_api

.eslintrc

@@ -14,6 +14,7 @@
           "match": false
         }
       }
-    ]
+    ],
+    "jsdoc/require-returns-type": "off"
   }
 }

src/domain/entities/note.ts

@@ -36,10 +36,20 @@ export interface Note {
    * Note creator id
    */
   creatorId: NoteCreatorId;
+
+  /**
+   * When note was created
+   */
+  createdAt: string;
+
+  /**
+   * Last time note was updated
+   */
+  updatedAt: string;
 }
 
 
 /**
- * Notes creation attributes, omitting id, because it's generated by database
+ * Part of note entity used to create new note
  */
-export type NoteCreationAttributes = Omit<Note, 'id'>;
+export type NoteCreationAttributes = Pick<Note, 'publicId' | 'content' | 'creatorId'>;

src/domain/service/note.ts

@@ -36,6 +36,24 @@ export default class NoteService {
     });
   }
 
+  /**
+   * Updates note
+   *
+   * @param id - note id
+   * @param content - new content
+   * @returns updated note
+   * @throws { Error } if note was not updated
+   */
+  public async updateNoteContentByPublicId(id: NotePublicId, content: Note['content']): Promise<Note> {
+    const updatedNote = await this.repository.updateNoteContentByPublicId(id, content);
+
+    if (updatedNote === null) {
+      throw new Error(`Note with id ${id} was not updated`);
+    }
+
+    return updatedNote;
+  }
+
   /**
    * Gets note by id
    *

src/presentation/http/middlewares/authRequired.ts

@@ -40,6 +40,8 @@ export default (authService: AuthService): preHandlerHookHandler => {
       await authService.verifyAccessToken(token);
 
       done();
+
+      return reply;
     } catch (error) {
       return reply
         .code(StatusCodes.UNAUTHORIZED)

src/presentation/http/middlewares/withUser.ts

@@ -25,7 +25,7 @@ export default (authService: AuthService): preHandlerHookHandler => {
     if (!notEmpty(authorizationHeader)) {
       done();
 
-      return;
+      return reply;
     }
 
     /**
@@ -44,6 +44,8 @@ export default (authService: AuthService): preHandlerHookHandler => {
       };
     } finally {
       done();
+
+      return reply;
     }
   };
 };

src/presentation/http/router/note.ts

@@ -27,6 +27,22 @@ interface AddNoteOptions {
   content: JSON;
 }
 
+/**
+ * Payload for update note request
+ */
+interface UpdateNoteOptions {
+  /**
+   * Note public id
+   */
+  id: NotePublicId;
+
+  /**
+   * New content
+   */
+  content: JSON;
+}
+
+
 /**
  * Interface for the note router.
  */
@@ -185,6 +201,34 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
     });
   });
 
+  /**
+   * Updates note by id.
+   */
+  fastify.patch<{
+    Body: UpdateNoteOptions,
+    Reply: {
+      updatedAt: Note['updatedAt'],
+    }
+  }>('/', {
+    preHandler: [
+      opts.middlewares.authRequired,
+      opts.middlewares.withUser,
+    ],
+  }, async (request, reply) => {
+    /**
+     * @todo Validate request params
+     * @todo Check user access right
+     */
+    const { id, content } = request.body;
+
+    const note = await noteService.updateNoteContentByPublicId(id, content);
+
+    return reply.send({
+      updatedAt: note.updatedAt,
+    });
+  });
+
+
   /**
    * Get note by custom hostname
    */

src/repository/note.repository.ts

@@ -33,6 +33,17 @@ export default class NoteRepository {
     return await this.storage.createNote(options);
   }
 
+  /**
+   * Update note content in a store using note public id
+   *
+   * @param publicId - note public id
+   * @param content - new content
+   * @returns Note on success, null on failure
+   */
+  public async updateNoteContentByPublicId(publicId: NotePublicId, content: Note['content'] ): Promise<Note | null> {
+    return await this.storage.updateNoteContentByPublicId(publicId, content);
+  }
+
   /**
    * Gets note by id
    *

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

@@ -34,6 +34,16 @@ export class NoteModel extends Model<InferAttributes<NoteModel>, InferCreationAt
    * Note creator, user identifier, who created this note
    */
   public declare creatorId: Note['creatorId'];
+
+  /**
+   * Time when note was created
+   */
+  public declare createdAt: CreationOptional<Note['createdAt']>;
+
+  /**
+   * Last time when note was updated
+   */
+  public declare updatedAt: CreationOptional<Note['updatedAt']>;
 }
 
 
@@ -96,6 +106,8 @@ export default class NoteSequelizeStorage {
           key: 'id',
         },
       },
+      createdAt: DataTypes.DATE,
+      updatedAt: DataTypes.DATE,
     }, {
       tableName: this.tableName,
       sequelize: this.database,
@@ -155,6 +167,30 @@ export default class NoteSequelizeStorage {
     return createdNote;
   }
 
+  /**
+   * Update note content by public id
+   *
+   * @param publicId - note public id
+   * @param content - new content
+   * @returns Note on success, null on failure
+   */
+  public async updateNoteContentByPublicId(publicId: NotePublicId, content: Note['content']): Promise<Note | null> {
+    const [affectedRowsCount, affectedRows] = await this.model.update({
+      content,
+    }, {
+      where: {
+        publicId,
+      },
+      returning: true,
+    });
+
+    if (affectedRowsCount !== 1) {
+      return null;
+    }
+
+    return affectedRows[0];
+  }
+
   /**
    * Gets note by id
    *