Merge pull request #141 from IQSS/135-collections-get-metadata-blocks

Get collection metadata blocks

Author: MellyGray

docs/useCases.md

@@ -38,6 +38,7 @@ The different use cases currently available in the package are classified below,
 - [Metadata Blocks](#metadata-blocks)
   - [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
     - [Get Metadata Block By Name](#get-metadata-block-by-name)
+    - [Get Collection Metadata Blocks](#get-collection-metadata-blocks)
 - [Users](#Users)
   - [Users read use cases](#users-read-use-cases)
     - [Get Current Authenticated User](#get-current-authenticated-user)
@@ -765,6 +766,32 @@ getMetadataBlockByName.execute(name).then((metadataBlock: MetadataBlock) => {
 
 _See [use case](../src/metadataBlocks/domain/useCases/GetMetadataBlockByName.ts) implementation_.
 
+#### Get Collection Metadata Blocks
+
+Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing the metadata blocks from the requested collection.
+
+##### Example call:
+
+```typescript
+import { getCollectionMetadataBlocks } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const collectionIdOrAlias = 'citation'
+
+getCollectionMetadataBlocks.execute(collectionAlias).then((metadataBlocks: MetadataBlock[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/metadataBlocks/domain/useCases/GetCollectionMetadataBlocks.ts) implementation_.
+
+The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
+
+There is a second optional parameter called `onlyDisplayedOnCreate` which indicates whether or not to return only the metadata blocks that are displayed on dataset creation. The default value is false.
+
 ## Users
 
 ### Users read use cases

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -1,4 +1,5 @@
 import { Collection } from '../models/Collection'
+
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -2,22 +2,16 @@ import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRepository'
 import { transformCollectionResponseToCollection } from './transformers/collectionTransformers'
 import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
+
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
-  private readonly collectionsDefaultOperationType: string = 'get'
 
   public async getCollection(
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS
   ): Promise<Collection> {
-    return this.doGet(
-      this.buildApiEndpoint(
-        this.collectionsResourceName,
-        this.collectionsDefaultOperationType,
-        collectionIdOrAlias
-      ),
-      true,
-      { returnOwners: true }
-    )
+    return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, true, {
+      returnOwners: true
+    })
       .then((response) => transformCollectionResponseToCollection(response))
       .catch((error) => {
         throw error

src/core/infra/repositories/ApiRepository.ts

@@ -39,10 +39,6 @@ export abstract class ApiRepository {
     operation: string,
     resourceId: number | string = undefined
   ) {
-    if (resourceName === 'dataverses') {
-      return `/${resourceName}/${resourceId}`
-    }
-
     return typeof resourceId === 'number'
       ? `/${resourceName}/${resourceId}/${operation}`
       : typeof resourceId === 'string'

src/datasets/domain/useCases/validators/MultipleMetadataFieldValidator.ts

@@ -4,6 +4,7 @@ import {
 } from './BaseMetadataFieldValidator'
 import { NewDatasetMetadataFieldValueDTO } from '../../dtos/NewDatasetDTO'
 import { SingleMetadataFieldValidator } from './SingleMetadataFieldValidator'
+import { MetadataFieldType } from '../../../../metadataBlocks/domain/models/MetadataBlock'
 
 export class MultipleMetadataFieldValidator extends BaseMetadataFieldValidator {
   constructor(private singleMetadataFieldValidator: SingleMetadataFieldValidator) {
@@ -19,14 +20,17 @@ export class MultipleMetadataFieldValidator extends BaseMetadataFieldValidator {
         'Expecting an array of values.'
       )
     }
-    if (this.isValidArrayType(metadataFieldValue, 'string') && metadataFieldInfo.type === 'NONE') {
+    if (
+      this.isValidArrayType(metadataFieldValue, 'string') &&
+      metadataFieldInfo.type === MetadataFieldType.None
+    ) {
       throw this.createGeneralValidationError(
         newDatasetMetadataFieldAndValueInfo,
         'Expecting an array of child fields, not strings.'
       )
     } else if (
       this.isValidArrayType(metadataFieldValue, 'object') &&
-      metadataFieldInfo.type !== 'NONE'
+      metadataFieldInfo.type !== MetadataFieldType.None
     ) {
       throw this.createGeneralValidationError(
         newDatasetMetadataFieldAndValueInfo,

src/datasets/domain/useCases/validators/SingleMetadataFieldValidator.ts

@@ -7,6 +7,7 @@ import { DateFormatFieldError } from './errors/DateFormatFieldError'
 import { MetadataFieldValidator } from './MetadataFieldValidator'
 import { NewDatasetMetadataChildFieldValueDTO } from '../../dtos/NewDatasetDTO'
 import { MultipleMetadataFieldValidator } from './MultipleMetadataFieldValidator'
+import { MetadataFieldType } from '../../../../metadataBlocks/domain/models/MetadataBlock'
 
 export class SingleMetadataFieldValidator extends BaseMetadataFieldValidator {
   validate(newDatasetMetadataFieldAndValueInfo: NewDatasetMetadataFieldAndValueInfo): void {
@@ -18,13 +19,19 @@ export class SingleMetadataFieldValidator extends BaseMetadataFieldValidator {
         'Expecting a single field, not an array.'
       )
     }
-    if (typeof metadataFieldValue === 'object' && metadataFieldInfo.type !== 'NONE') {
+    if (
+      typeof metadataFieldValue === 'object' &&
+      metadataFieldInfo.type !== MetadataFieldType.None
+    ) {
       throw this.createGeneralValidationError(
         newDatasetMetadataFieldAndValueInfo,
         'Expecting a string, not child fields.'
       )
     }
-    if (typeof metadataFieldValue === 'string' && metadataFieldInfo.type === 'NONE') {
+    if (
+      typeof metadataFieldValue === 'string' &&
+      metadataFieldInfo.type === MetadataFieldType.None
+    ) {
       throw this.createGeneralValidationError(
         newDatasetMetadataFieldAndValueInfo,
         'Expecting child fields, not a string.'
@@ -41,7 +48,7 @@ export class SingleMetadataFieldValidator extends BaseMetadataFieldValidator {
       this.validateControlledVocabularyFieldValue(newDatasetMetadataFieldAndValueInfo)
     }
 
-    if (metadataFieldInfo.type == 'DATE') {
+    if (metadataFieldInfo.type == MetadataFieldType.Date) {
       this.validateDateFieldValue(newDatasetMetadataFieldAndValueInfo)
     }
 

src/metadataBlocks/domain/models/MetadataBlock.ts

@@ -3,15 +3,16 @@ export interface MetadataBlock {
   name: string
   displayName: string
   metadataFields: Record<string, MetadataFieldInfo>
+  displayOnCreate: boolean
 }
 
 export interface MetadataFieldInfo {
   name: string
   displayName: string
   title: string
-  type: string
-  typeClass: string
-  watermark: string
+  type: MetadataFieldType
+  typeClass: MetadataFieldTypeClass
+  watermark: MetadataFieldWatermark
   description: string
   multiple: boolean
   isControlledVocabulary: boolean
@@ -20,4 +21,37 @@ export interface MetadataFieldInfo {
   childMetadataFields?: Record<string, MetadataFieldInfo>
   isRequired: boolean
   displayOrder: number
+  displayOnCreate: boolean
+}
+
+export enum MetadataFieldType {
+  Date = 'DATE',
+  Email = 'EMAIL',
+  Float = 'FLOAT',
+  Int = 'INT',
+  None = 'NONE',
+  Text = 'TEXT',
+  Textbox = 'TEXTBOX',
+  URL = 'URL'
+}
+
+export enum MetadataFieldTypeClass {
+  Compound = 'compound',
+  ControlledVocabulary = 'controlledVocabulary',
+  Primitive = 'primitive'
+}
+
+export enum MetadataFieldWatermark {
+  Empty = '',
+  EnterAFloatingPointNumber = 'Enter a floating-point number.',
+  EnterAnInteger = 'Enter an integer.',
+  FamilyNameGivenNameOrOrganization = 'FamilyName, GivenName or Organization',
+  HTTPS = 'https://',
+  NameEmailXyz = '[email protected]',
+  OrganizationXYZ = 'Organization XYZ',
+  The1FamilyNameGivenNameOr2Organization = '1) FamilyName, GivenName or 2) Organization',
+  The1FamilyNameGivenNameOr2OrganizationXYZ = '1) Family Name, Given Name or 2) Organization XYZ',
+  WatermarkEnterAnInteger = 'Enter an integer...',
+  YYYYOrYYYYMMOrYYYYMMDD = 'YYYY or YYYY-MM or YYYY-MM-DD',
+  YyyyMmDD = 'YYYY-MM-DD'
 }

src/metadataBlocks/domain/repositories/IMetadataBlocksRepository.ts

@@ -2,4 +2,9 @@ import { MetadataBlock } from '../models/MetadataBlock'
 
 export interface IMetadataBlocksRepository {
   getMetadataBlockByName(metadataBlockName: string): Promise<MetadataBlock>
+
+  getCollectionMetadataBlocks(
+    collectionIdOrAlias: number | string,
+    onlyDisplayedOnCreate: boolean
+  ): Promise<MetadataBlock[]>
 }

src/metadataBlocks/domain/useCases/GetCollectionMetadataBlocks.ts

@@ -0,0 +1,30 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { MetadataBlock } from '../..'
+import { ROOT_COLLECTION_ALIAS } from '../../../collections/domain/models/Collection'
+import { IMetadataBlocksRepository } from '../repositories/IMetadataBlocksRepository'
+
+export class GetCollectionMetadataBlocks implements UseCase<MetadataBlock[]> {
+  private metadataBlocksRepository: IMetadataBlocksRepository
+
+  constructor(metadataBlocksRepository: IMetadataBlocksRepository) {
+    this.metadataBlocksRepository = metadataBlocksRepository
+  }
+
+  /**
+   * Returns a MetadataBlock array containing the metadata blocks from the requested collection.
+   *
+   * @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'
+   * @param {boolean} [onlyDisplayedOnCreate=false] - Indicates whether or not to return only the metadata blocks that are displayed on dataset creation. The default value is false.
+   * @returns {Promise<MetadataBlock[]>}
+   */
+  async execute(
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS,
+    onlyDisplayedOnCreate = false
+  ): Promise<MetadataBlock[]> {
+    return await this.metadataBlocksRepository.getCollectionMetadataBlocks(
+      collectionIdOrAlias,
+      onlyDisplayedOnCreate
+    )
+  }
+}

src/metadataBlocks/index.ts

@@ -1,9 +1,16 @@
 import { GetMetadataBlockByName } from './domain/useCases/GetMetadataBlockByName'
 import { MetadataBlocksRepository } from './infra/repositories/MetadataBlocksRepository'
+import { GetCollectionMetadataBlocks } from './domain/useCases/GetCollectionMetadataBlocks'
 
 const metadataBlocksRepository = new MetadataBlocksRepository()
 
 const getMetadataBlockByName = new GetMetadataBlockByName(metadataBlocksRepository)
+const getCollectionMetadataBlocks = new GetCollectionMetadataBlocks(metadataBlocksRepository)
 
-export { getMetadataBlockByName }
-export { MetadataBlock, MetadataFieldInfo } from './domain/models/MetadataBlock'
+export { getMetadataBlockByName, getCollectionMetadataBlocks }
+export {
+  MetadataBlock,
+  MetadataFieldInfo,
+  MetadataFieldType,
+  MetadataFieldTypeClass
+} from './domain/models/MetadataBlock'