feat: get collection storage driver

Author: ChengShi-1

CHANGELOG.md

@@ -11,6 +11,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Datasets: Added `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms.
 - Datasets: Added `getDatasetStorageDriver` use case and repository method to support Dataverse endpoint `GET /datasets/{identifier}/storageDriver`, for retrieving dataset storage driver configuration with properties: name, type, label, directUpload, directDownload, and uploadOutOfBand.
 - Datasets: Added `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms
+- Collections: Added `getCollectionStorageDriver` use case and repository method to support Dataverse endpoints `GET /admin/dataverse/{alias}/storageDriver` and `GET /admin/dataverse/{alias}/storageDriver?getEffective=true`, returning storage driver configuration and optionally resolving the effective driver up the parent chain.
 - New Use Case: [Get Collections For Linking Use Case](./docs/useCases.md#get-collections-for-linking).
 - New Use Case: [Create a Template](./docs/useCases.md#create-a-template) under Templates.
 - New Use Case: [Get a Template](./docs/useCases.md#get-a-template) under Templates.
@@ -23,6 +24,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Templates: Rename `CreateDatasetTemplateDTO` to `CreateTemplateDTO`.
 - Templates: Rename `createDatasetTemplate` repository method to `createTemplate`.
 - Templates: Rename `getDatasetTemplates` repository method to `getTemplatesByCollectionId`.
+- Storage Driver endpoints: map new response shape (`name`, `type`, `label`) replacing the legacy `message` field for dataset and collection storage driver retrieval.
 
 ### Fixed
 

docs/useCases.md

@@ -13,6 +13,7 @@ The different use cases currently available in the package are classified below,
     - [Get a Collection](#get-a-collection)
     - [Get Collection Facets](#get-collection-facets)
     - [Get User Permissions on a Collection](#get-user-permissions-on-a-collection)
+    - [Get Collection Storage Driver](#get-collection-storage-driver)
     - [List All Collection Items](#list-all-collection-items)
     - [List My Data Collection Items](#list-my-data-collection-items)
     - [Get Collection Featured Items](#get-collection-featured-items)
@@ -227,6 +228,30 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
 
+#### Get Collection Storage Driver
+
+Returns a [StorageDriver](../src/datasets/domain/models/StorageDriver.ts) instance describing the storage driver configuration for a collection, including name, type, label, and upload/download capabilities. You can optionally resolve the effective storage driver by traversing parent collections.
+
+##### Example call:
+
+```typescript
+import { getCollectionStorageDriver } from '@iqss/dataverse-client-javascript'
+
+const collectionAlias = 'sampleCollection'
+
+// Get the storage driver configured directly on the collection
+getCollectionStorageDriver.execute(collectionAlias).then((storageDriver) => {
+  console.log(storageDriver.name, storageDriver.label)
+})
+
+// Get the effective storage driver (looks up the parent chain)
+getCollectionStorageDriver.execute(collectionAlias, true).then((storageDriver) => {
+  console.log(storageDriver.name, storageDriver.label)
+})
+```
+
+_See [use case](../src/collections/domain/useCases/GetCollectionStorageDriver.ts)_ implementation.
+
 #### List All Collection Items
 
 Returns an instance of [CollectionItemSubset](../src/collections/domain/models/CollectionItemSubset.ts) that contains reduced information for each collection item that the calling user can access in the installation.
@@ -1421,6 +1446,7 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetTemplates.ts)_ definit
 #### Get Dataset Storage Driver
 
 Returns a [StorageDriver](../src/datasets/domain/models/StorageDriver.ts) instance with storage driver configuration for a dataset, including properties like name, type, label, and upload/download capabilities.
+If you're targeting Dataverse versions that previously returned the field `message` instead of `name`, this client transparently maps that legacy field to `name`.
 
 ##### Example call:
 

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -12,6 +12,7 @@ import { CollectionItemType } from '../../../collections/domain/models/Collectio
 import { CollectionLinks } from '../models/CollectionLinks'
 import { CollectionSummary } from '../models/CollectionSummary'
 import { LinkingObjectType } from '../useCases/GetCollectionsForLinking'
+import { StorageDriver } from '../../../datasets/domain/models/StorageDriver'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
@@ -68,4 +69,8 @@ export interface ICollectionsRepository {
     searchTerm: string,
     alreadyLinked: boolean
   ): Promise<CollectionSummary[]>
+  getCollectionStorageDriver(
+    collectionIdOrAlias: number | string,
+    getEffective?: boolean
+  ): Promise<StorageDriver>
 }

src/collections/domain/useCases/GetCollectionStorageDriver.ts

@@ -0,0 +1,25 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { StorageDriver } from '../../../datasets/domain/models/StorageDriver'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class GetCollectionStorageDriver implements UseCase<StorageDriver> {
+  private readonly collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Returns the storage driver information for a given Collection.
+   *
+   * @param {number | string} collectionIdOrAlias - The collection identifier, which can be a string (alias) or numeric id.
+   * @param {boolean} [getEffective=false] - Whether to resolve the effective storage driver up the parent chain.
+   * @returns {Promise<StorageDriver>}
+   */
+  async execute(
+    collectionIdOrAlias: number | string,
+    getEffective = false
+  ): Promise<StorageDriver> {
+    return this.collectionsRepository.getCollectionStorageDriver(collectionIdOrAlias, getEffective)
+  }
+}

src/collections/index.ts

@@ -16,6 +16,7 @@ import { LinkCollection } from './domain/useCases/LinkCollection'
 import { UnlinkCollection } from './domain/useCases/UnlinkCollection'
 import { GetCollectionLinks } from './domain/useCases/GetCollectionLinks'
 import { GetCollectionsForLinking } from './domain/useCases/GetCollectionsForLinking'
+import { GetCollectionStorageDriver } from './domain/useCases/GetCollectionStorageDriver'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -36,6 +37,7 @@ const linkCollection = new LinkCollection(collectionsRepository)
 const unlinkCollection = new UnlinkCollection(collectionsRepository)
 const getCollectionLinks = new GetCollectionLinks(collectionsRepository)
 const getCollectionsForLinking = new GetCollectionsForLinking(collectionsRepository)
+const getCollectionStorageDriver = new GetCollectionStorageDriver(collectionsRepository)
 
 export {
   getCollection,
@@ -54,7 +56,8 @@ export {
   linkCollection,
   unlinkCollection,
   getCollectionLinks,
-  getCollectionsForLinking
+  getCollectionsForLinking,
+  getCollectionStorageDriver
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -40,6 +40,7 @@ import { ReadError } from '../../../core/domain/repositories/ReadError'
 import { CollectionLinks } from '../../domain/models/CollectionLinks'
 import { CollectionSummary } from '../../domain/models/CollectionSummary'
 import { LinkingObjectType } from '../../domain/useCases/GetCollectionsForLinking'
+import { StorageDriver } from '../../../datasets/domain/models/StorageDriver'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -528,4 +529,17 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+
+  public async getCollectionStorageDriver(
+    collectionIdOrAlias: number | string,
+    getEffective = false
+  ): Promise<StorageDriver> {
+    const queryParams = getEffective ? { getEffective: true } : {}
+
+    return this.doGet(`/admin/dataverse/${collectionIdOrAlias}/storageDriver`, true, queryParams)
+      .then((response) => response.data.data as StorageDriver)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/unit/collections/GetCollectionStorageDriver.test.ts

@@ -0,0 +1,58 @@
+import { GetCollectionStorageDriver } from '../../../src/collections/domain/useCases/GetCollectionStorageDriver'
+import { ICollectionsRepository } from '../../../src/collections/domain/repositories/ICollectionsRepository'
+import { StorageDriver } from '../../../src/datasets/domain/models/StorageDriver'
+import { ReadError } from '../../../src/core/domain/repositories/ReadError'
+
+describe('GetCollectionStorageDriver (unit)', () => {
+  const testStorageDriver: StorageDriver = {
+    name: 'local',
+    type: 'filesystem',
+    label: 'Local Storage',
+    directUpload: true,
+    directDownload: true,
+    uploadOutOfBand: false
+  }
+
+  test('should return storage driver on repository success', async () => {
+    const collectionsRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionsRepositoryStub.getCollectionStorageDriver = jest
+      .fn()
+      .mockResolvedValue(testStorageDriver)
+
+    const sut = new GetCollectionStorageDriver(collectionsRepositoryStub)
+
+    const actual = await sut.execute('collection-alias')
+
+    expect(actual).toEqual(testStorageDriver)
+    expect(actual.name).toBe('local')
+    expect(actual.type).toBe('filesystem')
+    expect(actual.label).toBe('Local Storage')
+    expect(actual.directUpload).toBe(true)
+    expect(actual.directDownload).toBe(true)
+    expect(actual.uploadOutOfBand).toBe(false)
+  })
+
+  test('should pass getEffective flag to repository', async () => {
+    const collectionsRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionsRepositoryStub.getCollectionStorageDriver = jest
+      .fn()
+      .mockResolvedValue(testStorageDriver)
+
+    const sut = new GetCollectionStorageDriver(collectionsRepositoryStub)
+
+    await sut.execute(123, true)
+
+    expect(collectionsRepositoryStub.getCollectionStorageDriver).toHaveBeenCalledWith(123, true)
+  })
+
+  test('should throw on repository error', async () => {
+    const collectionsRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionsRepositoryStub.getCollectionStorageDriver = jest
+      .fn()
+      .mockRejectedValue(new ReadError('[404] Collection not found'))
+
+    const sut = new GetCollectionStorageDriver(collectionsRepositoryStub)
+
+    await expect(sut.execute('missing')).rejects.toThrow(ReadError)
+  })
+})