feat: add use case to submit feedback to contacts

Author: ChengShi-1

docs/useCases.md

@@ -63,6 +63,8 @@ The different use cases currently available in the package are classified below,
   - [Get Dataverse Backend Version](#get-dataverse-backend-version)
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
   - [Get ZIP Download Limit](#get-zip-download-limit)
+- [Contact](#Contact)
+  - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
 
 ## Collections
 
@@ -1363,3 +1365,23 @@ getZipDownloadLimit.execute().then((downloadLimit: number) => {
 ```
 
 _See [use case](../src/info/domain/useCases/GetZipDownloadLimit.ts) implementation_.
+
+##Contact
+
+#### Send Feedback to Object Contacts
+
+Returns a [Contact](../src/contactInfo/domain/models/Contact.ts) object, which contains contact return information, showing toEmail, fromEmail, subject, body.
+
+##### Example call:
+
+```typescript
+import { submitContactInfo } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+submitContactInfo.execute((contact: ContactDTO)).then( => {
+/* ... */
+})
+
+/* ... */
+```

src/contactInfo/domain/dtos/ContactDTO.ts

@@ -0,0 +1,6 @@
+export interface ContactDTO {
+  targetId: number
+  subject: string
+  body: string
+  fromEmail: string
+}

src/contactInfo/domain/models/Contact.ts

@@ -0,0 +1,6 @@
+export interface Contact {
+  fromEmail: string
+  toEmail: string
+  body: string
+  subject: string
+}

src/contactInfo/domain/repositories/IContactRepository.ts

@@ -0,0 +1,6 @@
+import { Contact } from '../models/Contact'
+import { ContactDTO } from '../dtos/ContactDTO'
+
+export interface IContactRepository {
+  submitContactInfo(contactDTO: ContactDTO): Promise<Contact[]>
+}

src/contactInfo/domain/useCases/SubmitContactInfo.ts

@@ -0,0 +1,25 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ContactDTO } from '../dtos/ContactDTO'
+import { Contact } from '../models/Contact'
+import { IContactRepository } from '../repositories/IContactRepository'
+
+export class SubmitContactInfo implements UseCase<Contact[]> {
+  private contactRepository: IContactRepository
+
+  constructor(contactRepository: IContactRepository) {
+    this.contactRepository = contactRepository
+  }
+  /**
+   * Submits contact information and returns a DTO containing the submitted data.
+   *
+   * @param {ContactDTO} contactDTO - The contact information to be submitted.
+   * @returns {Promise<Contact>} A promise resolving to a ContactDTO.
+   */
+  async execute(contactDTO: ContactDTO): Promise<Contact[]> {
+    try {
+      return await this.contactRepository.submitContactInfo(contactDTO)
+    } catch (error) {
+      throw new Error(`${error.message}`)
+    }
+  }
+}

src/contactInfo/index.ts

@@ -0,0 +1,9 @@
+import { SubmitContactInfo } from './domain/useCases/SubmitContactInfo'
+import { ContactRepository } from './infra/repositories/ContactRepository'
+
+const contactRepository = new ContactRepository()
+const submitContactInfo = new SubmitContactInfo(contactRepository)
+
+export { submitContactInfo }
+export { Contact } from './domain/models/Contact'
+export { ContactDTO } from './domain/dtos/ContactDTO'

src/contactInfo/infra/repositories/ContactRepository.ts

@@ -0,0 +1,24 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { Contact } from '../../domain/models/Contact'
+import { IContactRepository } from '../../domain/repositories/IContactRepository'
+import { ContactDTO } from '../../domain/dtos/ContactDTO'
+
+export class ContactRepository extends ApiRepository implements IContactRepository {
+  public async submitContactInfo(contactDTO: ContactDTO): Promise<Contact[]> {
+    return this.doPost(`/admin/feedback`, contactDTO)
+      .then((response) => {
+        const responseData = response.data
+        const contact: Contact[] = responseData.data.map((item: Contact) => ({
+          fromEmail: item.fromEmail,
+          toEmail: item.toEmail,
+          subject: item.subject,
+          body: item.body
+        }))
+
+        return contact
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
+}

src/index.ts

@@ -6,3 +6,4 @@ export * from './datasets'
 export * from './collections'
 export * from './metadataBlocks'
 export * from './files'
+export * from './contactInfo'

test/functional/contact/SubmitContactInfo.test.ts

@@ -0,0 +1,80 @@
+import { ApiConfig, submitContactInfo, ContactDTO, WriteError } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+
+describe('submitContactInfo', () => {
+  beforeAll(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should return success result on repository success', async () => {
+    const subject = 'Data Question'
+    const fromEmail = '[email protected]'
+    const collectionAlias = 'collection-1'
+    const collectionEmail = '[email protected],[email protected]'
+    const baseUrl = 'http://localhost:8080/dataverse/'
+
+    const contactDTO: ContactDTO = {
+      targetId: 6,
+      subject: subject,
+      body: 'Please help me understand your data. Thank you!',
+      fromEmail: fromEmail
+    }
+
+    const bodyMessage =
+      'You have just been sent the following message from ' +
+      fromEmail +
+      ' via the Root hosted dataverse named "' +
+      collectionAlias +
+      '":\n' +
+      '\n' +
+      '---\n' +
+      '\n' +
+      'Please help me understand your data. Thank you!\n' +
+      '\n' +
+      '---\n' +
+      '\n' +
+      'Root Support\n' +
+      'null\n' +
+      '\n' +
+      'Go to dataverse ' +
+      baseUrl +
+      collectionAlias +
+      '\n' +
+      '\n' +
+      'You received this email because you have been listed as a contact for the dataverse. If you believe this was an error, please contact Root Support at null. To respond directly to the individual who sent the message, simply reply to this email.'
+
+    const expectedResponse = [
+      {
+        fromEmail: fromEmail,
+        toEmail: collectionEmail,
+        subject: 'Root contact: ' + subject,
+        body: bodyMessage
+      }
+    ]
+
+    let contactInfo
+    try {
+      contactInfo = await submitContactInfo.execute(contactDTO)
+    } catch (error) {
+      throw new Error('Contact info should be submitted')
+    } finally {
+      expect(contactInfo).toEqual(expectedResponse)
+    }
+  })
+
+  test('should return error if the target id is unexisted', async () => {
+    const contactDTO: ContactDTO = {
+      targetId: 0, // non-existent target id
+      subject: '',
+      body: '',
+      fromEmail: '[email protected]'
+    }
+    const expectedError = new WriteError(`[400] Feedback target object not found`)
+    await expect(submitContactInfo.execute(contactDTO)).rejects.toThrow(expectedError)
+  })
+})

test/integration/contact/ContactRepository.test.ts

@@ -0,0 +1,73 @@
+import { ContactRepository } from '../../../src/contactInfo/infra/repositories/ContactRepository'
+import { ApiConfig, Contact, ContactDTO, WriteError } from '../../../src'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+
+describe('submitContactInfo', () => {
+  beforeAll(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  const testContactDTO: ContactDTO = {
+    targetId: 6,
+    subject: 'Data Question',
+    body: 'Please help me understand your data. Thank you!',
+    fromEmail: '[email protected]'
+  }
+
+  const sut: ContactRepository = new ContactRepository()
+
+  test('should return ContactDTO when contact info is successfully submitted', async () => {
+    const collectionAlias = 'collection-1'
+    const collectionEmail = '[email protected],[email protected]'
+    const baseUrl = 'http://localhost:8080/dataverse/'
+    const bodyMessage =
+      'You have just been sent the following message from ' +
+      testContactDTO.fromEmail +
+      ' via the Root hosted dataverse named "' +
+      collectionAlias +
+      '":\n' +
+      '\n' +
+      '---\n' +
+      '\n' +
+      'Please help me understand your data. Thank you!\n' +
+      '\n' +
+      '---\n' +
+      '\n' +
+      'Root Support\n' +
+      'null\n' +
+      '\n' +
+      'Go to dataverse ' +
+      baseUrl +
+      collectionAlias +
+      '\n' +
+      '\n' +
+      'You received this email because you have been listed as a contact for the dataverse. If you believe this was an error, please contact Root Support at null. To respond directly to the individual who sent the message, simply reply to this email.'
+
+    const expectedResponse: Contact[] = [
+      {
+        fromEmail: testContactDTO.fromEmail,
+        toEmail: collectionEmail,
+        subject: 'Root contact: ' + testContactDTO.subject,
+        body: bodyMessage
+      }
+    ]
+    const actual = await sut.submitContactInfo(testContactDTO)
+    expect(actual).toEqual(expectedResponse)
+  })
+
+  test('should return error if the target id is unexisted', async () => {
+    const invalidContactDTO: ContactDTO = {
+      targetId: 0,
+      subject: '',
+      body: '',
+      fromEmail: ''
+    }
+    const expectedError = new WriteError(`[400] Feedback target object not found`)
+    await expect(sut.submitContactInfo(invalidContactDTO)).rejects.toThrow(expectedError)
+  })
+})