feat: get collection items optional show type counts param

g-saracca · g-saracca · commit 1839da517d66 · 2025-06-05T16:13:16.000-03:00
diff --git a/src/collections/domain/models/CollectionItemSubset.ts b/src/collections/domain/models/CollectionItemSubset.ts
@@ -6,7 +6,7 @@ export interface CollectionItemSubset {
   items: (CollectionPreview | DatasetPreview | FilePreview)[]
   facets: CollectionItemsFacet[]
   totalItemCount: number
-  countPerObjectType: CountPerObjectType
+  countPerObjectType?: CountPerObjectType
 }
 
 export interface CollectionItemsFacet {
diff --git a/src/collections/domain/repositories/ICollectionsRepository.ts b/src/collections/domain/repositories/ICollectionsRepository.ts
@@ -26,7 +26,8 @@ export interface ICollectionsRepository {
     collectionId?: string,
     limit?: number,
     offset?: number,
-    collectionSearchCriteria?: CollectionSearchCriteria
+    collectionSearchCriteria?: CollectionSearchCriteria,
+    showTypeCounts?: boolean
   ): Promise<CollectionItemSubset>
   getMyDataCollectionItems(
     roleIds: number[],
diff --git a/src/collections/domain/useCases/GetCollectionItems.ts b/src/collections/domain/useCases/GetCollectionItems.ts
@@ -18,19 +18,22 @@ export class GetCollectionItems implements UseCase<CollectionItemSubset> {
    * @param {number} [limit] - Limit for pagination (optional).
    * @param {number} [offset] - Offset for pagination (optional).
    * @param {CollectionSearchCriteria} [collectionSearchCriteria] - Supports filtering the collection items by different properties (optional).
+   * @param {boolean} [showTypeCounts] - If true, the response will include the count per object type (optional).
    * @returns {Promise<CollectionItemSubset>}
    */
   async execute(
     collectionId?: string,
     limit?: number,
     offset?: number,
-    collectionSearchCriteria?: CollectionSearchCriteria
+    collectionSearchCriteria?: CollectionSearchCriteria,
+    showTypeCounts = false
   ): Promise<CollectionItemSubset> {
     return await this.collectionsRepository.getCollectionItems(
       collectionId,
       limit,
       offset,
-      collectionSearchCriteria
+      collectionSearchCriteria,
+      showTypeCounts
     )
   }
 }
diff --git a/src/collections/infra/repositories/CollectionsRepository.ts b/src/collections/infra/repositories/CollectionsRepository.ts
@@ -156,14 +156,14 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     collectionId?: string,
     limit?: number,
     offset?: number,
-    collectionSearchCriteria?: CollectionSearchCriteria
+    collectionSearchCriteria?: CollectionSearchCriteria,
+    showTypeCounts?: boolean
   ): Promise<CollectionItemSubset> {
     const queryParams = new URLSearchParams({
       [GetCollectionItemsQueryParams.QUERY]: '*',
       [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
       [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-      [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
-      [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
+      [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
     })
 
     if (collectionId) {
@@ -178,6 +178,10 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       queryParams.set(GetCollectionItemsQueryParams.START, offset.toString())
     }
 
+    if (showTypeCounts) {
+      queryParams.set(GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS, 'true')
+    }
+
     if (collectionSearchCriteria) {
       this.applyCollectionSearchCriteriaToQueryParams(queryParams, collectionSearchCriteria)
     }
diff --git a/src/collections/infra/repositories/transformers/collectionTransformers.ts b/src/collections/infra/repositories/transformers/collectionTransformers.ts
@@ -10,7 +10,8 @@ import { CollectionFacet } from '../../../domain/models/CollectionFacet'
 import { CollectionFacetPayload } from './CollectionFacetPayload'
 import {
   CollectionItemsFacet,
-  CollectionItemSubset
+  CollectionItemSubset,
+  CountPerObjectType
 } from '../../../domain/models/CollectionItemSubset'
 import { DatasetPreview } from '../../../../datasets'
 import { FilePreview } from '../../../../files'
@@ -101,9 +102,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 countPerObjectTypePayload = responseDataPayload['total_count_per_object_type'] as
+    | CollectionItemsCountPerObjectTypePayload
+    | undefined
 
   const items: (DatasetPreview | FilePreview | CollectionPreview)[] = []
 
@@ -136,17 +137,19 @@ export const transformCollectionItemsResponseToCollectionItemSubset = (
     })
   )
 
-  const countPerObjectType = {
-    collections: countPerObjectTypePayload['Dataverses'],
-    datasets: countPerObjectTypePayload['Datasets'],
-    files: countPerObjectTypePayload['Files']
-  }
+  const countPerObjectType: CountPerObjectType | undefined = countPerObjectTypePayload
+    ? {
+        collections: countPerObjectTypePayload['Dataverses'],
+        datasets: countPerObjectTypePayload['Datasets'],
+        files: countPerObjectTypePayload['Files']
+      }
+    : undefined
 
   return {
     items,
     facets,
     totalItemCount: responseDataPayload.total_count,
-    countPerObjectType
+    ...(countPerObjectType && { countPerObjectType })
   }
 }
 
diff --git a/test/integration/collections/CollectionsRepository.test.ts b/test/integration/collections/CollectionsRepository.test.ts
@@ -530,9 +530,6 @@ describe('CollectionsRepository', () => {
       expect(actualCollectionPreview.type).toBe(CollectionItemType.COLLECTION)
 
       expect(actual.totalItemCount).toBe(3)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       expect(actual.facets).toEqual(expectedFacetsAll)
 
@@ -554,9 +551,6 @@ describe('CollectionsRepository', () => {
       )
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
-      expect(actual.countPerObjectType.collections).toBe(0)
-      expect(actual.countPerObjectType.datasets).toBe(0)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       const collectionSearchCriteriaForDataset = new CollectionSearchCriteria().withSearchText(
         'Dataset created using'
@@ -570,9 +564,6 @@ describe('CollectionsRepository', () => {
 
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
-      expect(actual.countPerObjectType.collections).toBe(0)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(0)
 
       const collectionSearchCriteriaForDatasetAndCollection =
         new CollectionSearchCriteria().withSearchText('the')
@@ -585,9 +576,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test search text, limit and offset
       actual = await sut.getCollectionItems(
@@ -599,9 +587,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test type collection
       const collectionSearchCriteriaForCollectionType =
@@ -616,9 +601,6 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
       expect(actual.facets).toEqual(expectedFacetsFromCollectionOnly)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test type dataset
       const collectionSearchCriteriaForDatasetType = new CollectionSearchCriteria().withItemTypes([
@@ -634,9 +616,6 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
       expect(actual.facets).toEqual(expectedFacetsFromDatasetOnly)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test type file
       const collectionSearchCriteriaForFileType = new CollectionSearchCriteria().withItemTypes([
@@ -652,9 +631,6 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
       expect(actual.facets).toEqual(expectedFacetsFromFileOnly)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test multiple types
       const collectionSearchCriteriaForMultiTypes = new CollectionSearchCriteria().withItemTypes([
@@ -672,9 +648,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by name ascending
       const collectionSearchCriteriaNameAscending = new CollectionSearchCriteria()
@@ -692,9 +665,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by name descending
       const collectionSearchCriteriaNameDescending = new CollectionSearchCriteria()
@@ -712,9 +682,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by date ascending
       const collectionSearchCriteriaDateAscending = new CollectionSearchCriteria()
@@ -732,9 +699,6 @@ 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.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test Sort by date descending
       const collectionSearchCriteriaDateDescending = new CollectionSearchCriteria()
@@ -752,9 +716,6 @@ describe('CollectionsRepository', () => {
       expect((actual.items[0] as DatasetPreview).type).toBe(CollectionItemType.DATASET)
       expect((actual.items[1] as FilePreview).type).toBe(CollectionItemType.FILE)
       expect((actual.items[2] as CollectionPreview).type).toBe(CollectionItemType.COLLECTION)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(1)
 
       // Test with Filter query related to the collection
       const collectionSearchCriteriaFilterQueryCollection =
@@ -770,9 +731,6 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
       expect(actual.facets).toEqual(expectedFacetsFromCollectionOnly)
-      expect(actual.countPerObjectType.collections).toBe(1)
-      expect(actual.countPerObjectType.datasets).toBe(0)
-      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test with Filter query related to the dataset
       const collectionSearchCriteriaFilterQueryDataset =
@@ -790,9 +748,6 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
       expect(actual.facets).toEqual(expectedFacetsFromDatasetOnly)
-      expect(actual.countPerObjectType.collections).toBe(0)
-      expect(actual.countPerObjectType.datasets).toBe(1)
-      expect(actual.countPerObjectType.files).toBe(0)
 
       // Test with Filter query related to the file
       const collectionSearchCriteriaFilterQuerieCollAndFile =
@@ -809,9 +764,18 @@ describe('CollectionsRepository', () => {
       expect(actual.totalItemCount).toBe(1)
       expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
       expect(actual.facets).toEqual(expectedFacetsFromFileOnly)
-      expect(actual.countPerObjectType.collections).toBe(0)
-      expect(actual.countPerObjectType.datasets).toBe(0)
-      expect(actual.countPerObjectType.files).toBe(1)
+
+      // Test with showTypeCounts param in true
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        undefined,
+        true
+      )
+      expect(actual.countPerObjectType?.collections).toBe(1)
+      expect(actual.countPerObjectType?.datasets).toBe(1)
+      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
@@ -419,8 +419,7 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.QUERY]: '*',
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
-        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
+        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
       })
 
       const expectedRequestConfigApiKey = {
@@ -465,7 +464,6 @@ 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()
       })
@@ -513,7 +511,6 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
         [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
-        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true',
         [GetCollectionItemsQueryParams.SUBTREE]: testCollectionId
       })
 
@@ -557,8 +554,7 @@ describe('CollectionsRepository', () => {
         [GetCollectionItemsQueryParams.QUERY]: '*',
         [GetCollectionItemsQueryParams.SHOW_FACETS]: 'true',
         [GetCollectionItemsQueryParams.SORT]: SortType.DATE,
-        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC,
-        [GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS]: 'true'
+        [GetCollectionItemsQueryParams.ORDER]: OrderType.DESC
       })
 
       const expectedRequestConfigApiKey = {
diff --git a/test/unit/collections/GetCollectionItems.test.ts b/test/unit/collections/GetCollectionItems.test.ts

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ export interface CollectionItemSubset {`
`6`	`6`	`items: (CollectionPreview \| DatasetPreview \| FilePreview)[]`
`7`	`7`	`facets: CollectionItemsFacet[]`
`8`	`8`	`totalItemCount: number`
`9`		`- countPerObjectType: CountPerObjectType`
	`9`	`+ countPerObjectType?: CountPerObjectType`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`export interface CollectionItemsFacet {`