Stash: CollectionSearchCriteria for GetCollectionItems WIP

Author: GPortas

docs/useCases.md

@@ -186,10 +186,14 @@ _See [use case](../src/collections/domain/useCases/GetCollectionItems.ts) implem
 
 Note that `collectionId` is an optional parameter to filter the items by a specific collection. If not set, the use case will return items starting from the root collection.
 
-Note that `limit` and `offset` are optional parameters for pagination.
-
 The `CollectionItemSubset`returned instance contains a property called `totalItemCount` which is necessary for pagination.
 
+This use case supports the following optional parameters depending on the search goals:
+
+- **limit**: (number) Limit for pagination.
+- **offset**: (number) Offset for pagination.
+- **collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
+
 ### Collections Write Use Cases
 
 #### Create a Collection

src/collections/domain/models/CollectionSearchCriteria.ts

@@ -0,0 +1,7 @@
+export class CollectionSearchCriteria {
+  constructor(public readonly searchText?: string) {}
+
+  withSearchText(searchText: string | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(searchText)
+  }
+}

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -2,6 +2,7 @@ import { CollectionDTO } from '../dtos/CollectionDTO'
 import { Collection } from '../models/Collection'
 import { CollectionFacet } from '../models/CollectionFacet'
 import { CollectionItemSubset } from '../models/CollectionItemSubset'
+import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
 import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 
 export interface ICollectionsRepository {
@@ -17,6 +18,7 @@ export interface ICollectionsRepository {
   getCollectionItems(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset>
 }

src/collections/domain/useCases/GetCollectionItems.ts

@@ -1,4 +1,5 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { CollectionSearchCriteria } from '../../../collections'
 import { CollectionItemSubset } from '../models/CollectionItemSubset'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 
@@ -16,13 +17,20 @@ export class GetCollectionItems implements UseCase<CollectionItemSubset> {
    * @param {string} [collectionId] - Collection id (optional).
    * @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).
    * @returns {Promise<CollectionItemSubset>}
    */
   async execute(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria,
   ): Promise<CollectionItemSubset> {
-    return await this.collectionsRepository.getCollectionItems(collectionId, limit, offset)
+    return await this.collectionsRepository.getCollectionItems(
+      collectionId,
+      limit,
+      offset,
+      collectionSearchCriteria
+    )
   }
 }

src/collections/index.ts

@@ -26,3 +26,4 @@ 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'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -11,6 +11,7 @@ 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'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -42,6 +43,7 @@ export interface GetCollectionItemsQueryParams {
   subtree?: string
   per_page?: number
   start?: number
+  searchText?: string
 }
 
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
@@ -131,7 +133,8 @@ export class CollectionsRepository extends ApiRepository implements ICollections
   public async getCollectionItems(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset> {
     const queryParams: GetCollectionItemsQueryParams = {}
     if (collectionId !== undefined) {
@@ -143,10 +146,22 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     if (offset !== undefined) {
       queryParams.start = offset
     }
+    if (collectionSearchCriteria !== undefined) {
+      this.applyCollectionSearchCriteriaToQueryParams(queryParams, collectionSearchCriteria)
+    }
     return this.doGet('/search?q=*&sort=date&order=desc', true, queryParams)
       .then((response) => transformCollectionItemsResponseToCollectionItemSubset(response))
       .catch((error) => {
         throw error
       })
   }
+
+  private applyCollectionSearchCriteriaToQueryParams(
+    queryParams: GetCollectionItemsQueryParams,
+    collectionSearchCriteria: CollectionSearchCriteria
+  ) {
+    if (collectionSearchCriteria.searchText !== undefined) {
+      queryParams.searchText = collectionSearchCriteria.searchText
+    }
+  }
 }