Added: type filtering to GetCollectionItems

Author: GPortas

src/collections/domain/models/CollectionSearchCriteria.ts

@@ -1,7 +1,20 @@
 export class CollectionSearchCriteria {
-  constructor(public readonly searchText?: string) {}
+  constructor(
+    public readonly searchText?: string,
+    public readonly itemTypes?: CollectionItemType[]
+  ) {}
 
   withSearchText(searchText: string | undefined): CollectionSearchCriteria {
-    return new CollectionSearchCriteria(searchText)
+    return new CollectionSearchCriteria(searchText, this.itemTypes)
   }
+
+  withItemTypes(itemTypes: CollectionItemType[] | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(this.searchText, itemTypes)
+  }
+}
+
+export enum CollectionItemType {
+  FILE = 'file',
+  DATASET = 'dataset',
+  COLLECTION = 'dataverse'
 }

src/collections/index.ts

@@ -26,4 +26,7 @@ export { CollectionFacet } from './domain/models/CollectionFacet'
 export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'
 export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'
 export { CollectionPreview } from './domain/models/CollectionPreview'
-export { CollectionSearchCriteria } from './domain/models/CollectionSearchCriteria'
+export {
+  CollectionSearchCriteria,
+  CollectionItemType
+} from './domain/models/CollectionSearchCriteria'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -11,7 +11,10 @@ import { CollectionFacet } from '../../domain/models/CollectionFacet'
 import { CollectionUserPermissions } from '../../domain/models/CollectionUserPermissions'
 import { transformCollectionUserPermissionsResponseToCollectionUserPermissions } from './transformers/collectionUserPermissionsTransformers'
 import { CollectionItemSubset } from '../../domain/models/CollectionItemSubset'
-import { CollectionSearchCriteria } from '../../domain/models/CollectionSearchCriteria'
+import {
+  CollectionItemType,
+  CollectionSearchCriteria
+} from '../../domain/models/CollectionSearchCriteria'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -44,6 +47,7 @@ export interface GetCollectionItemsQueryParams {
   subtree?: string
   per_page?: number
   start?: number
+  type?: string
 }
 
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
@@ -139,19 +143,29 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     const queryParams: GetCollectionItemsQueryParams = {
       q: '*'
     }
-    if (collectionId !== undefined) {
+    if (collectionId) {
       queryParams.subtree = collectionId
     }
-    if (limit !== undefined) {
+    if (limit) {
       queryParams.per_page = limit
     }
-    if (offset !== undefined) {
+    if (offset) {
       queryParams.start = offset
     }
-    if (collectionSearchCriteria !== undefined) {
+    if (collectionSearchCriteria) {
       this.applyCollectionSearchCriteriaToQueryParams(queryParams, collectionSearchCriteria)
     }
-    return this.doGet('/search?sort=date&order=desc', true, queryParams)
+
+    let url = '/search?sort=date&order=desc'
+
+    if (collectionSearchCriteria?.itemTypes) {
+      const itemTypesQueryString = collectionSearchCriteria.itemTypes
+        .map((itemType: CollectionItemType) => `type=${itemType.toString()}`)
+        .join('&')
+      url += `&${itemTypesQueryString}`
+    }
+
+    return this.doGet(url, true, queryParams)
       .then((response) => transformCollectionItemsResponseToCollectionItemSubset(response))
       .catch((error) => {
         throw error
@@ -162,7 +176,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     queryParams: GetCollectionItemsQueryParams,
     collectionSearchCriteria: CollectionSearchCriteria
   ) {
-    if (collectionSearchCriteria.searchText !== undefined) {
+    if (collectionSearchCriteria.searchText) {
       queryParams.q = encodeURIComponent(collectionSearchCriteria.searchText)
     }
   }

test/integration/collections/CollectionsRepository.test.ts

@@ -1,6 +1,7 @@
 import { CollectionsRepository } from '../../../src/collections/infra/repositories/CollectionsRepository'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import {
+  CollectionItemType,
   CollectionPreview,
   CollectionSearchCriteria,
   CreatedDatasetIdentifiers,
@@ -367,6 +368,63 @@ describe('CollectionsRepository', () => {
       expect(actual.items.length).toBe(1)
       expect(actual.totalItemCount).toBe(2)
       expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
+
+      // Test type collection
+      const collectionSearchCriteriaForCollectionType =
+        new CollectionSearchCriteria().withItemTypes([CollectionItemType.COLLECTION])
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForCollectionType
+      )
+      expect(actual.items.length).toBe(1)
+      expect(actual.totalItemCount).toBe(1)
+      expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
+
+      // Test type dataset
+      const collectionSearchCriteriaForDatasetType = new CollectionSearchCriteria().withItemTypes([
+        CollectionItemType.DATASET
+      ])
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForDatasetType
+      )
+      expect(actual.items.length).toBe(1)
+      expect(actual.totalItemCount).toBe(1)
+      expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
+
+      // Test type file
+      const collectionSearchCriteriaForFileType = new CollectionSearchCriteria().withItemTypes([
+        CollectionItemType.FILE
+      ])
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForFileType
+      )
+      expect(actual.items.length).toBe(1)
+      expect(actual.totalItemCount).toBe(1)
+      expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
+
+      // Test multiple types
+      const collectionSearchCriteriaForMultiTypes = new CollectionSearchCriteria().withItemTypes([
+        CollectionItemType.FILE,
+        CollectionItemType.COLLECTION
+      ])
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForMultiTypes
+      )
+      expect(actual.items.length).toBe(2)
+      expect(actual.totalItemCount).toBe(2)
+      expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
+      expect((actual.items[1] as CollectionPreview).name).toBe(expectedCollectionsName)
     })
 
     test('should return error when collection does not exist', async () => {