feat(full-text-search): return score result as an equivalent array to result set data (#69)

Author: Viatorus

packages/full-text-search/spec/generic/full_text_search.spec.ts

@@ -110,7 +110,7 @@ describe("full-text search", () => {
     const sorted_desc = res.sortByScoring().data();
     const sorted_asc = res.sortByScoring(true).data();
 
-    expect(Object.keys(res.getScoring())).toEqual(Object.keys(unsorted));
+    expect(res.getScoring()).toBeArrayOfSize(unsorted.length);
 
     expect(unsorted.length).toBe(sorted_desc.length);
     expect(sorted_desc.length).toBe(sorted_asc.length);
@@ -130,7 +130,7 @@ describe("full-text search", () => {
     expect(dv.applySortByScoring).toThrowAnyError();
     dv.applyFind({"$fts": query});
 
-    expect(Object.keys(dv.getScoring())).toEqual(Object.keys(unsorted));
+    expect(dv.getScoring()).toBeArrayOfSize(unsorted.length);
 
     expect(dv.applySortByScoring().data()).toEqual(sorted_desc);
     expect(dv.applySortByScoring(true).data()).toEqual(sorted_asc);

packages/full-text-search/src/full_text_search.ts

@@ -72,7 +72,7 @@ export class FullTextSearch {
     }
   }
 
-  public search(query: Query): Scorer.ScoreResult {
+  public search(query: Query): Scorer.ScoreResults {
     return this._idxSearcher.search(query);
   }
 

packages/full-text-search/src/index_searcher.ts

@@ -25,15 +25,15 @@ export class IndexSearcher {
     this._scorer = new Scorer(this._invIdxs);
   }
 
-  public search(query: Query): Scorer.ScoreResult {
+  public search(query: Query): Scorer.ScoreResults {
     let queryResults = this._recursive(query.query, true);
 
     // Do final scoring.
     if (query.final_scoring !== undefined ? query.final_scoring : true) {
       return this._scorer.finalScore(query, queryResults);
     }
 
-    const result: Scorer.ScoreResult = {};
+    const result: Scorer.ScoreResults = {};
     for (const key of queryResults.keys()) {
       result[key] = {score: 1};
     }

packages/full-text-search/src/scorer.ts

@@ -48,8 +48,8 @@ export class Scorer {
     return queryResults;
   }
 
-  public finalScore(query: Query, queryResults: Scorer.QueryResults): Scorer.ScoreResult {
-    const result: Scorer.ScoreResult = {};
+  public finalScore(query: Query, queryResults: Scorer.QueryResults): Scorer.ScoreResults {
+    const result: Scorer.ScoreResults = {};
     const k1 = query.bm25 !== undefined ? query.bm25.k1 : 1.2;
     const b = query.bm25 !== undefined ? query.bm25.b : 0.75;
     const explain = query.explain !== undefined ? query.explain : false;
@@ -177,6 +177,6 @@ export namespace Scorer {
   }
 
   export type ScoreExplanation = BM25Explanation | ConstantExplanation;
-
-  export type ScoreResult = Dict<{ score: number, explanation?: ScoreExplanation[] }>;
+  export type ScoreResult = { score: number, explanation?: ScoreExplanation[] };
+  export type ScoreResults = Dict<ScoreResult>;
 }

packages/loki/src/dynamic_view.ts

@@ -297,9 +297,9 @@ export class DynamicView<TData extends object = object, TNested extends object =
 
   /**
    * Returns the scoring of the last full-text-search.
-   * @returns {ScoreResult}
+   * @returns {ScoreResult[]}
    */
-  public getScoring(): Scorer.ScoreResult {
+  public getScoring(): Scorer.ScoreResult[] {
     return this._resultSet.getScoring();
   }
 

packages/loki/src/result_set.ts

@@ -293,7 +293,7 @@ export class ResultSet<TData extends object = object, TNested extends object = o
   public _filteredRows: number[];
   public _filterInitialized: boolean;
   // Holds the scoring result of the last full-text search.
-  private _scoring: Scorer.ScoreResult;
+  private _scoring: Scorer.ScoreResults;
 
   /**
    * Constructor.
@@ -635,13 +635,17 @@ export class ResultSet<TData extends object = object, TNested extends object = o
 
   /**
    * Returns the scoring of the last full-text-search.
-   * @returns {ScoreResult}
+   * @returns {ScoreResult[]}
    */
-  public getScoring(): Scorer.ScoreResult {
+  public getScoring(): Scorer.ScoreResult[] {
     if (this._scoring === null) {
       throw new Error("No scoring available");
     }
-    return this._scoring;
+    const scoring: Scorer.ScoreResult[] = [];
+    for (let i = 0; i < this._filteredRows.length; i++) {
+      scoring.push(this._scoring[this._filteredRows[i]]);
+    }
+    return scoring;
   }
 
   /**