Changed: returning detailed facet model instead of string

Author: GPortas

docs/useCases.md

@@ -104,7 +104,7 @@ If no collection identifier is specified, the default collection identifier; `ro
 
 #### Get Collection Facets
 
-Returns the names of the configured collection facets, given a collection identifier or alias.
+Returns a [CollectionFacet](../src/collections/domain/models/CollectionFacet.ts) array containing the facets of the requested collection, given the collection identifier or alias.
 
 ##### Example call:
 
@@ -115,7 +115,7 @@ const collectionIdOrAlias = 12345
 
 getCollectionFacets
   .execute(collectionId)
-  .then((facets: string[]) => {
+  .then((facets: CollectionFacet[]) => {
     /* ... */
   })
   .catch((error: Error) => {

src/collections/domain/models/CollectionFacet.ts

@@ -0,0 +1,5 @@
+export interface CollectionFacet {
+  id: number
+  name: string
+  displayName: string
+}

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -1,11 +1,12 @@
 import { CollectionDTO } from '../dtos/CollectionDTO'
 import { Collection } from '../models/Collection'
+import { CollectionFacet } from '../models/CollectionFacet'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
   createCollection(
     collectionDTO: CollectionDTO,
     parentCollectionId: number | string
   ): Promise<number>
-  getCollectionFacets(collectionIdOrAlias: number | string): Promise<string[]>
+  getCollectionFacets(collectionIdOrAlias: number | string): Promise<CollectionFacet[]>
 }

src/collections/domain/useCases/GetCollectionFacets.ts

@@ -1,22 +1,25 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 import { ROOT_COLLECTION_ALIAS } from '../models/Collection'
+import { CollectionFacet } from '../models/CollectionFacet'
 
-export class GetCollectionFacets implements UseCase<string[]> {
+export class GetCollectionFacets implements UseCase<CollectionFacet[]> {
   private collectionsRepository: ICollectionsRepository
 
   constructor(collectionsRepository: ICollectionsRepository) {
     this.collectionsRepository = collectionsRepository
   }
 
   /**
-   * Returns the names of the configured collection facets, given a collection identifier or alias.
+   * Returns a CollectionFacet array containing the facets of the requested collection, given the collection identifier or alias.
    *
    * @param {number | string} [collectionIdOrAlias = 'root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
    * If this parameter is not set, the default value is: 'root'
    * @returns {Promise<string[]>}
    */
-  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS): Promise<string[]> {
+  async execute(
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS
+  ): Promise<CollectionFacet[]> {
     return await this.collectionsRepository.getCollectionFacets(collectionIdOrAlias)
   }
 }

src/collections/index.ts

@@ -12,4 +12,5 @@ const getCollectionFacets = new GetCollectionFacets(collectionsRepository)
 
 export { getCollection, createCollection, getCollectionFacets }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
+export { CollectionFacet } from './domain/models/CollectionFacet'
 export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -1,8 +1,12 @@
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRepository'
-import { transformCollectionResponseToCollection } from './transformers/collectionTransformers'
+import {
+  transformCollectionFacetsResponseToCollectionFacets,
+  transformCollectionResponseToCollection
+} from './transformers/collectionTransformers'
 import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
 import { CollectionDTO } from '../../domain/dtos/CollectionDTO'
+import { CollectionFacet } from '../../domain/models/CollectionFacet'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -87,9 +91,13 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
   }
 
-  public async getCollectionFacets(collectionIdOrAlias: string | number): Promise<string[]> {
-    return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/facets`, true)
-      .then((response) => response.data.data)
+  public async getCollectionFacets(
+    collectionIdOrAlias: string | number
+  ): Promise<CollectionFacet[]> {
+    return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/facets`, true, {
+      returnDetails: true
+    })
+      .then((response) => transformCollectionFacetsResponseToCollectionFacets(response))
       .catch((error) => {
         throw error
       })

src/collections/infra/repositories/transformers/CollectionFacetPayload.ts

@@ -0,0 +1,5 @@
+export interface CollectionFacetPayload {
+  id: string
+  name: string
+  displayName: string
+}

src/collections/infra/repositories/transformers/collectionTransformers.ts

@@ -3,12 +3,25 @@ import { AxiosResponse } from 'axios'
 import { CollectionInputLevelPayload, CollectionPayload } from './CollectionPayload'
 import { transformPayloadToOwnerNode } from '../../../../core/infra/repositories/transformers/dvObjectOwnerNodeTransformer'
 import { transformHtmlToMarkdown } from '../../../../datasets/infra/repositories/transformers/datasetTransformers'
+import { CollectionFacet } from '../../../domain/models/CollectionFacet'
+import { CollectionFacetPayload } from './CollectionFacetPayload'
 
 export const transformCollectionResponseToCollection = (response: AxiosResponse): Collection => {
   const collectionPayload = response.data.data
   return transformPayloadToCollection(collectionPayload)
 }
 
+export const transformCollectionFacetsResponseToCollectionFacets = (
+  response: AxiosResponse
+): CollectionFacet[] => {
+  const facetsPayloads = response.data.data
+  return facetsPayloads.map((facetsPayload: CollectionFacetPayload) => ({
+    id: Number(facetsPayload.id),
+    name: facetsPayload.name,
+    displayName: facetsPayload.displayName
+  }))
+}
+
 const transformPayloadToCollection = (collectionPayload: CollectionPayload): Collection => {
   const collectionModel: Collection = {
     id: collectionPayload.id,

test/functional/collections/GetCollectionFacets.test.ts

@@ -1,4 +1,4 @@
-import { ApiConfig, ReadError, getCollectionFacets } from '../../../src'
+import { ApiConfig, CollectionFacet, ReadError, getCollectionFacets } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
@@ -13,16 +13,14 @@ describe('execute', () => {
   })
 
   test('should return facets when a valid collection alias is provided', async () => {
-    let actual: string[] = []
+    let actual: CollectionFacet[] = []
     try {
       actual = await getCollectionFacets.execute(ROOT_COLLECTION_ALIAS)
     } catch (error) {
       throw new Error('Facets should be retrieved')
     } finally {
-      expect(actual).toContain('authorName')
-      expect(actual).toContain('subject')
-      expect(actual).toContain('keywordValue')
-      expect(actual).toContain('dateOfDeposit')
+      expect(actual[0].name).toBe('authorName')
+      expect(actual.length).toBe(4)
     }
   })
 

test/integration/collections/CollectionsRepository.test.ts

@@ -149,10 +149,10 @@ describe('CollectionsRepository', () => {
   describe('getCollectionFacets', () => {
     test('should return collection facets given a valid collection alias', async () => {
       const actual = await sut.getCollectionFacets(testCollectionAlias)
-      expect(actual).toContain('authorName')
-      expect(actual).toContain('subject')
-      expect(actual).toContain('keywordValue')
-      expect(actual).toContain('dateOfDeposit')
+      expect(actual.length).toBe(4)
+      expect(actual[0].name).toBe('authorName')
+      expect(actual[0].displayName).toBe('Author Name')
+      expect(actual[0].id).not.toBe(undefined)
     })
 
     test('should return error when collection does not exist', async () => {