do not import types from the legacy elasticsearch package

elastic · Jul 28, 2021 · 702b2b5 · 702b2b5
1 parent 63bedaa
commit 702b2b5
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 20 deletions.
diff --git a/src/plugins/data/common/search/search_source/types.ts b/src/plugins/data/common/search/search_source/types.ts
@@ -6,7 +6,6 @@
  * Side Public License, v 1.
  */
 import type { estypes } from '@elastic/elasticsearch';
-import { NameList } from 'elasticsearch';
 import { IAggConfigs } from 'src/plugins/data/public';
 import { Query } from '../..';
 import { Filter } from '../../es_query';
@@ -90,7 +89,7 @@ export interface SearchSourceFields {
  aggs?: object | IAggConfigs | (() => object);
  from?: number;
  size?: number;
- source?: NameList;
+ source?: boolean | estypes.Fields;
  version?: boolean;
  /**
  * Retrieve fields via the search Fields API
@@ -101,7 +100,7 @@ export interface SearchSourceFields {
  *
  * @deprecated It is recommended to use `fields` wherever possible.
  */
- fieldsFromSource?: NameList;
+ fieldsFromSource?: estypes.Fields;
  /**
  * {@link IndexPatternService}
  */

diff --git a/src/plugins/data/common/search/tabify/tabify_docs.test.ts b/src/plugins/data/common/search/tabify/tabify_docs.test.ts
@@ -8,7 +8,7 @@
 
 import { tabifyDocs } from './tabify_docs';
 import { IndexPattern } from '../../index_patterns/index_patterns';
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 
 describe('tabifyDocs', () => {
  const fieldFormats = {
@@ -33,6 +33,7 @@ describe('tabifyDocs', () => {
  fieldFormats: fieldFormats as any,
  });
 
+ // @ts-expect-error not full inteface
  const response = {
  hits: {
  hits: [
@@ -46,7 +47,7 @@ describe('tabifyDocs', () => {
  },
  ],
  },
- } as SearchResponse<unknown>;
+ } as estypes.SearchResponse<unknown>;
 
  it('converts fields by default', () => {
  const table = tabifyDocs(response, index);

diff --git a/src/plugins/data/common/search/tabify/tabify_docs.ts b/src/plugins/data/common/search/tabify/tabify_docs.ts
@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 import { isPlainObject } from 'lodash';
 import { IndexPattern } from '../../index_patterns/index_patterns';
 import { Datatable, DatatableColumn, DatatableColumnType } from '../../../../expressions/common';
@@ -18,7 +18,7 @@ export interface TabifyDocsOptions {
 }
 
 export function flattenHit(
- hit: SearchResponse<unknown>['hits']['hits'][0],
+ hit: estypes.SearchHit,
  indexPattern?: IndexPattern,
  params?: TabifyDocsOptions
 ) {
@@ -58,7 +58,7 @@ export function flattenHit(
  }
  }
 
- flatten(hit.fields);
+ flatten(hit.fields || {});
  if (params?.source !== false && hit._source) {
  flatten(hit._source as Record<string, any>);
  }
@@ -72,7 +72,7 @@ export function flattenHit(
 }
 
 export const tabifyDocs = (
- esResponse: SearchResponse<unknown>,
+ esResponse: estypes.SearchResponse<unknown>,
  index?: IndexPattern,
  params: TabifyDocsOptions = {}
 ): Datatable => {

diff --git a/src/plugins/data/public/ui/shard_failure_modal/__mocks__/shard_failure_response.ts b/src/plugins/data/public/ui/shard_failure_modal/__mocks__/shard_failure_response.ts
@@ -6,9 +6,9 @@
  * Side Public License, v 1.
  */
 
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 
-export const shardFailureResponse: SearchResponse<any> = {
+export const shardFailureResponse: estypes.SearchResponse<any> = {
  _shards: {
  total: 2,
  successful: 1,

diff --git a/src/plugins/data/server/autocomplete/terms_agg.test.ts b/src/plugins/data/server/autocomplete/terms_agg.test.ts
@@ -12,7 +12,7 @@ import { ConfigSchema } from '../../config';
 import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import type { ApiResponse } from '@elastic/elasticsearch';
 import { termsAggSuggestions } from './terms_agg';
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 import { duration } from 'moment';
 
 let savedObjectsClientMock: jest.Mocked<SavedObjectsClientContract>;
@@ -22,6 +22,8 @@ const configMock = ({
  valueSuggestions: { timeout: duration(4513), terminateAfter: duration(98430) },
  },
 } as unknown) as ConfigSchema;
+
+// @ts-expect-error not full interface
 const mockResponse = {
  body: {
  aggregations: {
@@ -30,7 +32,7 @@ const mockResponse = {
  },
  },
  },
-} as ApiResponse<SearchResponse<any>>;
+} as ApiResponse<estypes.SearchResponse<any>>;
 
 jest.mock('../index_patterns');
 

diff --git a/src/plugins/data/server/search/strategies/es_search/response_utils.test.ts b/src/plugins/data/server/search/strategies/es_search/response_utils.test.ts
@@ -7,7 +7,7 @@
  */
 
 import { getTotalLoaded, toKibanaSearchResponse, shimHitsTotal } from './response_utils';
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 
 describe('response utils', () => {
  describe('getTotalLoaded', () => {
@@ -19,7 +19,7 @@ describe('response utils', () => {
  skipped: 5,
  total: 100,
  },
- } as unknown) as SearchResponse<unknown>);
+ } as unknown) as estypes.SearchResponse<unknown>);
 
  expect(result).toEqual({
  total: 100,
@@ -37,7 +37,7 @@ describe('response utils', () => {
  skipped: 5,
  total: 100,
  },
- } as unknown) as SearchResponse<unknown>);
+ } as unknown) as estypes.SearchResponse<unknown>);
 
  expect(result).toEqual({
  rawResponse: {

diff --git a/src/plugins/data/server/search/strategies/ese_search/ese_search_strategy.ts b/src/plugins/data/server/search/strategies/ese_search/ese_search_strategy.ts
@@ -9,7 +9,7 @@
 import type { Observable } from 'rxjs';
 import type { IScopedClusterClient, Logger, SharedGlobalConfig } from 'kibana/server';
 import { catchError, first, tap } from 'rxjs/operators';
-import { SearchResponse } from 'elasticsearch';
+import type { estypes } from '@elastic/elasticsearch';
 import { from } from 'rxjs';
 import type { ISearchStrategy, SearchStrategyDependencies } from '../../types';
 import type {
@@ -121,7 +121,7 @@ export const enhancedEsSearchStrategyProvider = (
  });
 
  const esResponse = await shimAbortSignal(promise, options?.abortSignal);
- const response = esResponse.body as SearchResponse<any>;
+ const response = esResponse.body as estypes.SearchResponse<any>;
  return {
  rawResponse: shimHitsTotal(response, options),
  ...getTotalLoaded(response),

diff --git a/src/plugins/data/server/search/strategies/ese_search/types.ts b/src/plugins/data/server/search/strategies/ese_search/types.ts
@@ -7,7 +7,6 @@
  */
 
 import type { estypes } from '@elastic/elasticsearch';
-import { ShardsResponse } from 'elasticsearch';
 
 export interface AsyncSearchResponse<T = unknown> {
  id?: string;
@@ -19,5 +18,5 @@ export interface AsyncSearchResponse<T = unknown> {
 }
 export interface AsyncSearchStatusResponse extends Omit<AsyncSearchResponse, 'response'> {
  completion_status: number;
- _shards: ShardsResponse;
+ _shards: estypes.ShardStatistics;
 }