Updated opensearch-js to reflect the latest OpenSearch API spec (2025-04-02) (#1003)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: nhtruong <[email protected]>

Author: opensearch-trigger-bot[bot]

api/OpenSearchApi.d.ts

@@ -692,6 +692,14 @@ export default class OpenSearchAPI {
 
   };
 
+  ltr: {
+    stats (params?: API.Ltr_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ltr_Stats_Response>;
+    stats (callback: callbackFn<API.Ltr_Stats_Response>): TransportRequestCallback;
+    stats (params: API.Ltr_Stats_Request, callback: callbackFn<API.Ltr_Stats_Response>): TransportRequestCallback;
+    stats (params: API.Ltr_Stats_Request, options: TransportRequestOptions, callback: callbackFn<API.Ltr_Stats_Response>): TransportRequestCallback;
+
+  };
+
   ml: {
     executeAlgorithm (params: API.Ml_ExecuteAlgorithm_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_ExecuteAlgorithm_Response>;
     executeAlgorithm (params: API.Ml_ExecuteAlgorithm_Request, callback: callbackFn<API.Ml_ExecuteAlgorithm_Response>): TransportRequestCallback;

api/OpenSearchApi.js

@@ -35,6 +35,7 @@ class OpenSearchAPI {
       ism: new(require('./ism/_api'))(this),
       knn: new(require('./knn/_api'))(this),
       list: new(require('./list/_api'))(this),
+      ltr: new(require('./ltr/_api'))(this),
       ml: new(require('./ml/_api'))(this),
       nodes: new(require('./nodes/_api'))(this),
       notifications: new(require('./notifications/_api'))(this),
@@ -165,6 +166,7 @@ class OpenSearchAPI {
       ism: { get() { return this[kApiModules].ism } },
       knn: { get() { return this[kApiModules].knn } },
       list: { get() { return this[kApiModules].list } },
+      ltr: { get() { return this[kApiModules].ltr } },
       ml: { get() { return this[kApiModules].ml } },
       nodes: { get() { return this[kApiModules].nodes } },
       notifications: { get() { return this[kApiModules].notifications } },

api/_core/exists.d.ts

@@ -34,9 +34,7 @@ export interface Exists_Request extends Global.Params {
   version_type?: Common.VersionType;
 }
 
-export interface Exists_Response extends ApiResponse {
-  body: Exists_ResponseBody;
-}
+export type Exists_Response = boolean
 
 export type Exists_ResponseBody = Record<string, any>
 

api/_core/existsSource.d.ts

@@ -33,9 +33,7 @@ export interface ExistsSource_Request extends Global.Params {
   version_type?: Common.VersionType;
 }
 
-export interface ExistsSource_Response extends ApiResponse {
-  body: ExistsSource_ResponseBody;
-}
+export type ExistsSource_Response = boolean
 
 export type ExistsSource_ResponseBody = Record<string, any>
 

api/_core/ping.d.ts

@@ -19,9 +19,7 @@ import * as Global from '../_types/_global'
 
 export type Ping_Request = Global.Params & Record<string, any>
 
-export interface Ping_Response extends ApiResponse {
-  body: Ping_ResponseBody;
-}
+export type Ping_Response = boolean
 
 export type Ping_ResponseBody = Record<string, any>
 

api/_types/_common.aggregations.d.ts

@@ -42,79 +42,150 @@ export type Aggregation = {
 }
 
 export type AggregationContainer = {
-  adjacency_matrix?: AdjacencyMatrixAggregation;
   aggregations?: Record<string, AggregationContainer>;
-  auto_date_histogram?: AutoDateHistogramAggregation;
-  avg?: AverageAggregation;
-  avg_bucket?: AverageBucketAggregation;
-  boxplot?: BoxplotAggregation;
-  bucket_script?: BucketScriptAggregation;
-  bucket_selector?: BucketSelectorAggregation;
-  bucket_sort?: BucketSortAggregation;
-  cardinality?: CardinalityAggregation;
-  children?: ChildrenAggregation;
-  composite?: CompositeAggregation;
-  cumulative_cardinality?: CumulativeCardinalityAggregation;
-  cumulative_sum?: CumulativeSumAggregation;
-  date_histogram?: DateHistogramAggregation;
-  date_range?: DateRangeAggregation;
-  derivative?: DerivativeAggregation;
-  diversified_sampler?: DiversifiedSamplerAggregation;
-  extended_stats?: ExtendedStatsAggregation;
-  extended_stats_bucket?: ExtendedStatsBucketAggregation;
-  filter?: Common_QueryDsl.QueryContainer;
-  filters?: FiltersAggregation;
-  geo_bounds?: GeoBoundsAggregation;
-  geo_centroid?: GeoCentroidAggregation;
-  geo_distance?: GeoDistanceAggregation;
-  geo_line?: GeoLineAggregation;
-  geohash_grid?: GeoHashGridAggregation;
-  geotile_grid?: GeoTileGridAggregation;
-  global?: GlobalAggregation;
-  histogram?: HistogramAggregation;
-  inference?: InferenceAggregation;
-  ip_range?: IpRangeAggregation;
-  line?: GeoLineAggregation;
-  matrix_stats?: MatrixStatsAggregation;
-  max?: MaxAggregation;
-  max_bucket?: MaxBucketAggregation;
-  median_absolute_deviation?: MedianAbsoluteDeviationAggregation;
+  aggs?: Record<string, AggregationContainer>;
   meta?: Common.Metadata;
-  min?: MinAggregation;
-  min_bucket?: MinBucketAggregation;
-  missing?: MissingAggregation;
-  moving_avg?: MovingAverageAggregation;
-  moving_fn?: MovingFunctionAggregation;
-  moving_percentiles?: MovingPercentilesAggregation;
-  multi_terms?: MultiTermsAggregation;
-  nested?: NestedAggregation;
-  normalize?: NormalizeAggregation;
-  parent?: ParentAggregation;
-  percentile_ranks?: PercentileRanksAggregation;
-  percentiles?: PercentilesAggregation;
-  percentiles_bucket?: PercentilesBucketAggregation;
-  range?: RangeAggregation;
-  rare_terms?: RareTermsAggregation;
-  rate?: RateAggregation;
-  reverse_nested?: ReverseNestedAggregation;
-  sampler?: SamplerAggregation;
-  scripted_metric?: ScriptedMetricAggregation;
-  serial_diff?: SerialDifferencingAggregation;
-  significant_terms?: SignificantTermsAggregation;
-  significant_text?: SignificantTextAggregation;
-  stats?: StatsAggregation;
-  stats_bucket?: StatsBucketAggregation;
-  string_stats?: StringStatsAggregation;
-  sum?: SumAggregation;
-  sum_bucket?: SumBucketAggregation;
-  t_test?: TTestAggregation;
-  terms?: TermsAggregation;
-  top_hits?: TopHitsAggregation;
-  top_metrics?: TopMetricsAggregation;
-  value_count?: ValueCountAggregation;
-  variable_width_histogram?: VariableWidthHistogramAggregation;
-  weighted_avg?: WeightedAverageAggregation;
-}
+} & ({
+  adjacency_matrix: AdjacencyMatrixAggregation;
+} | {
+  auto_date_histogram: AutoDateHistogramAggregation;
+} | {
+  avg: AverageAggregation;
+} | {
+  avg_bucket: AverageBucketAggregation;
+} | {
+  boxplot: BoxplotAggregation;
+} | {
+  bucket_script: BucketScriptAggregation;
+} | {
+  bucket_selector: BucketSelectorAggregation;
+} | {
+  bucket_sort: BucketSortAggregation;
+} | {
+  cardinality: CardinalityAggregation;
+} | {
+  children: ChildrenAggregation;
+} | {
+  composite: CompositeAggregation;
+} | {
+  cumulative_cardinality: CumulativeCardinalityAggregation;
+} | {
+  cumulative_sum: CumulativeSumAggregation;
+} | {
+  date_histogram: DateHistogramAggregation;
+} | {
+  date_range: DateRangeAggregation;
+} | {
+  derivative: DerivativeAggregation;
+} | {
+  diversified_sampler: DiversifiedSamplerAggregation;
+} | {
+  extended_stats: ExtendedStatsAggregation;
+} | {
+  extended_stats_bucket: ExtendedStatsBucketAggregation;
+} | {
+  filter: Common_QueryDsl.QueryContainer;
+} | {
+  filters: FiltersAggregation;
+} | {
+  geo_bounds: GeoBoundsAggregation;
+} | {
+  geo_centroid: GeoCentroidAggregation;
+} | {
+  geo_distance: GeoDistanceAggregation;
+} | {
+  geohash_grid: GeoHashGridAggregation;
+} | {
+  geo_line: GeoLineAggregation;
+} | {
+  geotile_grid: GeoTileGridAggregation;
+} | {
+  global: GlobalAggregation;
+} | {
+  histogram: HistogramAggregation;
+} | {
+  ip_range: IpRangeAggregation;
+} | {
+  inference: InferenceAggregation;
+} | {
+  line: GeoLineAggregation;
+} | {
+  matrix_stats: MatrixStatsAggregation;
+} | {
+  max: MaxAggregation;
+} | {
+  max_bucket: MaxBucketAggregation;
+} | {
+  median_absolute_deviation: MedianAbsoluteDeviationAggregation;
+} | {
+  min: MinAggregation;
+} | {
+  min_bucket: MinBucketAggregation;
+} | {
+  missing: MissingAggregation;
+} | {
+  moving_avg: MovingAverageAggregation;
+} | {
+  moving_percentiles: MovingPercentilesAggregation;
+} | {
+  moving_fn: MovingFunctionAggregation;
+} | {
+  multi_terms: MultiTermsAggregation;
+} | {
+  nested: NestedAggregation;
+} | {
+  normalize: NormalizeAggregation;
+} | {
+  parent: ParentAggregation;
+} | {
+  percentile_ranks: PercentileRanksAggregation;
+} | {
+  percentiles: PercentilesAggregation;
+} | {
+  percentiles_bucket: PercentilesBucketAggregation;
+} | {
+  range: RangeAggregation;
+} | {
+  rare_terms: RareTermsAggregation;
+} | {
+  rate: RateAggregation;
+} | {
+  reverse_nested: ReverseNestedAggregation;
+} | {
+  sampler: SamplerAggregation;
+} | {
+  scripted_metric: ScriptedMetricAggregation;
+} | {
+  serial_diff: SerialDifferencingAggregation;
+} | {
+  significant_terms: SignificantTermsAggregation;
+} | {
+  significant_text: SignificantTextAggregation;
+} | {
+  stats: StatsAggregation;
+} | {
+  stats_bucket: StatsBucketAggregation;
+} | {
+  string_stats: StringStatsAggregation;
+} | {
+  sum: SumAggregation;
+} | {
+  sum_bucket: SumBucketAggregation;
+} | {
+  terms: TermsAggregation;
+} | {
+  top_hits: TopHitsAggregation;
+} | {
+  t_test: TTestAggregation;
+} | {
+  top_metrics: TopMetricsAggregation;
+} | {
+  value_count: ValueCountAggregation;
+} | {
+  weighted_avg: WeightedAverageAggregation;
+} | {
+  variable_width_histogram: VariableWidthHistogramAggregation;
+})
 
 export type AggregationRange = {
   from?: undefined | number | string;
@@ -1088,6 +1159,7 @@ export type SimpleValueAggregate = SingleMetricAggregateBase & Record<string, an
 
 export type SingleBucketAggregateBase = AggregateBase & {
   doc_count: number;
+  [key: string]: any | Aggregate;
 }
 
 export type SingleMetricAggregateBase = AggregateBase & {

api/_types/_common.d.ts

@@ -471,6 +471,7 @@ export type PluginStats = {
   licensed?: boolean;
   name: Name;
   opensearch_version: VersionString;
+  optional_extended_plugins?: string[];
   version: VersionString;
 }
 
@@ -894,7 +895,7 @@ export type WaitForActiveShardOptions = 'all' | 'index-setting'
 
 export type WaitForActiveShards = number | WaitForActiveShardOptions
 
-export type WaitForEvents = 'high' | 'immediate' | 'languid' | 'low' | 'normal' | 'urgent'
+export type WaitForEvents = 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid'
 
 export type WarmerStats = {
   current: number;

api/_types/_common.mapping.d.ts

@@ -452,6 +452,7 @@ export type VersionProperty = DocValuesPropertyBase & {
 }
 
 export type WildcardProperty = DocValuesPropertyBase & {
+  normalizer?: string;
   null_value?: string;
   type: 'wildcard';
 }

api/_types/_common.query_dsl.d.ts

@@ -92,7 +92,15 @@ export type DisMaxQuery = QueryBase & {
   tie_breaker?: number;
 }
 
-export type DistanceFeatureQuery = QueryBase & Record<string, any>
+export type DistanceFeatureQuery = QueryBase & ({
+  field: Common.Field;
+  origin: Common.GeoLocation;
+  pivot: Common.Distance;
+} | {
+  field: Common.Field;
+  origin: Common.DateMath;
+  pivot: Common.Duration;
+})
 
 export type ExistsQuery = QueryBase & {
   field: Common.Field;
@@ -224,6 +232,7 @@ export type HasParentQuery = QueryBase & {
 }
 
 export type HybridQuery = QueryBase & {
+  pagination_depth?: number;
   queries?: QueryContainer[];
 }
 
@@ -590,7 +599,7 @@ export type RandomScoreFunction = {
   seed?: number | string;
 }
 
-export type RangeQuery = RangeQueryBase & Record<string, any>
+export type RangeQuery = RangeQueryBase & (NumberRangeQueryParameters | DateRangeQueryParameters)
 
 export type RangeQueryBase = QueryBase & {
   relation?: RangeRelation;

api/_types/_core.explain.d.ts

@@ -18,12 +18,12 @@
 export type Explanation = {
   description: string;
   details: ExplanationDetail[];
-  value: number | number | number | number;
+  value: number;
 }
 
 export type ExplanationDetail = {
   description: string;
   details?: ExplanationDetail[];
-  value: number | number | number | number;
+  value: number;
 }