Updated opensearch-js to reflect the latest OpenSearch API spec (2025…

…-02-23) (#980)

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

api/_types/_common.analysis.d.ts

@@ -493,6 +493,16 @@ export type SimpleAnalyzer = {
   version?: Common.VersionString;
 }
 
+export type SimplePatternSplitTokenizer = TokenizerBase & {
+  pattern?: string;
+  type: 'simple_pattern_split';
+}
+
+export type SimplePatternTokenizer = TokenizerBase & {
+  pattern?: string;
+  type: 'simple_pattern';
+}
+
 export type SmartcnAnalyzer = {
   type?: 'smartcn';
 }
@@ -598,7 +608,7 @@ export type TokenizerBase = {
   version?: Common.VersionString;
 }
 
-export type TokenizerDefinition = CharGroupTokenizer | EdgeNGramTokenizer | KeywordTokenizer | LetterTokenizer | LowercaseTokenizer | NGramTokenizer | NoriTokenizer | PathHierarchyTokenizer | StandardTokenizer | UaxEmailUrlTokenizer | WhitespaceTokenizer | KuromojiTokenizer | PatternTokenizer | IcuTokenizer | SmartcnTokenizer
+export type TokenizerDefinition = CharGroupTokenizer | EdgeNGramTokenizer | KeywordTokenizer | LetterTokenizer | LowercaseTokenizer | NGramTokenizer | NoriTokenizer | PathHierarchyTokenizer | StandardTokenizer | UaxEmailUrlTokenizer | WhitespaceTokenizer | KuromojiTokenizer | PatternTokenizer | SimplePatternTokenizer | SimplePatternSplitTokenizer | IcuTokenizer | SmartcnTokenizer
 
 export type TrimTokenFilter = TokenFilterBase & {
   type: 'trim';

api/_types/_core.search.d.ts

@@ -52,21 +52,16 @@ export type AggregationProfileDebug = {
   collection_strategy?: string;
   deferred_aggregators?: string[];
   delegate?: string;
-  delegate_debug?: AggregationProfileDebug;
+  delegate_debug?: AggregationProfileDelegateDebug;
   empty_collectors_used?: number;
   extract_count?: number;
   extract_ns?: number;
-  filters?: AggregationProfileDelegateDebugFilter[];
   has_filter?: boolean;
   map_reducer?: string;
   numeric_collectors_used?: number;
   ordinals_collectors_overhead_too_high?: number;
   ordinals_collectors_used?: number;
   result_strategy?: string;
-  segments_collected?: number;
-  segments_counted?: number;
-  segments_with_deleted_docs?: number;
-  segments_with_doc_count_field?: number;
   segments_with_multi_valued_ords?: number;
   segments_with_single_valued_ords?: number;
   string_hashing_collectors_used?: number;
@@ -75,6 +70,14 @@ export type AggregationProfileDebug = {
   values_fetched?: number;
 }
 
+export type AggregationProfileDelegateDebug = {
+  filters?: AggregationProfileDelegateDebugFilter[];
+  segments_collected?: number;
+  segments_counted?: number;
+  segments_with_deleted_docs?: number;
+  segments_with_doc_count_field?: number;
+}
+
 export type AggregationProfileDelegateDebugFilter = {
   query?: string;
   results_from_metadata?: number;
@@ -93,10 +96,25 @@ export type Collector = {
   time_in_nanos: Common.DurationValueUnitNanos;
 }
 
+export type CompletionContext = Context | {
+  boost?: number;
+  context: Context;
+  neighbours?: Common.GeoHashPrecision[];
+  precision?: Common.GeoHashPrecision;
+  prefix?: boolean;
+}
+
 export type CompletionSuggest = SuggestBase & {
   options: CompletionSuggestOption | CompletionSuggestOption[];
 }
 
+export type CompletionSuggester = SuggesterBase & {
+  contexts?: Record<string, CompletionContext[]>;
+  fuzzy?: SuggestFuzziness;
+  regex?: string;
+  skip_duplicates?: boolean;
+}
+
 export type CompletionSuggestOption = {
   _id?: string;
   _index?: Common.IndexName;
@@ -112,6 +130,20 @@ export type CompletionSuggestOption = {
 
 export type Context = string | Common.GeoLocation
 
+export type DirectGenerator = {
+  field: string;
+  max_edits?: number;
+  max_inspections?: number;
+  max_term_freq?: number;
+  min_doc_freq?: number;
+  min_word_length?: number;
+  post_filter?: string;
+  pre_filter?: string;
+  prefix_length?: number;
+  size?: number;
+  suggest_mode?: Common.SuggestMode;
+}
+
 export type FetchProfile = {
   breakdown: FetchProfileBreakdown;
   children?: FetchProfile[];
@@ -143,6 +175,15 @@ export type FieldCollapse = {
   max_concurrent_group_searches?: number;
 }
 
+export type FieldSuggester = {
+  completion?: CompletionSuggester;
+  phrase?: PhraseSuggester;
+  prefix?: string;
+  regex?: string;
+  term?: TermSuggester;
+  text?: string;
+}
+
 export type Highlight = HighlightBase & {
   encoder?: HighlighterEncoder;
   fields: Record<string, HighlightField>;
@@ -240,6 +281,16 @@ export type InnerHitsResult = {
   hits: HitsMetadata;
 }
 
+export type LaplaceSmoothingModel = {
+  alpha: number;
+}
+
+export type LinearInterpolationSmoothingModel = {
+  bigram_lambda: number;
+  trigram_lambda: number;
+  unigram_lambda: number;
+}
+
 export type NestedIdentity = {
   _nested?: NestedIdentity;
   field: Common.Field;
@@ -250,6 +301,38 @@ export type PhraseSuggest = SuggestBase & {
   options: PhraseSuggestOption | PhraseSuggestOption[];
 }
 
+export type PhraseSuggestCollate = {
+  params?: Record<string, any>;
+  prune?: boolean;
+  query: PhraseSuggestCollateQuery;
+}
+
+export type PhraseSuggestCollateQuery = {
+  id?: string;
+  source?: string;
+}
+
+export type PhraseSuggester = SuggesterBase & {
+  collate?: PhraseSuggestCollate;
+  confidence?: number;
+  direct_generator?: DirectGenerator[];
+  force_unigrams?: boolean;
+  gram_size?: number;
+  highlight?: PhraseSuggestHighlight;
+  max_errors?: number;
+  real_word_error_likelihood?: number;
+  separator?: string;
+  shard_size?: number;
+  smoothing?: SmoothingModel;
+  text?: string;
+  token_limit?: number;
+}
+
+export type PhraseSuggestHighlight = {
+  post_tag: string;
+  pre_tag: string;
+}
+
 export type PhraseSuggestOption = {
   collate_match?: boolean;
   highlighted?: string;
@@ -340,6 +423,12 @@ export type ShardProfile = {
   searches: SearchProfile[];
 }
 
+export type SmoothingModel = {
+  laplace?: LaplaceSmoothingModel;
+  linear_interpolation?: LinearInterpolationSmoothingModel;
+  stupid_backoff?: StupidBackoffSmoothingModel;
+}
+
 export type SourceConfig = boolean | SourceFilter
 
 export type SourceConfigParam = boolean | Common.Fields
@@ -349,6 +438,12 @@ export type SourceFilter = Common.Fields | {
   includes?: Common.Fields;
 }
 
+export type StringDistance = 'damerau_levenshtein' | 'internal' | 'jaro_winkler' | 'levenshtein' | 'ngram'
+
+export type StupidBackoffSmoothingModel = {
+  discount: number;
+}
+
 export type Suggest = CompletionSuggest | PhraseSuggest | TermSuggest
 
 export type SuggestBase = {
@@ -359,15 +454,47 @@ export type SuggestBase = {
 
 export type Suggester = {
   text?: string;
+  [key: string]: any | FieldSuggester;
+}
+
+export type SuggesterBase = {
+  analyzer?: string;
+  field: string;
+  size?: number;
 }
 
+export type SuggestFuzziness = {
+  fuzziness: string;
+  min_length: number;
+  prefix_length: number;
+  transpositions: boolean;
+  unicode_aware: boolean;
+}
+
+export type SuggestSort = 'frequency' | 'score'
+
 export type TermSuggest = SuggestBase & {
   options: TermSuggestOption | TermSuggestOption[];
 }
 
+export type TermSuggester = SuggesterBase & {
+  lowercase_terms?: boolean;
+  max_edits?: number;
+  max_inspections?: number;
+  max_term_freq?: number;
+  min_doc_freq?: number;
+  min_word_length?: number;
+  prefix_length?: number;
+  shard_size?: number;
+  sort?: SuggestSort;
+  string_distance?: StringDistance;
+  suggest_mode?: Common.SuggestMode;
+  text?: string;
+}
+
 export type TermSuggestOption = {
   collate_match?: boolean;
-  freq: number;
+  freq?: number;
   highlighted?: string;
   score: number;
   text: string;

api/_types/search_pipeline._common.d.ts

@@ -14,6 +14,7 @@
  * modify the API generator.
  */
 
+import * as Common_QueryDsl from './_common.query_dsl'
 
 export type CollapseResponseProcessor = {
   context_prefix?: string;
@@ -26,7 +27,7 @@ export type CollapseResponseProcessor = {
 export type FilterQueryRequestProcessor = {
   description?: string;
   ignore_failure?: boolean;
-  query?: UserDefinedObjectStructure;
+  query?: Common_QueryDsl.QueryContainer;
   tag?: string;
 }
 
@@ -188,62 +189,3 @@ export type TruncateHitsResponseProcessor = {
   target_size?: number;
 }
 
-export type UserDefinedObjectStructure = {
-  bool?: any;
-  boosting?: any;
-  combined_fields?: any;
-  constant_score?: any;
-  dis_max?: any;
-  distance_feature?: any;
-  exists?: any;
-  field_masking_span?: any;
-  function_score?: any;
-  fuzzy?: UserDefinedValueMap;
-  geo_bounding_box?: any;
-  geo_distance?: any;
-  geo_polygon?: any;
-  geo_shape?: any;
-  has_child?: any;
-  has_parent?: any;
-  ids?: any;
-  intervals?: UserDefinedValueMap;
-  knn?: any;
-  match?: UserDefinedValueMap;
-  match_all?: any;
-  match_bool_prefix?: UserDefinedValueMap;
-  match_none?: any;
-  match_phrase?: UserDefinedValueMap;
-  match_phrase_prefix?: UserDefinedValueMap;
-  more_like_this?: any;
-  multi_match?: any;
-  nested?: any;
-  parent_id?: any;
-  percolate?: any;
-  pinned?: any;
-  prefix?: UserDefinedValueMap;
-  query_string?: any;
-  range?: UserDefinedValueMap;
-  rank_feature?: any;
-  regexp?: UserDefinedValueMap;
-  script?: any;
-  script_score?: any;
-  shape?: any;
-  simple_query_string?: any;
-  span_containing?: any;
-  span_first?: any;
-  span_multi?: any;
-  span_near?: any;
-  span_not?: any;
-  span_or?: any;
-  span_term?: UserDefinedValueMap;
-  span_within?: any;
-  term?: UserDefinedValueMap;
-  terms?: any;
-  terms_set?: UserDefinedValueMap;
-  wildcard?: UserDefinedValueMap;
-  wrapper?: any;
-}
-
-export type UserDefinedValueMap = {
-}
-

api/security/authinfo.js

@@ -19,14 +19,14 @@
 const { normalizeArguments } = require('../utils');
 
 /**
- * Returns the authentication information.
+ * Returns or updates authentication information for the currently authenticated user.
  * <br/> See Also: {@link undefined - security.authinfo}
  *
  * @memberOf API-Security
  *
  * @param {object} [params]
- * @param {string} [params.auth_type] - The type of current authentication request.
- * @param {boolean} [params.verbose] - Indicates whether a verbose response should be returned.
+ * @param {string} [params.auth_type] - The type of the current authentication request.
+ * @param {boolean} [params.verbose] - Whether to return a verbose response.
  *
  * @param {TransportRequestOptions} [options] - Options for {@link Transport#request}
  * @param {function} [callback] - Callback that handles errors and response

api/security/authtoken.js

@@ -19,7 +19,7 @@
 const { normalizeArguments } = require('../utils');
 
 /**
- * Returns the authorization token.
+ * Returns the authorization token for the current user.
  * <br/> See Also: {@link undefined - security.authtoken}
  *
  * @memberOf API-Security

api/security/configUpgradeCheck.js

@@ -19,7 +19,7 @@
 const { normalizeArguments } = require('../utils');
 
 /**
- * Check whether or not an upgrade can be performed and what resources can be updated.
+ * Checks whether or not an upgrade can be performed and which security resources can be updated.
  * <br/> See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check - security.config_upgrade_check}
  *
  * @memberOf API-Security

api/security/configUpgradePerform.js

@@ -19,7 +19,7 @@
 const { normalizeArguments } = require('../utils');
 
 /**
- * Helps cluster operator upgrade missing defaults and stale default definitions.
+ * Assists the cluster operator with upgrading missing default values and stale default definitions.
  * <br/> See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade - security.config_upgrade_perform}
  *
  * @memberOf API-Security

api/security/createAllowlist.js

@@ -19,7 +19,7 @@
 const { normalizeArguments, handleMissingParam } = require('../utils');
 
 /**
- * Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission.
+ * Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.
  * <br/> See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - security.create_allowlist}
  *
  * @memberOf API-Security