created apiSearch function to implement api search functionality

Author: jdaigneau5

src/search/BasicSearchManager.ts

@@ -21,8 +21,23 @@ export class SearchOptions {
   sort: {}[];
   from: number;
   size: number;
+  searchFields: Array<string>;
+  filters: Array<object>;
+  resultsPerPage: number;
+  rangeObjects: Array<rangeObject>
+  rangeStart: Date;
+  rangeEnd: Date;
+  rangeField: string;
+
 }
 
+//support for date ranges
+export class rangeObject {
+  rangeField: string;
+  rangeStart: Date;
+  rangeEnd: Date;
+
+}
 
 /** A manager class that provides basic search capabilities 
  *  including a flexible search() that provides consistent
@@ -68,4 +83,121 @@ export class BasicSearchManager {
     return result
   }
 
+  /** search for text at search provider
+   *  @param searchText the text string to search for
+   *  @param options options to specify how to search, with well-defined defaults
+   */
+  async apiSearch(searchText: string, options: Partial<SearchOptions> = undefined, queryStrings?: Array<object>): Promise<CveResult> {
+     let response = undefined;
+
+    if (!options) {
+      options = {
+        useCache: true,
+        searchFields: null,
+        filters: null,
+        resultsPerPage: 20,
+        rangeObjects: null,
+        rangeStart: null,
+        rangeEnd: null,
+        rangeField: null,
+        track_total_hits: true,
+        default_operator: "AND",
+        metadataOnly: false,
+        fields: []
+      };
+    }
+
+    let validateResult = this.validateSearchText(searchText, options.filters)
+
+    //Build range object to add to the query
+    let rangeObj = null;
+    let rangeArray = [];
+
+    if (options.rangeObjects) {
+      options.rangeObjects.forEach(rangeObject => {
+        rangeObj = {
+          range: {
+            [rangeObject.rangeField]: {
+              "gte": rangeObject.rangeStart,
+              "lte": rangeObject.rangeEnd,
+            }
+          }
+        };
+        rangeArray.push(rangeObj);
+      })
+
+    }
+    //Build query object
+    const queryObj = {
+      must: [],
+      filter: [
+        ...options.filters
+      ],
+    };
+
+    //Add rangeObj only if it exists
+    if (rangeArray) {
+      queryObj.filter.push(...rangeArray);
+    }
+
+    if (searchText != null) {
+      queryObj.must = [
+        {
+          query_string: {
+            query: searchText,
+            fields: ["containers.cna.descriptions.value"]
+          },
+        }
+      ];
+    }
+
+    //Add query_string only if there is text to search
+    else if (queryStrings != null) {
+      queryObj.must = [
+        ...queryStrings
+      ];
+    } else {
+      delete queryObj.must
+    }
+   
+    if (validateResult.isOk()) {
+
+      response = await this._searchReader._client.search({
+        index: this._searchReader._cveIndex,
+        body: {
+          query: {
+            bool: queryObj
+
+          },
+          track_total_hits: true,
+          size: options.resultsPerPage
+        }
+      });
+
+      return CveResult.ok(response.body as SearchResultData);
+    }
+    else {
+      // return CveResult.error(new CveError(1, `Unknown error when searching for ${text}`));
+      return validateResult
+    }
+  }
+
+  /** validates search text string and marks up CveResult
+   *  with errors and/or notes, if any
+   */
+  // @todo
+  validateSearchText(text: string, filters: Array<object>): CveResult {
+
+    let result: CveResult
+    if (!text && !filters) {
+      result = CveResult.error(9002)
+    }
+    else {
+      result = CveResult.ok("", ["no validation was done"])
+    }
+
+    return result
+  }
+
+
 }