From d07ed471dcab452bd82ccf692daf1d3e3aa6c588 Mon Sep 17 00:00:00 2001
From: Mike Lewis <mtlewis@users.noreply.github.com>
Date: Fri, 11 Mar 2022 18:31:40 +0000
Subject: [PATCH] search-backend-node: use new IndexableResultSet type as
 return type of engine#query

Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
---
 .changeset/light-drinks-rule.md                           | 3 ++-
 plugins/search-backend-node/api-report.md                 | 4 ++--
 .../search-backend-node/src/engines/LunrSearchEngine.ts   | 8 ++++----
 3 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/.changeset/light-drinks-rule.md b/.changeset/light-drinks-rule.md
index 75eca35ad9..b83a14c986 100644
--- a/.changeset/light-drinks-rule.md
+++ b/.changeset/light-drinks-rule.md
@@ -1,6 +1,7 @@
 ---
+'@backstage/plugin-search-backend-node': patch
 '@backstage/plugin-search-backend-module-elasticsearch': patch
 '@backstage/plugin-search-backend-module-pg': patch
 ---
 
-Use new `IndexableResultSet` type as return type of engine#query.
+Use new `IndexableResultSet` type as return type of query method in `SearchEngine` implementation.
diff --git a/plugins/search-backend-node/api-report.md b/plugins/search-backend-node/api-report.md
index e4359eafac..ebc49df280 100644
--- a/plugins/search-backend-node/api-report.md
+++ b/plugins/search-backend-node/api-report.md
@@ -9,13 +9,13 @@ import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
 import { DocumentDecoratorFactory } from '@backstage/plugin-search-common';
 import { DocumentTypeInfo } from '@backstage/plugin-search-common';
 import { IndexableDocument } from '@backstage/plugin-search-common';
+import { IndexableResultSet } from '@backstage/plugin-search-common';
 import { Logger } from 'winston';
 import { default as lunr_2 } from 'lunr';
 import { QueryTranslator } from '@backstage/plugin-search-common';
 import { Readable } from 'stream';
 import { SearchEngine } from '@backstage/plugin-search-common';
 import { SearchQuery } from '@backstage/plugin-search-common';
-import { SearchResultSet } from '@backstage/plugin-search-common';
 import { Transform } from 'stream';
 import { Writable } from 'stream';
 
@@ -87,7 +87,7 @@ export class LunrSearchEngine implements SearchEngine {
   // (undocumented)
   protected lunrIndices: Record<string, lunr_2.Index>;
   // (undocumented)
-  query(query: SearchQuery): Promise<SearchResultSet>;
+  query(query: SearchQuery): Promise<IndexableResultSet>;
   // (undocumented)
   setTranslator(translator: LunrQueryTranslator): void;
   // (undocumented)
diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts
index b1d695ad1d..09e8729ba8 100644
--- a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts
+++ b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts
@@ -16,8 +16,8 @@
 
 import {
   IndexableDocument,
+  IndexableResultSet,
   SearchQuery,
-  SearchResultSet,
   QueryTranslator,
   SearchEngine,
 } from '@backstage/plugin-search-common';
@@ -147,7 +147,7 @@ export class LunrSearchEngine implements SearchEngine {
     return indexer;
   }
 
-  async query(query: SearchQuery): Promise<SearchResultSet> {
+  async query(query: SearchQuery): Promise<IndexableResultSet> {
     const { lunrQueryBuilder, documentTypes, pageSize } = this.translator(
       query,
     ) as ConcreteLunrQuery;
@@ -196,8 +196,8 @@ export class LunrSearchEngine implements SearchEngine {
       ? encodePageCursor({ page: page - 1 })
       : undefined;
 
-    // Translate results into SearchResultSet
-    const realResultSet: SearchResultSet = {
+    // Translate results into IndexableResultSet
+    const realResultSet: IndexableResultSet = {
       results: results.slice(offset, offset + pageSize).map(d => {
         return { type: d.type, document: this.docStore[d.result.ref] };
       }),