Merge pull request #422 from IQSS/407-add-use-cases-for-publish-dataset-settings

Add use cases for Publish Dataset text settings. All tests passing locally and in GH.

Author: jp-tosca

CHANGELOG.md

@@ -20,6 +20,8 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Guestbooks: Added dataset-level guestbook assignment and removal support via `assignDatasetGuestbook` (`PUT /api/datasets/{identifier}/guestbook`) and `removeDatasetGuestbook` (`DELETE /api/datasets/{identifier}/guestbook`).
 - Datasets/Guestbooks: Added `guestbookId` in `getDataset` responses.
 - Access: Added`access` module for guestbook-at-request and download terms/guestbook submission endpoints.
+- New Use Case: [Get Publish Dataset Disclaimer Text](./docs/useCases.md#get-publish-dataset-disclaimer-text).
+- New Use Case: [Get Dataset Publish Popup Custom Text](./docs/useCases.md#get-dataset-publish-popup-custom-text).
 - DatasetType: Updated datasetType data model. Added two more fields: description and displayName.
 
 ### Changed

docs/useCases.md

@@ -2589,6 +2589,42 @@ getAvailableDatasetMetadataExportFormats
 
 _See [use case](../src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts) implementation_.
 
+#### Get Dataset Publish Popup Custom Text
+
+Returns the custom text displayed in the dataset publish confirmation popup
+
+##### Example call:
+
+```typescript
+import { getDatasetPublishPopupCustomText } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getDatasetPublishPopupCustomText.execute().then((text: string) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/info/domain/useCases/GetDatasetPublishPopupCustomText.ts) implementation_.
+
+#### Get Publish Dataset Disclaimer Text
+
+Returns the disclaimer text displayed in the dataset publish flow.
+
+##### Example calls:
+
+```typescript
+import { getPublishDatasetDisclaimerText } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getPublishDatasetDisclaimerText.execute().then((disclaimerText: string) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/info/domain/useCases/GetPublishDatasetDisclaimerText.ts) implementation_.
+
 ## Licenses
 
 ### Get Available Standard License Terms
@@ -2623,7 +2659,7 @@ import { submitContactInfo } from '@iqss/dataverse-client-javascript'
 /* ... */
 
 const contactDTO: ContactDTO = {
-  targedId: 1
+  targetId: 1,
   subject: 'Data Question',
   body: 'Please help me understand your data. Thank you!',
   fromEmail: '[email protected]'

src/info/domain/repositories/IDataverseInfoRepository.ts

@@ -7,4 +7,6 @@ export interface IDataverseInfoRepository {
   getMaxEmbargoDurationInMonths(): Promise<number>
   getApplicationTermsOfUse(lang?: string): Promise<string>
   getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats>
+  getDatasetPublishPopupCustomText(): Promise<string>
+  getPublishDatasetDisclaimerText(): Promise<string>
 }

src/info/domain/useCases/GetDatasetPublishPopupCustomText.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetDatasetPublishPopupCustomText implements UseCase<string> {
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a string containing custom text for the Publish Dataset modal.
+   *
+   * @returns {Promise<string>}
+   */
+  async execute(): Promise<string> {
+    return await this.dataverseInfoRepository.getDatasetPublishPopupCustomText()
+  }
+}

src/info/domain/useCases/GetPublishDatasetDisclaimerText.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetPublishDatasetDisclaimerText implements UseCase<string> {
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a string containing the disclaimer text for the Publish Dataset modal.
+   *
+   * @returns {Promise<string>}
+   */
+  async execute(): Promise<string> {
+    return await this.dataverseInfoRepository.getPublishDatasetDisclaimerText()
+  }
+}

src/info/index.ts

@@ -4,6 +4,8 @@ import { GetZipDownloadLimit } from './domain/useCases/GetZipDownloadLimit'
 import { GetMaxEmbargoDurationInMonths } from './domain/useCases/GetMaxEmbargoDurationInMonths'
 import { GetApplicationTermsOfUse } from './domain/useCases/GetApplicationTermsOfUse'
 import { GetAvailableDatasetMetadataExportFormats } from './domain/useCases/GetAvailableDatasetMetadataExportFormats'
+import { GetDatasetPublishPopupCustomText } from './domain/useCases/GetDatasetPublishPopupCustomText'
+import { GetPublishDatasetDisclaimerText } from './domain/useCases/GetPublishDatasetDisclaimerText'
 
 const dataverseInfoRepository = new DataverseInfoRepository()
 
@@ -14,13 +16,19 @@ const getApplicationTermsOfUse = new GetApplicationTermsOfUse(dataverseInfoRepos
 const getAvailableDatasetMetadataExportFormats = new GetAvailableDatasetMetadataExportFormats(
   dataverseInfoRepository
 )
+const getPublishDatasetDisclaimerText = new GetPublishDatasetDisclaimerText(dataverseInfoRepository)
+const getDatasetPublishPopupCustomText = new GetDatasetPublishPopupCustomText(
+  dataverseInfoRepository
+)
 
 export {
   getDataverseVersion,
   getZipDownloadLimit,
   getMaxEmbargoDurationInMonths,
   getApplicationTermsOfUse,
-  getAvailableDatasetMetadataExportFormats
+  getAvailableDatasetMetadataExportFormats,
+  getDatasetPublishPopupCustomText,
+  getPublishDatasetDisclaimerText
 }
 
 export { DatasetMetadataExportFormats } from './domain/models/DatasetMetadataExportFormats'

src/info/infra/repositories/DataverseInfoRepository.ts

@@ -66,4 +66,26 @@ export class DataverseInfoRepository extends ApiRepository implements IDataverse
         throw error
       })
   }
+  public async getDatasetPublishPopupCustomText(): Promise<string> {
+    return this.doGet(
+      this.buildApiEndpoint(this.infoResourceName, `settings/:DatasetPublishPopupCustomText`)
+    )
+      .then((response: AxiosResponse<{ data: { message: string } }>) => {
+        return response.data.data.message
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
+  public async getPublishDatasetDisclaimerText(): Promise<string> {
+    return this.doGet(
+      this.buildApiEndpoint(this.infoResourceName, `settings/:PublishDatasetDisclaimerText`)
+    )
+      .then((response: AxiosResponse<{ data: { message: string } }>) => {
+        return response.data.data.message
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/integration/info/DataverseInfoRepository.test.ts

@@ -7,7 +7,9 @@ import { TestConstants } from '../../testHelpers/TestConstants'
 import {
   deleteApplicationTermsOfUseViaApi,
   setApplicationTermsOfUseViaApi,
-  setMaxEmbargoDurationInMonthsViaApi
+  setDatasetPublishPopupCustomTextViaApi,
+  setMaxEmbargoDurationInMonthsViaApi,
+  setPublishDatasetDisclaimerTextViaApi
 } from '../../testHelpers/info/infoHelper'
 import { ReadError } from '../../../src/core/domain/repositories/ReadError'
 
@@ -53,7 +55,40 @@ describe('DataverseInfoRepository', () => {
       expect(actual).toBe(testMaxEmbargoDurationInMonths)
     })
   })
+  describe('getPublishDatasetDisclaimerText', () => {
+    test('should return error when the setting does not exist', async () => {
+      const errorExpected: ReadError = new ReadError(
+        '[404] Setting :PublishDatasetDisclaimerText not found'
+      )
+
+      await expect(sut.getPublishDatasetDisclaimerText()).rejects.toThrow(errorExpected)
+    })
 
+    test('should return text when the setting exists', async () => {
+      const testPublishDatasetDisclaimerText = 'please read and accept'
+      await setPublishDatasetDisclaimerTextViaApi(testPublishDatasetDisclaimerText)
+      const actual = await sut.getPublishDatasetDisclaimerText()
+
+      expect(actual).toBe(testPublishDatasetDisclaimerText)
+    })
+  })
+  describe('getDatasetPublishPopupCustomText', () => {
+    test('should return error when the setting does not exist', async () => {
+      const errorExpected: ReadError = new ReadError(
+        '[404] Setting :DatasetPublishPopupCustomText not found'
+      )
+
+      await expect(sut.getDatasetPublishPopupCustomText()).rejects.toThrow(errorExpected)
+    })
+
+    test('should return text when the setting exists', async () => {
+      const testDatasetPublishPopupCustomText = 'custom publish popup text'
+      await setDatasetPublishPopupCustomTextViaApi(testDatasetPublishPopupCustomText)
+      const actual = await sut.getDatasetPublishPopupCustomText()
+
+      expect(actual).toBe(testDatasetPublishPopupCustomText)
+    })
+  })
   describe('getApplicationTermsOfUse', () => {
     test('should return no terms message when terms are not set', async () => {
       const defaultNoTermsOfUseMessage =

test/testHelpers/info/infoHelper.ts

@@ -24,7 +24,28 @@ export const setApplicationTermsOfUseViaApi = async (
     }
   )
 }
-
+export const setDatasetPublishPopupCustomTextViaApi = async (
+  datasetPublishPopupCustomText: string
+): Promise<AxiosResponse> => {
+  return await axios.put(
+    `${TestConstants.TEST_API_URL}/admin/settings/:DatasetPublishPopupCustomText`,
+    datasetPublishPopupCustomText,
+    {
+      headers: { 'Content-Type': 'text/plain' }
+    }
+  )
+}
+export const setPublishDatasetDisclaimerTextViaApi = async (
+  publishDatasetDisclaimerText: string
+): Promise<AxiosResponse> => {
+  return await axios.put(
+    `${TestConstants.TEST_API_URL}/admin/settings/:PublishDatasetDisclaimerText`,
+    publishDatasetDisclaimerText,
+    {
+      headers: { 'Content-Type': 'text/plain' }
+    }
+  )
+}
 export const deleteApplicationTermsOfUseViaApi = async (): Promise<AxiosResponse> => {
   return await axios.delete(`${TestConstants.TEST_API_URL}/admin/settings/:ApplicationTermsOfUse`)
 }

test/unit/info/DataverseInfoRepository.test.ts

@@ -240,4 +240,76 @@ describe('DataverseInfoRepository', () => {
       expect(error).toBeInstanceOf(Error)
     })
   })
+
+  describe('getDatasetPublishPopupCustomText', () => {
+    test('should return dataset publish popup custom text on successful response', async () => {
+      const testPopupText = 'Custom popup text.'
+      const testSuccessfulResponse = {
+        data: {
+          status: 'OK',
+          data: {
+            message: testPopupText
+          }
+        }
+      }
+      jest.spyOn(axios, 'get').mockResolvedValue(testSuccessfulResponse)
+
+      const actual = await sut.getDatasetPublishPopupCustomText()
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/info/settings/:DatasetPublishPopupCustomText`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(actual).toMatch(testPopupText)
+    })
+
+    test('should return error result on error response', async () => {
+      jest.spyOn(axios, 'get').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
+
+      let error: ReadError | undefined
+      await sut.getDatasetPublishPopupCustomText().catch((e) => (error = e))
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/info/settings/:DatasetPublishPopupCustomText`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(error).toBeInstanceOf(Error)
+    })
+  })
+
+  describe('getPublishDatasetDisclaimerText', () => {
+    test('should return publish dataset disclaimer text on successful response', async () => {
+      const testDisclaimerText = 'Disclaimer text.'
+      const testSuccessfulResponse = {
+        data: {
+          status: 'OK',
+          data: {
+            message: testDisclaimerText
+          }
+        }
+      }
+      jest.spyOn(axios, 'get').mockResolvedValue(testSuccessfulResponse)
+
+      const actual = await sut.getPublishDatasetDisclaimerText()
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/info/settings/:PublishDatasetDisclaimerText`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(actual).toMatch(testDisclaimerText)
+    })
+
+    test('should return error result on error response', async () => {
+      jest.spyOn(axios, 'get').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
+
+      let error: ReadError | undefined
+      await sut.getPublishDatasetDisclaimerText().catch((e) => (error = e))
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/info/settings/:PublishDatasetDisclaimerText`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(error).toBeInstanceOf(Error)
+    })
+  })
 })