Merge pull request #240 from IQSS/feat/233-count-per-object-extension

ofahimIQSS · web-flow · commit 4f3d824cb6b0 · 2025-02-04T14:09:44.000-05:00
Get Collection Items extension - Count per object type
diff --git a/src/collections/domain/models/CollectionItemSubset.ts b/src/collections/domain/models/CollectionItemSubset.ts
@@ -6,6 +6,7 @@ export interface CollectionItemSubset {
   items: (CollectionPreview | DatasetPreview | FilePreview)[]
   facets: CollectionItemsFacet[]
   totalItemCount: number
+  countPerObjectType: CountPerObjectType
 }
 
 export interface CollectionItemsFacet {
@@ -18,3 +19,9 @@ interface CollectionItemsFacetLabel {
   name: string
   count: number
 }
+
+interface CountPerObjectType {
+  dataverses: number
+  datasets: number
+  files: number
+}
diff --git a/src/collections/infra/repositories/CollectionsRepository.ts b/src/collections/infra/repositories/CollectionsRepository.ts
@@ -57,7 +57,8 @@ export enum GetCollectionItemsQueryParams {
   PER_PAGE = 'per_page',
   START = 'start',
   TYPE = 'type',
-  FILTERQUERY = 'fq'
+  FILTERQUERY = 'fq',
+  SHOW_TYPE_COUNTS = 'show_type_counts'
 }
 
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
@@ -135,7 +136,8 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       [GetCollectionItemsQueryParams.QUERY]: '*',
       [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
       [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-      [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
+      [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
+      [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
     })
 
     if (collectionId) {
diff --git a/src/collections/infra/repositories/transformers/CollectionItemsCountPerObjectTypePayload.ts b/src/collections/infra/repositories/transformers/CollectionItemsCountPerObjectTypePayload.ts
@@ -0,0 +1,5 @@
+export interface CollectionItemsCountPerObjectTypePayload {
+  Dataverses: number
+  Datasets: number
+  Files: number
+}
diff --git a/src/collections/infra/repositories/transformers/collectionTransformers.ts b/src/collections/infra/repositories/transformers/collectionTransformers.ts
@@ -25,6 +25,7 @@ import { CollectionPreview } from '../../../domain/models/CollectionPreview'
 import { CollectionContact } from '../../../domain/models/CollectionContact'
 import { CollectionType } from '../../../domain/models/CollectionType'
 import { CollectionItemsFacetPayload } from './CollectionItemsFacetsPayload'
+import { CollectionItemsCountPerObjectTypePayload } from './CollectionItemsCountPerObjectTypePayload'
 
 export const transformCollectionResponseToCollection = (response: AxiosResponse): Collection => {
   const collectionPayload = response.data.data
@@ -84,6 +85,9 @@ export const transformCollectionItemsResponseToCollectionItemSubset = (
   const responseDataPayload = response.data.data
   const itemsPayload = responseDataPayload.items
   const facetsPayload = responseDataPayload.facets as CollectionItemsFacetPayload
+  const countPerObjectTypePayload = responseDataPayload[
+    'total_count_per_object_type'
+  ] as CollectionItemsCountPerObjectTypePayload
 
   const items: (DatasetPreview | FilePreview | CollectionPreview)[] = []
 
@@ -116,10 +120,17 @@ export const transformCollectionItemsResponseToCollectionItemSubset = (
     })
   )
 
+  const countPerObjectType = {
+    dataverses: countPerObjectTypePayload['Dataverses'],
+    datasets: countPerObjectTypePayload['Datasets'],
+    files: countPerObjectTypePayload['Files']
+  }
+
   return {
     items,
     facets,
-    totalItemCount: responseDataPayload.total_count
+    totalItemCount: responseDataPayload.total_count,
+    countPerObjectType
   }
 }
 
diff --git a/test/integration/collections/CollectionsRepository.test.ts b/test/integration/collections/CollectionsRepository.test.ts
@@ -425,6 +425,9 @@ describe('CollectionsRepository', () => {
       expect(actualCollectionPreview.type).toBe(CollectionItemType.COLLECTION)
 
       expect(actual.totalItemCount).toBe(3)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       expect(actual.facets).toEqual(expectedFacetsAll)
 
@@ -446,6 +449,9 @@ describe('CollectionsRepository', () => {
       )
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       const collectionSearchCriteriaForDataset = new CollectionSearchCriteria().withSearchText(
         'This is the description'
@@ -458,6 +464,9 @@ describe('CollectionsRepository', () => {
       )
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       const collectionSearchCriteriaForDatasetAndCollection =
         new CollectionSearchCriteria().withSearchText('the')
@@ -470,6 +479,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(2)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
       expect((actual.items[1] as CollectionPreview).name).toBe(expectedCollectionsName)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test search text, limit and offset
       actual = await sut.getCollectionItems(
@@ -481,6 +493,9 @@ describe('CollectionsRepository', () => {
       expect(actual.items.length).toBe(1)
       expect(actual.totalItemCount).toBe(2)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test type collection
       const collectionSearchCriteriaForCollectionType =
@@ -495,6 +510,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
       expect(actual.facets).toEqual(expectedFacetsFromCollectionOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test type dataset
       const collectionSearchCriteriaForDatasetType = new CollectionSearchCriteria().withItemTypes([
@@ -510,6 +528,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
       expect(actual.facets).toEqual(expectedFacetsFromDatasetOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test type file
       const collectionSearchCriteriaForFileType = new CollectionSearchCriteria().withItemTypes([
@@ -525,6 +546,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
       expect(actual.facets).toEqual(expectedFacetsFromFileOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test multiple types
       const collectionSearchCriteriaForMultiTypes = new CollectionSearchCriteria().withItemTypes([
@@ -542,6 +566,9 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
       expect((actual.items[1] as CollectionPreview).name).toBe(expectedCollectionsName)
       expect(actual.facets).toEqual(expectedFacetsFromCollectionAndFile)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by name ascending
       const collectionSearchCriteriaNameAscending = new CollectionSearchCriteria()
@@ -559,6 +586,9 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as DatasetPreview).type).toBe(CollectionItemType.DATASET)
       expect((actual.items[1] as CollectionPreview).type).toBe(CollectionItemType.COLLECTION)
       expect((actual.items[2] as FilePreview).type).toBe(CollectionItemType.FILE)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by name descending
       const collectionSearchCriteriaNameDescending = new CollectionSearchCriteria()
@@ -576,6 +606,9 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as FilePreview).type).toBe(CollectionItemType.FILE)
       expect((actual.items[1] as CollectionPreview).type).toBe(CollectionItemType.COLLECTION)
       expect((actual.items[2] as DatasetPreview).type).toBe(CollectionItemType.DATASET)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by date ascending
       const collectionSearchCriteriaDateAscending = new CollectionSearchCriteria()
@@ -593,6 +626,9 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as CollectionPreview).type).toBe(CollectionItemType.COLLECTION)
       expect((actual.items[1] as DatasetPreview).type).toBe(CollectionItemType.DATASET)
       expect((actual.items[2] as FilePreview).type).toBe(CollectionItemType.FILE)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by date descending
       const collectionSearchCriteriaDateDescending = new CollectionSearchCriteria()
@@ -610,6 +646,9 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as FilePreview).type).toBe(CollectionItemType.FILE)
       expect((actual.items[1] as DatasetPreview).type).toBe(CollectionItemType.DATASET)
       expect((actual.items[2] as CollectionPreview).type).toBe(CollectionItemType.COLLECTION)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test with Filter query related to the collection
       const collectionSearchCriteriaFilterQueryCollection =
@@ -625,6 +664,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
       expect(actual.facets).toEqual(expectedFacetsFromCollectionOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(1)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test with Filter query related to the dataset
       const collectionSearchCriteriaFilterQueryDataset =
@@ -642,6 +684,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
       expect(actual.facets).toEqual(expectedFacetsFromDatasetOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(1)
+      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test with Filter query related to the file
       const collectionSearchCriteriaFilterQuerieCollAndFile =
@@ -658,6 +703,9 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
       expect(actual.facets).toEqual(expectedFacetsFromFileOnly)
+      expect(actual.countPerObjectType.dataverses).toBe(0)
+      expect(actual.countPerObjectType.datasets).toBe(0)
+      expect(actual.countPerObjectType.files).toBe(1)
     })
 
     test('should return error when collection does not exist', async () => {
diff --git a/test/unit/collections/CollectionsRepository.test.ts b/test/unit/collections/CollectionsRepository.test.ts
@@ -373,11 +373,17 @@ describe('CollectionsRepository', () => {
     ]
     const testTotalCount = 2
     const testFacets = createCollectionItemsFacetsModel()
+    const testCountPerObjectType = {
+      dataverses: 0,
+      datasets: 1,
+      files: 1
+    }
 
     const testItemSubset: CollectionItemSubset = {
       items: testItems,
       facets: testFacets,
-      totalItemCount: testTotalCount
+      totalItemCount: testTotalCount,
+      countPerObjectType: testCountPerObjectType
     }
 
     const testItemPreviewsResponse = {
@@ -390,7 +396,12 @@ describe('CollectionsRepository', () => {
             createFilePreviewPayload(),
             createCollectionPreviewPayload()
           ],
-          facets: createCollectionItemsFacetsPayload()
+          facets: createCollectionItemsFacetsPayload(),
+          total_count_per_object_type: {
+            Dataverses: 0,
+            Datasets: 1,
+            Files: 1
+          }
         }
       }
     }
@@ -407,7 +418,8 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.QUERY]: '*',
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
+        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
+        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
       })
 
       const expectedRequestConfigApiKey = {
@@ -452,6 +464,7 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
         [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
+        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true',
         [GetCollectionItemsQueryParams.PER_PAGE]: testLimit.toString(),
         [GetCollectionItemsQueryParams.START]: testOffset.toString()
       })
@@ -499,6 +512,7 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
         [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
+        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true',
         [GetCollectionItemsQueryParams.SUBTREE]: testCollectionId
       })
 
@@ -542,7 +556,8 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.QUERY]: '*',
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
+        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
+        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
       })
 
       const expectedRequestConfigApiKey = {
diff --git a/test/unit/collections/GetCollectionItems.test.ts b/test/unit/collections/GetCollectionItems.test.ts
@@ -18,11 +18,17 @@ describe('execute', () => {
   ]
   const testTotalCount = 3
   const testFacets = createCollectionItemsFacetsModel()
+  const testCountPerObjectType = {
+    dataverses: 1,
+    datasets: 1,
+    files: 1
+  }
 
   const testItemSubset: CollectionItemSubset = {
     items: testItems,
     facets: testFacets,
-    totalItemCount: testTotalCount
+    totalItemCount: testTotalCount,
+    countPerObjectType: testCountPerObjectType
   }
 
   beforeEach(() => {
