rename ConcreteElasticSearchQuery -> ElasticSearchConcreteQuery

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

.changeset/seven-readers-drop.md

@@ -5,7 +5,7 @@
 Additional types now exported publicly:
 
 - ElasticSearchAgentOptions
-- ConcreteElasticSearchQuery
+- ElasticSearchConcreteQuery
 - ElasticSearchQueryTranslator
 - ElasticSearchConnectionConstructor,
 - ElasticSearchTransportConstructor,

plugins/search-backend-module-elasticsearch/api-report.md

@@ -15,13 +15,6 @@ import { Logger } from 'winston';
 import { SearchEngine } from '@backstage/plugin-search-common';
 import { SearchQuery } from '@backstage/plugin-search-common';
 
-// @public
-export type ConcreteElasticSearchQuery = {
-  documentTypes?: string[];
-  elasticSearchQuery: Object;
-  pageSize: number;
-};
-
 // @public (undocumented)
 export interface ElasticSearchAgentOptions {
   // (undocumented)
@@ -119,6 +112,13 @@ export interface ElasticSearchClientOptions {
   Transport?: ElasticSearchTransportConstructor;
 }
 
+// @public
+export type ElasticSearchConcreteQuery = {
+  documentTypes?: string[];
+  elasticSearchQuery: Object;
+  pageSize: number;
+};
+
 // @public (undocumented)
 export interface ElasticSearchConnectionConstructor {
   // (undocumented)
@@ -186,7 +186,7 @@ export type ElasticSearchOptions = {
 export type ElasticSearchQueryTranslator = (
   query: SearchQuery,
   options?: ElasticSearchQueryTranslatorOptions,
-) => ConcreteElasticSearchQuery;
+) => ElasticSearchConcreteQuery;
 
 // @public
 export type ElasticSearchQueryTranslatorOptions = {
@@ -220,7 +220,7 @@ export class ElasticSearchSearchEngine implements SearchEngine {
   protected translator(
     query: SearchQuery,
     options?: ElasticSearchQueryTranslatorOptions,
-  ): ConcreteElasticSearchQuery;
+  ): ElasticSearchConcreteQuery;
 }
 
 // @public

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.test.ts

@@ -19,7 +19,7 @@ import { ConfigReader } from '@backstage/config';
 import { Client, errors } from '@elastic/elasticsearch';
 import Mock from '@elastic/elasticsearch-mock';
 import {
-  ConcreteElasticSearchQuery,
+  ElasticSearchConcreteQuery,
   decodePageCursor,
   ElasticSearchSearchEngine,
   encodePageCursor,
@@ -131,7 +131,7 @@ describe('ElasticSearchSearchEngine', () => {
         types: ['indexName'],
         term: 'testTerm',
         filters: { kind: 'testKind' },
-      }) as ConcreteElasticSearchQuery;
+      }) as ElasticSearchConcreteQuery;
 
       expect(actualTranslatedQuery).toMatchObject({
         documentTypes: ['indexName'],
@@ -170,7 +170,7 @@ describe('ElasticSearchSearchEngine', () => {
         types: ['indexName'],
         term: 'testTerm',
         pageCursor: 'MQ==',
-      }) as ConcreteElasticSearchQuery;
+      }) as ElasticSearchConcreteQuery;
 
       expect(actualTranslatedQuery).toMatchObject({
         documentTypes: ['indexName'],
@@ -210,7 +210,7 @@ describe('ElasticSearchSearchEngine', () => {
           foo: 123,
           bar: true,
         },
-      }) as ConcreteElasticSearchQuery;
+      }) as ElasticSearchConcreteQuery;
 
       expect(actualTranslatedQuery).toMatchObject({
         documentTypes: ['indexName'],
@@ -266,7 +266,7 @@ describe('ElasticSearchSearchEngine', () => {
         types: ['indexName'],
         term: 'testTerm',
         filters: { kind: ['testKind', 'kastTeint'] },
-      }) as ConcreteElasticSearchQuery;
+      }) as ElasticSearchConcreteQuery;
 
       expect(actualTranslatedQuery).toMatchObject({
         documentTypes: ['indexName'],
@@ -327,7 +327,7 @@ describe('ElasticSearchSearchEngine', () => {
             fragmentDelimiter: ' ... ',
           },
         },
-      ) as ConcreteElasticSearchQuery;
+      ) as ElasticSearchConcreteQuery;
 
       expect(actualTranslatedQuery).toMatchObject({
         documentTypes: ['indexName'],
@@ -369,7 +369,7 @@ describe('ElasticSearchSearchEngine', () => {
           types: ['indexName'],
           term: 'testTerm',
           filters: { kind: { a: 'b' } },
-        }) as ConcreteElasticSearchQuery;
+        }) as ElasticSearchConcreteQuery;
       expect(actualTranslatedQuery).toThrow();
     });
   });

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts

@@ -40,7 +40,7 @@ export type { ElasticSearchClientOptions };
  * Search query that the elasticsearch engine understands.
  * @public
  */
-export type ConcreteElasticSearchQuery = {
+export type ElasticSearchConcreteQuery = {
   documentTypes?: string[];
   elasticSearchQuery: Object;
   pageSize: number;
@@ -61,7 +61,7 @@ export type ElasticSearchQueryTranslatorOptions = {
 export type ElasticSearchQueryTranslator = (
   query: SearchQuery,
   options?: ElasticSearchQueryTranslatorOptions,
-) => ConcreteElasticSearchQuery;
+) => ElasticSearchConcreteQuery;
 
 /**
  * Options for instansiate ElasticSearchSearchEngine
@@ -174,7 +174,7 @@ export class ElasticSearchSearchEngine implements SearchEngine {
   protected translator(
     query: SearchQuery,
     options?: ElasticSearchQueryTranslatorOptions,
-  ): ConcreteElasticSearchQuery {
+  ): ElasticSearchConcreteQuery {
     const { term, filters = {}, types, pageCursor } = query;
 
     const filter = Object.entries(filters)

plugins/search-backend-module-elasticsearch/src/engines/index.ts

@@ -23,7 +23,7 @@ export type {
   ElasticSearchAuth,
 } from './ElasticSearchClientOptions';
 export type {
-  ConcreteElasticSearchQuery,
+  ElasticSearchConcreteQuery,
   ElasticSearchClientOptions,
   ElasticSearchHighlightConfig,
   ElasticSearchHighlightOptions,

plugins/search-backend-module-elasticsearch/src/index.ts

@@ -23,7 +23,7 @@
 export { ElasticSearchSearchEngine } from './engines';
 export type {
   ElasticSearchAgentOptions,
-  ConcreteElasticSearchQuery,
+  ElasticSearchConcreteQuery,
   ElasticSearchClientOptions,
   ElasticSearchHighlightConfig,
   ElasticSearchHighlightOptions,