fix: createGuestbook returns ID

Author: ChengShi-1

src/guestbooks/domain/repositories/IGuestbooksRepository.ts

@@ -5,7 +5,7 @@ export interface IGuestbooksRepository {
   createGuestbook(
     collectionIdOrAlias: number | string,
     guestbook: CreateGuestbookDTO
-  ): Promise<void>
+  ): Promise<number>
   getGuestbook(guestbookId: number): Promise<Guestbook>
   getGuestbooksByCollectionId(collectionIdOrAlias: number | string): Promise<Guestbook[]>
   setGuestbookEnabled(

src/guestbooks/domain/useCases/CreateGuestbook.ts

@@ -1,18 +1,20 @@
-import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { CreateGuestbookDTO } from '../dtos/CreateGuestbookDTO'
 import { IGuestbooksRepository } from '../repositories/IGuestbooksRepository'
 
-export class CreateGuestbook implements UseCase<void> {
+export class CreateGuestbook {
   constructor(private readonly guestbooksRepository: IGuestbooksRepository) {}
 
   /**
    * Creates a guestbook for the given collection.
    *
    * @param {CreateGuestbookDTO} guestbook - Guestbook creation payload.
    * @param {number | string} collectionIdOrAlias - Collection identifier (numeric id or alias).
-   * @returns {Promise<void>}
+   * @returns {Promise<number>} - The created guestbook identifier.
    */
-  async execute(guestbook: CreateGuestbookDTO, collectionIdOrAlias: number | string) {
+  async execute(
+    guestbook: CreateGuestbookDTO,
+    collectionIdOrAlias: number | string
+  ): Promise<number> {
     return await this.guestbooksRepository.createGuestbook(collectionIdOrAlias, guestbook)
   }
 }

src/guestbooks/infra/repositories/GuestbooksRepository.ts

@@ -10,12 +10,12 @@ export class GuestbooksRepository extends ApiRepository implements IGuestbooksRe
   public async createGuestbook(
     collectionIdOrAlias: number | string,
     guestbook: CreateGuestbookDTO
-  ): Promise<void> {
+  ): Promise<number> {
     return this.doPost(
       this.buildApiEndpoint(this.guestbooksResourceName, `${collectionIdOrAlias}`),
       guestbook
     )
-      .then(() => undefined)
+      .then((response) => response.data.data.id)
       .catch((error) => {
         throw error
       })

test/integration/guestbooks/GuestbooksRepository.test.ts

@@ -79,12 +79,20 @@ describe('GuestbooksRepository', () => {
   describe('createGuestbook', () => {
     test('should create guestbook for collection', async () => {
       const actual = await sut.createGuestbook(testCollectionId, createGuestbookDTO)
-      expect(actual).toBeUndefined()
+      expect(actual).toEqual(expect.any(Number))
+      expect(actual).toBeGreaterThan(0)
+
+      const getGuestbookResponse = await sut.getGuestbook(actual)
+      expect(getGuestbookResponse.name).toBe(createGuestbookDTO.name)
     })
 
     test('should create guestbook for collection by collection alias', async () => {
       const actual = await sut.createGuestbook(testCollectionAlias, createGuestbookDTO)
-      expect(actual).toBeUndefined()
+      expect(actual).toEqual(expect.any(Number))
+      expect(actual).toBeGreaterThan(0)
+
+      const getGuestbookResponse = await sut.getGuestbook(actual)
+      expect(getGuestbookResponse.name).toBe(createGuestbookDTO.name)
     })
 
     test('should return error when collection does not exist', async () => {
@@ -94,16 +102,20 @@ describe('GuestbooksRepository', () => {
 
   describe('getGuestbooksByCollectionId', () => {
     test('should list guestbooks for collection', async () => {
-      await sut.createGuestbook(testCollectionId, createGuestbookDTO)
+      createdGuestbookId = await sut.createGuestbook(testCollectionId, createGuestbookDTO)
       const actual = await sut.getGuestbooksByCollectionId(testCollectionId)
       expect(actual.length).toBeGreaterThan(0)
-      createdGuestbookId = actual[0].id as number
+      expect(actual.some((guestbook) => guestbook.id === createdGuestbookId)).toBe(true)
     })
 
     test('should list guestbooks for collection by collection alias', async () => {
-      await sut.createGuestbook(testCollectionAlias, createGuestbookDTO)
+      const createdByAliasGuestbookId = await sut.createGuestbook(
+        testCollectionAlias,
+        createGuestbookDTO
+      )
       const actual = await sut.getGuestbooksByCollectionId(testCollectionAlias)
       expect(actual.length).toBeGreaterThan(0)
+      expect(actual.some((guestbook) => guestbook.id === createdByAliasGuestbookId)).toBe(true)
     })
 
     test('should return error when collection does not exist', async () => {
@@ -113,8 +125,8 @@ describe('GuestbooksRepository', () => {
 
   describe('getGuestbook', () => {
     test('should get guestbook by id', async () => {
-      await sut.createGuestbook(testCollectionId, createGuestbookDTO)
-      const actual = await sut.getGuestbook(createdGuestbookId as number)
+      createdGuestbookId = await sut.createGuestbook(testCollectionId, createGuestbookDTO)
+      const actual = await sut.getGuestbook(createdGuestbookId)
       expect(actual.id).toBe(createdGuestbookId)
       expect(actual.name).toBe(createGuestbookDTO.name)
     })
@@ -126,17 +138,17 @@ describe('GuestbooksRepository', () => {
 
   describe('setGuestbookEnabled', () => {
     test('should disable guestbook', async () => {
-      await sut.createGuestbook(testCollectionId, createGuestbookDTO)
+      createdGuestbookId = await sut.createGuestbook(testCollectionId, createGuestbookDTO)
 
-      await sut.setGuestbookEnabled(testCollectionId, createdGuestbookId as number, false)
-      const actual = await sut.getGuestbook(createdGuestbookId as number)
+      await sut.setGuestbookEnabled(testCollectionId, createdGuestbookId, false)
+      const actual = await sut.getGuestbook(createdGuestbookId)
 
       expect(actual.enabled).toBe(false)
     })
 
     test('should enable guestbook', async () => {
-      await sut.setGuestbookEnabled(testCollectionId, createdGuestbookId as number, true)
-      const actual = await sut.getGuestbook(createdGuestbookId as number)
+      await sut.setGuestbookEnabled(testCollectionId, createdGuestbookId, true)
+      const actual = await sut.getGuestbook(createdGuestbookId)
 
       expect(actual.enabled).toBe(true)
     })
@@ -153,17 +165,11 @@ describe('GuestbooksRepository', () => {
     let assignableGuestbookId: number
 
     beforeAll(async () => {
-      await sut.createGuestbook(testCollectionId, {
+      assignableGuestbookId = await sut.createGuestbook(testCollectionId, {
         ...createGuestbookDTO,
         name: 'assign/remove guestbook test'
       })
 
-      const guestbooks = await sut.getGuestbooksByCollectionId(testCollectionId)
-      const assignableGuestbook = guestbooks.find(
-        (guestbook) => guestbook.name === 'assign/remove guestbook test'
-      )
-      assignableGuestbookId = assignableGuestbook?.id as number
-
       testDatasetIds = await createDataset.execute(
         TestConstants.TEST_NEW_DATASET_DTO,
         testCollectionAlias

test/unit/guestbooks/CreateGuestbook.test.ts

@@ -45,13 +45,13 @@ describe('CreateGuestbook', () => {
 
   test('should create guestbook for collection', async () => {
     const repository: IGuestbooksRepository = {} as IGuestbooksRepository
-    repository.createGuestbook = jest.fn().mockResolvedValue(undefined)
+    repository.createGuestbook = jest.fn().mockResolvedValue(123)
 
     const sut = new CreateGuestbook(repository)
     const actual = await sut.execute(createGuestbookDTO, collectionId)
 
     expect(repository.createGuestbook).toHaveBeenCalledWith(collectionId, createGuestbookDTO)
-    expect(actual).toBeUndefined()
+    expect(actual).toBe(123)
   })
 
   test('should throw WriteError when repository fails', async () => {