Merge pull request #169 from IQSS/167-get-all-facets

Adds use case for getting all facetable fields defined in the installation

Author: GPortas

docs/useCases.md

@@ -44,6 +44,7 @@ The different use cases currently available in the package are classified below,
     - [File Uploading Use Cases](#file-uploading-use-cases)
 - [Metadata Blocks](#metadata-blocks)
   - [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
+    - [Get All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
     - [Get All Metadata Blocks](#get-all-metadata-blocks)
     - [Get Metadata Block By Name](#get-metadata-block-by-name)
     - [Get Collection Metadata Blocks](#get-collection-metadata-blocks)
@@ -105,7 +106,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:
 
@@ -116,7 +117,7 @@ const collectionIdOrAlias = 12345
 
 getCollectionFacets
   .execute(collectionId)
-  .then((facets: string[]) => {
+  .then((facets: CollectionFacet[]) => {
     /* ... */
   })
   .catch((error: Error) => {
@@ -1001,6 +1002,26 @@ The following error might arise from the `AddUploadedFileToDataset` use case:
 
 ### Metadata Blocks read use cases
 
+#### Get All Facetable Metadata Fields
+
+Returns a [MetadataFieldInfo](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing all facetable metadata fields defined in the installation.
+
+##### Example call:
+
+```typescript
+import { getAllFacetableMetadataFields } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAllFacetableMetadataFields.execute().then((metadataFieldInfos: MetadataFieldInfo[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/metadataBlocks/domain/useCases/GetAllFacetableMetadataFields.ts) implementation_.
+
 #### Get All Metadata Blocks
 
 Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing the metadata blocks defined in the installation.

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,5 +1,6 @@
 import { CollectionDTO } from '../dtos/CollectionDTO'
 import { Collection } from '../models/Collection'
+import { CollectionFacet } from '../models/CollectionFacet'
 import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 
 export interface ICollectionsRepository {
@@ -8,7 +9,7 @@ export interface ICollectionsRepository {
     collectionDTO: CollectionDTO,
     parentCollectionId: number | string
   ): Promise<number>
-  getCollectionFacets(collectionIdOrAlias: number | string): Promise<string[]>
+  getCollectionFacets(collectionIdOrAlias: number | string): Promise<CollectionFacet[]>
   getCollectionUserPermissions(
     collectionIdOrAlias: number | string
   ): Promise<CollectionUserPermissions>

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

@@ -14,5 +14,6 @@ const getCollectionUserPermissions = new GetCollectionUserPermissions(collection
 
 export { getCollection, createCollection, getCollectionFacets, getCollectionUserPermissions }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
+export { CollectionFacet } from './domain/models/CollectionFacet'
 export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'
 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'
 import { CollectionUserPermissions } from '../../domain/models/CollectionUserPermissions'
 import { transformCollectionUserPermissionsResponseToCollectionUserPermissions } from './transformers/collectionUserPermissionsTransformers'
 
@@ -11,6 +15,8 @@ export interface NewCollectionRequestPayload {
   name: string
   dataverseContacts: NewCollectionContactRequestPayload[]
   dataverseType: string
+  description?: string
+  affiliation?: string
   metadataBlocks: NewCollectionMetadataBlocksRequestPayload
 }
 
@@ -56,7 +62,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     )
 
     const inputLevelsRequestBody: NewCollectionInputLevelRequestPayload[] =
-      collectionDTO.inputLevels.map((inputLevel) => ({
+      collectionDTO.inputLevels?.map((inputLevel) => ({
         datasetFieldTypeName: inputLevel.datasetFieldName,
         include: inputLevel.include,
         required: inputLevel.required
@@ -67,6 +73,12 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       name: collectionDTO.name,
       dataverseContacts: dataverseContacts,
       dataverseType: collectionDTO.type,
+      ...(collectionDTO.description && {
+        description: collectionDTO.description
+      }),
+      ...(collectionDTO.affiliation && {
+        affiliation: collectionDTO.affiliation
+      }),
       metadataBlocks: {
         metadataBlockNames: collectionDTO.metadataBlockNames,
         facetIds: collectionDTO.facetIds,
@@ -81,9 +93,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,

src/metadataBlocks/domain/repositories/IMetadataFieldInfosRepository.ts

@@ -0,0 +1,5 @@
+import { MetadataFieldInfo } from '../..'
+
+export interface IMetadataFieldInfosRepository {
+  getAllFacetableMetadataFields(): Promise<MetadataFieldInfo[]>
+}

src/metadataBlocks/domain/useCases/GetAllFacetableMetadataFields.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { MetadataFieldInfo } from '../..'
+import { IMetadataFieldInfosRepository } from '../repositories/IMetadataFieldInfosRepository'
+
+export class GetAllFacetableMetadataFields implements UseCase<MetadataFieldInfo[]> {
+  private metadataFieldInfosRepository: IMetadataFieldInfosRepository
+
+  constructor(metadataFieldInfosRepository: IMetadataFieldInfosRepository) {
+    this.metadataFieldInfosRepository = metadataFieldInfosRepository
+  }
+
+  /**
+   * Returns a MetadataFieldInfo array containing all facetable metadata fields defined in the installation.
+   *
+   * @returns {Promise<MetadataFieldInfo[]>}
+   */
+  async execute(): Promise<MetadataFieldInfo[]> {
+    return await this.metadataFieldInfosRepository.getAllFacetableMetadataFields()
+  }
+}