refactor: remove AllowedDatasetType and replace with DatasetType, update related interfaces and transformers

Author: jp-tosca

mini.js

@@ -1,39 +1,43 @@
 const { ApiConfig, getDataset, getDatasetStorageDriver, getCollection } = require('./dist')
 
 function requiredEnv(name) {
-	const value = process.env[name]
-	if (!value) {
-		throw new Error(`Missing required environment variable: ${name}`)
-	}
-	return value
+  const value = process.env[name]
+  if (!value) {
+    throw new Error(`Missing required environment variable: ${name}`)
+  }
+  return value
 }
 
 async function main() {
-	const DATAVERSE_API_URL = "http://localhost:8080/api"
-	const DATAVERSE_API_KEY = "e79d640d-0cc1-465d-b5a1-1bc134d562e8"
-	const DATASET_ID = "reviews"
-	const DATASET_VERSION = process.env.DATASET_VERSION || 'latest'
+  const DATAVERSE_API_URL = 'http://localhost:8080/api'
+  const DATAVERSE_API_KEY = 'e79d640d-0cc1-465d-b5a1-1bc134d562e8'
+  const DATASET_ID = 'reviews'
+  const DATASET_VERSION = process.env.DATASET_VERSION || 'latest'
 
-	ApiConfig.init("http://localhost:8080/api", ApiConfig.API_KEY, "e79d640d-0cc1-465d-b5a1-1bc134d562e8");
+  ApiConfig.init(
+    'http://localhost:8080/api',
+    ApiConfig.API_KEY,
+    'e79d640d-0cc1-465d-b5a1-1bc134d562e8'
+  )
 
-
-	getCollection.execute("reviews")
-        .then(collection => {
-            console.log('Collection allowed dataset types:', collection.allowedDatasetTypes);
-            console.log('Collection:', collection);
-        })
-        .catch(error => {
-            console.error('Error fetching collection:', {
-                name: error?.name,
-                message: error?.message,
-                cause: error?.cause,
-                stack: error?.stack,
-            });
-        });
+  getCollection
+    .execute('reviews')
+    .then((collection) => {
+      console.log('Collection allowed dataset types:', collection.allowedDatasetTypes)
+      console.log('Collection:', collection)
+    })
+    .catch((error) => {
+      console.error('Error fetching collection:', {
+        name: error?.name,
+        message: error?.message,
+        cause: error?.cause,
+        stack: error?.stack
+      })
+    })
 }
 
 main().catch((error) => {
-	console.error('Execution failed:')
-	console.error(error?.message || error)
-	process.exit(1)
+  console.error('Execution failed:')
+  console.error(error?.message || error)
+  process.exit(1)
 })

src/collections/domain/models/AllowedDatasetType.ts

@@ -1,7 +1,7 @@
 import { DvObjectOwnerNode } from '../../../core'
 import { CollectionContact } from './CollectionContact'
 import { CollectionType } from './CollectionType'
-import { AllowedDatasetType } from './AllowedDatasetType'
+import { DatasetType } from '../../../datasets'
 
 export interface Collection {
   id: number
@@ -14,7 +14,7 @@ export interface Collection {
   inputLevels?: CollectionInputLevel[]
   type: CollectionType
   contacts?: CollectionContact[]
-  allowedDatasetTypes?: AllowedDatasetType[]
+  allowedDatasetTypes?: DatasetType[]
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
   childCount: number

src/collections/domain/models/Collection.ts

@@ -66,4 +66,3 @@ export { CollectionSearchCriteria } from './domain/models/CollectionSearchCriter
 export { FeaturedItem } from './domain/models/FeaturedItem'
 export { FeaturedItemsDTO } from './domain/dtos/FeaturedItemsDTO'
 export { CollectionSummary } from './domain/models/CollectionSummary'
-export { AllowedDatasetType } from './domain/models/AllowedDatasetType'

src/collections/index.ts

@@ -29,7 +29,10 @@ export interface CollectionContactPayload {
 }
 
 export interface AllowedDatasetTypePayload {
+  id: number
   name: string
   displayName: string
   description?: string
+  linkedMetadataBlocks?: string[]
+  availableLicenses?: string[]
 }

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

@@ -14,7 +14,7 @@ import {
   CollectionItemSubset,
   CountPerObjectType
 } from '../../../domain/models/CollectionItemSubset'
-import { DatasetPreview } from '../../../../datasets'
+import { DatasetPreview, DatasetType } from '../../../../datasets'
 import { FilePreview } from '../../../../files'
 import { DatasetPreviewPayload } from '../../../../datasets/infra/repositories/transformers/DatasetPreviewPayload'
 import { FilePreviewPayload } from '../../../../files/infra/repositories/transformers/FilePreviewPayload'
@@ -46,7 +46,6 @@ import {
 } from '../../../domain/models/MyDataCollectionItemSubset'
 import { PublicationStatus } from '../../../../core/domain/models/PublicationStatus'
 import { CollectionLinks } from '../../../domain/models/CollectionLinks'
-import { AllowedDatasetType } from '../../../domain/models/AllowedDatasetType'
 
 export const transformCollectionResponseToCollection = (response: AxiosResponse): Collection => {
   const collectionPayload = response.data.data
@@ -262,10 +261,13 @@ const transformContactsPayloadToContacts = (
 
 const transformAllowedDatasetTypesPayloadToAllowedDatasetTypes = (
   allowedDatasetTypesPayload: AllowedDatasetTypePayload[]
-): AllowedDatasetType[] => {
+): DatasetType[] => {
   return allowedDatasetTypesPayload.map((allowedDatasetType) => ({
+    id: allowedDatasetType.id,
     name: allowedDatasetType.name,
     displayName: allowedDatasetType.displayName,
-    description: allowedDatasetType.description
+    description: allowedDatasetType.description,
+    linkedMetadataBlocks: allowedDatasetType.linkedMetadataBlocks,
+    availableLicenses: allowedDatasetType.availableLicenses
   }))
 }

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

@@ -47,6 +47,7 @@ export const createCollectionModel = (): Collection => {
     ],
     allowedDatasetTypes: [
       {
+        id: 1,
         name: 'review',
         displayName: 'Review',
         description: 'A review of a dataset compiled by the expert community.'
@@ -84,6 +85,7 @@ export const createCollectionPayload = (): CollectionPayload => {
     ],
     allowedDatasetTypes: [
       {
+        id: 1,
         name: 'review',
         displayName: 'Review',
         description: 'A review of a dataset compiled by the expert community.'