Merge branch 'develop' into feat/317-get-dataset-templates

g-saracca · g-saracca · commit 4405fc0b1525 · 2025-09-09T15:24:59.000-03:00
diff --git a/docs/useCases.md b/docs/useCases.md
@@ -90,6 +90,9 @@ The different use cases currently available in the package are classified below,
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
   - [Get ZIP Download Limit](#get-zip-download-limit)
   - [Get Application Terms of Use](#get-application-terms-of-use)
+  - [Get Available Dataset Metadata Export Formats](#get-available-dataset-metadata-export-formats)
+- [Licenses](#Licenses)
+  - [Get Available Standard License Terms](#get-available-standard-license-terms)
 - [Contact](#Contact)
   - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
 - [Notifications](#Notifications)
@@ -2108,6 +2111,51 @@ getApplicationTermsOfUse.execute().then((termsOfUse: string) => {
 
 _See [use case](../src/info/domain/useCases/GetApplicationTermsOfUse.ts) implementation_.
 
+#### Get Available Dataset Metadata Export Formats
+
+Returns a [DatasetMetadataExportFormats](../src/info/domain/models/DatasetMetadataExportFormats.ts) object containing the available dataset metadata export formats.
+
+##### Example call:
+
+```typescript
+import {
+  getAvailableDatasetMetadataExportFormats,
+  DatasetMetadataExportFormats
+} from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAvailableDatasetMetadataExportFormats
+  .execute()
+  .then((datasetMetadataExportFormats: DatasetMetadataExportFormats) => {
+    /* ... */
+  })
+
+/* ... */
+```
+
+_See [use case](../src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts) implementation_.
+
+## Licenses
+
+### Get Available Standard License Terms
+
+Returns a list of available standard licenses that can be selected for a dataset.
+
+##### Example call:
+
+```typescript
+import { getAvailableStandardLicenses, License } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAvailableStandardLicenses.execute().then((licenses: License[]) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/licenses/domain/useCases/GetAvailableStandardLicenses.ts) implementation_.
+
 ## Contact
 
 #### Send Feedback to Object Contacts
diff --git a/src/index.ts b/src/index.ts
@@ -10,3 +10,4 @@ export * from './files'
 export * from './contactInfo'
 export * from './notifications'
 export * from './search'
+export * from './licenses'
diff --git a/src/info/domain/models/DatasetMetadataExportFormats.ts b/src/info/domain/models/DatasetMetadataExportFormats.ts
@@ -0,0 +1,16 @@
+export type DatasetMetadataExportFormats = Record<string, DatasetMetadataExportFormat>
+
+type DatasetMetadataExportFormat = DatasetMetadataExportFormatBase | XmlDatasetMetadataExportFormat
+
+interface DatasetMetadataExportFormatBase {
+  displayName: string
+  mediaType: string
+  isHarvestable: boolean
+  isVisibleInUserInterface: boolean
+}
+
+interface XmlDatasetMetadataExportFormat extends DatasetMetadataExportFormatBase {
+  XMLNameSpace: string
+  XMLSchemaLocation: string
+  XMLSchemaVersion: string
+}
diff --git a/src/info/domain/repositories/IDataverseInfoRepository.ts b/src/info/domain/repositories/IDataverseInfoRepository.ts
@@ -1,8 +1,10 @@
+import { DatasetMetadataExportFormats } from '../models/DatasetMetadataExportFormats'
 import { DataverseVersion } from '../models/DataverseVersion'
 
 export interface IDataverseInfoRepository {
   getDataverseVersion(): Promise<DataverseVersion>
   getZipDownloadLimit(): Promise<number>
   getMaxEmbargoDurationInMonths(): Promise<number>
   getApplicationTermsOfUse(lang?: string): Promise<string>
+  getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats>
 }
diff --git a/src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts b/src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts
@@ -0,0 +1,22 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetMetadataExportFormats } from '../models/DatasetMetadataExportFormats'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetAvailableDatasetMetadataExportFormats
+  implements UseCase<DatasetMetadataExportFormats>
+{
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a DatasetMetadataExportFormats object containing the available dataset metadata export formats.
+   *
+   * @returns {Promise<DatasetMetadataExportFormats>}
+   */
+  async execute(): Promise<DatasetMetadataExportFormats> {
+    return await this.dataverseInfoRepository.getAvailableDatasetMetadataExportFormats()
+  }
+}
diff --git a/src/info/index.ts b/src/info/index.ts
@@ -3,17 +3,24 @@ import { GetDataverseVersion } from './domain/useCases/GetDataverseVersion'
 import { GetZipDownloadLimit } from './domain/useCases/GetZipDownloadLimit'
 import { GetMaxEmbargoDurationInMonths } from './domain/useCases/GetMaxEmbargoDurationInMonths'
 import { GetApplicationTermsOfUse } from './domain/useCases/GetApplicationTermsOfUse'
+import { GetAvailableDatasetMetadataExportFormats } from './domain/useCases/GetAvailableDatasetMetadataExportFormats'
 
 const dataverseInfoRepository = new DataverseInfoRepository()
 
 const getDataverseVersion = new GetDataverseVersion(dataverseInfoRepository)
 const getZipDownloadLimit = new GetZipDownloadLimit(dataverseInfoRepository)
 const getMaxEmbargoDurationInMonths = new GetMaxEmbargoDurationInMonths(dataverseInfoRepository)
 const getApplicationTermsOfUse = new GetApplicationTermsOfUse(dataverseInfoRepository)
+const getAvailableDatasetMetadataExportFormats = new GetAvailableDatasetMetadataExportFormats(
+  dataverseInfoRepository
+)
 
 export {
   getDataverseVersion,
   getZipDownloadLimit,
   getMaxEmbargoDurationInMonths,
-  getApplicationTermsOfUse
+  getApplicationTermsOfUse,
+  getAvailableDatasetMetadataExportFormats
 }
+
+export { DatasetMetadataExportFormats } from './domain/models/DatasetMetadataExportFormats'
diff --git a/src/info/infra/repositories/DataverseInfoRepository.ts b/src/info/infra/repositories/DataverseInfoRepository.ts
@@ -2,6 +2,7 @@ import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { IDataverseInfoRepository } from '../../domain/repositories/IDataverseInfoRepository'
 import { DataverseVersion } from '../../domain/models/DataverseVersion'
 import { AxiosResponse } from 'axios'
+import { DatasetMetadataExportFormats } from '../../domain/models/DatasetMetadataExportFormats'
 
 export class DataverseInfoRepository extends ApiRepository implements IDataverseInfoRepository {
   private readonly infoResourceName: string = 'info'
@@ -55,4 +56,14 @@ export class DataverseInfoRepository extends ApiRepository implements IDataverse
         throw error
       })
   }
+
+  public async getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats> {
+    return this.doGet(this.buildApiEndpoint(this.infoResourceName, `exportFormats`))
+      .then((response: AxiosResponse<{ data: DatasetMetadataExportFormats }>) => {
+        return response.data.data
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
 }
diff --git a/src/licenses/domain/models/License.ts b/src/licenses/domain/models/License.ts
@@ -0,0 +1,14 @@
+export interface License {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUri?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}
diff --git a/src/licenses/domain/repositories/ILicensesRepository.ts b/src/licenses/domain/repositories/ILicensesRepository.ts
@@ -0,0 +1,5 @@
+import { License } from '../models/License'
+
+export interface ILicensesRepository {
+  getAvailableStandardLicenses(): Promise<License[]>
+}
diff --git a/src/licenses/domain/repositories/transformers/LicensePayload.ts b/src/licenses/domain/repositories/transformers/LicensePayload.ts
@@ -0,0 +1,14 @@
+export interface LicensePayload {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUrl?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}
diff --git a/src/licenses/domain/repositories/transformers/licenseTransformers.ts b/src/licenses/domain/repositories/transformers/licenseTransformers.ts
@@ -0,0 +1,22 @@
+import { AxiosResponse } from 'axios'
+import { License } from '../../models/License'
+import { LicensePayload } from './LicensePayload'
+
+export const transformPayloadToLicense = (response: AxiosResponse): License[] => {
+  const payload = response.data.data as LicensePayload[]
+
+  return payload.map((license: LicensePayload) => ({
+    id: license.id,
+    name: license.name,
+    shortDescription: license.shortDescription,
+    uri: license.uri,
+    iconUri: license.iconUrl, // in payload, it is called iconUrl, but iconUri is the name matching everywhere else
+    active: license.active,
+    isDefault: license.isDefault,
+    sortOrder: license.sortOrder,
+    rightsIdentifier: license.rightsIdentifier,
+    rightsIdentifierScheme: license.rightsIdentifierScheme,
+    schemeUri: license.schemeUri,
+    languageCode: license.languageCode
+  }))
+}
diff --git a/src/licenses/domain/useCases/GetAvailableStandardLicenses.ts b/src/licenses/domain/useCases/GetAvailableStandardLicenses.ts
@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { License } from '../models/License'
+import { ILicensesRepository } from '../repositories/ILicensesRepository'
+
+export class GetAvailableStandardLicenses implements UseCase<License[]> {
+  private licensesRepository: ILicensesRepository
+
+  constructor(licensesRepository: ILicensesRepository) {
+    this.licensesRepository = licensesRepository
+  }
+
+  /**
+   * Returns the list of available standard license terms that can be selected for a dataset.
+   *
+   * @returns {Promise<License[]>}
+   */
+  async execute(): Promise<License[]> {
+    return await this.licensesRepository.getAvailableStandardLicenses()
+  }
+}
diff --git a/src/licenses/index.ts b/src/licenses/index.ts
@@ -0,0 +1,10 @@
+import { LicensesRepository } from './infra/repositories/LicensesRepository'
+import { GetAvailableStandardLicenses } from './domain/useCases/GetAvailableStandardLicenses'
+
+const licensesRepository = new LicensesRepository()
+
+const getAvailableStandardLicenses = new GetAvailableStandardLicenses(licensesRepository)
+
+export { getAvailableStandardLicenses }
+
+export { License } from './domain/models/License'
diff --git a/src/licenses/infra/repositories/LicensesRepository.ts b/src/licenses/infra/repositories/LicensesRepository.ts
@@ -0,0 +1,15 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { ILicensesRepository } from '../../domain/repositories/ILicensesRepository'
+import { License } from '../../domain/models/License'
+
+export class LicensesRepository extends ApiRepository implements ILicensesRepository {
+  private readonly licensesResourceName: string = 'licenses'
+
+  public async getAvailableStandardLicenses(): Promise<License[]> {
+    return this.doGet(this.buildApiEndpoint(this.licensesResourceName))
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
+}
diff --git a/test/functional/licenses/GetAvailableStandardLicenses.test.ts b/test/functional/licenses/GetAvailableStandardLicenses.test.ts
@@ -0,0 +1,51 @@
+import { ApiConfig, getAvailableStandardLicenses, License } from '../../../src'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+
+describe('getAvailableStandardLicenses', () => {
+  describe('execute', () => {
+    beforeAll(async () => {
+      ApiConfig.init(
+        TestConstants.TEST_API_URL,
+        DataverseApiAuthMechanism.API_KEY,
+        process.env.TEST_API_KEY
+      )
+    })
+
+    test('should return available standard license terms', async () => {
+      const actualLicenses: License[] = await getAvailableStandardLicenses.execute()
+      const expectedLicenses = [
+        {
+          id: 1,
+          name: 'CC0 1.0',
+          shortDescription: 'Creative Commons CC0 1.0 Universal Public Domain Dedication.',
+          uri: 'http://creativecommons.org/publicdomain/zero/1.0',
+          iconUrl: 'https://licensebuttons.net/p/zero/1.0/88x31.png',
+          active: true,
+          isDefault: true,
+          sortOrder: 0,
+          rightsIdentifier: 'CC0-1.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        },
+        {
+          id: 2,
+          name: 'CC BY 4.0',
+          shortDescription: 'Creative Commons Attribution 4.0 International License.',
+          uri: 'http://creativecommons.org/licenses/by/4.0',
+          iconUrl: 'https://licensebuttons.net/l/by/4.0/88x31.png',
+          active: true,
+          isDefault: false,
+          sortOrder: 2,
+          rightsIdentifier: 'CC-BY-4.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        }
+      ]
+
+      expect(actualLicenses).toEqual(expectedLicenses)
+    })
+  })
+})
diff --git a/test/integration/info/DataverseInfoRepository.test.ts b/test/integration/info/DataverseInfoRepository.test.ts
@@ -73,4 +73,12 @@ describe('DataverseInfoRepository', () => {
       await deleteApplicationTermsOfUseViaApi()
     })
   })
+
+  describe('getAvailableDatasetMetadataExportFormats', () => {
+    test('should return available dataset metadata export formats', async () => {
+      const actual = await sut.getAvailableDatasetMetadataExportFormats()
+
+      expect(actual).toBeDefined()
+    })
+  })
 })
diff --git a/test/integration/licenses/LicensesRepository.test.ts b/test/integration/licenses/LicensesRepository.test.ts
@@ -0,0 +1,57 @@
+import {
+  ApiConfig,
+  DataverseApiAuthMechanism
+} from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { LicensesRepository } from '../../../src/licenses/infra/repositories/LicensesRepository'
+
+describe('LicensesRepository', () => {
+  const sut: LicensesRepository = new LicensesRepository()
+
+  describe('getAvailableStandardLicenses', () => {
+    beforeAll(async () => {
+      ApiConfig.init(
+        TestConstants.TEST_API_URL,
+        DataverseApiAuthMechanism.API_KEY,
+        process.env.TEST_API_KEY
+      )
+    })
+
+    test('should return list of available standard license terms', async () => {
+      const actual = await sut.getAvailableStandardLicenses()
+
+      const licenses = [
+        {
+          id: 1,
+          name: 'CC0 1.0',
+          shortDescription: 'Creative Commons CC0 1.0 Universal Public Domain Dedication.',
+          uri: 'http://creativecommons.org/publicdomain/zero/1.0',
+          iconUrl: 'https://licensebuttons.net/p/zero/1.0/88x31.png',
+          active: true,
+          isDefault: true,
+          sortOrder: 0,
+          rightsIdentifier: 'CC0-1.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        },
+        {
+          id: 2,
+          name: 'CC BY 4.0',
+          shortDescription: 'Creative Commons Attribution 4.0 International License.',
+          uri: 'http://creativecommons.org/licenses/by/4.0',
+          iconUrl: 'https://licensebuttons.net/l/by/4.0/88x31.png',
+          active: true,
+          isDefault: false,
+          sortOrder: 2,
+          rightsIdentifier: 'CC-BY-4.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        }
+      ]
+
+      expect(actual).toEqual(licenses)
+    })
+  })
+})
diff --git a/test/unit/info/DataverseInfoRepository.test.ts b/test/unit/info/DataverseInfoRepository.test.ts
diff --git a/test/unit/licenses/GetAvailableStandardLicenses.test.ts b/test/unit/licenses/GetAvailableStandardLicenses.test.ts
