types

Author: jp-tosca

mini.js

@@ -0,0 +1,39 @@
+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
+}
+
+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'
+
+	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,
+            });
+        });
+}
+
+main().catch((error) => {
+	console.error('Execution failed:')
+	console.error(error?.message || error)
+	process.exit(1)
+})

package.json

@@ -9,6 +9,7 @@
   ],
   "scripts": {
     "build": "tsc",
+    "mini": "node mini.js",
     "test": "jest -c jest.config.ts",
     "test:unit": "jest -c jest.config.unit.ts",
     "test:integration": "jest -c jest.config.integration.ts",

src/collections/domain/models/AllowedDatasetType.ts

@@ -0,0 +1,5 @@
+export interface AllowedDatasetType {
+  name: string
+  displayName: string
+  description?: string
+}

src/collections/domain/models/Collection.ts

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

src/collections/index.ts

@@ -66,3 +66,4 @@ 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/infra/repositories/transformers/CollectionPayload.ts

@@ -10,6 +10,7 @@ export interface CollectionPayload {
   isPartOf: OwnerNodePayload
   inputLevels?: CollectionInputLevelPayload[]
   dataverseContacts?: CollectionContactPayload[]
+  allowedDatasetTypes?: AllowedDatasetTypePayload[]
   dataverseType: string
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
@@ -26,3 +27,9 @@ export interface CollectionContactPayload {
   contactEmail: string
   displayOrder: number
 }
+
+export interface AllowedDatasetTypePayload {
+  name: string
+  displayName: string
+  description?: string
+}

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

@@ -3,7 +3,8 @@ import { AxiosResponse } from 'axios'
 import {
   CollectionContactPayload,
   CollectionInputLevelPayload,
-  CollectionPayload
+  CollectionPayload,
+  AllowedDatasetTypePayload
 } from './CollectionPayload'
 import { transformPayloadToOwnerNode } from '../../../../core/infra/repositories/transformers/dvObjectOwnerNodeTransformer'
 import { CollectionFacet } from '../../../domain/models/CollectionFacet'
@@ -45,6 +46,7 @@ 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
@@ -82,6 +84,11 @@ const transformPayloadToCollection = (collectionPayload: CollectionPayload): Col
     }),
     ...(collectionPayload.dataverseContacts && {
       contacts: transformContactsPayloadToContacts(collectionPayload.dataverseContacts)
+    }),
+    ...(collectionPayload.allowedDatasetTypes && {
+      allowedDatasetTypes: transformAllowedDatasetTypesPayloadToAllowedDatasetTypes(
+        collectionPayload.allowedDatasetTypes
+      )
     })
   }
   return collectionModel
@@ -252,3 +259,13 @@ const transformContactsPayloadToContacts = (
     displayOrder: contactPayload.displayOrder
   }))
 }
+
+const transformAllowedDatasetTypesPayloadToAllowedDatasetTypes = (
+  allowedDatasetTypesPayload: AllowedDatasetTypePayload[]
+): AllowedDatasetType[] => {
+  return allowedDatasetTypesPayload.map((allowedDatasetType) => ({
+    name: allowedDatasetType.name,
+    displayName: allowedDatasetType.displayName,
+    description: allowedDatasetType.description
+  }))
+}

test/environment/setup.ts

@@ -15,11 +15,14 @@ const API_KEY_USER_ENDPOINT = '/builtin-users/dataverseAdmin/api-token'
 const API_KEY_USER_PASSWORD = 'admin1'
 
 export default async function setupTestEnvironment(): Promise<void> {
-  await setupContainers()
+  await setupContainers() //Set skipContainers to true to skip container setup and run tests against an already running instance
   await setupApiKey()
 }
 
-async function setupContainers(): Promise<void> {
+async function setupContainers(skipContainers?: boolean): Promise<void> {
+  if (skipContainers) {
+    return
+  }
   console.log('Cleaning up old container volumes...')
   fs.rmSync(`${__dirname}/docker-dev-volumes`, { recursive: true, force: true })
   console.log('Running test containers...')

test/testHelpers/collections/collectionHelper.ts

@@ -45,6 +45,13 @@ export const createCollectionModel = (): Collection => {
         displayOrder: 0
       }
     ],
+    allowedDatasetTypes: [
+      {
+        name: 'review',
+        displayName: 'Review',
+        description: 'A review of a dataset compiled by the expert community.'
+      }
+    ],
     isMetadataBlockRoot: true,
     isFacetRoot: true,
     childCount: 0
@@ -75,6 +82,13 @@ export const createCollectionPayload = (): CollectionPayload => {
         displayOrder: 0
       }
     ],
+    allowedDatasetTypes: [
+      {
+        name: 'review',
+        displayName: 'Review',
+        description: 'A review of a dataset compiled by the expert community.'
+      }
+    ],
     isMetadataBlockRoot: true,
     isFacetRoot: true,
     childCount: 0