Added: GetAllFacetableDatasetFields use case

Author: GPortas

src/metadataBlocks/domain/repositories/IMetadataFieldInfosRepository.ts

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

src/metadataBlocks/domain/useCases/GetAllFacetableDatasetFields.ts

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

src/metadataBlocks/index.ts

@@ -1,13 +1,17 @@
 import { GetMetadataBlockByName } from './domain/useCases/GetMetadataBlockByName'
 import { MetadataBlocksRepository } from './infra/repositories/MetadataBlocksRepository'
 import { GetCollectionMetadataBlocks } from './domain/useCases/GetCollectionMetadataBlocks'
+import { GetAllFacetableDatasetFields } from './domain/useCases/GetAllFacetableDatasetFields'
+import { MetadataFieldInfosRepository } from './infra/repositories/MetadataFieldInfosRepository'
 
 const metadataBlocksRepository = new MetadataBlocksRepository()
+const metadataFieldInfosRepository = new MetadataFieldInfosRepository()
 
 const getMetadataBlockByName = new GetMetadataBlockByName(metadataBlocksRepository)
 const getCollectionMetadataBlocks = new GetCollectionMetadataBlocks(metadataBlocksRepository)
+const getAllFacetableDatasetFields = new GetAllFacetableDatasetFields(metadataFieldInfosRepository)
 
-export { getMetadataBlockByName, getCollectionMetadataBlocks }
+export { getMetadataBlockByName, getCollectionMetadataBlocks, getAllFacetableDatasetFields }
 export {
   MetadataBlock,
   MetadataFieldInfo,

src/metadataBlocks/infra/repositories/MetadataFieldInfosRepository.ts

@@ -0,0 +1,19 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { MetadataFieldInfo } from '../..'
+import { IMetadataFieldInfosRepository } from '../../domain/repositories/IMetadataFieldInfosRepository'
+import { transformMetadataFieldInfosResponseToMetadataFieldInfos } from './transformers/metadataBlockTransformers'
+
+export class MetadataFieldInfosRepository
+  extends ApiRepository
+  implements IMetadataFieldInfosRepository
+{
+  private readonly datasetFieldsResourceName: string = 'datasetfields'
+
+  public async getAllFacetableMetadataFields(): Promise<MetadataFieldInfo[]> {
+    return this.doGet(`/${this.datasetFieldsResourceName}/facetables`, false)
+      .then((response) => transformMetadataFieldInfosResponseToMetadataFieldInfos(response))
+      .catch((error) => {
+        throw error
+      })
+  }
+}

src/metadataBlocks/infra/repositories/transformers/MetadataFieldInfoPayload.ts

@@ -0,0 +1,17 @@
+export interface MetadataFieldInfoPayload {
+  name: string
+  displayName: string
+  displayOnCreate: boolean
+  title: string
+  type: string
+  typeClass: string
+  watermark: string
+  description: string
+  multiple: boolean
+  isControlledVocabulary: boolean
+  displayFormat: string
+  displayOrder: number
+  isRequired: boolean
+  controlledVocabularyValues?: string[]
+  childMetadataFields?: Record<string, MetadataFieldInfoPayload>
+}

src/metadataBlocks/infra/repositories/transformers/metadataBlockTransformers.ts

@@ -7,6 +7,7 @@ import {
   MetadataFieldWatermark
 } from '../../../domain/models/MetadataBlock'
 import { MetadataBlockPayload } from './MetadataBlockPayload'
+import { MetadataFieldInfoPayload } from './MetadataFieldInfoPayload'
 
 export const transformMetadataBlocksResponseToMetadataBlocks = (
   response: AxiosResponse
@@ -26,6 +27,17 @@ export const transformMetadataBlockResponseToMetadataBlock = (
   return transformMetadataBlockPayloadToMetadataBlock(metadataBlockPayload)
 }
 
+export const transformMetadataFieldInfosResponseToMetadataFieldInfos = (
+  response: AxiosResponse
+): MetadataFieldInfo[] => {
+  const metadataFieldInfosPayload = response.data.data
+  const metadataFieldInfos: MetadataFieldInfo[] = []
+  metadataFieldInfosPayload.forEach(function (metadataBlockPayload: MetadataFieldInfoPayload) {
+    metadataFieldInfos.push(transformPayloadMetadataFieldInfo(metadataBlockPayload))
+  })
+  return metadataFieldInfos
+}
+
 const transformMetadataBlockPayloadToMetadataBlock = (
   metadataBlockPayload: MetadataBlockPayload
 ): MetadataBlock => {
@@ -35,7 +47,9 @@ const transformMetadataBlockPayloadToMetadataBlock = (
   Object.keys(metadataBlockFieldsPayload).forEach((metadataFieldKey) => {
     const metadataFieldIsAlreadyPresentAsChildField = childFieldKeys.has(metadataFieldKey)
     if (!metadataFieldIsAlreadyPresentAsChildField) {
-      const metadataFieldInfoPayload = metadataBlockFieldsPayload[metadataFieldKey]
+      const metadataFieldInfoPayload = metadataBlockFieldsPayload[
+        metadataFieldKey
+      ] as MetadataFieldInfoPayload
       metadataFields[metadataFieldKey] = transformPayloadMetadataFieldInfo(metadataFieldInfoPayload)
     }
   })
@@ -63,8 +77,7 @@ const getChildFieldKeys = (metadataBlockFieldsPayload: Record<string, unknown>):
 }
 
 const transformPayloadMetadataFieldInfo = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  metadataFieldInfoPayload: any,
+  metadataFieldInfoPayload: MetadataFieldInfoPayload,
   isChild = false
 ): MetadataFieldInfo => {
   const metadataFieldInfo: MetadataFieldInfo = {
@@ -86,7 +99,10 @@ const transformPayloadMetadataFieldInfo = (
     displayOnCreate: metadataFieldInfoPayload.displayOnCreate
   }
   if (!isChild && 'childFields' in metadataFieldInfoPayload) {
-    const childMetadataFieldsPayload = metadataFieldInfoPayload.childFields
+    const childMetadataFieldsPayload = metadataFieldInfoPayload.childFields as Record<
+      string,
+      MetadataFieldInfoPayload
+    >
     const childMetadataFields: Record<string, MetadataFieldInfo> = {}
     Object.keys(childMetadataFieldsPayload).map((metadataFieldKey) => {
       childMetadataFields[metadataFieldKey] = transformPayloadMetadataFieldInfo(

test/environment/.env

@@ -2,5 +2,5 @@ POSTGRES_VERSION=13
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=9.3.0
 DATAVERSE_IMAGE_REGISTRY=ghcr.io
-DATAVERSE_IMAGE_TAG=10633-create-collection-api-ext
+DATAVERSE_IMAGE_TAG=10726-facets-api-extension
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/integration/metadataBlocks/MetadataBlocksRepository.test.ts

@@ -10,11 +10,13 @@ describe('getMetadataBlockByName', () => {
   const sut: MetadataBlocksRepository = new MetadataBlocksRepository()
   const citationMetadataBlockName = 'citation'
 
-  ApiConfig.init(
-    TestConstants.TEST_API_URL,
-    DataverseApiAuthMechanism.API_KEY,
-    process.env.TEST_API_KEY
-  )
+  beforeAll(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
 
   test('should return error when metadata block does not exist', async () => {
     const nonExistentMetadataBlockName = 'nonExistentMetadataBlock'

test/integration/metadataBlocks/MetadataFieldsInfoRepository.test.ts

@@ -0,0 +1,26 @@
+import { MetadataFieldInfosRepository } from '../../../src/metadataBlocks/infra/repositories/MetadataFieldInfosRepository'
+import {
+  ApiConfig,
+  DataverseApiAuthMechanism
+} from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+
+describe('getAllFacetableMetadataFields', () => {
+  const sut: MetadataFieldInfosRepository = new MetadataFieldInfosRepository()
+
+  beforeAll(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should return all facetable dataset fields', async () => {
+    const actual = await sut.getAllFacetableMetadataFields()
+
+    expect(actual.length).toBe(59)
+    expect(actual[0].name).toBe('authorName')
+    expect(actual[0].displayName).toBe('Author Name')
+  })
+})

test/testHelpers/metadataBlocks/metadataBlockHelper.ts

@@ -2,9 +2,11 @@ import {
   MetadataBlock,
   MetadataFieldType,
   MetadataFieldWatermark,
-  MetadataFieldTypeClass
+  MetadataFieldTypeClass,
+  MetadataFieldInfo
 } from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 import { MetadataBlockPayload } from '../../../src/metadataBlocks/infra/repositories/transformers/MetadataBlockPayload'
+import { MetadataFieldInfoPayload } from '../../../src/metadataBlocks/infra/repositories/transformers/MetadataFieldInfoPayload'
 
 export const createMetadataBlockModel = (): MetadataBlock => {
   return {
@@ -151,3 +153,39 @@ export const createMetadataBlockPayload = (): MetadataBlockPayload => {
     }
   }
 }
+
+export const createMetadataFieldInfoModel = (): MetadataFieldInfo => {
+  return {
+    name: 'testName1',
+    displayName: 'testDisplayName1',
+    title: 'testTitle1',
+    type: MetadataFieldType.Text,
+    watermark: MetadataFieldWatermark.Empty,
+    description: 'testDescription1',
+    multiple: false,
+    isControlledVocabulary: false,
+    displayFormat: '#VALUE',
+    isRequired: true,
+    displayOrder: 0,
+    typeClass: MetadataFieldTypeClass.Primitive,
+    displayOnCreate: true
+  }
+}
+
+export const createMetadataFieldInfoPayload = (): MetadataFieldInfoPayload => {
+  return {
+    name: 'testName1',
+    displayName: 'testDisplayName1',
+    title: 'testTitle1',
+    type: 'TEXT',
+    watermark: '',
+    description: 'testDescription1',
+    multiple: false,
+    isControlledVocabulary: false,
+    displayFormat: '#VALUE',
+    isRequired: true,
+    displayOrder: 0,
+    typeClass: 'primitive',
+    displayOnCreate: true
+  }
+}