6c82a4967e
* Updated types generation script * Refactored api method definitions * Updated test - Removed old test code - Added tsd dev dependency - Rewritten test with tsd * Removed unused dependencies * Fixed definition * Updated test * Updated docs * Improved events type definitions * Updated test * Minor fixes in the type definitons * More type test * Improved Transport type definitions * Updated test * Addressed comments * Code generation * Use RequestBody, Response and Context everywhere, also default Context to unknown * Updated test * body -> hasBody * Fixed conflicts * Updated code generation * Improved request body type definition * Updated code generation * Use BodyType for both request and reponses generics - Use extends for defining the RequestBody generic to force the user following the same shape. - BodyType and NDBodyType now accepts a generics to allow injecting more specific types in the future * API generation * Updated test * Updated docs * Use BodyType also in ReponseError * Removed useless client generics * Renamed generics and types - prefixed all generics with a T - BodyType => RequestBody - NDBodyType => RequestNDBody - Added ResponseBody * Updated test * Updated docs * Test ResponseBody as well * Simplify overloads * API generation * Updated test * Updated error types
129 lines
2.4 KiB
TypeScript
129 lines
2.4 KiB
TypeScript
// Licensed to Elasticsearch B.V under one or more agreements.
|
|
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
|
|
// See the LICENSE file in the project root for more information
|
|
|
|
import { expectType, expectError } from 'tsd'
|
|
import { ResponseBody } from '../../lib/Transport'
|
|
import { Client } from '../../'
|
|
|
|
const client = new Client({
|
|
node: 'http://localhost:9200'
|
|
})
|
|
|
|
interface SearchBody {
|
|
query: {
|
|
match: { foo: string }
|
|
}
|
|
}
|
|
|
|
interface ShardsResponse {
|
|
total: number;
|
|
successful: number;
|
|
failed: number;
|
|
skipped: number;
|
|
}
|
|
|
|
interface Explanation {
|
|
value: number;
|
|
description: string;
|
|
details: Explanation[];
|
|
}
|
|
|
|
interface SearchResponse<T> {
|
|
took: number;
|
|
timed_out: boolean;
|
|
_scroll_id?: string;
|
|
_shards: ShardsResponse;
|
|
hits: {
|
|
total: number;
|
|
max_score: number;
|
|
hits: Array<{
|
|
_index: string;
|
|
_type: string;
|
|
_id: string;
|
|
_score: number;
|
|
_source: T;
|
|
_version?: number;
|
|
_explanation?: Explanation;
|
|
fields?: any;
|
|
highlight?: any;
|
|
inner_hits?: any;
|
|
matched_queries?: string[];
|
|
sort?: string[];
|
|
}>;
|
|
};
|
|
aggregations?: any;
|
|
}
|
|
|
|
interface Source {
|
|
foo: string
|
|
}
|
|
|
|
// Use a bad body
|
|
expectError(
|
|
client.search({
|
|
index: 'hello',
|
|
body: 42
|
|
}).then(console.log)
|
|
)
|
|
|
|
// No generics
|
|
{
|
|
const response = await client.search({
|
|
index: 'test',
|
|
body: {
|
|
query: {
|
|
match: { foo: 'bar' }
|
|
}
|
|
}
|
|
})
|
|
|
|
expectType<ResponseBody>(response.body)
|
|
expectType<unknown>(response.meta.context)
|
|
}
|
|
|
|
// Define only the request body
|
|
{
|
|
const response = await client.search<SearchBody>({
|
|
index: 'test',
|
|
body: {
|
|
query: {
|
|
match: { foo: 'bar' }
|
|
}
|
|
}
|
|
})
|
|
|
|
expectType<ResponseBody>(response.body)
|
|
expectType<unknown>(response.meta.context)
|
|
}
|
|
|
|
// Define request body and response body
|
|
{
|
|
const response = await client.search<SearchBody, SearchResponse<Source>>({
|
|
index: 'test',
|
|
body: {
|
|
query: {
|
|
match: { foo: 'bar' }
|
|
}
|
|
}
|
|
})
|
|
|
|
expectType<SearchResponse<Source>>(response.body)
|
|
expectType<unknown>(response.meta.context)
|
|
}
|
|
|
|
// Define request body, response body and the context
|
|
{
|
|
const response = await client.search<SearchBody, SearchResponse<Source>, string>({
|
|
index: 'test',
|
|
body: {
|
|
query: {
|
|
match: { foo: 'bar' }
|
|
}
|
|
}
|
|
})
|
|
|
|
expectType<SearchResponse<Source>>(response.body)
|
|
expectType<string>(response.meta.context)
|
|
}
|