Define and export type SearchResponse

🚀 Feature Proposal

Export the generic types defined in https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html (specially the SearchResponse<T>)

Motivation

This way people won’t have to reimplement these types every time.

Example

The exact same documentation example, but we would only have to define the Source type.

[joshdover]

I’m still on the fence about publishing a handwritten definition of the responses, as there is no way to test their correctness.

I think that until we have a real API spec from Elasticsearch that defines the full typings so we can generate all types, developers in the wild are going to end up writing types by hand anyways. I know in the case of Kibana, we will definitely want to fill in the gaps of what’s missing.

So then the question becomes, why duplicate all this work in each project rather than having them done in one place? By having handwritten types in this package, all projects can benefit from more complete typings, even if they’re not 100% perfect. I think we’re much more likely to get it right if done here then if done in each downstream project that consumes this library.

In terms of where these types should live, I personally prefer they live in this module rather than in @types/elasticsearch. Primary benefit being that it’s much more obvious if the full types ship with the library than if they’re in some auxiliary package.

If that’s the direction we go, I think we should also look into having @types/elasticsearch removed or at least marked as deprecated in some way.

[delvedor]

Hello! Thank you @joshdover for the summary! I’ve just opened #1119, which should vastly improve the developer experience with TypeScript and help the future work that will start from this issue. A review would be highly appreciated!