feat: new use case for listing dataset types #363

Author: pdurbin

src/datasetTypes/domain/models/DatasetType.ts

@@ -0,0 +1,6 @@
+export interface DatasetType {
+  id: number
+  name: string
+  linkedMetadataBlocks?: string[]
+  availableLicenses?: string[]
+}

src/datasetTypes/domain/repositories/IDatasetTypesRepository.ts

@@ -0,0 +1,5 @@
+import { DatasetType } from '../models/DatasetType'
+
+export interface IDatasetTypesRepository {
+  getAvailableDatasetTypes(): Promise<DatasetType[]>
+}

src/datasetTypes/domain/repositories/transformers/DatasetTypePayload.ts

@@ -0,0 +1,6 @@
+export interface DatasetTypePayload {
+  id: number
+  name: string
+  linkedMetadataBlocks?: string[]
+  availableLicenses?: string[]
+}

src/datasetTypes/domain/repositories/transformers/datasetTypeTransformers.ts

@@ -0,0 +1,14 @@
+import { AxiosResponse } from 'axios'
+import { DatasetType } from '../../models/DatasetType'
+import { DatasetTypePayload } from './DatasetTypePayload'
+
+export const transformPayloadToDatasetType = (response: AxiosResponse): DatasetType[] => {
+  const payload = response.data.data as DatasetTypePayload[]
+
+  return payload.map((datasetType: DatasetTypePayload) => ({
+    id: datasetType.id,
+    name: datasetType.name,
+    linkedMetadataBlocks: datasetType.linkedMetadataBlocks,
+    availableLicenses: datasetType.availableLicenses
+  }))
+}

src/datasetTypes/domain/useCases/GetAvailableDatasetTypes.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetType } from '../models/DatasetType'
+import { IDatasetTypesRepository } from '../repositories/IDatasetTypesRepository'
+
+export class GetAvailableDatasetTypes implements UseCase<DatasetType[]> {
+  private datasetTypesRepository: IDatasetTypesRepository
+
+  constructor(datasetTypesRepository: IDatasetTypesRepository) {
+    this.datasetTypesRepository = datasetTypesRepository
+  }
+
+  /**
+   * Returns the list of available dataset types that can be selected for a dataset.
+   *
+   * @returns {Promise<DatasetType[]>}
+   */
+  async execute(): Promise<DatasetType[]> {
+    return await this.datasetTypesRepository.getAvailableDatasetTypes()
+  }
+}

src/datasetTypes/index.ts

@@ -0,0 +1,10 @@
+import { DatasetTypesRepository } from './infra/repositories/DatasetTypesRepository'
+import { GetAvailableDatasetTypes } from './domain/useCases/GetAvailableDatasetTypes'
+
+const datasetTypesRepository = new DatasetTypesRepository()
+
+const getAvailableDatasetTypes = new GetAvailableDatasetTypes(datasetTypesRepository)
+
+export { getAvailableDatasetTypes }
+
+export { DatasetType } from './domain/models/DatasetType'

src/datasetTypes/infra/repositories/DatasetTypesRepository.ts

@@ -0,0 +1,15 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { IDatasetTypesRepository } from '../../domain/repositories/IDatasetTypesRepository'
+import { DatasetType } from '../../domain/models/DatasetType'
+
+export class DatasetTypesRepository extends ApiRepository implements IDatasetTypesRepository {
+  private readonly datasetTypesResourceName: string = 'datasets/datasetTypes'
+
+  public async getAvailableDatasetTypes(): Promise<DatasetType[]> {
+    return this.doGet(this.buildApiEndpoint(this.datasetTypesResourceName))
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
+}

src/index.ts

@@ -10,3 +10,4 @@ export * from './files'
 export * from './contactInfo'
 export * from './notifications'
 export * from './search'
+export * from './datasetTypes'

test/functional/datasetTypes/GetAvailableDatasetTypes.test.ts

@@ -0,0 +1,31 @@
+import { ApiConfig } from '../../../src'
+import { getAvailableDatasetTypes } from '../../../src/datasetTypes'
+import { DatasetType } from '../../../src/datasetTypes/domain/models/DatasetType'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+
+describe('getAvailableDatasetTypes', () => {
+  describe('execute', () => {
+    beforeAll(async () => {
+      ApiConfig.init(
+        TestConstants.TEST_API_URL,
+        DataverseApiAuthMechanism.API_KEY,
+        process.env.TEST_API_KEY
+      )
+    })
+
+    test('should return available dataset types', async () => {
+      const actualDatasetTypes: DatasetType[] = await getAvailableDatasetTypes.execute()
+      const expectedDatasetTypes = [
+        {
+          id: 1,
+          name: 'dataset',
+          linkedMetadataBlocks: [],
+          availableLicenses: []
+        }
+      ]
+
+      expect(actualDatasetTypes).toEqual(expectedDatasetTypes)
+    })
+  })
+})

test/integration/datasetTypes/DatasetTypesRepository.test.ts

@@ -0,0 +1,36 @@
+import {
+  ApiConfig,
+  DataverseApiAuthMechanism
+} from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DatasetTypesRepository } from '../../../src/datasetTypes/infra/repositories/DatasetTypesRepository'
+// import { LicensesRepository } from '../../../src/licenses/infra/repositories/LicensesRepository'
+
+describe('DatasetTypesRepository', () => {
+  const sut: DatasetTypesRepository = new DatasetTypesRepository()
+
+  describe('getAvailableDatasetTypes', () => {
+    beforeAll(async () => {
+      ApiConfig.init(
+        TestConstants.TEST_API_URL,
+        DataverseApiAuthMechanism.API_KEY,
+        process.env.TEST_API_KEY
+      )
+    })
+
+    test('should return list of available dataset types', async () => {
+      const actual = await sut.getAvailableDatasetTypes()
+
+      const datasetTypes = [
+        {
+          id: 1,
+          name: 'dataset',
+          linkedMetadataBlocks: [],
+          availableLicenses: []
+        }
+      ]
+
+      expect(actual).toEqual(datasetTypes)
+    })
+  })
+})