fix: add a test of using pId

ChengShi-1 · ChengShi-1 · commit faf2b4245358 · 2026-06-08T18:01:37.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,8 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Added
 
 - Files: Added `getFileCitationByFormat` use case, repository method, and `FileCitationFormat` enum to support Dataverse file citation exports in `EndNote`, `RIS`, `BibTeX`, `CSL`, and `Internal` formats.
+- Collections: Added `allowedDatasetTypes` field to the [Collection](./src/collections/domain/models/Collection.ts) model. This field is optional and only populated the feature is enabled on the installation and configured on the collection.
+- Collections: Added theme information when retrieving a collection using `getCollection`.
 
 ### Changed
 
diff --git a/docs/useCases.md b/docs/useCases.md
@@ -198,6 +198,20 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
 
+##### Collection Allowed Dataset Types
+
+Collections can optionally restrict which [DatasetType](../src/datasets/domain/models/DatasetType.ts) objects can be created within them. The `allowedDatasetTypes` field contains an array of dataset types allowed on the collection when configured. If not configured on the collection, this field will be `undefined`.
+
+```typescript
+getCollection.execute('myCollection').then((collection: Collection) => {
+  if (collection.allowedDatasetTypes) {
+    collection.allowedDatasetTypes.forEach((datasetType) => {
+      console.log(`Allowed type: ${datasetType.displayName}`)
+    })
+  }
+})
+```
+
 #### Get Collection Storage Driver
 
 Returns a [StorageDriver](../src/core/domain/models/StorageDriver.ts) instance describing the collection's assigned storage driver.
diff --git a/src/collections/domain/models/Collection.ts b/src/collections/domain/models/Collection.ts
@@ -1,6 +1,7 @@
 import { DvObjectOwnerNode } from '../../../core'
 import { CollectionContact } from './CollectionContact'
 import { CollectionType } from './CollectionType'
+import { DatasetType } from '../../../datasets'
 
 export interface Collection {
   id: number
@@ -13,9 +14,22 @@ export interface Collection {
   inputLevels?: CollectionInputLevel[]
   type: CollectionType
   contacts?: CollectionContact[]
+  allowedDatasetTypes?: DatasetType[]
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
   childCount: number
+  theme?: CollectionTheme
+}
+
+export interface CollectionTheme {
+  id: number
+  logo?: string
+  tagline?: string
+  linkUrl?: string
+  linkColor?: string
+  textColor?: string
+  backgroundColor?: string
+  logoBackgroundColor?: string
 }
 
 export interface CollectionInputLevel {
diff --git a/src/collections/index.ts b/src/collections/index.ts
@@ -70,7 +70,7 @@ export {
   deleteCollectionStorageDriver,
   getAllowedCollectionStorageDrivers
 }
-export { Collection, CollectionInputLevel } from './domain/models/Collection'
+export { Collection, CollectionInputLevel, CollectionTheme } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'
 export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'
 export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'
diff --git a/src/collections/infra/repositories/transformers/CollectionPayload.ts b/src/collections/infra/repositories/transformers/CollectionPayload.ts
@@ -10,10 +10,23 @@ export interface CollectionPayload {
   isPartOf: OwnerNodePayload
   inputLevels?: CollectionInputLevelPayload[]
   dataverseContacts?: CollectionContactPayload[]
+  allowedDatasetTypes?: AllowedDatasetTypePayload[]
   dataverseType: string
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
   childCount: number
+  theme?: CollectionThemePayload
+}
+
+export interface CollectionThemePayload {
+  id: number
+  logo?: string
+  tagline?: string
+  linkUrl?: string
+  linkColor?: string
+  textColor?: string
+  backgroundColor?: string
+  logoBackgroundColor?: string
 }
 
 export interface CollectionInputLevelPayload {
@@ -26,3 +39,10 @@ export interface CollectionContactPayload {
   contactEmail: string
   displayOrder: number
 }
+
+export interface AllowedDatasetTypePayload {
+  id: number
+  name: string
+  displayName: string
+  description?: string
+}
diff --git a/src/collections/infra/repositories/transformers/collectionTransformers.ts b/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'
@@ -13,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'
@@ -74,6 +75,9 @@ const transformPayloadToCollection = (collectionPayload: CollectionPayload): Col
     isFacetRoot: collectionPayload.isFacetRoot,
     description: collectionPayload.description,
     childCount: collectionPayload.childCount,
+    ...(collectionPayload.theme && {
+      theme: collectionPayload.theme
+    }),
     ...(collectionPayload.isPartOf && {
       isPartOf: transformPayloadToOwnerNode(collectionPayload.isPartOf)
     }),
@@ -82,6 +86,11 @@ const transformPayloadToCollection = (collectionPayload: CollectionPayload): Col
     }),
     ...(collectionPayload.dataverseContacts && {
       contacts: transformContactsPayloadToContacts(collectionPayload.dataverseContacts)
+    }),
+    ...(collectionPayload.allowedDatasetTypes && {
+      allowedDatasetTypes: transformAllowedDatasetTypesPayloadToAllowedDatasetTypes(
+        collectionPayload.allowedDatasetTypes
+      )
     })
   }
   return collectionModel
@@ -252,3 +261,14 @@ const transformContactsPayloadToContacts = (
     displayOrder: contactPayload.displayOrder
   }))
 }
+
+const transformAllowedDatasetTypesPayloadToAllowedDatasetTypes = (
+  allowedDatasetTypesPayload: AllowedDatasetTypePayload[]
+): DatasetType[] => {
+  return allowedDatasetTypesPayload.map((allowedDatasetType) => ({
+    id: allowedDatasetType.id,
+    name: allowedDatasetType.name,
+    displayName: allowedDatasetType.displayName,
+    description: allowedDatasetType.description
+  }))
+}
diff --git a/test/functional/datasets/GetDatasetAvailableDatasetTypes.test.ts b/test/functional/datasets/GetDatasetAvailableDatasetTypes.test.ts
@@ -14,18 +14,17 @@ describe('getDatasetAvailableDatasetTypes', () => {
 
     test('should return available dataset types', async () => {
       const actualDatasetTypes: DatasetType[] = await getDatasetAvailableDatasetTypes.execute()
-      const expectedDatasetTypes = [
-        {
-          id: 1,
-          name: 'dataset',
-          linkedMetadataBlocks: [],
-          availableLicenses: [],
-          description:
-            'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.',
-          displayName: 'Dataset'
-        }
-      ]
-      expect(actualDatasetTypes).toEqual(expectedDatasetTypes)
+      const expectedDatasetType = {
+        id: 1,
+        name: 'dataset',
+        linkedMetadataBlocks: [],
+        availableLicenses: [],
+        description:
+          'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.',
+        displayName: 'Dataset'
+      }
+
+      expect(actualDatasetTypes).toContainEqual(expectedDatasetType)
     })
   })
 })
diff --git a/test/integration/collections/CollectionsRepository.test.ts b/test/integration/collections/CollectionsRepository.test.ts
@@ -110,6 +110,17 @@ describe('CollectionsRepository', () => {
         expect(actual.alias).toBe(ROOT_COLLECTION_ALIAS)
         expect(actual.isReleased).toBe(true)
       })
+
+      test('should return theme for root collection', async () => {
+        const actual = await sut.getCollection()
+        expect(actual.alias).toBe(ROOT_COLLECTION_ALIAS)
+        // Root collection might or might not have a theme, but the property should be present if it does
+        // and we want to ensure the transformer doesn't fail.
+        // In a default Dataverse installation, root theme is usually undefined or has some default values.
+        if (actual.theme) {
+          expect(actual.theme).toHaveProperty('id')
+        }
+      })
     })
     describe('by string alias', () => {
       test('should return collection when it exists filtering by id AS (alias)', async () => {
@@ -176,6 +187,13 @@ describe('CollectionsRepository', () => {
       expect(actualAfterDatasetDeletion.childCount).toBe(0)
       await deleteCollectionViaApi(parentCollectionAlias)
     })
+
+    test('should transform allowedDatasetTypes correctly when retrieving a collection', async () => {
+      const actual = await sut.getCollection(testCollectionAlias)
+      expect(
+        actual.allowedDatasetTypes === undefined || Array.isArray(actual.allowedDatasetTypes)
+      ).toBe(true)
+    })
   })
 
   describe('publishCollection', () => {
diff --git a/test/integration/files/FilesRepository.test.ts b/test/integration/files/FilesRepository.test.ts
@@ -682,6 +682,19 @@ describe('FilesRepository', () => {
       expect(citation.trimStart()).toMatch(/^@\w+\{/)
     })
 
+    test('should return BibTeX citation when file is requested by persistent id', async () => {
+      expect(testFilePersistentId).toBeTruthy()
+
+      const citation = await sut.getFileCitationByFormat(
+        testFilePersistentId,
+        FileCitationFormat.BIBTEX
+      )
+
+      expect(typeof citation).toBe('string')
+      // BibTeX entries start with @<entry-type>{
+      expect(citation.trimStart()).toMatch(/^@\w+\{/)
+    })
+
     test('should return CSL citation as JSON', async () => {
       const citation = await sut.getFileCitationByFormat(testFileId, FileCitationFormat.CSL)
 
diff --git a/test/testHelpers/collections/collectionHelper.ts b/test/testHelpers/collections/collectionHelper.ts
@@ -1,6 +1,9 @@
-import { Collection, CollectionFacet } from '../../../src/collections'
+import { Collection, CollectionFacet, CollectionTheme } from '../../../src/collections'
 import { DvObjectType } from '../../../src'
-import { CollectionPayload } from '../../../src/collections/infra/repositories/transformers/CollectionPayload'
+import {
+  CollectionPayload,
+  CollectionThemePayload
+} from '../../../src/collections/infra/repositories/transformers/CollectionPayload'
 import { TestConstants } from '../TestConstants'
 import axios from 'axios'
 import { CollectionDTO } from '../../../src/collections/domain/dtos/CollectionDTO'
@@ -22,7 +25,7 @@ const DATAVERSE_API_REQUEST_HEADERS = {
   headers: { 'Content-Type': 'application/json', 'X-Dataverse-Key': process.env.TEST_API_KEY }
 }
 
-export const createCollectionModel = (): Collection => {
+export const createCollectionModel = (theme?: CollectionTheme): Collection => {
   const collectionModel: Collection = {
     id: COLLECTION_ID,
     alias: COLLECTION_ALIAS_STR,
@@ -45,14 +48,23 @@ export const createCollectionModel = (): Collection => {
         displayOrder: 0
       }
     ],
+    allowedDatasetTypes: [
+      {
+        id: 1,
+        name: 'review',
+        displayName: 'Review',
+        description: 'A review of a dataset compiled by the expert community.'
+      }
+    ],
     isMetadataBlockRoot: true,
     isFacetRoot: true,
-    childCount: 0
+    childCount: 0,
+    ...(theme && { theme })
   }
   return collectionModel
 }
 
-export const createCollectionPayload = (): CollectionPayload => {
+export const createCollectionPayload = (theme?: CollectionThemePayload): CollectionPayload => {
   const collectionPayload: CollectionPayload = {
     id: COLLECTION_ID,
     alias: COLLECTION_ALIAS_STR,
@@ -75,9 +87,18 @@ export const createCollectionPayload = (): CollectionPayload => {
         displayOrder: 0
       }
     ],
+    allowedDatasetTypes: [
+      {
+        id: 1,
+        name: 'review',
+        displayName: 'Review',
+        description: 'A review of a dataset compiled by the expert community.'
+      }
+    ],
     isMetadataBlockRoot: true,
     isFacetRoot: true,
-    childCount: 0
+    childCount: 0,
+    ...(theme && { theme })
   }
   return collectionPayload
 }
diff --git a/test/unit/collections/CollectionsRepository.test.ts b/test/unit/collections/CollectionsRepository.test.ts
@@ -12,11 +12,12 @@ import {
   createCollectionFacetRequestPayload,
   createCollectionModel,
   createCollectionPayload,
-  createNewCollectionRequestPayload
+  createNewCollectionRequestPayload,
 } from '../../testHelpers/collections/collectionHelper'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { ReadError, WriteError } from '../../../src'
-import { ROOT_COLLECTION_ID } from '../../../src/collections/domain/models/Collection'
+import { ROOT_COLLECTION_ID, CollectionTheme } from '../../../src/collections/domain/models/Collection'
+import { CollectionThemePayload } from '../../../src/collections/infra/repositories/transformers/CollectionPayload'
 import { AllowedStorageDrivers } from '../../../src/collections/domain/models/AllowedStorageDrivers'
 import { StorageDriver } from '../../../src/core/domain/models/StorageDriver'
 import {
@@ -137,6 +138,31 @@ describe('CollectionsRepository', () => {
         expect(error).toBeInstanceOf(Error)
       })
     })
+
+    describe('with theme', () => {
+      test('should return Collection with theme when providing a numeric id and the collection has a theme with only some fields', async () => {
+        const testThemePayload: CollectionThemePayload = {
+          id: 1
+        }
+        const testCollectionPayload = createCollectionPayload(testThemePayload)
+        const testThemeModel: CollectionTheme = {
+          id: 1
+        }
+        const testCollectionModelWithTheme = createCollectionModel(testThemeModel)
+
+        jest.spyOn(axios, 'get').mockResolvedValue({
+          data: {
+            status: 'OK',
+            data: testCollectionPayload
+          }
+        })
+
+        const actual = await sut.getCollection(testCollectionModel.id)
+
+        expect(actual).toStrictEqual(testCollectionModelWithTheme)
+      })
+    })
+
     describe('by alias id', () => {
       test('should return a Collection when providing the Collection alias is successful', async () => {
         jest.spyOn(axios, 'get').mockResolvedValue(testCollectionSuccessfulResponse)
diff --git a/test/unit/files/FilesRepository.test.ts b/test/unit/files/FilesRepository.test.ts
@@ -1219,21 +1219,6 @@ describe('FilesRepository', () => {
       }
     )
 
-    test('should authenticate via session cookie when configured', async () => {
-      const testCitation = '@article{test}'
-      jest.spyOn(axios, 'get').mockResolvedValue({ data: testCitation })
-      const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/access/datafile/${testFile.id}/citation/BibTeX`
-
-      ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
-      const actual = await sut.getFileCitationByFormat(testFile.id, FileCitationFormat.BIBTEX)
-
-      expect(axios.get).toHaveBeenCalledWith(
-        expectedApiEndpoint,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
-      )
-      expect(actual).toEqual(testCitation)
-    })
-
     test('should return error on repository read error', async () => {
       jest.spyOn(axios, 'get').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
 

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ export {`
`70`	`70`	`deleteCollectionStorageDriver,`
`71`	`71`	`getAllowedCollectionStorageDrivers`
`72`	`72`	`}`
`73`		`-export { Collection, CollectionInputLevel } from './domain/models/Collection'`
	`73`	`+export { Collection, CollectionInputLevel, CollectionTheme } from './domain/models/Collection'`
`74`	`74`	`export { CollectionFacet } from './domain/models/CollectionFacet'`
`75`	`75`	`export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'`
`76`	`76`	`export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'`