Merge pull request #308 from IQSS/enhanced_search

Enhanced search

Author: ofahimIQSS

docs/useCases.md

@@ -85,6 +85,8 @@ The different use cases currently available in the package are classified below,
   - [Get Application Terms of Use](#get-application-terms-of-use)
 - [Contact](#Contact)
   - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
+- [Search](#Search)
+  - [Get Search Services](#get-search-services)
 
 ## Collections
 
@@ -222,6 +224,8 @@ This use case supports the following optional parameters depending on the search
 - **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.
+- **searchServiceName**: The search service name on which to execute the search (Optional).
+- **showTypeCounts**: If true, the response will include the count per object type (Optional).
 
 #### List My Data Collection Items
 
@@ -1991,3 +1995,25 @@ In ContactDTO, it takes the following information:
 - **subject**: the email subject line.
 - **body**: the email body to send.
 - **fromEmail**: the email to list in the reply-to field.
+
+## Search
+
+#### Get Search Services
+
+Returns all [Search Services](../src/search/domain/models/SearchService.ts) available in the installation.
+
+##### Example call:
+
+```typescript
+import { getSearchServices } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getSearchServices.execute().then((searchServices: SearchService[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/search/domain/useCases/GetSearchServices.ts) implementation_.

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -27,6 +27,7 @@ export interface ICollectionsRepository {
     limit?: number,
     offset?: number,
     collectionSearchCriteria?: CollectionSearchCriteria,
+    searchServiceName?: string,
     showTypeCounts?: boolean
   ): Promise<CollectionItemSubset>
   getMyDataCollectionItems(

src/collections/domain/useCases/GetCollectionItems.ts

@@ -18,6 +18,7 @@ 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 {string} [searchServiceName] - The search service name on which to execute the search (optional).
    * @param {boolean} [showTypeCounts] - If true, the response will include the count per object type (optional).
    * @returns {Promise<CollectionItemSubset>}
    */
@@ -26,13 +27,15 @@ export class GetCollectionItems implements UseCase<CollectionItemSubset> {
     limit?: number,
     offset?: number,
     collectionSearchCriteria?: CollectionSearchCriteria,
+    searchServiceName?: string,
     showTypeCounts = false
   ): Promise<CollectionItemSubset> {
     return await this.collectionsRepository.getCollectionItems(
       collectionId,
       limit,
       offset,
       collectionSearchCriteria,
+      searchServiceName,
       showTypeCounts
     )
   }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -75,7 +75,8 @@ export enum GetCollectionItemsQueryParams {
   START = 'start',
   TYPE = 'type',
   FILTERQUERY = 'fq',
-  SHOW_TYPE_COUNTS = 'show_type_counts'
+  SHOW_TYPE_COUNTS = 'show_type_counts',
+  SEARCH_SERVICE_NAME = 'search_service'
 }
 
 export enum GetMyDataCollectionItemsQueryParams {
@@ -168,6 +169,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     limit?: number,
     offset?: number,
     collectionSearchCriteria?: CollectionSearchCriteria,
+    searchServiceName?: string,
     showTypeCounts?: boolean
   ): Promise<CollectionItemSubset> {
     const queryParams = new URLSearchParams({
@@ -193,6 +195,10 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       queryParams.set(GetCollectionItemsQueryParams.SHOW_TYPE_COUNTS, 'true')
     }
 
+    if (searchServiceName) {
+      queryParams.set(GetCollectionItemsQueryParams.SEARCH_SERVICE_NAME, searchServiceName)
+    }
+
     if (collectionSearchCriteria) {
       this.applyCollectionSearchCriteriaToQueryParams(queryParams, collectionSearchCriteria)
     }

src/index.ts

@@ -8,3 +8,4 @@ export * from './collections'
 export * from './metadataBlocks'
 export * from './files'
 export * from './contactInfo'
+export * from './search'

src/search/domain/models/SearchService.ts

@@ -0,0 +1,4 @@
+export interface SearchService {
+  name: string
+  displayName: string
+}

src/search/domain/repositories/ISearchServicesRepository.ts

@@ -0,0 +1,5 @@
+import { SearchService } from '../models/SearchService'
+
+export interface ISearchServicesRepository {
+  getSearchServices(): Promise<SearchService[]>
+}

src/search/domain/useCases/GetSearchServices.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { SearchService } from '../models/SearchService'
+import { ISearchServicesRepository } from '../repositories/ISearchServicesRepository'
+
+export class GetSearchServices implements UseCase<SearchService[]> {
+  private searchServicesRepository: ISearchServicesRepository
+
+  constructor(searchServicesRepository: ISearchServicesRepository) {
+    this.searchServicesRepository = searchServicesRepository
+  }
+
+  /**
+   * Returns all search services available in the installation.
+   *
+   * @returns {Promise<SearchService[]>}
+   */
+  async execute(): Promise<SearchService[]> {
+    return await this.searchServicesRepository.getSearchServices()
+  }
+}

src/search/index.ts

@@ -0,0 +1,10 @@
+import { GetSearchServices } from './domain/useCases/GetSearchServices'
+import { SearchServicesRepository } from './infra/repositories/SearchServicesRepository'
+
+const searchServicesRepository = new SearchServicesRepository()
+
+const getSearchServices = new GetSearchServices(searchServicesRepository)
+
+export { getSearchServices }
+
+export { SearchService } from './domain/models/SearchService'

src/search/infra/repositories/SearchServicesRepository.ts

@@ -0,0 +1,14 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { SearchService } from '../../domain/models/SearchService'
+import { ISearchServicesRepository } from '../../domain/repositories/ISearchServicesRepository'
+import { transformSearchServicesResponseToSearchServices } from './transformers/searchServiceTransformers'
+
+export class SearchServicesRepository extends ApiRepository implements ISearchServicesRepository {
+  public async getSearchServices(): Promise<SearchService[]> {
+    return this.doGet(`/search/services`)
+      .then((response) => transformSearchServicesResponseToSearchServices(response))
+      .catch((error) => {
+        throw error
+      })
+  }
+}