feat: getDatasetStorageDriver

Author: g-saracca

src/core/domain/models/StorageDriver.ts

@@ -0,0 +1,7 @@
+export interface StorageDriver {
+  name: string
+  type: string
+  label: string
+  directUpload: boolean
+  directDownload: boolean
+}

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -14,6 +14,7 @@ import { CitationFormat } from '../models/CitationFormat'
 import { FormattedCitation } from '../models/FormattedCitation'
 import { DatasetTemplate } from '../models/DatasetTemplate'
 import { DatasetType } from '../models/DatasetType'
+import { StorageDriver } from '../../../core/domain/models/StorageDriver'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -90,4 +91,5 @@ export interface IDatasetsRepository {
     licenses: string[]
   ): Promise<void>
   deleteDatasetType(datasetTypeId: number): Promise<void>
+  getDatasetStorageDriver(datasetId: number | string): Promise<StorageDriver>
 }

src/datasets/domain/useCases/GetDatasetStorageDriver.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+import { StorageDriver } from '../../../core/domain/models/StorageDriver'
+
+export class GetDatasetStorageDriver implements UseCase<StorageDriver> {
+  private readonly datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Returns the current storage driver used for a dataset.
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<StorageDriver>}
+   */
+  async execute(datasetId: number | string): Promise<StorageDriver> {
+    return this.datasetsRepository.getDatasetStorageDriver(datasetId)
+  }
+}

src/datasets/index.ts

@@ -32,6 +32,7 @@ import { SetAvailableLicensesForDatasetType } from './domain/useCases/SetAvailab
 import { DeleteDatasetType } from './domain/useCases/DeleteDatasetType'
 import { GetDatasetCitationInOtherFormats } from './domain/useCases/GetDatasetCitationInOtherFormats'
 import { GetDatasetTemplates } from './domain/useCases/GetDatasetTemplates'
+import { GetDatasetStorageDriver } from './domain/useCases/GetDatasetStorageDriver'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -80,6 +81,7 @@ const setAvailableLicensesForDatasetType = new SetAvailableLicensesForDatasetTyp
 const deleteDatasetType = new DeleteDatasetType(datasetsRepository)
 const getDatasetCitationInOtherFormats = new GetDatasetCitationInOtherFormats(datasetsRepository)
 const getDatasetTemplates = new GetDatasetTemplates(datasetsRepository)
+const getDatasetStorageDriver = new GetDatasetStorageDriver(datasetsRepository)
 
 export {
   getDataset,
@@ -109,7 +111,8 @@ export {
   addDatasetType,
   linkDatasetTypeWithMetadataBlocks,
   setAvailableLicensesForDatasetType,
-  deleteDatasetType
+  deleteDatasetType,
+  getDatasetStorageDriver
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -29,6 +29,7 @@ import { DatasetTemplate } from '../../domain/models/DatasetTemplate'
 import { DatasetTemplatePayload } from './transformers/DatasetTemplatePayload'
 import { transformDatasetTemplatePayloadToDatasetTemplate } from './transformers/datasetTemplateTransformers'
 import { DatasetType } from '../../domain/models/DatasetType'
+import { StorageDriver } from '../../../core/domain/models/StorageDriver'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -451,4 +452,15 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
+  public async getDatasetStorageDriver(datasetId: number | string): Promise<StorageDriver> {
+    return this.doGet(
+      this.buildApiEndpoint(this.datasetsResourceName, `storageDriver`, datasetId),
+      true
+    )
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
 }