Add documentation and unit tests

Author: ekraffmiller

docs/useCases.md

@@ -1398,8 +1398,6 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetAvailableCategories.ts
 
 The `datasetId` parameter is a number for numeric identifiers or string for persistent identifiers.
 
-# <<<<<<< HEAD
-
 #### Get Dataset Templates
 
 Returns a [DatasetTemplate](../src/datasets/domain/models/DatasetTemplate.ts) array containing the dataset templates of the requested collection, given the collection identifier or alias.
@@ -2525,6 +2523,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
@@ -2559,7 +2593,7 @@ import { submitContactInfo } from '@iqss/dataverse-client-javascript'
 /* ... */
 
 const contactDTO: ContactDTO = {
-  targedId: 1
+  targedId: 1,
   subject: 'Data Question',
   body: 'Please help me understand your data. Thank you!',
   fromEmail: 'test@gmail.com'

src/info/index.ts

@@ -4,6 +4,7 @@ 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'
 
 const dataverseInfoRepository = new DataverseInfoRepository()
 
@@ -14,13 +15,19 @@ const getApplicationTermsOfUse = new GetApplicationTermsOfUse(dataverseInfoRepos
 const getAvailableDatasetMetadataExportFormats = new GetAvailableDatasetMetadataExportFormats(
   dataverseInfoRepository
 )
+const getPublishDatasetDisclaimerText = new GetApplicationTermsOfUse(dataverseInfoRepository)
+const getDatasetPublishPopupCustomText = new GetDatasetPublishPopupCustomText(
+  dataverseInfoRepository
+)
 
 export {
   getDataverseVersion,
   getZipDownloadLimit,
   getMaxEmbargoDurationInMonths,
   getApplicationTermsOfUse,
-  getAvailableDatasetMetadataExportFormats
+  getAvailableDatasetMetadataExportFormats,
+  getDatasetPublishPopupCustomText,
+  getPublishDatasetDisclaimerText
 }
 
 export { DatasetMetadataExportFormats } from './domain/models/DatasetMetadataExportFormats'

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)
+    })
+  })
 })