[IngestPipelineSimulation] Typing error on exported type

[tonyghiani]

🐛 Bug report

📓 Summary

In Kibana, we use the IngestPipelineSimulation type to manipulate response values from the POST /_ingest/pipeline/_simulate API.

First issue is about naming, the IngestPipelineSimulation represents the property IngestSimulateDocumentResult.processor_results, which is a bit misleading since it's not the result of the whole pipeline, but represent a single processor result. Maybe something IngestPipelineProcessorResult would fit better.

We want to run guards against the status property, and it is currently set to WatcherActionStatusOptions, which seems wrong as we don't get types for the right status (e.g. skipped).

Would be great to fix the type to get the expected status mapping that comes from the ES implementation.

To reproduce

const processorResult: IngestPipelineSimulation = {
  status: 'skipped', // Type '"skipped"' is not assignable to type 'WatcherActionStatusOptions | undefined'.ts(2322)
};

Expected behavior

const processorResult: IngestPipelineSimulation = {
  status: 'skipped' // ✅ Valid value
};

Node.js version

Any version

@elastic/elasticsearch version

v9.0.0-alpha

Operating system

macOs

Any other relevant environment information

No response

[JoshMock]

Hey @tonyghiani. I just opened a PR on the spec repo to fix this type. Once that merges it should show up in the next patch or minor release of the client.

[tonyghiani]

Great, thanks @JoshMock!