Merge pull request #417 from vera/feat/get-collection-theme

Extend "get collection" use case to return theme

Author: ChengShi-1

CHANGELOG.md

@@ -9,6 +9,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Added
 
 - 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
 

src/collections/domain/models/Collection.ts

@@ -18,6 +18,18 @@ export interface Collection {
   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 {

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'

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

@@ -15,6 +15,18 @@ export interface CollectionPayload {
   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 {

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

@@ -75,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)
     }),

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 () => {

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,
@@ -55,12 +58,13 @@ export const createCollectionModel = (): Collection => {
     ],
     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,
@@ -93,7 +97,8 @@ export const createCollectionPayload = (): CollectionPayload => {
     ],
     isMetadataBlockRoot: true,
     isFacetRoot: true,
-    childCount: 0
+    childCount: 0,
+    ...(theme && { theme })
   }
   return collectionPayload
 }

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)