Skip to content

New type definitions #1358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Mar 24, 2021
Merged

New type definitions #1358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
a4121a2
Introduce new type definition
delvedor Nov 19, 2020
a0d6165
Updated kibana definition
delvedor Nov 19, 2020
c6d327f
Removed old type generation
delvedor Nov 19, 2020
754239e
Updated types
delvedor Nov 24, 2020
32510c3
Updated test
delvedor Nov 24, 2020
e25ea2f
Standard
delvedor Nov 24, 2020
f6d61c4
Merge branch 'master' into type-definitions
delvedor Dec 22, 2020
d1f1134
Updated type definitions
delvedor Dec 22, 2020
d0ee735
Export es types as estypes
delvedor Dec 22, 2020
b223500
Updated test
delvedor Dec 22, 2020
9f451c7
Set params as required where needed
delvedor Dec 22, 2020
ac52ad3
Updated types
delvedor Jan 12, 2021
fff0c08
Updated types
delvedor Jan 14, 2021
7b88f15
Updated types
delvedor Jan 15, 2021
ad2f481
Updated types
delvedor Jan 18, 2021
5d9b5e4
Updated test
delvedor Jan 18, 2021
f904c49
Updated types
delvedor Jan 27, 2021
4eef868
Updated types
delvedor Feb 9, 2021
e731895
Merge branch 'master' into type-definitions
delvedor Mar 4, 2021
e26c836
Updated types
delvedor Mar 4, 2021
ea0e4f3
Update types
delvedor Mar 8, 2021
236b28c
Updated types
delvedor Mar 10, 2021
8b784b2
Merge branch 'master' into type-definitions
delvedor Mar 15, 2021
b078a8d
Integration test: Fix yaml parser and crash on failure (#1423)
delvedor Mar 24, 2021
caeda78
Updated types
delvedor Mar 24, 2021
2b93b49
Merge branch 'master' into type-definitions
delvedor Mar 24, 2021
3c5e4b0
Updated types
delvedor Mar 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,418 changes: 1,418 additions & 0 deletions api/esapi.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

757 changes: 386 additions & 371 deletions api/kibana.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

12,802 changes: 12,802 additions & 0 deletions api/types.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

2,533 changes: 6 additions & 2,527 deletions index.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/Transport.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export type ApiError = errors.ConfigurationError | errors.ConnectionError |
errors.NoLivingConnectionsError | errors.ResponseError |
errors.TimeoutError | errors.RequestAbortedError

export type Context = Record<string, unknown> | null
export type Context = unknown

export interface nodeSelectorFn {
(connections: Connection[]): Connection;
Expand Down
32 changes: 1 addition & 31 deletions scripts/generate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ const {
generate,
cloneAndCheckout,
genFactory,
generateRequestTypes,
generateDocs
} = require('./utils')

Expand All @@ -47,10 +46,7 @@ function start (opts) {
const packageFolder = join(__dirname, '..', 'api')
const apiOutputFolder = join(packageFolder, 'api')
const mainOutputFile = join(packageFolder, 'index.js')
const typeDefFile = join(__dirname, '..', 'index.d.ts')
const kibanaTypeDefFile = join(packageFolder, 'kibana.d.ts')
const docOutputFile = join(__dirname, '..', 'docs', 'reference.asciidoc')
const requestParamsOutputFile = join(packageFolder, 'requestParams.d.ts')

log.text = 'Cleaning API folder...'
rimraf.sync(join(apiOutputFolder, '*.js'))
Expand Down Expand Up @@ -84,39 +80,13 @@ function start (opts) {
writeFileSync(filePath, code, { encoding: 'utf8' })
}

writeFileSync(
requestParamsOutputFile,
generateRequestTypes(opts.branch || opts.tag, allSpec),
{ encoding: 'utf8' }
)

const { fn: factory, types, kibanaTypes } = genFactory(apiOutputFolder, [apiFolder, xPackFolder], namespaces)
const { fn: factory } = genFactory(apiOutputFolder, [apiFolder, xPackFolder], namespaces)
writeFileSync(
mainOutputFile,
factory,
{ encoding: 'utf8' }
)

let oldTypeDefString = readFileSync(typeDefFile, 'utf8')
let start = oldTypeDefString.indexOf('/* GENERATED */')
let end = oldTypeDefString.indexOf('/* /GENERATED */')
let newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + types + '\n ' + oldTypeDefString.slice(end)
writeFileSync(
typeDefFile,
newTypeDefString,
{ encoding: 'utf8' }
)

oldTypeDefString = readFileSync(kibanaTypeDefFile, 'utf8')
start = oldTypeDefString.indexOf('/* GENERATED */')
end = oldTypeDefString.indexOf('/* /GENERATED */')
newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + kibanaTypes + '\n ' + oldTypeDefString.slice(end)
writeFileSync(
kibanaTypeDefFile,
newTypeDefString,
{ encoding: 'utf8' }
)

lintFiles(log, () => {
log.text = 'Generating documentation'
writeFileSync(
Expand Down
2 changes: 0 additions & 2 deletions scripts/utils/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
'use strict'

const generate = require('./generateApis')
const generateRequestTypes = require('./generateRequestTypes')
const cloneAndCheckout = require('./clone-es')
const genFactory = require('./generateMain')
const generateDocs = require('./generateDocs')
Expand All @@ -29,6 +28,5 @@ module.exports = {
generate,
cloneAndCheckout,
genFactory,
generateRequestTypes,
generateDocs
}
173 changes: 12 additions & 161 deletions test/types/api-response-body.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,57 +20,12 @@
import { expectType, expectError } from 'tsd'
import { Readable as ReadableStream } from 'stream';
import { TransportRequestCallback, Context } from '../../lib/Transport'
import { Client, ApiError } from '../../'
import { Client, ApiError, estypes } 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
}
Expand All @@ -94,28 +49,13 @@ expectError(
}
})

expectType<Record<string, any>>(response.body)
expectType<Context>(response.meta.context)
}

// Define only the response body (promise style)
{
const response = await client.search<SearchResponse<Source>>({
index: 'test',
body: {
query: {
match: { foo: 'bar' }
}
}
})

expectType<SearchResponse<Source>>(response.body)
expectType<estypes.SearchResponse<unknown>>(response.body)
expectType<Context>(response.meta.context)
}

// Define response body and request body (promise style)
// Define only the source (promise style)
{
const response = await client.search<SearchResponse<Source>, SearchBody>({
const response = await client.search<Source>({
index: 'test',
body: {
query: {
Expand All @@ -124,13 +64,13 @@ expectError(
}
})

expectType<SearchResponse<Source>>(response.body)
expectType<estypes.SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
}

// Define response body, request body and the context (promise style)
{
const response = await client.search<SearchResponse<Source>, SearchBody, Context>({
const response = await client.search<Source, Context>({
index: 'test',
body: {
query: {
Expand All @@ -139,40 +79,7 @@ expectError(
}
})

expectType<SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
}

// Send request body as string (promise style)
{
const response = await client.search({
index: 'test',
body: 'hello world'
})

expectType<Record<string, any>>(response.body)
expectType<Context>(response.meta.context)
}

// Send request body as buffer (promise style)
{
const response = await client.search({
index: 'test',
body: Buffer.from('hello world')
})

expectType<Record<string, any>>(response.body)
expectType<Context>(response.meta.context)
}

// Send request body as readable stream (promise style)
{
const response = await client.search({
index: 'test',
body: new ReadableStream()
})

expectType<Record<string, any>>(response.body)
expectType<estypes.SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
}

Expand All @@ -187,15 +94,15 @@ expectError(
}
}, (err, response) => {
expectType<ApiError>(err)
expectType<Record<string, any>>(response.body)
expectType<estypes.SearchResponse<unknown>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Define only the response body (callback style)
{
const result = client.search<SearchResponse<Source>>({
const result = client.search<Source>({
index: 'test',
body: {
query: {
Expand All @@ -204,32 +111,15 @@ expectError(
}
}, (err, response) => {
expectType<ApiError>(err)
expectType<SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Define response body and request body (callback style)
{
const result = client.search<SearchResponse<Source>, SearchBody>({
index: 'test',
body: {
query: {
match: { foo: 'bar' }
}
}
}, (err, response) => {
expectType<ApiError>(err)
expectType<SearchResponse<Source>>(response.body)
expectType<estypes.SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Define response body, request body and the context (callback style)
{
const result = client.search<SearchResponse<Source>, SearchBody, Context>({
const result = client.search<Source, Context>({
index: 'test',
body: {
query: {
Expand All @@ -238,46 +128,7 @@ expectError(
}
}, (err, response) => {
expectType<ApiError>(err)
expectType<SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Send request body as string (callback style)
{
const result = client.search({
index: 'test',
body: 'hello world'
}, (err, response) => {
expectType<ApiError>(err)
expectType<Record<string, any>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Send request body as buffer (callback style)
{
const result = client.search({
index: 'test',
body: Buffer.from('hello world')
}, (err, response) => {
expectType<ApiError>(err)
expectType<Record<string, any>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
}

// Send request body as readable stream (callback style)
{
const result = client.search({
index: 'test',
body: new ReadableStream()
}, (err, response) => {
expectType<ApiError>(err)
expectType<Record<string, any>>(response.body)
expectType<estypes.SearchResponse<Source>>(response.body)
expectType<Context>(response.meta.context)
})
expectType<TransportRequestCallback>(result)
Expand Down
Loading