Merge pull request #26 from tainguyenbui/feature/add_fq_query_parameter

Add fq query parameter

Author: tainguyenbui

package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dataverse",
-  "version": "1.0.41",
+  "version": "1.0.42",
   "description": "A Dataverse module for JavaScript/TypeScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/@types/searchOptions.ts

@@ -1,25 +1,27 @@
 export interface DataverseSearchOptions {
-  q: string,
-  subtree?: string,
-  start?: number,
-  type?: SearchType,
-  sort?: SearchSortAttribute,
-  order?: SearchOrder,
-  per_page?: number,
-  show_entity_ids?: boolean,
+  q: string
+  subtree?: string
+  start?: number
+  type?: SearchType
+  sort?: SearchSortAttribute
+  order?: SearchOrder
+  per_page?: number
+  show_entity_ids?: boolean
   show_relevance?: boolean
+  fq?: string
 }
 
 export interface SearchOptions {
-  query: string,
-  dataverseAlias?: string,
-  startPosition?: number,
-  type?: SearchType,
-  sortAttribute?: SearchSortAttribute,
-  order?: SearchOrder,
-  itemsPerPage?: number,
-  showEntityIds?: boolean,
+  query: string
+  dataverseAlias?: string
+  startPosition?: number
+  type?: SearchType
+  sortAttribute?: SearchSortAttribute
+  order?: SearchOrder
+  itemsPerPage?: number
+  showEntityIds?: boolean
   showRelevance?: boolean
+  fq?: string
 }
 
 export enum SearchType {

src/dataverseClient.ts

@@ -201,7 +201,8 @@ export class DataverseClient {
       order: options.order,
       'per_page': options.itemsPerPage,
       'show_entity_ids': options.showEntityIds,
-      'show_relevance': options.showRelevance
+      'show_relevance': options.showRelevance,
+      fq: options.fq
     }
   }
 }

test/dataverseClient.spec.ts

@@ -372,6 +372,7 @@ describe('DataverseClient', () => {
     it('should call axios with expected url and options', async () => {
       const query = random.word()
       const type: SearchType = SearchType.DATASET
+      const fq = 'publicationStatus:Published'
       const expectedOptions: DataverseSearchOptions = {
         q: query,
         subtree: undefined,
@@ -381,9 +382,10 @@ describe('DataverseClient', () => {
         order: undefined,
         'per_page': undefined,
         'show_entity_ids': undefined,
-        'show_relevance': undefined
+        'show_relevance': undefined,
+        fq: fq
       }
-      await client.search({ query, type })
+      await client.search({ query, type, fq })
 
       assert.calledOnce(axiosGetStub)
       assert.calledWithExactly(axiosGetStub, `${host}/api/search`, {